Properties
boolean	AffectOriginX `[get, set]`
	If an edge could be found using the Execute method the origin X of the image used in the control is set to the X position of the first edge found. More...

boolean	AffectOriginY `[get, set]`
	If an edge could be found using the Execute method the origin Y of the image used in the control is set to the Y position of the first edge found. More...

long	Density `[get, set]`
	Defines the density that used to scan the image data. Valid values are in the range from 100 to 1000. Higher value result in higher accuracy while lower values result in higher speed. It is recommended to use the default value. More...

long	EdgeCount `[get]`
	Returns the number of edges found. To retrieve the information about a specific edge you have to set its index first using the EdgeIndex property. Valid values are 0 to EdgeCount -1. The position of the edge is returned in the PX and PY properties, the quality is returned in the PQuality property. All these properties are read only. Use the MaxEdgeCount property to define the maximum number of edges to be found. More...

long	EdgeIndex `[get, set]`
	Used to set the index of the edge to access. Valid values are 0 to EdgeCount -1. The position of the edge is returned in the PX and PY properties, the quality is returned in the PQuality property. All these properties are read only. More...

boolean	Entire `[get, set]`
	If this property is set to `TRUE` the complete image will be used to detect a vertical edge (horizontal detection). More...

__int3264	Image `[get, set]`
	Defines the image object that is assigned to the Common Vision Edge Control. More...

long	MaxEdgeCount `[get, set]`
	Use this property to define the maximum number of edges you want to detect. More...

long	PlaneIndex `[get, set]`
	Defines the color plane to be used if the image assigned to the control consists of more than one plane. Valid values are 0 to ImageDimension (cvEdge.Image). If you specify an invalid value the CVCError will be fired. More...

EdgePolarity	Polarity1 `[get, set]`
	Defines the polarity of the edge. The polarity defines the direction of the edge (see EdgePolarity for more information). More...

EdgePolarity	Polarity2 `[get, set]`
	Defines the polarity of the the second edge of an edge pair. The polarity defines the direction of the edge (see EdgePolarity for more information). More...

double	PQuality `[get]`
	Returns the quality of the currently selected edge at index EdgeIndex. Indicates the quality of detection, depending on the method used ( see SearchMode property). More...

double	PX `[get]`
	Returns the x-position of the currently selected edge at index EdgeIndex. More...

double	PY `[get]`
	Returns the y-position of the currently selected edge at index EdgeIndex. More...

boolean	ResetCS `[get, set]`
	Indicates if the coordinate of the image will be reset. If this property is set to `TRUE` the coordinate system of the image will set in the Execute method so that it is based on the top, left corner and aligned to the X and Y axis of the image without scaling. The coordinate system is set on the top, left corner before the Execute method is executed. More...

SearchFunction	SearchFunction `[get, set]`
	Defines the search function being used in the Execute method. More...

SearchMode	SearchMode `[get, set]`
	Defines the search mode being used in the Execute method. More...

double	Threshold1 `[get, set]`
	Defines the threshold used to detect the edge. This property is used by all search functions. As the edge tool supports virtually any bit depth valid values are in the range of 0 to 2^ImageDataType(img, PlaneIndex) - 1. E.g 0 to 255 for 8Bit images or 0 to 1023 for 10Bit images. Notice that if you are using a simple threshold SearchMode the threshold is defined in gray values while in the other modes the threshold is defined by gray value differences (contrast) resulting in much lower values. More...

double	Threshold2 `[get, set]`
	Defines the threshold used to detect the second edge of an edge pair. This property is used only for the SEARCHFUNCTION_EDGEPAIR SearchFunction. As the edge tool supports virtually any bit depth valid values are in the range of 0 to 2^ImageDataType(img, PlaneIndex) - 1. E.g 0 to 255 for 8Bit images or 0 to 1023 for 10Bit images. Notice that if you are using a simple threshold SearchMode the threshold is defined in gray values while in the other modes the threshold is defined by gray value differences (contrast) resulting in much lower values. More...

