eVision Python API
Loading...
Searching...
No Matches
eVision.EMatchPosition Class Reference

Represents a single instance of the pattern in the search field, as returned by the EasyMatch matching process. More...

Public Member Functions

None __init__ (self)
None __init__ (self, float CenterX)
None __init__ (self, float CenterX, float CenterY)
None __init__ (self, float CenterX, float CenterY, float Angle)
None __init__ (self, float CenterX, float CenterY, float Angle, float Scale)
None __init__ (self, float CenterX, float CenterY, float Angle, float Scale, float ScaleX)
None __init__ (self, float CenterX, float CenterY, float Angle, float Scale, float ScaleX, float ScaleY)
None __init__ (self, float CenterX, float CenterY, float Angle, float Scale, float ScaleX, float ScaleY, float Score)
None __init__ (self, float CenterX, float CenterY, float Angle, float Scale, float ScaleX, float ScaleY, float Score, bool Interpolated)
None __init__ (self, float CenterX, float CenterY, float Angle, float Scale, float ScaleX, float ScaleY, float Score, bool Interpolated, float AreaRatio)
None __init__ (self, float CenterX, float CenterY, float Angle, float Scale, float ScaleX, float ScaleY, float Score, bool Interpolated, float AreaRatio, float Reserved)
None __init__ (self, float CenterX, float CenterY, float Angle, float Scale, float ScaleX, float ScaleY, float Score, bool Interpolated, float AreaRatio, float Reserved, float CachedRectangleSizeForOverlap)
None __init__ (self, eVision.EMatchPosition other)
eVision.ERegion ToRegion (self, int modelWidth, int modelHeight)
 Creates an ERegion from the eVision.EMatchPosition.
float CenterX (self)
 Abscissa of the center of the pattern found in the image.
 CenterX (self, float value)
 Abscissa of the center of the pattern found in the image.
float CenterY (self)
 Ordinate of the center of the pattern found in the image.
 CenterY (self, float value)
 Ordinate of the center of the pattern found in the image.
float Angle (self)
 Clockwise rotation angle, expressed using the current angle unit, of the pattern found in the image.
 Angle (self, float value)
 Clockwise rotation angle, expressed using the current angle unit, of the pattern found in the image.
float Scale (self)
 Scale factor of the pattern found in the image.
 Scale (self, float value)
 Scale factor of the pattern found in the image.
float ScaleX (self)
 Measured horizontal scaling of the pattern found in the image, expressed as a dimensionless ratio.
 ScaleX (self, float value)
 Measured horizontal scaling of the pattern found in the image, expressed as a dimensionless ratio.
float ScaleY (self)
 Measured vertical scaling of the pattern found in the image, expressed as a dimensionless ratio.
 ScaleY (self, float value)
 Measured vertical scaling of the pattern found in the image, expressed as a dimensionless ratio.
float Score (self)
 Indicates how good a matching was.
 Score (self, float value)
 Indicates how good a matching was.
bool Interpolated (self)
 Indicates whether sub-pixel interpolation was actually performed on the position.
 Interpolated (self, bool value)
 Indicates whether sub-pixel interpolation was actually performed on the position.
float AreaRatio (self)
 Ratio between the found pattern area inside the search ROI and its complete area.
 AreaRatio (self, float value)
 Ratio between the found pattern area inside the search ROI and its complete area.
float Reserved (self)
 Reserved (self, float value)
float CachedRectangleSizeForOverlap (self)
 CachedRectangleSizeForOverlap (self, float value)

Detailed Description

Represents a single instance of the pattern in the search field, as returned by the EasyMatch matching process.

Remarks:

eVision.EMatcher.GetPosition returns instances of this class. A eVision.EMatchPosition object represents one matched instance, with all the needed information about it.

License(s): None

Deprecated

Use eVision.EFoundPattern instead.

Deprecated in version 25.2. Scheduled to be removed in version 27.6.

Constructor & Destructor Documentation

◆ __init__() [1/13]

None eVision.EMatchPosition.__init__ ( self)

◆ __init__() [2/13]

None eVision.EMatchPosition.__init__ ( self,
float CenterX )
Parameters
CenterXAbscissa of the center of the pattern found in the image.

◆ __init__() [3/13]

None eVision.EMatchPosition.__init__ ( self,
float CenterX,
float CenterY )
Parameters
CenterXAbscissa of the center of the pattern found in the image.
CenterYOrdinate of the center of the pattern found in the image.

◆ __init__() [4/13]

None eVision.EMatchPosition.__init__ ( self,
float CenterX,
float CenterY,
float Angle )
Parameters
CenterXAbscissa of the center of the pattern found in the image.
CenterYOrdinate of the center of the pattern found in the image.
AngleClockwise rotation angle, expressed using the current angle unit, of the pattern found in the image.

◆ __init__() [5/13]

None eVision.EMatchPosition.__init__ ( self,
float CenterX,
float CenterY,
float Angle,
float Scale )
Parameters
CenterXAbscissa of the center of the pattern found in the image.
CenterYOrdinate of the center of the pattern found in the image.
AngleClockwise rotation angle, expressed using the current angle unit, of the pattern found in the image.
ScaleScale factor of the pattern found in the image.

