Variables
TCannyEdgeFilter	CannyEdgeFilterMethod
	Specifies the edge filtering method that is internally used for the canny filter operation. More...

boolean	Entire
	If this property is set to `TRUE` the area passed by the X0, X1, X2, Y0, Y1 and Y2 properties is ignored and the complete image will be used for the arithmetic operation. More...

TFilterType	FilterType
	Determines which operation is applied to the input image when the Execute method is called. Following filter types are possible: . More...

__int3264	ImageIn
	Specifies the input image object for the filter operations. More...

__int3264	ImageOut
	Handle to the resulting image after applying the Execute method. More...

long	Index
	Determines the plane which the filter is applied to. More...

long	KernelColumn
	Determines the horizontal position of the kernel element to the KernelValue property refers. More...

long	KernelRow
	Determines the vertical position of the kernel element to the KernelValue property refers. More...

double	KernelValue
	May be used to query or change an element of the kernel to be used for the custom filter type. More...

long	MaskHeight
	Defines the size of the mask/kernel, used for filter operations, in rows. More...

__int3264	MaskImage
	Specifies the custom (user-definable) morphological mask for the morphological operations (FT_OPENING, FT_CLOSING, FT_DILATE, FT_ERODE). More...

long	MaskOffsetX
	X-Position of the anchor cell within the mask/kernel. More...

long	MaskOffsetY
	Y-Position of the anchor cell within the mask/kernel. More...

long	MaskWidth
	Defines the size of the mask/kernel, used for filter operations, in columns. More...

TMorphologyMask	MorphologyMask
	Determines the mask type to be used with the morphological FilterTypes (FT_OPENING, FT_CLOSING, FT_DILATE, FT_ERODE). More...

boolean	ResetCS
	If this property is set to `TRUE` upon calling the Execute method is called, the image's coordinate system will be reset to a standard coordinate system prior to performing the filter operation on the selected area. More...

TSquareMaskType	SquareMaskType
	Determines the size of the square mask used with some filter operations. See the description of the individual filter function referenced under FilterType to find out if the SquareMaskType parameter is significant for the the filter operation you want to apply, and for permissible values of this property. More...

long	TargetMax
	Defines the maximum value which is used if the FilterType property is set to FT_NORMALIZEMINMAX for histogram adaption. More...

long	TargetMean
	Defines the mean value which is used if the FilterType property is set to FT_NORMALIZEMEANVARIANCE for histogram adaption. More...

long	TargetMin
	Defines the minimum value which is used if the FilterType property is set to FT_NORMALIZEMINMAX for histogram adaption. More...

long	TargetVariance
	Defines the variance value which is used if the FilterType property is set to FT_NORMALIZEMEANVARIANCE for histogram adaption. More...

long	ThresholdLower
	Determines the lower threshold if the canny filter (FT_CANNY) is used in the FilterType property. More...

long	ThresholdUpper
	Determines the upper threshold if the canny filter (FT_CANNY) is used in the FilterType property. More...

double	ThresholdWiener
	Determines the noise suppression threshold if the wiener filter (FT_WIENER) is used in the FilterType property. 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 filter. 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 filter. 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 filter. 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 filter. 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 filter. 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 filter. More...

Detailed Description

Variable Documentation

◆ CannyEdgeFilterMethod

TCannyEdgeFilter CannyEdgeFilterMethod

property

Specifies the edge filtering method that is internally used for the canny filter operation.

The canny filter is a sequence of different operations, one of which is an edge-filtering step that has considerable influence on the results.

Parameters

[in,out] CannyEdgeFilterMethod Edge filter method. See TCannyEdgeFilter for possible methods.

Returns: Edge filter method.

Supported platforms:: Win32
Win64

Related Topics:: FilterType property, FT_CANNY, TCannyEdgeFilter

◆ Entire

boolean Entire

property

