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

#include <eVision/Easy/EFoundPattern.h>

Collaboration diagram for eVision::EFoundPattern:

Public Member Functions
	EFoundPattern ()
	Constructs a EFoundPattern object.
	EFoundPattern (const eVision::EFoundPattern &other)
	Constructs a EFoundPattern object.
virtual	~EFoundPattern () throw ()
eVision::EFoundPattern &	operator= (const eVision::EFoundPattern &other)
	Copies all the data from another EFoundPattern object into the current EFoundPattern object.
bool	operator== (const eVision::EFoundPattern &other) const
	Equality operator.
bool	operator!= (const eVision::EFoundPattern &other) const
	Inequality operator.
eVision::EPoint	GetCenter () const
	Reference point of the instance.
float	GetAngle () const
	Angle of the found instance, in clockwise direction and in the current angle unit.
float	GetScale () const
	Scaling factor of the found pattern, in units (not percent).
float	GetScaleX () const
	Horizontal Scaling factor of the found pattern, in units (not percent).
float	GetScaleY () const
	Vertical Scaling factor of the found pattern, in units (not percent).
float	GetScore () const
	Matching score of the found pattern, in units (not percent).
float	GetAreaRatio () const
	When the EFoundPattern was computed from an EMatcher: Ratio between the found pattern area inside the search ROI/Region and its complete area. When the EFoundPattern was computed from an EPatternFinder: returns 1.0.
uint32_t	GetLearntPatternIndex () const
	Returns the index of the pattern learnt by EPatternFinder::LearnPatterns or EMatcher::LearnPatterns corresponding to this EFoundPattern::EFoundPattern or 0 if a single pattern was learnt.
void	SetDrawBoundingBox (bool drawBoundingBox)
	Flag indicating if the EFoundPattern::Draw method must draw the bounding box of the FoundPattern.
bool	GetDrawBoundingBox () const
	Flag indicating if the EFoundPattern::Draw method must draw the bounding box of the FoundPattern.
void	SetDrawCenter (bool drawCenter)
	Flag indicating if the EFoundPattern::Draw method must draw the center of the FoundPattern.
bool	GetDrawCenter () const
	Flag indicating if the EFoundPattern::Draw method must draw the center of the FoundPattern.
void	SetDrawFeaturePoints (bool drawFeaturePoints)
	Flag indicating if the EFoundPattern::Draw method must draw the feature points of the EFoundPattern::EFoundPattern object.
bool	GetDrawFeaturePoints () const
	Flag indicating if the EFoundPattern::Draw method must draw the feature points of the EFoundPattern::EFoundPattern object.
void	SetDrawRegion (eVision::EDrawRegion drawRegion)
	Flag indicating if the EFoundPattern::Draw method must draw the region of the EFoundPattern object (region that was used during Learn), its contour or neither. If no region was used during learning, setting this to EDrawRegion::EDrawRegion_DrawContour or EDrawRegion::EDrawRegion_Draw will throw an exception. See EFoundPattern::GetHasRegion to check if a region was used during learning.
eVision::EDrawRegion	GetDrawRegion () const
	Flag indicating if the EFoundPattern::Draw method must draw the region of the EFoundPattern object (region that was used during Learn), its contour or neither. If no region was used during learning, setting this to EDrawRegion::EDrawRegion_DrawContour or EDrawRegion::EDrawRegion_Draw will throw an exception. See EFoundPattern::GetHasRegion to check if a region was used during learning.
bool	GetHasRegion () const
	Indicates whether there is an ERegion associated with this EFoundPattern, i.e. whether an ERegion was used during the learning of the pattern. See EFoundPattern::SetDrawRegion to draw the region.
bool	GetHasFeaturePoints () const
	Indicates whether there are feature points within this EFoundPattern. See EFoundPattern::SetDrawFeaturePoints to draw the feature points.
eVision::ERegion	ToRegion () const
	Creates an ERegion from the EFoundPattern. If an ERegion was used to learn the pattern (see EFoundPattern::GetHasRegion), returns the learned region transformed to the position of the found pattern. Otherwise, return an ERegion representing all the pixels which are within the bounding box of the found pattern.
eVision::EFrame	ToFrame (bool useAngle, eVision::EFrameScaling frameScaling) const
	Creates an EFrame from the EFoundPattern.
eVision::EFrame	ToFrame (bool useAngle, eVision::EFrameScaling frameScaling, const eVision::EFrame &frame) const
	Creates an EFrame from the EFoundPattern.
