IP Profile

Serves as the root container for defining and executing a sequence or hierarchy of image processing operations in Grooper.

Remarks

The IP Profile class orchestrates the image processing workflow by organizing IP Steps and IP Groups into a configurable sequence or hierarchy. It is the entry point for applying a series of image processing commands to an image, supporting both simple linear pipelines and complex, conditionally branching workflows.

IP Profiles are highly flexible, allowing you to:

• Define a straightforward sequence of IP Steps, each specifying an IP Command to execute.
• Organize steps into nested IP Groups for modularity, reusability, and logical grouping.
• Apply conditional execution and flow control using expressions on steps and groups, enabling the workflow to adapt dynamically to image properties or results from previous operations.

Configuration and Usage

• Add IP Step and IP Group children to the IP Profile to build your processing pipeline.
• Use expressions on steps and groups to control execution order, branching, and early termination.
• The execution order is based on a pre-order tree traversal, meaning items execute in the order they appear when the tree is fully expanded. You can customize the flow using the 'Should Execute Expression' and 'Next Step Expression' properties on individual elements.

Best Practices

• Start with a clear, high-level design for your image processing workflow, using groups to break down complex logic.
• Leverage conditional logic to optimize performance and handle diverse document or image types.
• Document the intent and configuration of your IP Profile and its elements to improve maintainability and collaboration.

For more information on workflow organization, conditional logic, and available commands, see the documentation for IP Step, IP Group, and IP Command.

Properties

Name	Type		Description
Should Execute Expression	String	►	Defines an expression that determines whether the IP Step or IP Group should execute. EditorShould Execute Editor The 'Should Execute Expression' property allows you to specify a condition, written as a code expression, that must evaluate to a Boolean value. If the expression evaluates to true, the IP Element will execute; if false, it will be skipped. This enables you to create workflows that adapt dynamically to the properties of the input image or the results of previous processing steps. How to Configure Enter a code expression that returns a Boolean value. The expression can reference properties of the current image (e.g., Image.IsColor), results from previous steps (e.g., Results.Measure_Entropy.Entropy > 0.85), or other contextual information. If left blank, the IP Element will always execute. Examples Execute only if the input image is color: Image.IsColor Execute only if the input image is black and white: Image.IsBinary Execute only if the input image is 8-bit grayscale: Image.ColorFormat = GrooperImage.PixelFormat.Pixel8bppGrayscale Execute only if the previously-executed Measure Entropy command returned an entropy of more than 85%: Results.Measure_Entropy.Entropy > 0.85 Execute only if the previously-executed Classify Image command returned a Class Name of "Noisy Blue Background": Results.Classify_Image.ClassName = "Noisy Blue Background" Impact Configuring this property allows you to optimize processing by skipping unnecessary steps, improving performance, and ensuring that only relevant operations are performed on each image.
Next Step Expression	String	►	Defines an expression that determines the next IP Step or IP Group to execute after this one completes. EditorNext Step Editor The 'Next Step Expression' property allows you to control the flow of execution within an IP Profile by specifying, via a code expression, which IP Step or IP Group should be executed next. This expression is evaluated after the current IP Element completes, and can be used to implement conditional branching, early termination, or custom workflow logic. How to Configure Enter a code expression that returns an IP Step or IP Group object. The expression can reference the current image, results from previous steps, or any other available context. If the expression returns Nothing, execution of the IP Profile will terminate. If left blank, execution will proceed to the next item in the profile sequence. Examples If the image is black and white, run the 'Binary Cleanup' IP Group. Otherwise, run the 'Color Cleanup' group: If(Image.IsBinary, Steps.Binary_Cleanup, Steps.Color_Cleanup) If the image is black and white, terminate execution. Otherwise, proceed to the 'Color Detect' IP Step: If(Image.IsBinary, Nothing, Steps.Color_Detect) Impact By configuring this property, you can create highly flexible and adaptive workflows that respond to the results of previous processing steps, image characteristics, or other runtime conditions.
Description	String	►	Specifies a description for the item. EditorNode Description Editor

Design Tabs

General	View or edit properties of a node.
Reports	View reports for a node.
Tester	Edit properties pf am IP Profile or IP Group and test image processing.
Advanced	View or edit advanced details about a node.

Child Types

IP GroupIP Step

Used By

Execute ProfileOCR ProfileLexicalVisualThumbnail ViewBatch Page - Apply Image CleanupDetect SignatureRead ZoneRecognizeImage ProcessingScanner ProfileScan View