If this property is set to TRUE the area passed by the X0, X1, X2, Y0, Y1 and Y2 properties is ignored and the complete image will be used for the arithmetic operation.

Parameters

[in,out] Entire TRUE 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, X1, X2, Y0, Y1, Y2

◆ FilterType

TFilterType FilterType

property

Determines which operation is applied to the input image when the Execute method is called. Following filter types are possible:
.

Enumerated constant	numerical value	uses morphology mask	uses custom, kernel, width, height & offset	uses morphology mask	uses square 3x3 mask	uses square 5x5 mask
FT_ERODE	0	x	x	-	-
FT_DILATE	1	x	x	-	-
FT_OPENING	2	x	x	-	-
FT_CLOSING	3	x	x	-	-
FT_MEAN	4	-	x	-	-
FT_MIN	5	-	x	-	-
FT_MAX	6	-	x	-	-
FT_MEDIAN	7	-	x	-	-
FT_MEDIAN_COLOR	8	-	-	x	x
FT_CUSTOM	9	-	x	-	-
FT_WIENER	10	-	x	-	-
FT_PREWITT_HORIZONTAL	11	-	-	x	-
FT_PREWITT_VERTICAL	12	-	-	x	-
FT_SCHARR_HORIZONTAL	13	-	-	x	-
FT_SCHARR_VERTICAL	14	-	-	x	-
FT_SOBEL_HORIZONTAL	15	-	-	x	x
FT_SOBEL_VERTICAL	16	-	-	x	x
FT_SOBEL_2ND_HORIZONTAL	17	-	-	x	x
FT_SOBEL_2ND_VERTICAL	18	-	-	x	x
FT_SOBEL_CROSS	19	-	-	x	x
FT_ROBERTS_DOWN	20	-	-	x	-
FT_ROBERTS_UP	21	-	-	x	-
FT_LAPLACE	22	-	-	x	-
FT_GAUSS	23	-	-	x	x
FT_HIPASS	24	-	-	x	x
FT_LOPASS	25	-	-	x	x
FT_SHARPEN	26	-	-	x	-
FT_CANNY	27	-	-	-	-
FT_NORMALIZEMEANVARIANCE	28	-	-	-	-
FT_NORMALIZEMINMAX	29	-	-	-	-

Attention: Depending on the compiler being used, the value for MorphologyMask may be given as an enumerated named constant or as an integer number (Visual C++ 6).

Parameters

[in,out] FilterType Filter to be used. See TFilterType for more information of the underlying filtering functions.

Returns: Filter to be used.

Supported platforms:: Win32
Win64

Related Topics:: Related properties to the selected filter type:
CannyEdgeFilterMethod property
Entire property and X0, Y0, X1, Y1, X2, Y2
Index property

KernelColumn property, KernelRow property and KernelValue property
MaskHeight property, MaskWidth property, MaskImage property
MaskOffsetX property, MaskOffsetY property
MorphologyMask property, SquareMaskType property

TargetMin and TargetMax property
TargetMean and TargetVariance property

ThresholdLower and ThresholdUpper property
ThresholdWiener property

◆ ImageIn

__int3264 ImageIn

property

Specifies the input image object for the filter operations.

Parameters

[in,out] ImageIn Handle of the image object.

Returns: Image object handle.

Supported platforms:: Win32
Win64

Related Topics:: ImageOut

◆ ImageOut

__int3264 ImageOut

propertyreadonly

Handle to the resulting image after applying the Execute method.

Parameters

[out] ImageOut Handle of the result image object.

Returns: Image object handle.

Supported platforms:: Win32
Win64

Related Topics:: ImageIn

◆ Index

long Index

property

Determines the plane which the filter is applied to.

Attention: It is only used in connection with the Canny filter mode (see FT_CANNY)- all other filter operations process all the available image planes simultaneously.

Parameters

[in,out] Index Plane index to work on.

Returns: Plane index.

Supported platforms:: Win32
Win64