void	Draw (eVision::EDrawAdapter *graphicContext, float zoomX, float zoomY, float panX, float panY) const
	Draws the found pattern.
void	Draw (eVision::EDrawAdapter *graphicContext, float zoomX, float zoomY, float panX) const
	Draws the found pattern.
void	Draw (eVision::EDrawAdapter *graphicContext, float zoomX, float zoomY) const
	Draws the found pattern.
void	Draw (eVision::EDrawAdapter *graphicContext, float zoomX) const
	Draws the found pattern.
void	Draw (eVision::EDrawAdapter *graphicContext) const
	Draws the found pattern.
void	Draw (eVision::EDrawAdapter *graphicContext, const eVision::EFrame &frame, float zoomX, float zoomY, float panX, float panY) const
	Draws the found pattern.
void	Draw (eVision::EDrawAdapter *graphicContext, const eVision::EFrame &frame, float zoomX, float zoomY, float panX) const
	Draws the found pattern.
void	Draw (eVision::EDrawAdapter *graphicContext, const eVision::EFrame &frame, float zoomX, float zoomY) const
	Draws the found pattern.
void	Draw (eVision::EDrawAdapter *graphicContext, const eVision::EFrame &frame, float zoomX) const
	Draws the found pattern.
void	Draw (eVision::EDrawAdapter *graphicContext, const eVision::EFrame &frame) const
	Draws the found pattern.
void	Draw (HDC graphicContext, float zoomX, float zoomY, float panX, float panY) const
	Draws the found pattern.
void	Draw (HDC graphicContext, float zoomX, float zoomY, float panX) const
	Draws the found pattern.
void	Draw (HDC graphicContext, float zoomX, float zoomY) const
	Draws the found pattern.
void	Draw (HDC graphicContext, float zoomX) const
	Draws the found pattern.
void	Draw (HDC graphicContext) const
	Draws the found pattern.
void	Draw (HDC graphicContext, const eVision::ERGBColor &color, float zoomX, float zoomY, float panX, float panY) const
	Draws the found pattern.
void	Draw (HDC graphicContext, const eVision::ERGBColor &color, float zoomX, float zoomY, float panX) const
	Draws the found pattern.
void	Draw (HDC graphicContext, const eVision::ERGBColor &color, float zoomX, float zoomY) const
	Draws the found pattern.
void	Draw (HDC graphicContext, const eVision::ERGBColor &color, float zoomX) const
	Draws the found pattern.
void	Draw (HDC graphicContext, const eVision::ERGBColor &color) const
	Draws the found pattern.
void	DrawWithCurrentPen (HDC graphicContext, float zoomX, float zoomY, float panX, float panY) const
	Draws the found pattern.
void	DrawWithCurrentPen (HDC graphicContext, float zoomX, float zoomY, float panX) const
	Draws the found pattern.
void	DrawWithCurrentPen (HDC graphicContext, float zoomX, float zoomY) const
	Draws the found pattern.
void	DrawWithCurrentPen (HDC graphicContext, float zoomX) const
	Draws the found pattern.
void	DrawWithCurrentPen (HDC graphicContext) const
	Draws the found pattern.
eVision::EQuadrangle	GetQuadrangle () const
	Returns the corners of the bounding box of the found pattern.
	EFoundPattern (CppWrapperInternal::InternalConstructor)

Public Attributes
CppWrapperInternal::WrappedClass	wrappedClass_

Detailed Description

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

EPatternFinder::Find and EMatcher::Match return a collection of instances of this class. An EFoundPattern object represents one found instance, with all the needed information about it.

License(s): EasyFind or EasyMatch

Constructor & Destructor Documentation

◆ EFoundPattern() [1/3]

eVision::EFoundPattern::EFoundPattern ( )

Constructs a EFoundPattern object.

◆ EFoundPattern() [2/3]

eVision::EFoundPattern::EFoundPattern ( const eVision::EFoundPattern & other )

Constructs a EFoundPattern object.

Parameters

other EFoundPattern object to be copied

◆ ~EFoundPattern()

eVision::EFoundPattern::~EFoundPattern	(		)
throw	(	)

virtual

◆ EFoundPattern() [3/3]

eVision::EFoundPattern::EFoundPattern ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ Draw() [1/20]

void eVision::EFoundPattern::Draw ( eVision::EDrawAdapter * graphicContext ) const