◆ __init__() [6/13]

None eVision.EMatchPosition.__init__ ( self,
float CenterX,
float CenterY,
float Angle,
float Scale,
float ScaleX )
Parameters
CenterXAbscissa of the center of the pattern found in the image.
CenterYOrdinate of the center of the pattern found in the image.
AngleClockwise rotation angle, expressed using the current angle unit, of the pattern found in the image.
ScaleScale factor of the pattern found in the image.
ScaleXMeasured horizontal scaling of the pattern found in the image, expressed as a dimensionless ratio.

◆ __init__() [7/13]

None eVision.EMatchPosition.__init__ ( self,
float CenterX,
float CenterY,
float Angle,
float Scale,
float ScaleX,
float ScaleY )
Parameters
CenterXAbscissa of the center of the pattern found in the image.
CenterYOrdinate of the center of the pattern found in the image.
AngleClockwise rotation angle, expressed using the current angle unit, of the pattern found in the image.
ScaleScale factor of the pattern found in the image.
ScaleXMeasured horizontal scaling of the pattern found in the image, expressed as a dimensionless ratio.
ScaleYMeasured vertical scaling of the pattern found in the image, expressed as a dimensionless ratio.

◆ __init__() [8/13]

None eVision.EMatchPosition.__init__ ( self,
float CenterX,
float CenterY,
float Angle,
float Scale,
float ScaleX,
float ScaleY,
float Score )
Parameters
CenterXAbscissa of the center of the pattern found in the image.
CenterYOrdinate of the center of the pattern found in the image.
AngleClockwise rotation angle, expressed using the current angle unit, of the pattern found in the image.
ScaleScale factor of the pattern found in the image.
ScaleXMeasured horizontal scaling of the pattern found in the image, expressed as a dimensionless ratio.
ScaleYMeasured vertical scaling of the pattern found in the image, expressed as a dimensionless ratio.
ScoreIndicates how good a matching was.

◆ __init__() [9/13]

None eVision.EMatchPosition.__init__ ( self,
float CenterX,
float CenterY,
float Angle,
float Scale,
float ScaleX,
float ScaleY,
float Score,
bool Interpolated )
Parameters
CenterXAbscissa of the center of the pattern found in the image.
CenterYOrdinate of the center of the pattern found in the image.
AngleClockwise rotation angle, expressed using the current angle unit, of the pattern found in the image.
ScaleScale factor of the pattern found in the image.
ScaleXMeasured horizontal scaling of the pattern found in the image, expressed as a dimensionless ratio.
ScaleYMeasured vertical scaling of the pattern found in the image, expressed as a dimensionless ratio.
ScoreIndicates how good a matching was.
InterpolatedIndicates whether sub-pixel interpolation was actually performed on the position.

◆ __init__() [10/13]

None eVision.EMatchPosition.__init__ ( self,
float CenterX,
float CenterY,
float Angle,
float Scale,
float ScaleX,
float ScaleY,
float Score,
bool Interpolated,
float AreaRatio )
Parameters
CenterXAbscissa of the center of the pattern found in the image.
CenterYOrdinate of the center of the pattern found in the image.
AngleClockwise rotation angle, expressed using the current angle unit, of the pattern found in the image.
ScaleScale factor of the pattern found in the image.
ScaleXMeasured horizontal scaling of the pattern found in the image, expressed as a dimensionless ratio.
ScaleYMeasured vertical scaling of the pattern found in the image, expressed as a dimensionless ratio.
ScoreIndicates how good a matching was.
InterpolatedIndicates whether sub-pixel interpolation was actually performed on the position.
AreaRatioRatio between the found pattern area inside the search ROI and its complete area.

◆ __init__() [11/13]

None eVision.EMatchPosition.__init__ ( self,
float CenterX,
float CenterY,
float Angle,
float Scale,
float ScaleX,
float ScaleY,
float Score,
bool Interpolated,
float AreaRatio,
float Reserved )
Parameters
CenterXAbscissa of the center of the pattern found in the image.
CenterYOrdinate of the center of the pattern found in the image.
AngleClockwise rotation angle, expressed using the current angle unit, of the pattern found in the image.
ScaleScale factor of the pattern found in the image.
ScaleXMeasured horizontal scaling of the pattern found in the image, expressed as a dimensionless ratio.
ScaleYMeasured vertical scaling of the pattern found in the image, expressed as a dimensionless ratio.
ScoreIndicates how good a matching was.
InterpolatedIndicates whether sub-pixel interpolation was actually performed on the position.
AreaRatioRatio between the found pattern area inside the search ROI and its complete area.

◆ __init__() [12/13]