Related Topics:: FilterType, FT_CANNY

◆ KernelColumn

long KernelColumn

property

Determines the horizontal position of the kernel element to the KernelValue property refers.

Attention: The terms Mask and Kernel are used synonymously in the FFilter Control as some operations require a mask, and some require a kernel, but the semantics for both parameter types are identical.

Parameters

[in,out] KernelColumn X-position within the kernel.

Returns: X-position within the kernel.

Supported platforms:: Win32
Win64

Related Topics:: FilterType property, KernelRow

◆ KernelRow

long KernelRow

property

Determines the vertical position of the kernel element to the KernelValue property refers.

Attention: The terms Mask and Kernel are used synonymously in the FFilter Control as some operations require a mask, and some require a kernel, but the semantics for both parameter types are identical.

Parameters

[in,out] KernelRow Y-position within the kernel.

Returns: Y-position within the kernel.

Supported platforms:: Win32
Win64

Related Topics:: FilterType property, KernelColumn

◆ KernelValue

double KernelValue

property

May be used to query or change an element of the kernel to be used for the custom filter type.

The properties \ref KernelColumn and \ref KernelRow define to which kernel element the \ref KernelValue property currently refers.

Parameters

[in,out] KernelRow Value of the KernelValue.

Returns: Value of the KernelValue.

Supported platforms:: Win32
Win64

Related Topics:: FilterType property, KernelColumn, KernelRow

◆ MaskHeight

long MaskHeight

property

Defines the size of the mask/kernel, used for filter operations, in rows.

Attention: The terms mask and kernel are used synonymously in the FFilter Control as some operations require a mask, and some require a kernel, but the semantics for both parameter types are identical.

Parameters

[in,out] MaskHeight Number of rows in the mask/kernel.

Returns: Number of rows.; Number of rows.

Supported platforms:: Win32
Win64

Related Topics:: FilterType property, MaskWidth

◆ MaskImage

__int3264 MaskImage

property

Specifies the custom (user-definable) morphological mask for the morphological operations (FT_OPENING, FT_CLOSING, FT_DILATE, FT_ERODE).

Attention: This mask is only evaluated if the property MorphologyMask has been set to MM_CUSTOM. The MaskImage property is an image of maximum 256x256 pixel of size, with a gray value of only 0 or 255.

Parameters

[in,out] MaskImage Handle of the mask image object.

Returns: Mask image object handle.

Supported platforms:: Win32
Win64

Related Topics:: FilterType property, MorphologyMask

◆ MaskOffsetX

long MaskOffsetX

property

X-Position of the anchor cell within the mask/kernel.

The position has to be in the range of 0 to \ref MaskWidth -1.

Attention: The terms mask and kernel are used synonymously in the FFilter Control as some operations require a mask, and some require a kernel, but the semantics for both parameter types are identical.

Parameters

[in,out] MaskOffsetX X-offset in the mask/kernel.

Returns: X-offset in the mask/kernel.

Supported platforms:: Win32
Win64

Related Topics:: FilterType property, MaskWidth, MaskOffsetY

◆ MaskOffsetY

long MaskOffsetY

property

Y-Position of the anchor cell within the mask/kernel.

The position has to be in the range of 0 to \ref MaskHeight -1.

Attention: The terms mask and kernel are used synonymously in the FFilter Control as some operations require a mask, and some require a kernel, but the semantics for both parameter types are identical.

Parameters

[in,out] MaskOffsetY Y-offset in the mask/kernel.

Returns: Y-offset in the mask/kernel.

Supported platforms:: Win32
Win64

Related Topics:: FilterType property, MaskHeight, MaskOffsetX

◆ MaskWidth

long MaskWidth

property

Defines the size of the mask/kernel, used for filter operations, in columns.

Attention: The terms Mask and Kernel are used synonymously in the FFilter Control as some operations require a mask, and some require a kernel, but the semantics for both parameter types are identical.