Draws the found pattern.

Parameters

graphicContext Handle to the device context of the destination window.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

◆ Draw() [2/20]

void eVision::EFoundPattern::Draw	(	eVision::EDrawAdapter *	graphicContext,
		const eVision::EFrame &	frame ) const

Draws the found pattern.

Parameters

graphicContext	Handle to the device context of the destination window.
frame	Frame associated with the pattern.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

◆ Draw() [3/20]

void eVision::EFoundPattern::Draw	(	eVision::EDrawAdapter *	graphicContext,
		const eVision::EFrame &	frame,
		float	zoomX ) const

Draws the found pattern.

Parameters

graphicContext	Handle to the device context of the destination window.
frame	Frame associated with the pattern.
zoomX	Horizontal zooming factor.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

◆ Draw() [4/20]

void eVision::EFoundPattern::Draw	(	eVision::EDrawAdapter *	graphicContext,
		const eVision::EFrame &	frame,
		float	zoomX,
		float	zoomY ) const

Draws the found pattern.

Parameters

graphicContext	Handle to the device context of the destination window.
frame	Frame associated with the pattern.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

◆ Draw() [5/20]

void eVision::EFoundPattern::Draw	(	eVision::EDrawAdapter *	graphicContext,
		const eVision::EFrame &	frame,
		float	zoomX,
		float	zoomY,
		float	panX ) const

Draws the found pattern.

Parameters

graphicContext	Handle to the device context of the destination window.
frame	Frame associated with the pattern.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

◆ Draw() [6/20]

void eVision::EFoundPattern::Draw	(	eVision::EDrawAdapter *	graphicContext,
		const eVision::EFrame &	frame,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY ) const

Draws the found pattern.

Parameters

graphicContext	Handle to the device context of the destination window.
frame	Frame associated with the pattern.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

◆ Draw() [7/20]

void eVision::EFoundPattern::Draw	(	eVision::EDrawAdapter *	graphicContext,
		float	zoomX ) const

Draws the found pattern.

Parameters

graphicContext	Handle to the device context of the destination window.
zoomX	Horizontal zooming factor.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

◆ Draw() [8/20]

void eVision::EFoundPattern::Draw	(	eVision::EDrawAdapter *	graphicContext,
		float	zoomX,
		float	zoomY ) const

Draws the found pattern.

Parameters

graphicContext	Handle to the device context of the destination window.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

◆ Draw() [9/20]

void eVision::EFoundPattern::Draw	(	eVision::EDrawAdapter *	graphicContext,
		float	zoomX,
		float	zoomY,
		float	panX ) const

Draws the found pattern.

Parameters

graphicContext	Handle to the device context of the destination window.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

◆ Draw() [10/20]

void eVision::EFoundPattern::Draw	(	eVision::EDrawAdapter *	graphicContext,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY ) const

Draws the found pattern.

Parameters

graphicContext	Handle to the device context of the destination window.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

◆ Draw() [11/20]

void eVision::EFoundPattern::Draw ( HDC graphicContext ) const

Draws the found pattern.

Parameters

graphicContext Handle to the device context of the destination window.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ Draw() [12/20]

void eVision::EFoundPattern::Draw	(	HDC	graphicContext,
		const eVision::ERGBColor &	color ) const

Draws the found pattern.

Parameters

graphicContext	Handle to the device context of the destination window.
color	The color in which to draw the overlay.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ Draw() [13/20]

void eVision::EFoundPattern::Draw	(	HDC	graphicContext,
		const eVision::ERGBColor &	color,
		float	zoomX ) const

Draws the found pattern.

Parameters

graphicContext	Handle to the device context of the destination window.
color	The color in which to draw the overlay.
zoomX	Horizontal zooming factor.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ Draw() [14/20]

void eVision::EFoundPattern::Draw	(	HDC	graphicContext,
		const eVision::ERGBColor &	color,
		float	zoomX,
		float	zoomY ) const

Draws the found pattern.

Parameters

graphicContext	Handle to the device context of the destination window.
color	The color in which to draw the overlay.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ Draw() [15/20]

void eVision::EFoundPattern::Draw	(	HDC	graphicContext,
		const eVision::ERGBColor &	color,
		float	zoomX,
		float	zoomY,
		float	panX ) const

Draws the found pattern.

Parameters

graphicContext	Handle to the device context of the destination window.
color	The color in which to draw the overlay.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ Draw() [16/20]

