ImageGear for C and C++ on Windows v19.4 - Updated
ImageClean Component API Reference
API Reference Guide > ImageClean Component API Reference

The ImageGear ImageClean component provides several API functions that allow you to enhance bi-level image support. It includes the ability to clean borders, invert white text, auto-orient image, auto invert black text on a white background, and auto-crop.

This section provides detailed information about the ImageClean component API.

ImageClean functions are only accessible through the ImageClean component named "CLN". Please see the section Component Manager API.

ImageClean functions are designated with the prefix IG_IC_...

IG_IC_check_for_noise Checks the image for the number of objects exceeding the size of the specified threshold value.
IG_IC_clean_borders Automatically detects and removes large black regions near the borders of a 1-bit image.
IG_IC_clean_borders_ex Detects and removes large black regions that are placed near the borders of a 1-bit image and have characteristics set by parameters of this function.
IG_IC_crop_auto Automatically crops any white borders from a 1-bit image.
IG_IC_invert_black_image Inverts all pixel values of a 1-bit image in which the percentage of black pixels is higher than the value you assign.
IG_IC_invert_white_text Automatically detects areas of white text on black backgrounds in 1-bit images, and inverts them so that they become black text on white backgrounds.
IG_IC_invert_white_text_ex Automatically detects areas of white text on black backgrounds in 1-bit images and inverts them so that they become black text on white backgrounds. This function scans your entire image and makes adjustments to all areas of white text (on black) that fall within the scope of your settings.
IG_IC_orient_auto Automatically determines the proper orientation of a 1-bit image and rotates the image to the proper orientation.
IG_IC_orient_auto_ex Automatically determines what the proper orientation of a 1-bit image should be and rotates this image to achieve that proper orientation.
IG_IC_remove_dot_lines Automatically detects and removes the dot lines on the 1-bit scanned image.
IG_IC_remove_lines Automatically detects and removes the horizontal and vertical lines on the 1-bit scanned image such as frames and tables.
IG_IC_remove_punch_holes Automatically detects and removes the punch holes on the 1-bit scanned image.

ImageClean has the following structures:

AT_IC_DOT_LINE_OPTIONS Specifies parameters for IG_IC_remove_dot_lines method.
AT_IC_LINE_OPTIONS Specifies parameters for IG_IC_remove_lines method.
AT_IC_PUNCH_HOLE_PARAMS Specifies parameters for IG_IC_remove_punch_holes method.

ImageClean has the following enumerations:

enumIGICDirection Specifies types of object orientations for ImageClean API.
enumIGICMethods Contains modes for the ImageClean Component functions.
enumIGICUnits Specifies types of the measure units used in ImageClean.