IP Command

IP commands perform image processing work, such as image cleanup, format conversion, or feature detection.

Remarks

IP Commands are used to construct IP Profiles, and are also used as stand-alone properties on some Grooper types.

Some IP Commands modify the images they process, while other IP Commands simply detect features in an image, without modifying the image in any way.

Each IP Command defines a set of supported pixel formats. If an image with an unsupported pixel format is encountered, the command will take no action.

List of IP Command Types

Name Description
Border Cleanup
 Auto Border Crop Detects black borders around the edge of an image, crops the image to remove the border, and cleans up remaining edge artifacts.
 Auto Border Invert Detects dark borders around the edge of an image and inverts or fills the area occupied by the border.
 Border Fill Drops out artifacts around the edge of an image.
 Crop Crops borders of an image by a specified amount.
Color Adjustment
 Adjust Saturation Adjusts the saturation (color intensity) in an image.
 Adjust Tint Adjusts the tint in an image.
 Auto Adjust Levels The Adjust Levels command corrects the tonal range and color balance by adjusting the shadow, midtone, and highlights of an image.
 Auto Color Balance Automatically corrects the color and contrast of an image.
 Auto White Balance Automatically adjusts the white point in an image.
 Brightness Contrast Modifies the brightness and/or contrast of an image.
 Color Dropout Replaces pixels in a specific color range with a replacement color.
 Colorize This command can be used to replace the hue, saturation and luminance values in an image with those of the specified base color.
 Contrast Stretch Adjusts the contrast of an image so that the lightest pixels are 100% white, and darkest pixels are 100% black.
 Gamma Adjust Controls the gamma correction level.
 Invert Inverts images which are negated.
 Posterize Generates an image made up of primary and secondary colors of the source image.
 Solarize Use this command to adjust the curves to generate a classic "solarize" effect.
 Swap Channels Converts RGB to BGR.
Feature Detection
 Barcode Detection Detects and reads barcode data.
 Blank Page Detection Detects whether an image is blank.
 Box Detection Detects checkboxes in an image and reads their check state.
 Color Detection Detects whether an image contains color, grayscale, or black and white content, optionally converting the image to the detected color depth.
 Corner Detection Detects corners formed by lines in an image.
 Edge Detection Performs Canny edge detection.
 Hough Lines Detects lines at arbitrary angles in an image using a Hough Transform.
 Line Detection Detects the horizontal and vertical line structure in a document image.
 Patch Code Detection The Detect Patch Codes command is used to determine if an image contains a patch code. This command is frequently used for Separation. This command returns true if a patch code is detected and false if one is not.
 Shape Detection Detects regions within an image which are similar to a sample image.
 Sticky Note Detection Detects color sticky notes, optionally flagging the pages on which they are detected.
Feature Removal
 Barcode Removal Removes barcodes from an image.
 Blob Removal Removes blobs from the image which meet specific size and fill requirements.
 Box Removal Removes checkboxes from an image.
 Halftone Removal Removes halftone regions from an image.
 Hole Punch Removal Removes circular hole punch artifacts from an image.
 Line Removal Removes horizontal and vertical lines from an image.
 Negative Region Removal Detects rectangular negated regions in an image and either inverts or removes them.
 Scratch Removal Digitally removes scratches occurring on film-based media such as microfilm, microfiche, aperture cards, or 35mm slides.
 Shade Removal Removes rectangular shaded regions from a color or grayscale image.
 Shape Removal Detects and removes regions of an image which match one or more trained image templates.
 Speck Removal Removes small specks from an image.
Format Conversion
 Auto Convert Changes the color depth of an image to match the content of the image.
 Convert Changes the color format of an image.
 Threshold Converts an image to black and white using a variety of thresholding methods.
Image Analysis
 Analyze Photo Extracts a set of classification features from the visual content of an image.
 Auto QA Automatically flags images which meet certain criteria, such as being too dark, too light, or too busy.
 Compute Moments Calculates Hu Moments for an image.
 Extract Features Divides an image into an NxN matrix of cells and generates a vector of N*N features.
 Histogram Calculates an image histogram.
 Measure Entropy Measures the entropy (amount of change) in an image.
 Projection Profile Generates a projection profile.
Image Transforms
 Auto Deskew Detects the skew angle of text in an image, and rotates the image to compensate.
 Auto Orient Determines the correct orientation for an image and rotates the image by analyzing the orientation of the characters on the page.
 Extract Page Extracts a page from a carrier image.
 Resize Resizes an image.
 Rotate Rotates an image by a given angle.
 Warp Extracts a quadrilateral shape from an image, and warps it to a rectangular output image.
Miscellaneous
 Binarize Converts an image to 8-bit black and white using various thresholding methods.
 Classify Image Compares an image against a set of sample images and classifies the image based upon which sample image it is found to be most similar to.
 Dilate Erode Applies a dilation (thicken) or erosion (thinning) filter to the image.
 Execute Profile Use this command to execute another IP Profile.
 Extract Channel Extracts a single channel from the source image..
 Filter Applies a filter to an image.
 Randomize Defects Applies randomized defects to an image.

Properties

The following 2 properties are defined.

Property Name Description
Command Info
Command Type Type: String

The type of IP command.

Supported Pixel Formats Type: String

The pixel formats supported by this command.