FThresholding Control Reference 15.0
Properties

Variables

TComparisonMode ComparisonMode
 Defines the comparison mode to be used when calculating the output image in constant thresholding or image thresholding mode. More...
 
boolean Entire
 If this property is set to TRUE the currently set area of interest, defined through the properties X0, Y0, X1, Y1, X2 and Y2, is ignored and the thresholding operation affects the complete input image. More...
 
__int3264 ImageIn
 Specifies the input image object for the thresholding operations. It should be assigned prior to calling the Execute method. More...
 
__int3264 ImageOut
 Handle to the result image of the last thresholding operation. More...
 
__int3264 ImageThreshold
 Specifies the image which contains the local thresholds to be applied to the input image in the TM_Image mode. In other modes the handle stored in this property will be ignored. More...
 
long MaskSize
 Contains the mask window size to be used for averaging in dynamic thresholding (ThresholdingMode = TM_Dynamic). The minimum mask size to be used is 3, and valid mask sizes are odd (even numbers will internally automatically be reduced to the next odd number by subtracting 1). More...
 
boolean ResetCS
 If this property is set to TRUE the image's coordinate system is reset prior to doing anything else when the Execute method is invoked. This means that the origin will be located at the upper left corner of the image and the matrix will be the identity matrix. More...
 
long Threshold
 Defines the threshold against which the selected operation compares. More...
 
TThresholdingMode ThresholdingMode
 Defines the thresholding method which is be used when the Execute method is invoked. More...
 
double X0
 X-coordinate of the upper left point of the area of interest. The properties X0, Y0, X1, Y1, X2 and Y2 define the area in which the control calculates the threshold. More...
 
double X1
 X-coordinate of the lower left point of the area of interest. The properties X0, Y0, X1, Y1, X2 and Y2 define the area in which the control calculates the threshold. More...
 
double X2
 X-coordinate of the upper right point of the area of interest. The properties X0, Y0, X1, Y1, X2 and Y2 define the area in which the control calculates the threshold. More...
 
double Y0
 Y-coordinate of the upper left point of the area of interest. The properties X0, Y0, X1, Y1, X2 and Y2 define the area in which the control calculates the threshold. More...
 
double Y1
 Y-coordinate of the lower left point of the area of interest. The properties X0, Y0, X1, Y1, X2 and Y2 define the area in which the control calculates the threshold. More...
 
double Y2
 Y-coordinate of the upper right point of the area of interest. The properties X0, Y0, X1, Y1, X2 and Y2 define the area in which the control calculates the threshold. More...
 

Detailed Description

Variable Documentation

◆ ComparisonMode

TComparisonMode ComparisonMode
property

Defines the comparison mode to be used when calculating the output image in constant thresholding or image thresholding mode.

Parameters
[in,out]ComparisonModeComparison mode to be used. See TComparisonMode for possible modes.
Returns
Comparison mode.
Supported platforms:
Win32
Win64
Related Topics:
TComparisonMode, TM_Constant, TM_Image

◆ Entire

boolean Entire
property

If this property is set to TRUE the currently set area of interest, defined through the properties X0, Y0, X1, Y1, X2 and Y2, is ignored and the thresholding operation affects the complete input image.

Parameters
[in,out]EntireTRUE indicates that the complete image will be used, FALSE otherwise.
Returns
TRUE indicates that the complete image will be used, FALSE otherwise.
Supported platforms:
Win32
Win64
Related Topics:
X0, Y0, X1, Y1, X2, Y2

◆ ImageIn

__int3264 ImageIn
property

Specifies the input image object for the thresholding operations. It should be assigned prior to calling the Execute method.

Parameters
[in,out]ImageInHandle of the image object.
Returns
Image object handle.
Supported platforms:
Win32
Win64
Related Topics:
ImageOut

◆ ImageOut

__int3264 ImageOut
propertyreadonly

Handle to the result image of the last thresholding operation.

Parameters
[out]ImageOutHandle of the result image object.
Returns
Image object handle.
Supported platforms:
Win32
Win64
Related Topics:
ImageIn

◆ ImageThreshold

__int3264 ImageThreshold
property

Specifies the image which contains the local thresholds to be applied to the input image in the TM_Image mode. In other modes the handle stored in this property will be ignored.

Parameters
[in,out]ImageThresholdHandle of the threshold image object.
Returns
Threshold image object handle.
Supported platforms:
Win32
Win64
Related Topics:
ImageIn

◆ MaskSize

long MaskSize
property

Contains the mask window size to be used for averaging in dynamic thresholding (ThresholdingMode = TM_Dynamic). The minimum mask size to be used is 3, and valid mask sizes are odd (even numbers will internally automatically be reduced to the next odd number by subtracting 1).

Parameters
[in,out]MaskSizeComparison mode to be used. See TComparisonMode for possible modes.
Returns
Comparison mode.
Supported platforms:
Win32
Win64
Related Topics:
TComparisonMode, TM_Constant, TM_Image

◆ ResetCS

boolean ResetCS
property

If this property is set to TRUE the image's coordinate system is reset prior to doing anything else when the Execute method is invoked. This means that the origin will be located at the upper left corner of the image and the matrix will be the identity matrix.