double	X0 `[get, set]`
	Defines X0-coordinate of the area in which the control tries to find edges. More...

double	X1 `[get, set]`
	Defines X1-coordinate of the area in which the control tries to find edges. More...

double	X2 `[get, set]`
	Defines X2-coordinate of the area in which the control tries to find edges. More...

double	Y0 `[get, set]`
	Defines Y0-coordinate of the area in which the control tries to find edges. More...

double	Y1 `[get, set]`
	Defines Y1-coordinate of the area in which the control tries to find edges. More...

double	Y2 `[get, set]`
	Defines Y2-coordinate of the area in which the control tries to find edges. More...

Detailed Description

Properties

◆ AffectOriginX

boolean AffectOriginX

getset

If an edge could be found using the Execute method the origin X of the image used in the control is set to the X position of the first edge found.

Parameters

[in,out] AffectOriginX If TRUE the coordinate system of the image used will be modified in the Execute method.

Returns: Indicates if coordinate system of the image will be modified.

Supported platforms:: Win32
Win64

Related Topics:: AffectOriginY, ResetCS

Examples:: Delphi - Delphi Edge OCX Example
Visual Basic - VB Edge OCX Example
Visual C++ - VC Edge OCX Example

◆ AffectOriginY

boolean AffectOriginY

getset

If an edge could be found using the Execute method the origin Y of the image used in the control is set to the Y position of the first edge found.

Parameters

[in,out] AffectOriginY If TRUE the coordinate system of the image used will be modified in the Execute method.

Returns: Indicates if coordinate system of the image will be modified.

Supported platforms:: Win32
Win64

Related Topics:: AffectOriginX, ResetCS

Examples:: Delphi - Delphi Edge OCX Example
Visual Basic - VB Edge OCX Example
Visual C++ - VC Edge OCX Example

◆ Density

long Density

getset

Defines the density that used to scan the image data. Valid values are in the range from 100 to 1000. Higher value result in higher accuracy while lower values result in higher speed. It is recommended to use the default value.

Parameters

[in,out] Density Density to be used.

Returns: Used density.

Supported platforms:: Win32
Win64

Related Topics:: Subsampling with Density parameter

◆ EdgeCount

long EdgeCount

get

Returns the number of edges found. To retrieve the information about a specific edge you have to set its index first using the EdgeIndex property. Valid values are 0 to EdgeCount -1. The position of the edge is returned in the PX and PY properties, the quality is returned in the PQuality property. All these properties are read only. Use the MaxEdgeCount property to define the maximum number of edges to be found.

Parameters

[out] EdgeCount Number of edges found.

Returns: Number of edges.

Supported platforms:: Win32
Win64

Related Topics:: MaxEdgeCount, EdgeIndex, PX, PY, PQuality, Execute

Examples:: Delphi - Delphi Edge OCX Example
Visual Basic - VB Edge OCX Example
Visual C++ - VC Edge OCX Example

◆ EdgeIndex

long EdgeIndex

getset

Used to set the index of the edge to access.
Valid values are 0 to EdgeCount -1. The position of the edge is returned in the PX and PY properties, the quality is returned in the PQuality property. All these properties are read only.

Parameters

[in,out] EdgeIndex Index to access.

Returns: Edge index.

Supported platforms:: Win32
Win64

Related Topics:: EdgeCount, PX, PY, PQuality, Execute

Examples:: Delphi - Delphi Edge OCX Example
Visual Basic - VB Edge OCX Example
Visual C++ - VC Edge OCX Example

◆ Entire

boolean Entire

getset

If this property is set to TRUE the complete image will be used to detect a vertical edge (horizontal detection).

Attention: If this property is set to TRUE the area passed by the X0, Y0, X1, Y1, X2 and Y2 properties is ignored.

Parameters

[in,out] Entire TRUE indicates that complete image will be used, FALSE specifies that area of interest will be used.

Returns: Indicates if complete image is used.

Supported platforms:: Win32
Win64

