Auto Orient

Can be one of the following values:

The selected value determines which orientation detection algorithm is used by the 'AutoOrient' command.

• 'Transym': Uses the Transym OCR engine for orientation detection.
• 'Tesseract': Uses the Tesseract OCR engine for orientation detection.

The choice of method affects which properties are relevant and how orientation is determined.

The 'Threshold Settings' property defines how the input image is converted to black and white (binary) prior to analyzing its text orientation.
This preprocessing step is critical for reliable OCR-based orientation detection, as it enhances text clarity and reduces background noise.

The settings are configured using a Binarize object, which supports multiple thresholding methods:

• Simple: Applies a fixed threshold value to all pixels.
• Auto: Automatically determines the optimal threshold using Otsu's method.
• Adaptive: Calculates a local threshold for each pixel based on its neighborhood.
• Dynamic: Preserves dark regions more aggressively for challenging images.

Configuration Tips

• Choose the thresholding method and parameters that best suit your document type and image quality.
• For most scanned documents, 'Auto' or 'Adaptive' methods provide the best results.
• Use diagnostic mode to visualize the binarized image and fine-tune settings as needed.

Proper configuration of 'Threshold Settings' can significantly improve the accuracy of orientation detection. For more details, see the documentation for Binarize.

The 'Max Time' property limits how long the orientation detection process can run for each image when 'Method' is set to Transym.
This helps prevent excessive processing times on large or complex images, ensuring predictable performance in batch operations.

• If the analysis exceeds the specified time, the process will stop and return the best result found so far.
• This setting is ignored when 'Method' is set to Tesseract.

Configuration Guidance

• Increase 'Max Time' for images with dense or difficult-to-read text to improve detection accuracy.
• Decrease the value to speed up processing when working with large batches or when performance is a priority.
• Typical values range from 50 to 500 milliseconds, depending on image complexity and hardware.

Proper tuning of 'Max Time' can help balance accuracy and throughput in automated document processing workflows.

The 'Max Coverage' property controls the proportion of detected characters that the orientation detection process will analyze when 'Method' is set to Transym.
This allows you to balance detection accuracy with processing speed, especially on images with a large amount of text.

• A value of 1.0 (100%) means all detected characters will be considered for orientation analysis.
• Lower values (e.g., 0.5 for 50%) limit the analysis to a subset of characters, which can speed up processing at the potential cost of accuracy.
• This setting is ignored when 'Method' is set to Tesseract.

Configuration Guidance

• Use a lower 'Max Coverage' value to improve performance on high-volume or text-dense images.
• Use a higher value for critical documents where orientation accuracy is more important than speed.
• Typical values range from 0.01 (1%) to 1.0 (100%), with 1.0 being the default for maximum accuracy.

Adjusting 'Max Coverage' helps optimize the trade-off between processing time and orientation detection reliability in automated workflows.

The 'Minimum Confidence' property sets the threshold for accepting the orientation result when 'Method' is set to Tesseract.
The Tesseract engine assigns a confidence score (from 0.0 to 1.0) to its orientation detection. If the confidence is below this value, the result is considered unreliable and orientation will not be applied.

• A higher value increases the likelihood that only highly certain orientation results are accepted, but may cause more pages to be flagged as undetermined.
• A lower value allows more results to be accepted, but may increase the risk of incorrect orientation.
• This setting is ignored when 'Method' is set to Transym.

Configuration Guidance

• Increase 'Minimum Confidence' to reduce the risk of misoriented pages in critical workflows.
• Decrease the value to minimize the number of pages flagged for manual review.
• Typical values range from 0.01 (1%) to 1.0 (100%), with 0.25 (25%) as a common default.

Adjusting 'Minimum Confidence' helps you control the trade-off between automation and accuracy in orientation detection using Tesseract.

The 'Flag On Fail' property controls whether a page is explicitly flagged when orientation detection does not produce a reliable result.
When enabled, any image for which the orientation cannot be determined—due to low confidence, insufficient text, or other detection issues—will be marked for review.

• Flagged pages can be easily identified in downstream processes or user interfaces for manual inspection or correction.
• If disabled, pages with undetermined orientation will not be flagged, and processing will continue without special indication.

Usage Guidance

• Enable 'Flag On Fail' to ensure that problematic pages are not overlooked in quality control or exception handling workflows.
• Disabling this option may be appropriate in fully automated scenarios where manual review is not required.

This setting helps maintain document quality by drawing attention to pages that require further attention due to orientation detection failure.

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.