Filter

Can be one of the following values:

Selects the filtering operation performed by the Filter command. The filter type determines the mathematical method used to process each pixel and its neighbors, affecting the result's appearance and suitability for different tasks.

• Common filter types include smoothing (average, median), sharpening, edge detection, and noise reduction.
• The available options are defined by the FilterTypeEnum enumeration.
• The choice of filter type impacts which other properties are relevant (such as mask size, sigma, or noise).

Configuration Tip:
Use 'Median' to remove salt-and-pepper noise, 'Gaussian' for gentle blurring, or 'Sharpen' to enhance edges.

Example:
To reduce random noise, set 'Filter Type' to Median.

Specifies the horizontal size of the filter mask for custom mask filters (such as average, median, min, max, and Wiener). The mask defines the neighborhood of pixels considered when filtering each pixel.

• Must be an odd number of pixels (e.g., 3px, 5px, 7px).
• Used only for filter types that support custom rectangular masks.
• The value can be specified in pixels (e.g., 5px).

Configuration Tip:
Larger mask widths increase the strength of smoothing or noise reduction, but may blur fine details.

Example:
To use a 7-pixel wide mask, set 'Mask Width' to 7px.

Specifies the vertical size of the filter mask for custom mask filters (such as average, median, min, max, and Wiener). The mask defines the neighborhood of pixels considered when filtering each pixel.

• Must be an odd number of pixels (e.g., 3px, 5px, 7px).
• Used only for filter types that support custom rectangular masks.
• The value can be specified in pixels (e.g., 5px).

Configuration Tip:
Increasing the mask height can help smooth vertical noise or artifacts.

Example:
To use a 9-pixel tall mask, set 'Mask Height' to 9px.

Sets the size of a square mask for filters that require a square neighborhood, such as Gaussian filters.

• Must be an odd number of pixels (e.g., 3px, 5px, 7px).
• Used only for filter types that require a square mask.
• The value can be specified in pixels (e.g., 5px).

Configuration Tip:
Larger mask sizes increase the effect of blurring or smoothing, but may reduce detail.

Example:
To use a 9x9 mask, set 'Mask Size' to 9px.

Can be one of the following values:

Selects a predefined mask size (such as 3x3 or 5x5) for filters that only support specific mask dimensions.

• Applies to filter types like sharpen, Laplacian, high/low pass, and median cross.
• The available options are defined by the MaskSize enumeration.
• Predefined sizes ensure compatibility with the mathematical requirements of certain filters.

Configuration Tip:
Use a 3x3 mask for subtle effects, or 5x5 for a stronger effect.

Example:
To use a 5x5 mask, set 'Predefined Mask Size' to 5x5.

Controls the amount of blurring for Gaussian filters by setting the standard deviation (sigma) of the Gaussian function.

• Only used when 'Filter Type' is set to Gaussian.
• Higher sigma values produce more smoothing and a stronger blur effect.
• Typical values range from 0.5 (light blur) to 2.0 or higher (strong blur).

Configuration Tip:
Start with a sigma of 1.0 and increase as needed to reduce noise or soften features.

Example:
To apply a strong blur, set 'Sigma' to 2.0.

Specifies the expected noise level for Wiener noise reduction filters, as a value between 0 (no noise) and 1 (maximum noise).

• Only used when 'Filter Type' is set to Wiener.
• Setting this value accurately improves the filter's ability to remove noise while preserving detail.
• Typical values are 0.1 to 0.5 for moderate noise.

Configuration Tip:
Increase the noise value for images with heavy noise, or decrease for cleaner images to avoid over-smoothing.

Example:
For a noisy scan, set 'Noise' to 0.4.

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.