Parameters

[in,out] MaskWidth Number of columns in the mask/kernel.

Returns: Number of columns.

Supported platforms:: Win32
Win64

Related Topics:: FilterType property, MaskHeight

◆ MorphologyMask

TMorphologyMask MorphologyMask

property

Determines the mask type to be used with the morphological FilterTypes (FT_OPENING, FT_CLOSING, FT_DILATE, FT_ERODE).

Attention: Depending on the compiler being used, the value for MorphologyMask may be given as an enumerated named constant or as an integer number (Visual C++ 6).

Parameters

[in,out] MorphologyMask Morphological operation to use. See TMorphologyMask for more information.

Returns: Morphological operation.

Supported platforms:: Win32
Win64

Related Topics:: TMorphologyMask

◆ ResetCS

boolean ResetCS

property

If this property is set to TRUE upon calling the Execute method is called, the image's coordinate system will be reset to a standard coordinate system prior to performing the filter operation on the selected area.

Parameters

[in,out] ResetCS TRUE 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

◆ SquareMaskType

TSquareMaskType SquareMaskType

property

Determines the size of the square mask used with some filter operations. See the description of the individual filter function referenced under FilterType to find out if the SquareMaskType parameter is significant for the the filter operation you want to apply, and for permissible values of this property.

Attention: Depending on the compiler being used, the value for SquareMaskType may be given as an enumerated named constant or as an integer number (Visual C++ 6).

Parameters

[in,out] SquareMaskType Size for the different filter types. See TSquareMaskType for more information.

Returns: Size of the square mask.

Supported platforms:: Win32
Win64

Related Topics:: FilterType property, TSquareMaskType, FilterType

◆ TargetMax

long TargetMax

property

Defines the maximum value which is used if the FilterType property is set to FT_NORMALIZEMINMAX for histogram adaption.

It is the upper limit for the gray value distribution.

Parameters

[in,out] TargetMax Upper limit for the gray value distribution.

Returns: Upper limit.

Supported platforms:: Win32
Win64

Related Topics:: FilterType property, TargetMin, Image Manager Image Library function CreateNormalizedImage

◆ TargetMean

long TargetMean

property

Defines the mean value which is used if the FilterType property is set to FT_NORMALIZEMEANVARIANCE for histogram adaption.

It is the target average for the gray value distribution.

Parameters

[in,out] TargetMean Target average for the gray value distribution.

Returns: Target average for the gray value distribution.

Supported platforms:: Win32
Win64

Related Topics:: FilterType property, TargetVariance, Image Manager Image Library function CreateNormalizedImage

◆ TargetMin

long TargetMin

property

Defines the minimum value which is used if the FilterType property is set to FT_NORMALIZEMINMAX for histogram adaption.

It is the lower limit for the gray value distribution.

Parameters

[in,out] TargetMin Lower limit for the gray value distribution.

Returns: Lower limit.

Supported platforms:: Win32
Win64

Related Topics:: FilterType property, TargetMax, Image Manager Image Library function CreateNormalizedImage

Sample Code in Visual Basic:: FFilter1.ImageIn = CVimage1.Image

FFilter1.Entire = True

FFilter1.FilterType = FT_NORMALIZEMEANVARIANCE

// Target value must be 128 = 50 % grey intensity with a variance of 64

FFilter1.TargetMean = 128

FFilter1.TargetVariance = 64

FFilter1.Execute

// assign resultimage to display2

CVdisplay2.Image = FFilter1.ImageOut

FT_NORMALIZEMEANVARIANCE
@ FT_NORMALIZEMEANVARIANCE
Applies the mean value (target average for the gray value distribution) which is used for histogram a...
Definition: FFilter.idl:428

◆ TargetVariance

long TargetVariance

property

Defines the variance value which is used if the FilterType property is set to FT_NORMALIZEMEANVARIANCE for histogram adaption.

It is the target variance for the gray value distribution.