None eVision.EMatchPosition.__init__ ( self,
float CenterX,
float CenterY,
float Angle,
float Scale,
float ScaleX,
float ScaleY,
float Score,
bool Interpolated,
float AreaRatio,
float Reserved,
float CachedRectangleSizeForOverlap )
Parameters
CenterXAbscissa of the center of the pattern found in the image.
CenterYOrdinate of the center of the pattern found in the image.
AngleClockwise rotation angle, expressed using the current angle unit, of the pattern found in the image.
ScaleScale factor of the pattern found in the image.
ScaleXMeasured horizontal scaling of the pattern found in the image, expressed as a dimensionless ratio.
ScaleYMeasured vertical scaling of the pattern found in the image, expressed as a dimensionless ratio.
ScoreIndicates how good a matching was.
InterpolatedIndicates whether sub-pixel interpolation was actually performed on the position.
AreaRatioRatio between the found pattern area inside the search ROI and its complete area.

◆ __init__() [13/13]

None eVision.EMatchPosition.__init__ ( self,
eVision.EMatchPosition other )
Parameters
otherOther instance

Member Function Documentation

◆ Angle() [1/2]

float eVision.EMatchPosition.Angle ( self)

Clockwise rotation angle, expressed using the current angle unit, of the pattern found in the image.

Remarks:

0 if no rotation is allowed.

◆ Angle() [2/2]

eVision.EMatchPosition.Angle ( self,
float value )

Clockwise rotation angle, expressed using the current angle unit, of the pattern found in the image.

Remarks:

0 if no rotation is allowed.

◆ AreaRatio() [1/2]

float eVision.EMatchPosition.AreaRatio ( self)

Ratio between the found pattern area inside the search ROI and its complete area.

◆ AreaRatio() [2/2]

eVision.EMatchPosition.AreaRatio ( self,
float value )

Ratio between the found pattern area inside the search ROI and its complete area.

◆ CachedRectangleSizeForOverlap() [1/2]

float eVision.EMatchPosition.CachedRectangleSizeForOverlap ( self)

◆ CachedRectangleSizeForOverlap() [2/2]

eVision.EMatchPosition.CachedRectangleSizeForOverlap ( self,
float value )

◆ CenterX() [1/2]

float eVision.EMatchPosition.CenterX ( self)

Abscissa of the center of the pattern found in the image.

◆ CenterX() [2/2]

eVision.EMatchPosition.CenterX ( self,
float value )

Abscissa of the center of the pattern found in the image.

◆ CenterY() [1/2]

float eVision.EMatchPosition.CenterY ( self)

Ordinate of the center of the pattern found in the image.

◆ CenterY() [2/2]

eVision.EMatchPosition.CenterY ( self,
float value )

Ordinate of the center of the pattern found in the image.

◆ Interpolated() [1/2]

bool eVision.EMatchPosition.Interpolated ( self)

Indicates whether sub-pixel interpolation was actually performed on the position.

Remarks:

In some cases, when the pattern is found close to the ROI edge, sub-pixel interpolation cannot be used.

◆ Interpolated() [2/2]

eVision.EMatchPosition.Interpolated ( self,
bool value )

Indicates whether sub-pixel interpolation was actually performed on the position.

Remarks:

In some cases, when the pattern is found close to the ROI edge, sub-pixel interpolation cannot be used.

◆ Reserved() [1/2]

float eVision.EMatchPosition.Reserved ( self)

◆ Reserved() [2/2]

eVision.EMatchPosition.Reserved ( self,
float value )

◆ Scale() [1/2]

float eVision.EMatchPosition.Scale ( self)

Scale factor of the pattern found in the image.

Remarks:

1 if no scaling is allowed.

◆ Scale() [2/2]

eVision.EMatchPosition.Scale ( self,
float value )

Scale factor of the pattern found in the image.

Remarks:

1 if no scaling is allowed.

◆ ScaleX() [1/2]

float eVision.EMatchPosition.ScaleX ( self)

Measured horizontal scaling of the pattern found in the image, expressed as a dimensionless ratio.

◆ ScaleX() [2/2]

eVision.EMatchPosition.ScaleX ( self,
float value )

Measured horizontal scaling of the pattern found in the image, expressed as a dimensionless ratio.

◆ ScaleY() [1/2]

float eVision.EMatchPosition.ScaleY ( self)

Measured vertical scaling of the pattern found in the image, expressed as a dimensionless ratio.

◆ ScaleY() [2/2]

eVision.EMatchPosition.ScaleY ( self,
float value )

Measured vertical scaling of the pattern found in the image, expressed as a dimensionless ratio.

◆ Score() [1/2]

float eVision.EMatchPosition.Score ( self)

Indicates how good a matching was.

Remarks:

1 means that the matching was perfect. Lower values correspond to approximate matching; -1 corresponds to a perfect mismatch (pattern superimposed on its negative image).

◆ Score() [2/2]

eVision.EMatchPosition.Score ( self,
float value )

Indicates how good a matching was.

Remarks:

1 means that the matching was perfect. Lower values correspond to approximate matching; -1 corresponds to a perfect mismatch (pattern superimposed on its negative image).

◆ ToRegion()

eVision.ERegion eVision.EMatchPosition.ToRegion ( self,
int modelWidth,
int modelHeight )

Creates an ERegion from the eVision.EMatchPosition.

The ERegion represents all the pixels which are within the bounding box of the eVision.EMatchPosition.

Parameters
modelWidthWidth of the corresponding EasyMatch model.
modelHeightHeight of the corresponding EasyMatch model.