|
ShapeFinder2 OCX Reference 14.1
|
|
|
ShapeFinder2 OCX Reference 14.1
|
Properties | |
| boolean | AffectMatrix [get, set] |
If this property is set to TRUE the control will modify the coordinate system of the image to reflect the rotation and scaling of the best object found. More... | |
| boolean | AffectOrigin [get, set] |
If this property is set to TRUE the control will modify the coordinate system of the image to reflect the location of the best object found. More... | |
| long | BoosterMinQuality [get, set] |
| If the #PrecisionBooster property is set to #PRECISIONBOOSTER_LOW or #PRECISIONBOOSTER_HIGH this property defines the minimum correlation of an object to be reported in the result list. More... | |
| __int3264 | CLF [get, set] |
| Defines the handle to the classifier being used. More... | |
| BSTR | ClfName [get, set] |
| Defines the filename of the classifier being used. More... | |
| boolean | Entire [get, set] |
If this property is set to TRUE the area defined by the #X0, #Y0, #X1, and #Y1 properties is ignored and the complete image will be used in #Execute calls to search for object(s). More... | |
| __int3264 | Image [get, set] |
| Defines the image object that is assigned to the Common Vision ShapeFinder2 Search Control. More... | |
| long | Locality [get, set] |
| Defines the minimum distance between two objects in pixel. More... | |
| long | MaxObjectCount [get, set] |
| Defines the maximum number of objects to be found. More... | |
| long | MinimumThreshold [get, set] |
| Defines the minimum threshold (accumulator value) to be used to find objects. More... | |
| long | ObjectCount [get] |
| Returns the number of objects found. More... | |
| long | ObjectIndex [get, set] |
| Used to set the index to access one of the objects found. More... | |
| double | PAngle [get] |
| Returns the orientation (angle in degree) of the currently selected object at index #ObjectIndex. More... | |
| long | PlaneIndex [get, set] |
| Used to define the color plane to be used if the image assigned to the control contains more than one plane. More... | |
| double | PQuality [get] |
| Returns the quality of the currently selected object at index #ObjectIndex. More... | |
| PrecisionBooster | PrecisionBooster [get, set] |
| The Precision Booster controls the relationship between processing speed and accuracy. More... | |
| double | PScale [get] |
| Returns the number of objects found. More... | |
| double | PX [get] |
| Returns the x-position of the currently selected object at index #ObjectIndex. More... | |
| double | PY [get] |
| Returns the y-position of the currently selected object at index #ObjectIndex. More... | |
| long | RelativeThreshold [get, set] |
| Defines the quality threshold relative to the maximum in the image. More... | |
| boolean | ResetCS [get, set] |
| Indicates if the coordinate system will be reset before the actual search task will be executed. More... | |
| double | X0 [get, set] |
| The properties X0, #Y0, #X1 and #Y1 define the area in which the control tries to find an object. More... | |
| double | X1 [get, set] |
| The properties #X0, #Y0, X1 and #Y1 define the area in which the control tries to find an object. More... | |
| double | Y0 [get, set] |
| The properties #X0, Y0, #X1 and #Y1 define the area in which the control tries to find an object. More... | |
| double | Y1 [get, set] |
| The properties #X0, #Y0, #X1 and Y1 define the area in which the control tries to find an object. More... | |
|
getset |
If this property is set to TRUE the control will modify the coordinate system of the image to reflect the rotation and scaling of the best object found.
This is useful if you use the ShapeFinder2 Search control as a pre-processing tool of other tools that support the coordinate system of the image such as Edge and Minos. The search area of those tools will be transformed according to the image coordinate system. Doing so you are able to find an object position, orientation and scaling using the ShapeFinder2 control and then execute an OCR on the rotated and scaled image using e.g., Minos.
| [in,out] | AffectMatrix | If TRUE the used coordinate system of the image will be modified in the #Execute method, FALSE otherwise. |
TRUE indicates that the coordinate system will be modified, FALSE otherwise.
|
getset |
If this property is set to TRUE the control will modify the coordinate system of the image to reflect the location of the best object found.
This is useful if you use the ShapeFinder2 Search control as a pre-processing tool of other tools that support the coordinate system of the image such as Edge and Minos. The search area of those tools will be transformed according to the image coordinate system. Doing so you are able to find an object position, orientation and scaling using the ShapeFinder2 control and then execute an OCR on the rotated and scaled image using e.g., Minos.
| [in,out] | AffectOrigin | If TRUE the coordinate system of the image used will be modified in the #Execute method, FALSE otherwise. |
TRUE indicates that the coordinate system will be modified, FALSE otherwise.
|
getset |
If the #PrecisionBooster property is set to #PRECISIONBOOSTER_LOW or #PRECISIONBOOSTER_HIGH this property defines the minimum correlation of an object to be reported in the result list.
| [in,out] | BoosterMinQuality | Correlation threshold between 0 to 100. |
|
getset |
Defines the handle to the classifier being used.
The classifier has to be created using the ShapeFinder2 Teach application or with the \c CreateSF2 function of the ShapeFinder library.
| [in,out] | CLF | Handle to the classifier being used. |
TSearchAllParams Method
|
getset |
Defines the filename of the classifier being used.
If you write this property the control will automatically invoke the #LoadClassifier method. On the other hand if you invoke the #LoadClassifier or #LoadClassifierByDialog method this property will reflect the filename of the classifier being used.
| [in,out] | ClfName | Filename of the classifier being used. |
|
getset |
If this property is set to TRUE the area defined by the #X0, #Y0, #X1, and #Y1 properties is ignored and the complete image will be used in #Execute calls to search for object(s).
| [in,out] | Entire | TRUE indicates that the complete image will be searched, FALSE specifies that the search rectangle is defined by #X0, #Y0, #X1 and #Y1 is being used. |
|
getset |
|
getset |
Defines the minimum distance between two objects in pixel.
Objects that are closer together are treated as one (the one with the higher quality). The locality refers to the center points of the found objects. But the distance is not the euclidean distance. The x and y components are evaluated separately. If e.g. the euclidean distance of two center points is 57 pixels and the angle is about 45° the X and Y distance is about 40 pixels respectively. Thus the \a Locality must be below 40.
| [in,out] | Locality | Minimum distance between two objects. |
TSearchAllParams structure (LocXY member) in the ShapeFinder library.
|
getset |
Defines the maximum number of objects to be found.
| [in,out] | MaxObjectCount | Maximum number of objects to be found. |
TSearchAllParams structure (MaxNumSolutions member) in the ShapeFinder library.
|
getset |
Defines the minimum threshold (accumulator value) to be used to find objects.
Refer to the documentation of the search algorithm.
| [in,out] | MinimumThreshold | Minimum accumulator value. |
TSearchAllParams structure (MinimalThreshold member) in the ShapeFinder library.
|
get |
Returns the number of objects found.
To retrieve the information about a specific object you have to set its index first using the #ObjectIndex property. Valid values are 0 to \a ObjectCount - 1. The position of the object is returned in the #PX and #PY properties, the quality is returned in the #PQuality property. Orientation and Scaling are returned in the #PAngle and #PScale properties respectively. All these properties are read only. Use the #MaxObjectCount property to define the maximum number of object to be found.
| [out] | ObjectCount | Number of objects being found. |
|
getset |
Used to set the index to access one of the objects found.
Valid values are 0 to #ObjectCount - 1. The position of the object is returned in the #PX and #PY properties, the quality is returned in the #PQuality property. Orientation and Scaling are returned in the #PAngle and #PScale properties respectively. All these properties are read only.
| [in,out] | ObjectIndex | Current object index to select. |
|
get |
Returns the orientation (angle in degree) of the currently selected object at index #ObjectIndex.
| [out] | PAngle | Orientation of selected object. |
|
getset |
Used to define the color plane to be used if the image assigned to the control contains more than one plane.
Valid values are 0 to \a ImageDimension (cvSF2.Image) - 1. If you specify an invalid value the #CVCError event will be fired.
| [in,out] | PlaneIndex | Index of plane to be used. |
|
get |
Returns the quality of the currently selected object at index #ObjectIndex.
| [out] | PQuality | Quality of selected object. |
|
getset |
The Precision Booster controls the relationship between processing speed and accuracy.
Refer to <i>Theory of Operation</i> documentation of ShapeFinder2 search algorithm.
| [in,out] | PrecisionBooster | Minimum distance between two objects. |
TSearchAllParams structure (Precision member) in the ShapeFinder library.
|
get |
|
get |
Returns the x-position of the currently selected object at index #ObjectIndex.
| [out] | PX | X-position of selected object. |
|
get |
Returns the y-position of the currently selected object at index #ObjectIndex.
| [out] | PY | Y-position of selected object. |
|
getset |
Defines the quality threshold relative to the maximum in the image.
For detailed information refer to the \c TSearchAllParams structure in the ShapeFinder library.
| [in,out] | RelativeThreshold | Relative (to the best object found) quality threshold. |
TSearchAllParams structure (RelativeThreshold member) in the ShapeFinder library.
|
getset |
Indicates if the coordinate system will be reset before the actual search task will be executed.
| [in,out] | ResetCS | TRUE indicates that the coordinate system of the image will be reset before the actual search task will be executed, FALSE means that the search area will be transformed using the current image origin. |
TRUE indicates that the coordinate system will be reset before the search task, FALSE otherwise.
|
getset |
The properties X0, #Y0, #X1 and #Y1 define the area in which the control tries to find an object.
TRUE these values will be ignored and the complete image will be used instead to find objects. If the image coordinate system defines an origin other than 0,0 this area is shifted by origin X and origin Y respectively. Scaling and rotation of the coordinate system will be ignored. To ensure an origin at 0,0 set the #ResetCS property to TRUE. | [in,out] | X0 | X0 coordinate of the area of interest. |
|
getset |
The properties #X0, #Y0, X1 and #Y1 define the area in which the control tries to find an object.
TRUE these values will be ignored and the complete image will be used instead to find objects. If the image coordinate system defines an origin other than 0,0 this area is shifted by origin X and origin Y respectively. Scaling and rotation of the coordinate system will be ignored. To ensure an origin at 0,0 set the #ResetCS property to TRUE. | [in,out] | X1 | X1 coordinate of the area of interest. |
|
getset |
The properties #X0, Y0, #X1 and #Y1 define the area in which the control tries to find an object.
TRUE these values will be ignored and the complete image will be used instead to find objects. If the image coordinate system defines an origin other than 0,0 this area is shifted by origin X and origin Y respectively. Scaling and rotation of the coordinate system will be ignored. To ensure an origin at 0,0 set the #ResetCS property to TRUE. | [in,out] | Y0 | Y0 coordinate of the area of interest. |
|
getset |
The properties #X0, #Y0, #X1 and Y1 define the area in which the control tries to find an object.
TRUE these values will be ignored and the complete image will be used instead to find objects. If the image coordinate system defines an origin other than 0,0 this area is shifted by origin X and origin Y respectively. Scaling and rotation of the coordinate system will be ignored. To ensure an origin at 0,0 set the #ResetCS property to TRUE. | [in,out] | Y1 | Y1 coordinate of the area of interest. |