Parameters

[in,out] TargetVariance Target variance for the gray value distribution.

Returns: Target variance for the gray value distribution.

Supported platforms:: Win32
Win64

Related Topics:: FilterType property, TargetMean, Image Manager Image Library function CreateNormalizedImage

◆ ThresholdLower

long ThresholdLower

property

Determines the lower threshold if the canny filter (FT_CANNY) is used in the FilterType property.

This threshold is used for the hysteresis thresholding step.

Parameters

[in,out] ThresholdLower Lower threshold for the hysteresis thresholding step if the canny filter is chosen.

Returns: Lower threshold.

Supported platforms:: Win32
Win64

Related Topics:: FilterType property, FT_CANNY, ThresholdUpper

◆ ThresholdUpper

long ThresholdUpper

property

Determines the upper threshold if the canny filter (FT_CANNY) is used in the FilterType property.

This threshold is used for the hysteresis thresholding step.

Parameters

[in,out] ThresholdUpper Upper threshold for the hysteresis thresholding step if the canny filter is chosen.

Returns: Upper threshold.

Supported platforms:: Win32
Win64

Related Topics:: FilterType property, FT_CANNY, ThresholdLower

◆ ThresholdWiener

double ThresholdWiener

property

Determines the noise suppression threshold if the wiener filter (FT_WIENER) is used in the FilterType property.

Attention: 0 is a legal setting for this property, in which case the algorithm will automatically choose a suitable threshold.

Parameters

[in,out] ThresholdWiener Suppression threshold for the wiener filter.

Returns: Suppression threshold.

Supported platforms:: Win32
Win64

Related Topics:: FilterType property, FT_WIENER

◆ 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 filter.

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 filter operation (and the output image will be a rectangular image containing exactly the contents of this area).

Parameters

[in,out] X0 X-coordinate of the upper left point of the area of interest.

Returns: X-coordinate of the upper left point 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 filter.

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 filter operation (and the output image will be a rectangular image containing exactly the contents of this area).

Parameters

[in,out] X1 X-coordinate of the lower left point of the area of interest.

Returns: X-coordinate of the lower left point 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 filter.

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 filter operation (and the output image will be a rectangular image containing exactly the contents of this area).

Parameters

[in,out] X2 X-coordinate of the upper right point of the area of interest.

Returns: X-coordinate of the upper right point 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 filter.

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 filter operation (and the output image will be a rectangular image containing exactly the contents of this area).

Parameters

[in,out] Y0 Y-coordinate of the upper left point of the area of interest.

Returns: Y-coordinate of the upper left point 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 filter.

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 filter operation (and the output image will be a rectangular image containing exactly the contents of this area).

Parameters

[in,out] Y1 Y-coordinate of the lower left point of the area of interest.

Returns: Y-coordinate of the lower left point 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 filter.

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 filter operation (and the output image will be a rectangular image containing exactly the contents of this area).

Parameters

[in,out] Y2 Y-coordinate of the upper right point of the area of interest.

Returns: Y-coordinate of the upper right point of the area of interest.

Supported platforms:: Win32
Win64

Related Topics:: Entire property, Area of interest (AOI)

Variables

Detailed Description

Variable Documentation

◆ CannyEdgeFilterMethod

◆ Entire

◆ FilterType

◆ ImageIn

◆ ImageOut

◆ Index

◆ KernelColumn

◆ KernelRow

◆ KernelValue

◆ MaskHeight

◆ MaskImage

◆ MaskOffsetX

◆ MaskOffsetY

◆ MaskWidth

◆ MorphologyMask

◆ ResetCS

◆ SquareMaskType

◆ TargetMax

◆ TargetMean

◆ TargetMin

◆ TargetVariance

◆ ThresholdLower

◆ ThresholdUpper

◆ ThresholdWiener

◆ X0

◆ X1

◆ X2

◆ Y0

◆ Y1

◆ Y2