void eVision::EFoundPattern::Draw	(	HDC	graphicContext,
		const eVision::ERGBColor &	color,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY ) const

Draws the found pattern.

Parameters

graphicContext	Handle to the device context of the destination window.
color	The color in which to draw the overlay.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ Draw() [17/20]

void eVision::EFoundPattern::Draw	(	HDC	graphicContext,
		float	zoomX ) const

Draws the found pattern.

Parameters

graphicContext	Handle to the device context of the destination window.
zoomX	Horizontal zooming factor.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ Draw() [18/20]

void eVision::EFoundPattern::Draw	(	HDC	graphicContext,
		float	zoomX,
		float	zoomY ) const

Draws the found pattern.

Parameters

graphicContext	Handle to the device context of the destination window.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ Draw() [19/20]

void eVision::EFoundPattern::Draw	(	HDC	graphicContext,
		float	zoomX,
		float	zoomY,
		float	panX ) const

Draws the found pattern.

Parameters

graphicContext	Handle to the device context of the destination window.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ Draw() [20/20]

void eVision::EFoundPattern::Draw	(	HDC	graphicContext,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY ) const

Draws the found pattern.

Parameters

graphicContext	Handle to the device context of the destination window.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawWithCurrentPen() [1/5]

void eVision::EFoundPattern::DrawWithCurrentPen ( HDC graphicContext ) const

Draws the found pattern.

Parameters

graphicContext Handle to the device context of the destination window.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

Deprecated: Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawWithCurrentPen() [2/5]

void eVision::EFoundPattern::DrawWithCurrentPen	(	HDC	graphicContext,
		float	zoomX ) const

Draws the found pattern.

Parameters

graphicContext	Handle to the device context of the destination window.
zoomX	Horizontal zooming factor.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

Deprecated: Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawWithCurrentPen() [3/5]

void eVision::EFoundPattern::DrawWithCurrentPen	(	HDC	graphicContext,
		float	zoomX,
		float	zoomY ) const

Draws the found pattern.

Parameters

graphicContext	Handle to the device context of the destination window.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

Deprecated: Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawWithCurrentPen() [4/5]

void eVision::EFoundPattern::DrawWithCurrentPen	(	HDC	graphicContext,
		float	zoomX,
		float	zoomY,
		float	panX ) const

Draws the found pattern.

Parameters

graphicContext	Handle to the device context of the destination window.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

Deprecated: Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawWithCurrentPen() [5/5]

void eVision::EFoundPattern::DrawWithCurrentPen	(	HDC	graphicContext,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY ) const

Draws the found pattern.

Parameters

graphicContext	Handle to the device context of the destination window.
zoomX	Horizontal zooming factor.
zoomY	Vertical zooming factor. If set to 0, the horizontal zooming factor will be used for isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

This method draws different features of the EFoundPattern, according to the value of properties EFoundPattern::SetDrawFeaturePoints, EFoundPattern::SetDrawCenter, EFoundPattern::SetDrawBoundingBox and EFoundPattern::SetDrawRegion. The zoomX, zoomY, panX and panY parameters can be used to scale and/or translate the drawing operations.

Deprecated: Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ GetAngle()

float eVision::EFoundPattern::GetAngle ( ) const

Angle of the found instance, in clockwise direction and in the current angle unit.

This returned value is always comprised in the range [- a half turn, + a half turn].

◆ GetAreaRatio()

float eVision::EFoundPattern::GetAreaRatio ( ) const

When the EFoundPattern was computed from an EMatcher: Ratio between the found pattern area inside the search ROI/Region and its complete area. When the EFoundPattern was computed from an EPatternFinder: returns 1.0.

◆ GetCenter()

eVision::EPoint eVision::EFoundPattern::GetCenter ( ) const

Reference point of the instance.

By default, this is its center. If the property EPatternFinder::GetPivot has been changed in the EPatternFinder, the point returns the pivot_ in the instance.

◆ GetDrawBoundingBox()

bool eVision::EFoundPattern::GetDrawBoundingBox ( ) const

Flag indicating if the EFoundPattern::Draw method must draw the bounding box of the FoundPattern.

The default value is true.

◆ GetDrawCenter()

bool eVision::EFoundPattern::GetDrawCenter ( ) const

Flag indicating if the EFoundPattern::Draw method must draw the center of the FoundPattern.

The default value is true.

◆ GetDrawFeaturePoints()