Related Topics:: X0, Y0, X1, Y1, X2 and Y2 Properties

◆ Image

__int3264 Image

getset

Defines the image object that is assigned to the Common Vision Edge Control.

Parameters

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

Returns: Image object handle.

Supported platforms:: Win32
Win64

Examples:: Delphi - Delphi Edge OCX Example
Visual Basic - VB Edge OCX Example
Visual C++ - VC Edge OCX Example

◆ MaxEdgeCount

long MaxEdgeCount

getset

Use this property to define the maximum number of edges you want to detect.

Attention: The minimum allowed value is 2.

Parameters

[in,out] MaxEdgeCount Maximum number of edges to detect.

Returns: Maximum number of edges to detect.

Supported platforms:: Win32
Win64

Related Topics:: EdgeCount, EdgeIndex, PX, PY, PQuality, Execute

Examples:: Delphi - Delphi Edge OCX Example
Visual Basic - VB Edge OCX Example
Visual C++ - VC Edge OCX Example

◆ PlaneIndex

long PlaneIndex

getset

Defines the color plane to be used if the image assigned to the control consists of more than one plane. Valid values are 0 to ImageDimension (cvEdge.Image). If you specify an invalid value the CVCError will be fired.

Parameters

[in,out] PlaneIndex Plane index of image to access.

Returns: Plane index.

Supported platforms:: Win32
Win64

◆ Polarity1

EdgePolarity Polarity1

getset

Defines the polarity of the edge. The polarity defines the direction of the edge (see EdgePolarity for more information).

Attention: The POLARITY_DONT_CARE polarity can only be used in conjunction with the SEARCHMODE_OPTIMIZED_SUB SearchMode. This property is used for all search functions while the Polarity2 property is only used for SEARCHFUNCTION_EDGEPAIR SearchFunction.

Parameters

[in,out] Polarity1 Defines the polarity of the edge (see EdgePolarity for more information).

Returns: Polarity of the edge.

Supported platforms:: Win32
Win64

Related Topics:: Threshold1, Threshold2, SearchMode Property, SearchFunction Property, Polarity2, Positive and negative edge

Examples:: Delphi - Delphi Edge OCX Example
Visual Basic - VB Edge OCX Example
Visual C++ - VC Edge OCX Example

◆ Polarity2

EdgePolarity Polarity2

getset

Defines the polarity of the the second edge of an edge pair. The polarity defines the direction of the edge (see EdgePolarity for more information).

Attention: The POLARITY_DONT_CARE polarity can only be used in conjunction with the SEARCHMODE_OPTIMIZED_SUB SearchMode. This property is used only for the SEARCHFUNCTION_EDGEPAIR SearchFunction.

Parameters

[in,out] Polarity2 Defines the polarity of the edge (see EdgePolarity for more information).

Returns: Polarity of the edge.

Supported platforms:: Win32
Win64

Related Topics:: Threshold1, Threshold2, SearchMode Property, SearchFunction Property, Polarity1, Positive and negative edge

Examples:: Delphi - Delphi Edge OCX Example
Visual Basic - VB Edge OCX Example
Visual C++ - VC Edge OCX Example

◆ PQuality

double PQuality

get

Returns the quality of the currently selected edge at index EdgeIndex. Indicates the quality of detection, depending on the method used ( see SearchMode property).

With the threshold method, the projection value at position x,y.
With the contrast method, the contrast at position x,y.

Parameters

[out] PQuality Quality of the selected index.

Returns: Quality.

Supported platforms:: Win32
Win64

Related Topics:: EdgeIndex, PX, PY

Examples:: Delphi - Delphi Edge OCX Example
Visual Basic - VB Edge OCX Example
Visual C++ - VC Edge OCX Example

◆ PX

double PX

get

Returns the x-position of the currently selected edge at index EdgeIndex.

Parameters

[out] PX x-position of the currently selected edge.

Returns: x-position.

Supported platforms:: Win32
Win64

Related Topics:: EdgeIndex, PY, PQuality

