Skip to content

Thresholding

Image - FindBestThresholdValue

Finds the best threshold value based on the image pixels distribution.

IN

Name Type Description
InImage Image The input Image
InSelectionMethod Enum < ThresholdSelectionMethod > Method used to select the best threshold.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutFloat Float Best threshold value.
Error ErrorState Gets the execution error message

Image - HysteresisThreshold

Binarizes the image using a threshold range and hysteresis (using a lower threshold for neighboring pixels).

IN

Name Type Description
InImage Image The input Image
InHysteresis Float How much the threshold criteria is lowered for neighboring pixels. Range: 〔0, +inf).
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutImage Image Monochromatic image.
Error ErrorState Gets the execution error message

Image - Threshold

Binarizes the image using a threshold range. Note: Transforms each pixel value to the maximum value (foreground) if it's in the range [inMinValue, inMaxValue], otherwise sets it to the minimum value (background). The minimum and maximum values depend on the image pixel type.

IN

Name Type Description
InImage Image The input Image
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutImage Image Monochromatic image.
Error ErrorState Gets the execution error message

Image - ThresholdToRegion

Thresholds the image and converts it into a Region.

IN

Name Type Description
InImage Image The input Image
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutRegion Region Output region.
Error ErrorState Gets the execution error message

Image - ThresholdToRegions

Thresholds an image using two relative thresholds to separate foreground and background regions.

IN

Name Type Description
InImage Image The input Image
InReferenceImage Image Another image subtracted from the current one before thresholding.
InBrightThreshold Float Minimum relative value for a bright pixel.
InDarkThreshold Float Maximum relative value for a dark pixel.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutRegion RegionArray Foreground and background regions.
Error ErrorState Gets the execution error message

Image - ThresholdToRegion_Dynamic

Thresholds the image, based on the average pixel in its local neighborhood, and converts it to region.

IN

Name Type Description
InImage Image The input Image
InRadiusX Int Kernel's radius on X axis for averaging operation. Range: 〔0, +inf).
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutRegion Region Output region.
Error ErrorState Gets the execution error message

Image - ThresholdToRegion_HSx

Threshold the image, after converting it in the selected HSx color space, and converts it to region.

IN

Name Type Description
InImage Image The input Image
InHSxModel Enum < HSxModel > HSx color model.
InMinHue Int Minimum Hue value of the range. Range: 〔0, 255〕.
InMaxHue Int Maximum Hue value of the range. Range: 〔0, 255〕.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutRegion Region Output region.
Error ErrorState Gets the execution error message

Image - ThresholdToRegion_Pixel

Thresholds the image, based on a pixel color, and converts it to region.

IN

Name Type Description
InImage Image The input Image
InRgbPixel Pixel Color to compare the image to.
InChromaAmount Float Proportion of chromatic information used. Range: 〔0, 1〕.
InMaxDifference Float Maximum difference between every image pixel and the given RGB pixel. Range: 〔0, +inf).
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutRegion Region Monochromatic image.
Error ErrorState Gets the execution error message

Image - ThresholdToRegion_Relative

Thresholds the image, relatively to another one, and converts it into a region.

IN

Name Type Description
InImage Image The input Image
InReferenceImage Image Reference image.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutRegion Region Output region.
Error ErrorState Gets the execution error message

Image - ThresholdToRegion_RGBA

Thresholds the image, separately for every RGB(A) channel, and converts it to region.

IN

Name Type Description
InImage Image The input Image
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutRegion Region Output region.
Error ErrorState Gets the execution error message

Image - Threshold_Dynamic

Binarizes the image using a threshold range, relative to the value in its local neighborhood. Note: Transforms each pixel value to the maximum or minimum value based on the value computed in its local neighborhood. The minimum and maximum values depend on the image pixel type.

IN

Name Type Description
InImage Image The input Image
InDynamicThresholdMethod Enum < DynamicThresholdMethod > How the local threshold value is calculated (mean, median or middle value).
InKernel Enum < KernelShape > Kernel shape.
InRadiusX Int Kernel's radius on X axis. Range: 〔0, +inf).
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutImage Image Monochromatic image.
Error ErrorState Gets the execution error message

Image - Threshold_HSx

Binarizes the image using a threshold range, after converting it to the selected HSx color space. Note: Transforms each pixel value to the maximum value (foreground) if it's in its channel range, otherwise sets it to the minimum value (background).

IN

Name Type Description
InImage Image The input Image
InHSxModel Enum < HSxModel > HSx color model.
InMinHue Int Minimum Hue value of the range. Range: 〔0, 255〕.
InMaxHue Int Maximum Hue value of the range. Range: 〔0, 255〕.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutImage Image Monochromatic image.
Error ErrorState Gets the execution error message

Image - Threshold_Pixel

Binarizes the image based on the distance from a specific pixel color. Note: Transforms each pixel component to the maximum value (foreground) if it's not too distant from the given color, otherwise sets it to the minimum value (background).

IN

Name Type Description
InImage Image The input Image
InRgbPixel Pixel Color to compare the image to.
InChromaAmount Float Proportion of chromatic information used. Range: 〔0, 1〕.
InMaxDifference Float Maximum difference between every image pixel and the given RGB pixel. Range: 〔0, +inf).
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutImage Image Monochromatic image.
Error ErrorState Gets the execution error message

Image - Threshold_Relative

Binarizes the image using a threshold range, based on another reference image. Note: Transforms each pixel value to the maximum value (foreground) if it's in the range [inReferenceImage(x, y) + inMinValue, inReferenceImage(x, y) + inMaxValue], otherwise sets it to the minimum value (background). The minimum and maximum values depend on the image pixel type.

IN

Name Type Description
InImage Image The input Image
InReferenceImage Image Reference image.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutImage Image Monochromatic image.
Error ErrorState Gets the execution error message

Image - Threshold_RGBA

Binarizes the image using a threshold range, one for every RGB(A) channel. Note: Transforms each pixel component to the maximum value (foreground) if it's in the range specified, otherwise sets it to the minimum value (background).

IN

Name Type Description
InImage Image The input Image
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutImage Image Monochromatic image.
Error ErrorState Gets the execution error message