bool eVision::EFoundPattern::GetDrawFeaturePoints ( ) const

Flag indicating if the EFoundPattern::Draw method must draw the feature points of the EFoundPattern::EFoundPattern object.

When the EFoundPattern was computed from an EMatcher, there are no feature points to draw and setting this to true will throw an Exception.

When the EFoundPattern was computed from an EPatternFinder in which:

EPatternFinder::GetComputePerFeaturePointScore is true, the feature points are drawn in a Red-Yellow-Green colormap, where red indicates a per feature-point score close to -1, yellow to 0 and green to 1.
EPatternFinder::GetComputePerFeaturePointScore is false, the feature points are drawn using the default color of the DrawAdapter.

The default value is false.

◆ GetDrawRegion()

eVision::EDrawRegion eVision::EFoundPattern::GetDrawRegion ( ) const

Flag indicating if the EFoundPattern::Draw method must draw the region of the EFoundPattern object (region that was used during Learn), its contour or neither. If no region was used during learning, setting this to EDrawRegion::EDrawRegion_DrawContour or EDrawRegion::EDrawRegion_Draw will throw an exception. See EFoundPattern::GetHasRegion to check if a region was used during learning.

The default value is EDrawRegion::EDrawRegion_NoDraw.

◆ GetHasFeaturePoints()

bool eVision::EFoundPattern::GetHasFeaturePoints ( ) const

Indicates whether there are feature points within this EFoundPattern. See EFoundPattern::SetDrawFeaturePoints to draw the feature points.

◆ GetHasRegion()

bool eVision::EFoundPattern::GetHasRegion ( ) const

Indicates whether there is an ERegion associated with this EFoundPattern, i.e. whether an ERegion was used during the learning of the pattern. See EFoundPattern::SetDrawRegion to draw the region.

◆ GetLearntPatternIndex()

uint32_t eVision::EFoundPattern::GetLearntPatternIndex ( ) const

Returns the index of the pattern learnt by EPatternFinder::LearnPatterns or EMatcher::LearnPatterns corresponding to this EFoundPattern::EFoundPattern or 0 if a single pattern was learnt.

◆ GetQuadrangle()

eVision::EQuadrangle eVision::EFoundPattern::GetQuadrangle ( ) const

Returns the corners of the bounding box of the found pattern.

◆ GetScale()

float eVision::EFoundPattern::GetScale ( ) const

Scaling factor of the found pattern, in units (not percent).

Querying this will throw an Exception if EFoundPattern::GetScaleX != EFoundPattern::GetScaleY.

◆ GetScaleX()

float eVision::EFoundPattern::GetScaleX ( ) const

Horizontal Scaling factor of the found pattern, in units (not percent).

EPatternFinder does not support anisotropic scaling. In that case, this will return the same result as EFoundPattern::GetScale.

◆ GetScaleY()

float eVision::EFoundPattern::GetScaleY ( ) const

Vertical Scaling factor of the found pattern, in units (not percent).

EPatternFinder does not support anisotropic scaling. In that case, this will return the same result as EFoundPattern::GetScale.

◆ GetScore()

float eVision::EFoundPattern::GetScore ( ) const

Matching score of the found pattern, in units (not percent).

The matching score range is [-1.0..1.0].

◆ operator!=()

bool eVision::EFoundPattern::operator!= ( const eVision::EFoundPattern & other ) const

Inequality operator.

Parameters

other Instance to compare to.

◆ operator=()

eVision::EFoundPattern & eVision::EFoundPattern::operator= ( const eVision::EFoundPattern & other )

Copies all the data from another EFoundPattern object into the current EFoundPattern object.

Parameters

other EFoundPattern object to be copied

◆ operator==()

bool eVision::EFoundPattern::operator== ( const eVision::EFoundPattern & other ) const

Equality operator.

Parameters

other Instance to compare to.

◆ SetDrawBoundingBox()

void eVision::EFoundPattern::SetDrawBoundingBox ( bool drawBoundingBox )

Flag indicating if the EFoundPattern::Draw method must draw the bounding box of the FoundPattern.

The default value is true.

◆ SetDrawCenter()

void eVision::EFoundPattern::SetDrawCenter ( bool drawCenter )

Flag indicating if the EFoundPattern::Draw method must draw the center of the FoundPattern.

The default value is true.

◆ SetDrawFeaturePoints()

void eVision::EFoundPattern::SetDrawFeaturePoints ( bool drawFeaturePoints )