Examples:: Delphi - Delphi Edge OCX Example
Visual Basic - VB Edge OCX Example
Visual C++ - VC Edge OCX Example

◆ PY

double PY

get

Returns the y-position of the currently selected edge at index EdgeIndex.

Parameters

[out] PY y-position of the currently selected edge.

Returns: y-position.

Supported platforms:: Win32
Win64

Related Topics:: EdgeIndex, PX, PQuality

Examples:: Delphi - Delphi Edge OCX Example
Visual Basic - VB Edge OCX Example
Visual C++ - VC Edge OCX Example

◆ ResetCS

boolean ResetCS

getset

Indicates if the coordinate of the image will be reset. If this property is set to TRUE the coordinate system of the image will set in the Execute method so that it is based on the top, left corner and aligned to the X and Y axis of the image without scaling. The coordinate system is set on the top, left corner before the Execute method is executed.

Parameters

[in,out] ResetCS If TRUE the coordinate system will been reset.

Returns: Indicates if the coordinate system will been reset.

Supported platforms:: Win32
Win64

Related Topics:: AffectOriginX, AffectOriginY

◆ SearchFunction

SearchFunction SearchFunction

getset

Defines the search function being used in the Execute method.

Attention: Not all combinations of SearchFunctions and SearchModes are supported. Refer to the details below for exceptions. In case of unsupported settings the CVCError event is fired.

Parameters

[in,out] SearchFunction Sets the search mode (see SearchFunction for more information).

Returns: Search function.

Supported platforms:: Win32
Win64

Related Topics:: SearchMode Property

Examples:: Delphi - Delphi Edge OCX Example
Visual Basic - VB Edge OCX Example
Visual C++ - VC Edge OCX Example

◆ SearchMode

SearchMode SearchMode

getset

Defines the search mode being used in the Execute method.

Attention: Not all combinations of SearchFunctions and SearchModes are supported. Refer to the details below for exceptions. In case of unsupported settings the CVCError event is fired.

Parameters

[in,out] SearchMode Sets the search mode (see SearchMode for more information).

Returns: Search mode.

Supported platforms:: Win32
Win64

Related Topics:: SearchFunction Property

Examples:: Delphi - Delphi Edge OCX Example
Visual Basic - VB Edge OCX Example
Visual C++ - VC Edge OCX Example

◆ Threshold1

double Threshold1

getset

Defines the threshold used to detect the edge. This property is used by all search functions. As the edge tool supports virtually any bit depth valid values are in the range of 0 to 2^ImageDataType(img, PlaneIndex) - 1. E.g 0 to 255 for 8Bit images or 0 to 1023 for 10Bit images. Notice that if you are using a simple threshold SearchMode the threshold is defined in gray values while in the other modes the threshold is defined by gray value differences (contrast) resulting in much lower values.

Parameters

[in,out] Threshold1 Threshold used to detect the edge.

Returns: Threshold.

Supported platforms:: Win32
Win64

Related Topics:: Threshold2, SearchMode Property, SearchFunction Property, Polarity1, Polarity2

Examples:: Delphi - Delphi Edge OCX Example
Visual Basic - VB Edge OCX Example
Visual C++ - VC Edge OCX Example

◆ Threshold2

double Threshold2

getset

Defines the threshold used to detect the second edge of an edge pair. This property is used only for the SEARCHFUNCTION_EDGEPAIR SearchFunction. As the edge tool supports virtually any bit depth valid values are in the range of 0 to 2^ImageDataType(img, PlaneIndex) - 1. E.g 0 to 255 for 8Bit images or 0 to 1023 for 10Bit images. Notice that if you are using a simple threshold SearchMode the threshold is defined in gray values while in the other modes the threshold is defined by gray value differences (contrast) resulting in much lower values.

Parameters

[in,out] Threshold2 Threshold used to detect the edge.

Returns: Threshold.

Supported platforms:: Win32
Win64

Related Topics:: Threshold1, SearchMode Property, SearchFunction Property, Polarity1, Polarity2

