Manto OCX Reference 14.0
Properties

Properties

long AdvanceX [get, set]
 X-component of the advance vector. More...
 
long AdvanceY [get, set]
 Y-component of the advance vector. More...
 
BSTR ClassID [get]
 Holds the ID of the class in the classifier that has been selected through the #ClassIndex property. More...
 
long Classifier [get]
 The property Classifier holds the handle to the currently loaded classifier inside the ActiveX control. More...
 
long ClassIndex [get, set]
 ClassIndex references one of the #NumClasses classes that have been defined for the classifier. More...
 
BSTR Comment [get]
 Each classifier can potentially hold a comment string that is user-definable and is being stored along with the classifier's data. More...
 
long Dimension [get]
 This property holds the dimension (number of planes) for which a classifier has been generated. 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...
 
BSTR ExcludedClassID [get, set]
 When a classifier has been configured to find objects, it usually contains an excluded class i.e., a class that holds samples of everything that the user is not interested in. More...
 
long FeatureWindowHeight [get]
 The feature window height and width have been defined during creation of the classifier. More...
 
long FeatureWindowWidth [get]
 The feature window height and width have been defined during creation of the classifier. More...
 
BSTR FileName [get, set]
 This property FileName holds the name of the file from which the current classifier has been loaded. More...
 
boolean HasClassifier [get]
 Indicates if the classifier has been successfully loaded. More...
 
long Image [get, set]
 Defines the image object that is assigned to the Common Vision Manto Search Control. More...
 
double LearnResult [get]
 This property holds the learning success result of the classifier, a characteristic number that is approximately proportional to the classifier's capability to separate the feature space. More...
 
long Locality [get, set]
 The locality specifies the minimum distance between two results in #MC_SearchAll and an approximate minimum distance in #MC_SearchAll_Refined mode (see #SearchTask property). More...
 
long NumClasses [get]
 NumClasses holds the number of classes that have been defined for the currently loaded classifier. More...
 
long ObjectCount [get]
 Returns the number of objects that have been found during the last call to the #Execute method. More...
 
long ObjectIndex [get, set]
 This property may be used to select an individual result that has been found during the last call to the #Execute method in order to retrieve additional informations about the result. More...
 