Flag indicating if the EFoundPattern::Draw method must draw the feature points of the EFoundPattern::EFoundPattern object.

When the EFoundPattern was computed from an EMatcher, there are no feature points to draw and setting this to true will throw an Exception.

When the EFoundPattern was computed from an EPatternFinder in which:

EPatternFinder::GetComputePerFeaturePointScore is true, the feature points are drawn in a Red-Yellow-Green colormap, where red indicates a per feature-point score close to -1, yellow to 0 and green to 1.
EPatternFinder::GetComputePerFeaturePointScore is false, the feature points are drawn using the default color of the DrawAdapter.

The default value is false.

◆ SetDrawRegion()

void eVision::EFoundPattern::SetDrawRegion ( eVision::EDrawRegion drawRegion )

Flag indicating if the EFoundPattern::Draw method must draw the region of the EFoundPattern object (region that was used during Learn), its contour or neither. If no region was used during learning, setting this to EDrawRegion::EDrawRegion_DrawContour or EDrawRegion::EDrawRegion_Draw will throw an exception. See EFoundPattern::GetHasRegion to check if a region was used during learning.

The default value is EDrawRegion::EDrawRegion_NoDraw.

◆ ToFrame() [1/2]

eVision::EFrame eVision::EFoundPattern::ToFrame	(	bool	useAngle,
		eVision::EFrameScaling	frameScaling ) const

Creates an EFrame from the EFoundPattern.

Parameters

useAngle	Whether to use the angle of the EFoundPattern in the frame.
frameScaling	How to handle the scale of the frame.

◆ ToFrame() [2/2]

eVision::EFrame eVision::EFoundPattern::ToFrame	(	bool	useAngle,
		eVision::EFrameScaling	frameScaling,
		const eVision::EFrame &	frame ) const

Creates an EFrame from the EFoundPattern.

Parameters

useAngle	Whether to use the angle of the EFoundPattern in the frame.
frameScaling	How to handle the scale of the frame.
frame	Parent frame. Used when the EFoundPattern was read using a frame.

◆ ToRegion()

eVision::ERegion eVision::EFoundPattern::ToRegion ( ) const

Creates an ERegion from the EFoundPattern. If an ERegion was used to learn the pattern (see EFoundPattern::GetHasRegion), returns the learned region transformed to the position of the found pattern. Otherwise, return an ERegion representing all the pixels which are within the bounding box of the found pattern.

Member Data Documentation

◆ wrappedClass_

CppWrapperInternal::WrappedClass eVision::EFoundPattern::wrappedClass_

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EFoundPattern() [1/3]

◆ EFoundPattern() [2/3]

◆ ~EFoundPattern()

◆ EFoundPattern() [3/3]

Member Function Documentation

◆ Draw() [1/20]

◆ Draw() [2/20]

◆ Draw() [3/20]

◆ Draw() [4/20]

◆ Draw() [5/20]

◆ Draw() [6/20]

◆ Draw() [7/20]

◆ Draw() [8/20]

◆ Draw() [9/20]

◆ Draw() [10/20]

◆ Draw() [11/20]

◆ Draw() [12/20]

◆ Draw() [13/20]

◆ Draw() [14/20]

◆ Draw() [15/20]

◆ Draw() [16/20]

◆ Draw() [17/20]

◆ Draw() [18/20]

◆ Draw() [19/20]

◆ Draw() [20/20]

◆ DrawWithCurrentPen() [1/5]

◆ DrawWithCurrentPen() [2/5]

◆ DrawWithCurrentPen() [3/5]

◆ DrawWithCurrentPen() [4/5]

◆ DrawWithCurrentPen() [5/5]

◆ GetAngle()

◆ GetAreaRatio()

◆ GetCenter()

◆ GetDrawBoundingBox()

◆ GetDrawCenter()

◆ GetDrawFeaturePoints()

◆ GetDrawRegion()

◆ GetHasFeaturePoints()

◆ GetHasRegion()

◆ GetLearntPatternIndex()

◆ GetQuadrangle()

◆ GetScale()

◆ GetScaleX()

◆ GetScaleY()

◆ GetScore()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ SetDrawBoundingBox()

◆ SetDrawCenter()

◆ SetDrawFeaturePoints()

◆ SetDrawRegion()

◆ ToFrame() [1/2]

◆ ToFrame() [2/2]

◆ ToRegion()

Member Data Documentation

◆ wrappedClass_