Parameters
[in,out]ResetCSTRUE indicates that the coordinate system of the image is reseted before execution, FALSE otherwise.
Returns
TRUE indicates that the coordinate system of the image is reseted before execution, FALSE otherwise.
Supported platforms:
Win32
Win64

◆ Threshold

long Threshold
property

Defines the threshold against which the selected operation compares.

Attention
This property can only be used with constant or dynamic thresholding. In image thresholding mode this property will be ignored. Note that it may make sense with dynamic thresholding to use negative threshold values as well. Also note that usually in dynamic thresholding the absolute threshold values that lead to good results are considerably lower than in constant thresholding.
Parameters
[in,out]ThresholdComparison mode to be used. See TComparisonMode for possible modes.
Returns
Comparison mode.
Supported platforms:
Win32
Win64
Related Topics:
TM_Constant, TM_Dynamic, TM_Image

◆ ThresholdingMode

TThresholdingMode ThresholdingMode
property

Defines the thresholding method which is be used when the Execute method is invoked.

Parameters
[in,out]ThresholdingModeThresholding mode to be used. See TThresholdingMode for possible modes.
Returns
Thresholding mode.
Supported platforms:
Win32
Win64
Related Topics:
TThresholdingMode

◆ X0

double X0
property

X-coordinate of the upper left point of the area of interest. The properties X0, Y0, X1, Y1, X2 and Y2 define the area in which the control calculates the threshold.

Attention
If the Entire property is set to TRUE these values will be ignored and the complete image will be used instead. Otherwise only that part of the input image that lies within the parallelogram defined by these 6 properties will be subject to the binarization operation (and the output image will be a rectangular image containing exactly the contents of this area).
Parameters
[in,out]X0X-coordinate of the upper left point of the area of interest.
Returns
X-coordinate of the upper left of the area of interest.
Supported platforms:
Win32
Win64
Related Topics:
Entire property, Area of interest (AOI)

◆ X1

double X1
property

X-coordinate of the lower left point of the area of interest. The properties X0, Y0, X1, Y1, X2 and Y2 define the area in which the control calculates the threshold.

Attention
If the Entire property is set to TRUE these values will be ignored and the complete image will be used instead. Otherwise only that part of the input image that lies within the parallelogram defined by these 6 properties will be subject to the binarization operation (and the output image will be a rectangular image containing exactly the contents of this area).
Parameters
[in,out]X1X-coordinate of the lower left point of the area of interest.
Returns
X-coordinate of the lower left of the area of interest.
Supported platforms:
Win32
Win64
Related Topics:
Entire property, Area of interest (AOI)

◆ X2

double X2
property

X-coordinate of the upper right point of the area of interest. The properties X0, Y0, X1, Y1, X2 and Y2 define the area in which the control calculates the threshold.

Attention
If the Entire property is set to TRUE these values will be ignored and the complete image will be used instead. Otherwise only that part of the input image that lies within the parallelogram defined by these 6 properties will be subject to the binarization operation (and the output image will be a rectangular image containing exactly the contents of this area).
Parameters
[in,out]X1X-coordinate of the upper right point of the area of interest.
Returns
X-coordinate of the upper right of the area of interest.
Supported platforms:
Win32
Win64
Related Topics:
Entire property, Area of interest (AOI)

◆ Y0

double Y0
property

Y-coordinate of the upper left point of the area of interest. The properties X0, Y0, X1, Y1, X2 and Y2 define the area in which the control calculates the threshold.

Attention
If the Entire property is set to TRUE these values will be ignored and the complete image will be used instead. Otherwise only that part of the input image that lies within the parallelogram defined by these 6 properties will be subject to the binarization operation (and the output image will be a rectangular image containing exactly the contents of this area).
Parameters
[in,out]Y0Y-coordinate of the upper left point of the area of interest.
Returns
Y-coordinate of the upper left of the area of interest.
Supported platforms:
Win32
Win64
Related Topics:
Entire property, Area of interest (AOI)

◆ Y1

double Y1
property

Y-coordinate of the lower left point of the area of interest. The properties X0, Y0, X1, Y1, X2 and Y2 define the area in which the control calculates the threshold.

Attention
If the Entire property is set to TRUE these values will be ignored and the complete image will be used instead. Otherwise only that part of the input image that lies within the parallelogram defined by these 6 properties will be subject to the binarization operation (and the output image will be a rectangular image containing exactly the contents of this area).
Parameters
[in,out]Y1Y-coordinate of the lower left point of the area of interest.
Returns
Y-coordinate of the lower left of the area of interest.
Supported platforms:
Win32
Win64
Related Topics:
Entire property, Area of interest (AOI)

◆ Y2

double Y2
property

Y-coordinate of the upper right point of the area of interest. The properties X0, Y0, X1, Y1, X2 and Y2 define the area in which the control calculates the threshold.

Attention
If the Entire property is set to TRUE these values will be ignored and the complete image will be used instead. Otherwise only that part of the input image that lies within the parallelogram defined by these 6 properties will be subject to the binarization operation (and the output image will be a rectangular image containing exactly the contents of this area).
Parameters
[in,out]Y2Y-coordinate of the upper right point of the area of interest.
Returns
Y-coordinate of the upper right of the area of interest.
Supported platforms:
Win32
Win64
Related Topics:
Entire property, Area of interest (AOI)