Binarize

Can be one of the following values:

The BinarizationMethod enumeration defines the available algorithms for converting grayscale or color images to black and white (binary) in the Binarize command. Each method is suited to different document conditions and use cases. Choosing the right method is essential for achieving optimal clarity, minimizing noise, and preserving important content.

The selected method determines which additional properties are relevant and visible for configuration.

Specifies the intensity cutoff for binarization when 'Method' is set to Simple.

• Pixels with intensity above this value are set to white; those below are set to black.
• Only used when 'Method' is Simple.
• Typical values range from 100 to 180 for standard document images.

Configuration Guidance

Increase the value to make the image lighter (more pixels become white); decrease to make it darker.
Use diagnostic mode to visualize the effect and fine-tune for your document type.

Example:
For a faint document, try a lower value such as 110. For a dark, high-contrast scan, use a higher value such as 160.

Determines the size of the neighborhood used to calculate a local threshold for each pixel when 'Method' is Adaptive or Dynamic.

• Larger windows smooth out local variations but may miss fine details.
• Expressed in units such as 5pt or 10px.

Configuration Guidance

Increase the window size for documents with large, uneven backgrounds or shadows. Decrease for documents with small text or fine details.

Example:
Use 10px for general documents, 20px for forms with large background gradients, or 3pt for small-font receipts.

Can be one of the following values:

Determines how the local average is calculated for each pixel's neighborhood.

• Box: All pixels in the window contribute equally. Faster and suitable for most documents.
• Gaussian: Pixels near the center have more influence, producing smoother transitions and reducing noise in variable backgrounds.

Configuration Guidance

Use Box for speed and general use. Use Gaussian for documents with complex or noisy backgrounds.

Controls the sensitivity of local thresholding to small changes in pixel intensity.

• Higher values make thresholding less sensitive, reducing noise but possibly missing faint text.
• Lower values increase sensitivity, capturing more detail but potentially introducing noise.
• Only used when 'Method' is Adaptive or Dynamic.

Configuration Guidance

Start with a value between 8 and 32. Increase to suppress background noise; decrease to capture faint handwriting or marks.

Example:
For a noisy background, try 32. For faint pencil marks, try 8.

Controls the spread of the Gaussian function when 'Kernel Type' is Gaussian and 'Method' is Adaptive or Dynamic.

• Higher values produce more smoothing, reducing the effect of noise.
• If set to zero, sigma is calculated automatically based on window size.

Configuration Guidance

Increase sigma for documents with highly variable backgrounds. Use the default (zero) for most cases.

Example:
For a document with strong background gradients, try 2.0. For most documents, leave at 0.

Restricts the range of the threshold value selected by Otsu's method when 'Method' is Auto.

• Expressed as a percentage (0.01–0.5).
• Prevents over- or under-thresholding due to unusual lighting or content.

Configuration Guidance

Lower values restrict the threshold to a narrow range, which can help with consistent document types. Higher values allow more flexibility for variable images.

Example:
For highly consistent forms, use 0.10. For mixed-quality scans, use 0.30 or higher.

Offsets the threshold value selected by Otsu's method when 'Method' is Auto.

• Positive values make the image lighter (more pixels become white).
• Negative values make the image darker (more pixels become black).

Configuration Guidance

Use this property to fine-tune results for specific document types.
Increase to reduce background speckle; decrease to capture faint marks.

Example:
For a document with faint text, set 'Adjustment' to -10. For a dark scan, set to +10.

Determines the extent to which dark regions are retained when 'Method' is Dynamic.

• Range: 0 (least aggressive) to 1 (most aggressive).
• Higher values retain more dark regions, which can help with faint handwriting, stamps, or marginalia.

Configuration Guidance

Increase for documents with important faint marks or handwriting. Decrease to suppress background noise.

Example:
For a form with faint pencil notes, use 0.5 or higher. For a clean, printed form, use 0.1.

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.

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.