IP Command

Defines a configurable image processing command used to clean up, analyze, or transform images in Grooper.

Remarks

The IP Command class is the abstract base for all image processing commands in Grooper. Each command encapsulates a specific image processing operation, such as deskewing, binarization, color adjustment, or feature detection. IP Commands can be combined into IP Profiles or used as stand-alone properties on various Grooper objects.

• Each IP Command specifies the set of pixel formats it supports. If an image with an unsupported format is encountered, the command will take no action.
• Some IP Commands modify the image, while others only analyze or detect features without altering the image data.
• Many IP Commands support diagnostic mode, which can generate additional output (such as diagnostic images or logs) to assist with configuration and troubleshooting.

Supported Pixel Formats

Each IP Command defines its own list of supported pixel formats, accessible via the 'Supported Pixel Formats' property. By default, all pixel formats are supported unless overridden by a derived command.

Diagnostics

Some IP Commands generate diagnostic output when run in diagnostic mode. This may include before-and-after images, histograms, or log messages to help users understand the effect of the command and tune its parameters.

Usage Example

To construct an IP Profile, add one or more IP Commands in the desired order. Each command will be applied in sequence to the input image, with the output of one command serving as the input to the next.

Properties

Name	Type		Description
Command Type	String	►	The display name of this image processing command. The 'Command Type Name' property shows the user-friendly name of the IP Command as it appears in the Grooper UI. This helps users identify which command is being configured or executed, especially when working with IP Profiles containing multiple commands. This property is read-only and is automatically set based on the command's type.
Supported Pixel Formats	String	►	The pixel formats supported by this command. The 'Supported Pixel Formats' property lists the image pixel formats that the IP Command can process. If an image does not match one of these formats, the command will be skipped for that image. By default, all pixel formats are supported unless a derived command restricts this list. Example formats include Pixel8bppGrayscale, Pixel24bppBgr, and Pixel1bppIndexed. Use this property to verify compatibility when building IP Profiles or troubleshooting why a command did not execute.

Derived Types

There are 67 implementations of IP Command.

Border Cleanup
Auto Border Crop	Detects and removes black borders and edge artifacts from images.
Auto Border Invert	Detects dark borders around the edge of an image and inverts or fills the area occupied by the border.
Border Fill	Removes artifacts and unwanted features near the edges of binary images.
Crop	Crops borders of an image by a specified amount or region.
Color Adjustment
Adjust Saturation	Adjusts the saturation (color intensity) in an image.
Adjust Tint	Adjusts the tint in an image.
Auto Adjust Levels	Corrects the tonal range and color balance by adjusting the shadow, mid-tone, 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	Adjusts the brightness and contrast of an image using either traditional or linear methods.
Color Dropout	Replaces pixels in a specific color range with a replacement color.
Colorize	Replaces the hue, saturation, and luminance values in an image with those of a specified base color.
Contrast Stretch	Adjusts the contrast of an image so that the lightest pixels become pure white and the darkest pixels become pure black.
Gamma Adjust	Adjusts the gamma correction level of an image to control midtone brightness and contrast.
Invert	Inverts the pixel values of negated images, converting white features on a black background to black features on a white background.
Posterize	Reduces the number of colors in an image, generating a stylized effect using only primary and secondary colors.
Solarize	Applies a classic "solarize" effect to an image by adjusting the tonal curves.
Swap Channels	Swaps the red and blue channels of an image, converting between RGB and BGR formats.
Feature Detection
Barcode Detection	Detects and reads barcode data from images using a configurable set of barcode readers and preprocessing options.
Blank Page Detection	Detects whether an image is blank for the purposes of automated page deletion, separation, or classification.
Box Detection	Detects check boxes in an image and reads their check state.
Color Detection	Analyzes an image to determine whether it contains color.
Color Stamp Detection	Detects color stamps in document images for use in separation, classification, or automated removal workflows.
Corner Detection	Detects corners formed by lines in an image using configurable detection methods.
Edge Detection	Performs Canny edge detection on an image to identify edges and contours.
Hough Lines	Detects lines at arbitrary angles in an image using a Hough Transform.
Line Detection	Detects horizontal and vertical line structures in document images generating Layout Data for downstream processing.
Patch Code Detection	Detects patch codes in an image for use in document separation and classification workflows.
Shape Detection	Detects regions within an image which are similar to a sample image.
Sticky Note Detection	Detects color sticky notes in scanned images, optionally flagging pages where sticky notes are found.
Feature Removal
Barcode Removal	Removes barcode regions from an image using configurable detection and masking options.
Blob Removal	Removes blobs from the image that meet specific size, shape, or fill requirements.
Box Removal	Removes checkboxes from an image and generates Layout Data for OMR extraction.
Halftone Removal	Removes halftone regions from an image to improve OCR and document clarity.
Hole Punch Removal	Removes circular hole punch artifacts from an image, typically found along the edges of scanned documents.
Line Removal	Removes horizontal and vertical lines from an image, typically to clean up an image prior to OCR=.
Negative Region Removal	Detects negated regions in an image and either inverts or removes them.
OCR Cleanup	Performs temporary image cleanup to improve OCR results by removing non-text features.
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	Automatically converts an image to color, grayscale, or black and white based on its content.
Convert	Changes the color format of an image.
Threshold	Converts an image to black and white (binary) 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 the seven Hu invariant moments for an image, providing features that describe the image's shape and structure.
Extract Features	Divides an image into an NxN matrix of cells and generates a vector of N*N features.
Histogram	Analyzes the distribution of pixel intensities in an image by calculating a histogram.
Measure Entropy	Quantifies the amount of change or visual complexity in an image using entropy-based measurements.
Projection Profile	Computes projection profiles to analyze the distribution of pixel intensities along the X and Y axes of an image.
Image Transforms
Auto Deskew	Detects and corrects the skew angle of text in an image by analyzing character alignment and rotating the image to compensate.
Auto Orient	Rotates an image so that its text content is upright, using OCR-based orientation detection.
Extract Page	Extracts a page from a carrier image by detecting its edges and de-warping the result.
Mirror	Mirrors an image along the specified axis, producing a horizontally, vertically, or doubly mirrored result.
Resize	Resizes an image using a variety of sizing methods and interpolation modes.
Rotate	Rotates an image by a specified angle, allowing for precise orientation adjustments within a document processing workflow.
Warp	Warps a quadrilateral region of an image to a rectangular output, correcting for perspective distortion and enabling extraction of skewed or angled content.
Miscellaneous
Binarize	Converts grayscale or color images to black and white (binary) using multiple thresholding methods for optimal document clarity.
Classify Image	Classifies an image by comparing it to a set of sample images, assigning the image to the class with the highest similarity.
Dilate Erode	Applies a dilation (thickening) or erosion (thinning) filter to the image using a configurable mask and operation type.
Execute Profile	Executes a specified IP Profile as part of an image processing workflow, enabling modular and reusable processing pipelines.
Extract Channel	Extracts a single channel from the source image and outputs it as an 8-bit grayscale image.
Filter	Applies a configurable filter to an image for noise reduction, enhancement, or feature transformation.
Randomize Defects	Applies randomized defects to an image to simulate common scanning artifacts for testing of image cleanup workflows.
Undistort	Removes radial and tangential distortion from images captured with a camera or mobile device.

Used By

IP Step