Execute Profile

Executes a specified IP Profile as part of an image processing workflow, enabling modular and reusable processing pipelines.

Remarks

The Execute Profile command allows you to invoke another IP Profile from within an existing image processing sequence. This enables the construction of modular, maintainable, and reusable workflows by encapsulating complex or commonly used processing steps in separate profiles that can be executed as needed.

Supported Pixel Formats

Execute Profile supports all pixel formats that are accepted by the referenced IP Profile. The command does not impose additional restrictions on input formats; compatibility is determined by the configuration of the target profile.

How the Command Works

When Execute Profile is executed, it runs the selected IP Profile on the current image. The referenced profile may contain any combination of IP Steps and IP Groups, allowing for both simple and complex processing logic. The final output image produced by the profile becomes the output of the Execute Profile command.

This approach is ideal for scenarios where a set of image processing operations needs to be reused across multiple workflows, or when you want to break down a large, complex pipeline into smaller, more manageable components.

Diagnostics Generated

When diagnostic mode is enabled, Execute Profile collects and aggregates diagnostic information from the executed profile. This includes logs, diagnostic images, and any additional output generated by the steps within the profile. Diagnostics are useful for troubleshooting, validating configuration, and understanding the effect of the invoked profile on the image.

Classification Features

Execute Profile does not generate classification features directly. However, any classification or feature extraction performed by the referenced IP Profile will be included in the results, making this command suitable for chaining together feature extraction and transformation steps.

Configuration Guidance

• Use the 'IP Profile' property to select the profile to execute. The referenced profile should be fully configured and tested independently.
• Execute Profile can be used multiple times within a workflow to invoke different profiles as needed.
• When designing modular workflows, consider grouping related processing steps into dedicated profiles for reuse and clarity.
• If the referenced profile is missing or not specified, the command will throw an error at runtime.

Execute Profile is a powerful tool for building scalable, maintainable image processing solutions in Grooper, supporting best practices such as modularity, reuse, and separation of concerns.

Properties

Name	Type		Description
General
IP Profile	IP Profile	►	Specifies the IP Profile to execute as part of this command. EditorNode Reference Editor Requiredtrue The 'IP Profile' property determines which IP Profile will be invoked when the Execute Profile command runs. An IP Profile is a configurable sequence of image processing steps and groups, allowing you to define complex or reusable workflows for document cleanup, analysis, or transformation. Selecting an IP Profile enables modular workflow design, letting you encapsulate common processing logic in a single profile and reuse it across multiple commands or pipelines. This is especially useful for standardizing image preparation steps or applying consistent processing to different document types. To configure this property, select an existing IP Profile from the repository. The referenced profile should be fully configured and tested independently to ensure compatibility with the images and workflow in which it will be used. If no profile is specified, the Execute Profile command will throw an error at runtime. When the command executes, the selected profile is applied to the current image, and the final output image from the profile becomes the result of the command. Example usage: Select an IP Profile named "Standard Document Cleanup" Use this property to promote modularity, reuse, and maintainability in your image processing solutions.
Command Info
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.

See Also

IP Profile

Used By

IP Step