BSTR PClassID [get]
 The pattern name (#ClassID) returned by the respective search procedure. More...
 
double PConfidence [get]
 Hold the quality of the currently selected object at index #ObjectIndex. More...
 
BSTR PreprocessingCode [get]
 Retrieve the Manto Preprocessing Filter sequence that has been used during the generation of the classifier (for more informations about the Manto Preprocessing Filter please refer to the Manto Teach Tutorial. More...
 
BSTR PToken [get]
 It holds the concatenated class IDs of all the results that have been 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 Radius [get, set]
 The Radius property defines the size of the translated search rectangle to be used in the #MC_ReadToken search mode (see #SearchTask property). More...
 
long SampleOriginX [get]
 Return the x-component of the origin position inside the classifier's feature window. More...
 
long SampleOriginY [get]
 Holds the y-component of the origin position inside the classifier's feature window. More...
 
SearchMode SearchTask [get, set]
 The SearchTask property can be used to define the search mode for the next call to the #Execute method. More...
 
double Threshold [get, set]
 This property defines the minimum confidence level a result must have to be entered into the list of results (see #ObjectCount). More...
 
boolean UseDotSensitivity [get, set]
 Switch sensitivity on dot-signs in class labels on or off. More...
 
boolean UseVoting [get, set]
 Enable or disable the voting mechanism for the classification process. More...
 
double X0 [get, set]
 The properties X0, #Y0, #X1 and #Y1 define a rectangular area of interest in which the control tries to find an object. More...
 
double X1 [get, set]
 The properties #X0, #Y0, X1 and #Y1 define a rectangular area of interest in which the control tries to find an object. More...
 
double Y0 [get, set]
 The properties #X0, Y0, #X1 and #Y1 define a rectangular area of interest in which the control tries to find an object. More...
 
double Y1 [get, set]
 The properties #X0, #Y0, #X1 and Y1 define a rectangular area of interest in which the control tries to find an object. More...
 

Detailed Description

Properties

◆ AdvanceX

long AdvanceX
getsetproperty

X-component of the advance vector.

This property is only being used if the property #SearchTask has been set to #MC_ReadToken.

The #SearchTask #MC_ReadToken scans the frame (Left, Top, Right, Bottom) of the 
image to generate a list of pattern matches. After the first pattern was found, a small 
search window of size #Radius will be generated and moved by \a AdvanceX and #AdvanceY 
relative to the location of the previously found object and a new search is performed in this 
translated search area. This process is repeated until no more object can be found. 
The \ref ClassID "class IDs" of the results encountered during this search will be concatenated to the result string #PToken.
The other result reporting properties (#ObjectCount, #PX, #PY, #PConfidence, #PClassID) 
will also be updated accordingly.
Parameters
[in,out]AdvanceXX-component of the advance vector.
Returns
X-component of the advance vector.
Supported platforms:
Win32

◆ AdvanceY

long AdvanceY
getsetproperty

Y-component of the advance vector.

This property is only being used if the property #SearchTask has been set to #MC_ReadToken.

The #SearchTask #MC_ReadToken scans the frame (Left, Top, Right, Bottom) of the 
image to generate a list of pattern matches. After the first pattern was found, a small 
search window of size #Radius will be generated and moved by #AdvanceX and \a AdvanceY 
relative to the location of the previously found object and a new search is performed in this 
translated search area. This process is repeated until no more object can be found. 
The \ref ClassID "class IDs" of the results encountered during this search will be concatenated to the result string #PToken.
The other result reporting properties (#ObjectCount, #PX, #PY, #PConfidence, #PClassID) 
will also be updated accordingly.
Parameters
[in,out]AdvanceYY-component of the advance vector.
Returns
Y-component of the advance vector.
Supported platforms:
Win32

◆ ClassID

BSTR ClassID
getproperty

Holds the ID of the class in the classifier that has been selected through the #ClassIndex property.

By cycling the property #ClassIndex from 0 to #NumClasses - 1 you can retrieve the names of all classes that have been defined for the currently loaded classifier.

Parameters
[out]ClassIDSelected class ID.
Returns
Selected class ID.
Supported platforms:
Win32

◆ Classifier

long Classifier
getproperty

The property Classifier holds the handle to the currently loaded classifier inside the ActiveX control.

Attention
That handle is compatible with the handles that are being used inside the Manto library (type MFC), but it is generally not recommended to mix the use of the OCX and the library on the same handle.
Parameters
[out]Classifier0 indicates that no classifier has been loaded,
otherwise this is a handle to the classifier.
Returns
Indicates if a classifier has been loaded or not.
Supported platforms:
Win32

◆ ClassIndex

long ClassIndex
getsetproperty

ClassIndex references one of the #NumClasses classes that have been defined for the classifier.

Valid values range from 0 to  #NumClasses - 1.
Parameters
[in,out]ClassIndexClass index.
Returns
Class index.
Supported platforms:
Win32

◆ Comment

BSTR Comment
getproperty

Each classifier can potentially hold a comment string that is user-definable and is being stored along with the classifier's data.

Use the Comment property of the Manto OCX to readout the comment that has been specified for the currently loaded classifier.

Parameters
[out]CommentUser-defined comment.
Returns
User-defined comment.
Supported platforms:
Win32
Related Topics:
#FileName Property

◆ Dimension

long Dimension
getproperty

This property holds the dimension (number of planes) for which a classifier has been generated.

   For example if a classifier has been trained on monochrome images, \a Dimension will be 1, and consequently 
   it will not be possible to process images with more than 1 plane with this classifier! 
Attention
The number of planes in the image to be processed by a classifiers always needs to match the number of planes of the images from which the classifier has been trained.
Parameters
[out]DimensionNumber of planes for which a classifier has been generated.
Returns
Number of planes for which the classifier has been generated.
Supported platforms:
Win32

◆ Entire

boolean Entire
getsetproperty

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).

Parameters
[in,out]EntireTRUE 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.
Returns
Indicates if complete image is used.
Supported platforms:
Win32
Related Topics:
#X0, #Y0, #X1 and #Y1 Properties
#Execute Method

◆ ExcludedClassID

BSTR ExcludedClassID
getsetproperty

When a classifier has been configured to find objects, it usually contains an excluded class i.e., a class that holds samples of everything that the user is not interested in.

Attention
The class that should be suppressed during result reporting is selectable at runtime through the ExcludedClassID property. When trying to set an excluded class that is not part of the classifier or when trying to set an excluded class while no classifier is loaded, setting this property will raise the #CVCError event.
Parameters
[in,out]ExcludedClassIDID of excluded classifier.
Returns
ID of excluded classifier.
Supported platforms:
Win32

◆ FeatureWindowHeight

long FeatureWindowHeight
getproperty

The feature window height and width have been defined during creation of the classifier.

   The ActiveX control properties #FeatureWindowWidth and \a FeatureWindowHeight make these parameters 
   accessible to users. 
Attention
Please make sure that the image you are trying to run a classifier on is at least as big as the classifier's feature window.
Parameters
[out]FeatureWindowHeightHeight of classifier's feature window.
Returns
Height of classifier's feature window.
Supported platforms:
Win32
Related Topics:
#FeatureWindowWidth Property

◆ FeatureWindowWidth

long FeatureWindowWidth
getproperty

The feature window height and width have been defined during creation of the classifier.

   The ActiveX control properties \a FeatureWindowWidth and #FeatureWindowHeight make these parameters 
   accessible to users. 
Attention
Please make sure that the image you are trying to run a classifier on is at least as big as the classifier's feature window.
Parameters
[out]FeatureWindowWidthWidth of classifier's feature window.
Returns
Width of classifier's feature window.
Supported platforms:
Win32
Related Topics:
#FeatureWindowHeight Property

◆ FileName

BSTR FileName
getsetproperty

This property FileName holds the name of the file from which the current classifier has been loaded.

Parameters
[in,out]FileNameFile name of the current classifier.
Returns
File name of current classifier.
Supported platforms:
Win32

◆ HasClassifier

boolean HasClassifier
getproperty

Indicates if the classifier has been successfully loaded.

Parameters
[out]HasClassifierReturns TRUE once a classifier has been successfully loaded into the ActiveX control,
FALSE if there is no classifier available yet.
Returns
Indicates if the classifier has been successfully loaded.
Supported platforms:
Win32
Related Topics:
#FileName Property

◆ Image

long Image
getsetproperty

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

Parameters
[in,out]ImageHandle of the image object.
Returns
Image object handle.
Supported platforms:
Win32

◆ LearnResult

double LearnResult
getproperty

This property holds the learning success result of the classifier, a characteristic number that is approximately proportional to the classifier's capability to separate the feature space.

Learning success is determined during classifier creation, so for any given classifier this is a constant. If this number is less than or equal to 0.5, the classifier is most likely useless for classification. A learning success of 1.0 indicates a perfectly separable training data set.

Parameters
[out]LearnResultLearning success of the classifier.
Returns
Learning success of the classifer.
Supported platforms:
Win32

◆ Locality

long Locality
getsetproperty

The locality specifies the minimum distance between two results in #MC_SearchAll and an approximate minimum distance in #MC_SearchAll_Refined mode (see #SearchTask property).

Attention
Define this parameter prior to calling the #Execute method. Input values < 0 will set the Locality property to 0.
Parameters
[in,out]LocalityMinimum distance between two results.
Returns
Minimum distance between two results.
Supported platforms:
Win32
Related Topics:
#Execute Method

◆ NumClasses

long NumClasses
getproperty

NumClasses holds the number of classes that have been defined for the currently loaded classifier.

Parameters
[out]NumClassesNumber of classes that have been defined.
Returns
Number of classes.
Supported platforms:
Win32

◆ ObjectCount

long ObjectCount
getproperty

Returns the number of objects that have been found during the last call to the #Execute method.

Attention
To retrieve the information about a specific result you have to set its index first using the #ObjectIndex property. Valid values range from 0 to #ObjectCount - 1. The position of the object is returned in the #PX and #PY properties, the quality is returned in the #PConfidence property and the class ID in the #PClassID property. All these properties are read only.
Parameters
[out]ObjectCountNumber of objects found.
Returns
Number of objects found.
Supported platforms:
Win32

◆ ObjectIndex

long ObjectIndex
getsetproperty

This property may be used to select an individual result that has been found during the last call to the #Execute method in order to retrieve additional informations about the result.

Valid values range from 0 to #ObjectCount - 1. The position of the object is returned in the #PX and #PY properties, the quality is returned in the #PConfidence property and the #ClassID in the #PClassID property. All these properties are read only.

Parameters
[in,out]ObjectIndexCurrent object index to select.
Returns
Current object index.
Supported platforms:
Win32
Related Topics:
#ObjectCount Property

◆ PClassID

BSTR PClassID
getproperty

The pattern name (#ClassID) returned by the respective search procedure.

Attention
The value is valid only if the previous call of the #Execute method succeeded (i.e., if #PConfidence > 0).
Parameters
[out]PClassIDReturns the quality of selected object.
If #Execute fails the property will return -1.
Returns
Returns the quality of selected object.
Supported platforms:
Win32

◆ PConfidence

double PConfidence
getproperty

Hold the quality of the currently selected object at index #ObjectIndex.

Attention
Only meaningful if the last call to the #Execute method was successful.
Parameters
[out]PConfidenceReturns the quality of selected object.
If #Execute fails the property will return -1.
Returns
Returns the quality of selected object.
Supported platforms:
Win32

◆ PreprocessingCode

BSTR PreprocessingCode
getproperty

Retrieve the Manto Preprocessing Filter sequence that has been used during the generation of the classifier (for more informations about the Manto Preprocessing Filter please refer to the Manto Teach Tutorial.

Parameters
[out]PreprocessingCodeManto preprocessing filter sequence.
Returns
Preprocessing filter sequence.
Supported platforms:
Win32

◆ PToken

BSTR PToken
getproperty

It holds the concatenated class IDs of all the results that have been found.

Attention
This property is only meaningful if the the #SearchTask property was set to #MC_ReadToken before the last successful call to the #Execute method.
Parameters
[out]PTokenConcatenated class IDs of the results that have been found.
Returns
Concatenated class IDs.
Supported platforms:
Win32

◆ PX

double PX
getproperty

Returns the x-position of the currently selected object at index #ObjectIndex.

Attention
Only meaningful if the last successful call to the #Execute method yielded at least one result.
Parameters
[out]PXX-Position of selected object.
Returns
X-Position of selected object.
Supported platforms:
Win32
Related Topics:
#PY Property

◆ PY

double PY
getproperty

Returns the y-position of the currently selected object at index #ObjectIndex.

Attention
Only meaningful if the last successful call to the #Execute method yielded at least one result.
Parameters
[out]PXY-Position of selected object.
Returns
Y-Position of selected object.
Supported platforms:
Win32
Related Topics:
#PX Property

◆ Radius

long Radius
getsetproperty

The Radius property defines the size of the translated search rectangle to be used in the #MC_ReadToken search mode (see #SearchTask property).

Parameters
[in,out]RadiusRadius of translated search rectangle.
Returns
Radius of translated search rectangle.
Supported platforms:
Win32

◆ SampleOriginX

long SampleOriginX
getproperty

Return the x-component of the origin position inside the classifier's feature window.

Parameters
[out]SampleOriginXX-position inside the classifier's feature window.
Returns
X-position.
Supported platforms:
Win32
Related Topics:
#SampleOriginY Property

◆ SampleOriginY

long SampleOriginY
getproperty

Holds the y-component of the origin position inside the classifier's feature window.

Parameters
[out]SampleOriginYY-position inside the classifier's feature window.
Returns
Y-position.
Supported platforms:
Win32
Related Topics:
#SampleOriginX Property

◆ SearchTask

SearchMode SearchTask
getsetproperty

The SearchTask property can be used to define the search mode for the next call to the #Execute method.

Parameters
[in,out]SearchTaskSearch mode to execute (see #SearchMode for more details).
Returns
Search mode to execute.
Supported platforms:
Win32
Related Topics:
#Execute Method

◆ Threshold

double Threshold
getsetproperty

This property defines the minimum confidence level a result must have to be entered into the list of results (see #ObjectCount).

Attention
Default value is 0.5.
Parameters
[in,out]ThresholdThreshold ranging from 0 to 1.
Returns
Threshold ranging from 0 to 1.
Supported platforms:
Win32
Related Topics:
#Execute Method

◆ UseDotSensitivity

boolean UseDotSensitivity
getsetproperty

Switch sensitivity on dot-signs in class labels on or off.

The parameter \a UseDotSensitivity controls the format of the returned Model 
name by building equivalent class names for class labels differing only after 
the control character "." (dot).

If \a UseDotSensitivity is activated and the best match pattern label is part of
such a set of equivalent class names, #ClassID will merely contain the first
part of the class name i.e., the characters up to the dot sign.

If \a UseDotSensitivity is \c FALSE, the dot in a class name does not have a special meaning. 
Attention
Note that the #ExcludedClassID property of the classifier plays an important role during searching, since it can be used to condemn a class to inactivity during pattern match. For a thorough description of this important possibility see section Searching and Excluded Classes.
Parameters
[in,out]UseDotSensitivityTRUE indicates that dot sensitivity is activated,
FALSE otherwise (default value).
Returns
Indicates whether dot sensitivity is enabled or not.
Supported platforms:
Win32

◆ UseVoting

boolean UseVoting
getsetproperty

Enable or disable the voting mechanism for the classification process.

Although potentially time-consuming (especially for a classifier with a 
large number of classes), voting may in some cases (especially for a classifier 
with a large number of classes) improve the quality of the results. For a classifier
with only few classes (<10) voting typically has no significant effect. For a classifier
with 2 classes, voting has no effect.
Attention
Default value is FALSE.
Parameters
[in,out]UseVotingTRUE indicates that voting is enabled,
FALSE otherwise.
Returns
Indicates whether voting is enabled or not.
Supported platforms:
Win32
Related Topics:
Multiclass classifiers, vote and multiclass performance

◆ X0

double X0
getsetproperty

The properties X0, #Y0, #X1 and #Y1 define a rectangular area of interest in which the control tries to find an object.

Attention
If the #Entire property is set to TRUE these values will be ignored and the complete image will be used instead to find objects.
Parameters
[in,out]X0X0-coordinate of the area of interest.
Returns
X0-coordinate.
Supported platforms:
Win32
Related Topics:
#X0, #X1, #Y0, #Y1
#Entire Property, #Execute Method

◆ X1

double X1
getsetproperty

The properties #X0, #Y0, X1 and #Y1 define a rectangular area of interest in which the control tries to find an object.

Attention
If the #Entire property is set to TRUE these values will be ignored and the complete image will be used instead to find objects.
Parameters
[in,out]X1X1-coordinate of the area of interest.
Returns
X1-coordinate.
Supported platforms:
Win32
Related Topics:
#X0, #X1, #Y0, #Y1
#Entire Property, #Execute Method

◆ Y0

double Y0
getsetproperty

The properties #X0, Y0, #X1 and #Y1 define a rectangular area of interest in which the control tries to find an object.

Attention
If the #Entire property is set to TRUE these values will be ignored and the complete image will be used instead to find objects.
Parameters
[in,out]Y0Y0-coordinate of the area of interest.
Returns
Y0-coordinate.
Supported platforms:
Win32
Related Topics:
#X0, #X1, #Y0, #Y1
#Entire Property, #Execute Method

◆ Y1

double Y1
getsetproperty

The properties #X0, #Y0, #X1 and Y1 define a rectangular area of interest in which the control tries to find an object.

Attention
If the #Entire property is set to TRUE these values will be ignored and the complete image will be used instead to find objects.
Parameters
[in,out]Y1Y1-coordinate of the area of interest.
Returns
Y1-coordinate.
Supported platforms:
Win32
Related Topics:
#X0, #X1, #Y0, #Y1
#Entire Property, #Execute Method