Examples:: Delphi - Delphi Edge OCX Example
Visual Basic - VB Edge OCX Example
Visual C++ - VC Edge OCX Example

◆ X0

double X0

getset

Defines X0-coordinate of the area in which the control tries to find edges.

Attention: If the Entire property is set to TRUE these values will be ignored and the complete image will be used instead to detect a vertical edge (horizontal detection).

Parameters

[in,out] X0 XO-coordinate of the area of interest.

Returns: XO-coordinate.

Supported platforms:: Win32
Win64

Related Topics:: X0, X1, X2, Y0, Y1, Y2
Entire Property,
Search Area and Search Direction

Examples:: Delphi - Delphi Edge OCX Example
Visual Basic - VB Edge OCX Example
Visual C++ - VC Edge OCX Example

◆ X1

double X1

getset

Defines X1-coordinate of the area in which the control tries to find edges.

Attention: If the Entire property is set to TRUE these values will be ignored and the complete image will be used instead to detect a vertical edge (horizontal detection).

Parameters

[in,out] X1 X1-coordinate of the area of interest.

Returns: X1-coordinate.

Supported platforms:: Win32
Win64

Related Topics:: X0, X1, X2, Y0, Y1, Y2
Entire Property,
Search Area and Search Direction

Examples:: Delphi - Delphi Edge OCX Example
Visual Basic - VB Edge OCX Example
Visual C++ - VC Edge OCX Example

◆ X2

double X2

getset

Defines X2-coordinate of the area in which the control tries to find edges.

Attention: If the Entire property is set to TRUE these values will be ignored and the complete image will be used instead to detect a vertical edge (horizontal detection).

Parameters

[in,out] X2 X2-coordinate of the area of interest.

Returns: X2-coordinate.

Supported platforms:: Win32
Win64

Related Topics:: X0, X1, X2, Y0, Y1, Y2
Entire Property,
Search Area and Search Direction

Examples:: Delphi - Delphi Edge OCX Example
Visual Basic - VB Edge OCX Example
Visual C++ - VC Edge OCX Example

◆ Y0

double Y0

getset

Defines Y0-coordinate of the area in which the control tries to find edges.

Attention: If the Entire property is set to TRUE these values will be ignored and the complete image will be used instead to detect a vertical edge (horizontal detection).

Parameters

[in,out] Y0 Y0-coordinate of the area of interest.

Returns: Y0-coordinate.

Supported platforms:: Win32
Win64

Related Topics:: X0, X1, X2, Y0, Y1, Y2
Entire Property,
Search Area and Search Direction

Examples:: Delphi - Delphi Edge OCX Example
Visual Basic - VB Edge OCX Example
Visual C++ - VC Edge OCX Example

◆ Y1

double Y1

getset

Defines Y1-coordinate of the area in which the control tries to find edges.

Attention: If the Entire property is set to TRUE these values will be ignored and the complete image will be used instead to detect a vertical edge (horizontal detection).

Parameters

[in,out] Y1 Y1-coordinate of the area of interest.

Returns: Y1-coordinate.

Supported platforms:: Win32
Win64

Related Topics:: X0, X1, X2, Y0, Y1, Y2
Entire Property,
Search Area and Search Direction

Examples:: Delphi - Delphi Edge OCX Example
Visual Basic - VB Edge OCX Example
Visual C++ - VC Edge OCX Example

◆ Y2

double Y2

getset

Defines Y2-coordinate of the area in which the control tries to find edges.

Attention: If the Entire property is set to TRUE these values will be ignored and the complete image will be used instead to detect a vertical edge (horizontal detection).

Parameters

[in,out] Y2 Y2-coordinate of the area of interest.

Returns: Y2-coordinate.

Supported platforms:: Win32
Win64

Related Topics:: X0, X1, X2, Y0, Y1, Y2
Entire Property,
Search Area and Search Direction

Examples:: Delphi - Delphi Edge OCX Example
Visual Basic - VB Edge OCX Example
Visual C++ - VC Edge OCX Example