Manages a complete context for the inspection tool based on image comparison in EasyOCV. More...

#include <eVision/EasyOcv/Legacy/EChecker.h>

Collaboration diagram for eVision::Legacy::EChecker:

Public Member Functions
	EChecker ()
	Constructs an uninitialized checker context.
virtual	~EChecker () throw ()
eVision::EImageBW8 *	GetLow ()
	Low threshold image for the adaptive segmentation.
eVision::EImageBW8 *	GetHigh ()
	High threshold image for the adaptive segmentation.
eVision::EImageBW8 *	GetRegistered ()
	Represents the source image, after it has been aligned with the reference image.
void	Attach (eVision::EROIBW8 *source)
	Associates a source image to a checker context.
uint32_t	GetToleranceX () const
	Current horizontal search tolerance, in pixels.
uint32_t	GetToleranceY () const
	Current vertical search tolerance, in pixels.
void	SetTolerance (uint32_t toleranceX, uint32_t toleranceY)
	Sets the search margin, i.e. the width and height of the search area surrounding the alignment pattern(s).
uint32_t	GetNumAverageSamples () const
	Number of samples that were accumulated in the "average" phase of the training.
uint32_t	GetNumDeviationSamples () const
	Number of samples that were accumulated in the "deviation" phase of the training.
eVision::ENormalizationMode	GetNormalize () const
	Current normalization mode.
void	SetNormalize (eVision::ENormalizationMode eNormalize)
	Current normalization mode.
float	GetAverage () const
	Global intensity of the mother image.
float	GetDeviation () const
	Global contrast of the mother image.
uint32_t	GetDegreesOfFreedom () const
	Boolean combination of EDegreesOfFreedom members that indicates which degrees of freedom are to be considered.
void	SetDegreesOfFreedom (uint32_t un32DegreesOfFreedom)
	Boolean combination of EDegreesOfFreedom members that indicates which degrees of freedom are to be considered.
void	Register ()
	Realigns and normalizes the source image.
void	Learn (eVision::ELearningMode mode)
	Accumulates a reference image, following a sequence of operations.
float	GetRelativeTolerance () const
	Current tolerance factor to be used for threshold image setup.
void	SetRelativeTolerance (float f32RelativeTolerance)
	Current tolerance factor to be used for threshold image setup.
void	EmptyPathNames ()
	Clears the list of file pathnames.
void	AddPathName (const std::string &pathName)
	Adds a single file pathname.
void	BatchLearn (eVision::ELearningMode mode)
	Performs the learning sequence using the specified list of image files.
float	GetDarkGray () const
	Gray level in the dark areas of the mother image.
void	SetDarkGray (float f32DarkGray)
	Gray level in the dark areas of the mother image.
float	GetLightGray () const
	Gray level in the light areas of the mother image.
void	SetLightGray (float f32LightGray)
	Gray level in the light areas of the mother image.
void	SetZoom (float zoom)
	Sets the zooming factor for use in display operations.
void	SetZoom (float zoomX, float zoomY)
	Sets the zooming factor for use in display operations.
void	SetPan (float panX, float panY)
	Sets the panning value, expressed in pixels, for use in display operations.
float	GetZoomX () const
	Current horizontal zooming factor for use in display operations.
float	GetZoomY () const
	Current vertical zooming factor for use in display operations.
float	GetPanX () const
	Current horizontal panning value, expressed in pixels, for use in display operations.
float	GetPanY () const
	Current vertical panning value, expressed in pixels, for use in display operations.
void	Draw (eVision::EDrawAdapter *graphicContext, eVision::EDrawingMode drawingMode, bool handles, float zoomX, float zoomY, float panX, float panY)
	Draws one of the geometric items that define the EChecker::EChecker tool.
void	Draw (eVision::EDrawAdapter *graphicContext, eVision::EDrawingMode drawingMode, bool handles, float zoomX, float zoomY, float panX)
	Draws one of the geometric items that define the EChecker::EChecker tool.
void	Draw (eVision::EDrawAdapter *graphicContext, eVision::EDrawingMode drawingMode, bool handles, float zoomX, float zoomY)
	Draws one of the geometric items that define the EChecker::EChecker tool.
void	Draw (eVision::EDrawAdapter *graphicContext, eVision::EDrawingMode drawingMode, bool handles, float zoomX)
	Draws one of the geometric items that define the EChecker::EChecker tool.
void	Draw (eVision::EDrawAdapter *graphicContext, eVision::EDrawingMode drawingMode, bool handles)
	Draws one of the geometric items that define the EChecker::EChecker tool.
void	Draw (eVision::EDrawAdapter *graphicContext, eVision::EDrawingMode drawingMode)
	Draws one of the geometric items that define the EChecker::EChecker tool.
void	Draw (HDC graphicContext, eVision::EDrawingMode drawingMode, bool handles, float zoomX, float zoomY, float panX, float panY)
	Draws one of the geometric items that define the EChecker::EChecker tool.
void	Draw (HDC graphicContext, eVision::EDrawingMode drawingMode, bool handles, float zoomX, float zoomY, float panX)
	Draws one of the geometric items that define the EChecker::EChecker tool.
void	Draw (HDC graphicContext, eVision::EDrawingMode drawingMode, bool handles, float zoomX, float zoomY)
	Draws one of the geometric items that define the EChecker::EChecker tool.
void	Draw (HDC graphicContext, eVision::EDrawingMode drawingMode, bool handles, float zoomX)
	Draws one of the geometric items that define the EChecker::EChecker tool.
void	Draw (HDC graphicContext, eVision::EDrawingMode drawingMode, bool handles)
	Draws one of the geometric items that define the EChecker::EChecker tool.
void	Draw (HDC graphicContext, eVision::EDrawingMode drawingMode)
	Draws one of the geometric items that define the EChecker::EChecker tool.
void	Draw (HDC graphicContext, const eVision::ERGBColor &color, eVision::EDrawingMode drawingMode, bool handles, float zoomX, float zoomY, float panX, float panY)
	Draws one of the geometric items that define the EChecker::EChecker tool.
void	Draw (HDC graphicContext, const eVision::ERGBColor &color, eVision::EDrawingMode drawingMode, bool handles, float zoomX, float zoomY, float panX)
	Draws one of the geometric items that define the EChecker::EChecker tool.
void	Draw (HDC graphicContext, const eVision::ERGBColor &color, eVision::EDrawingMode drawingMode, bool handles, float zoomX, float zoomY)
	Draws one of the geometric items that define the EChecker::EChecker tool.
void	Draw (HDC graphicContext, const eVision::ERGBColor &color, eVision::EDrawingMode drawingMode, bool handles, float zoomX)
	Draws one of the geometric items that define the EChecker::EChecker tool.
void	Draw (HDC graphicContext, const eVision::ERGBColor &color, eVision::EDrawingMode drawingMode, bool handles)
	Draws one of the geometric items that define the EChecker::EChecker tool.
void	Draw (HDC graphicContext, const eVision::ERGBColor &color, eVision::EDrawingMode drawingMode)
	Draws one of the geometric items that define the EChecker::EChecker tool.
void	DrawWithCurrentPen (HDC graphicContext, eVision::EDrawingMode drawingMode, bool handles, float zoomX, float zoomY, float panX, float panY)
	Draws one of the geometric items that define the EChecker::EChecker tool.
void	DrawWithCurrentPen (HDC graphicContext, eVision::EDrawingMode drawingMode, bool handles, float zoomX, float zoomY, float panX)
	Draws one of the geometric items that define the EChecker::EChecker tool.
void	DrawWithCurrentPen (HDC graphicContext, eVision::EDrawingMode drawingMode, bool handles, float zoomX, float zoomY)
	Draws one of the geometric items that define the EChecker::EChecker tool.
void	DrawWithCurrentPen (HDC graphicContext, eVision::EDrawingMode drawingMode, bool handles, float zoomX)
	Draws one of the geometric items that define the EChecker::EChecker tool.
void	DrawWithCurrentPen (HDC graphicContext, eVision::EDrawingMode drawingMode, bool handles)
	Draws one of the geometric items that define the EChecker::EChecker tool.
void	DrawWithCurrentPen (HDC graphicContext, eVision::EDrawingMode drawingMode)
	Draws one of the geometric items that define the EChecker::EChecker tool.
bool	HitTest (int32_t x, int32_t y)
	Returns true if the cursor is over one of the dragging handles.
eVision::EDragHandle	GetHitHandle () const
	Handle currently hit.
eVision::ERoiHit	GetHitRoi () const
	ROI currently hit.
void	Drag (int32_t x, int32_t y)
	Moves the relevant ROI by means of its handle.
void	Load (eVision::ESerializer *serializer)
	Loads the EChecker. The given ESerializer must have been created for reading.
void	Load (const std::string &path)
	Loads the EChecker. The given ESerializer must have been created for reading.
void	Save (eVision::ESerializer *serializer)
	Saves the EChecker. The given ESerializer must have been created for writing.
void	Save (const std::string &path)
	Saves the EChecker. The given ESerializer must have been created for writing.
	EChecker (CppWrapperInternal::InternalConstructor)

Public Attributes
CppWrapperInternal::WrappedClass	wrappedClass_

Detailed Description

Manages a complete context for the inspection tool based on image comparison in EasyOCV.

License(s): EasyMatch and EasyObject and EasyImage

Deprecated

Use EChecker::EChecker instead.

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

Constructor & Destructor Documentation

◆ EChecker() [1/2]

eVision::Legacy::EChecker::EChecker ( )

Constructs an uninitialized checker context.

◆ ~EChecker()

eVision::Legacy::EChecker::~EChecker	(		)
throw	(	)

virtual

◆ EChecker() [2/2]

eVision::Legacy::EChecker::EChecker ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ AddPathName()

void eVision::Legacy::EChecker::AddPathName ( const std::string & pathName )

Adds a single file pathname.

Parameters

pathName NULL terminated text string containing the file pathname.

◆ Attach()

void eVision::Legacy::EChecker::Attach ( eVision::EROIBW8 * source )

Associates a source image to a checker context.

Parameters

source Pointer to the source image.

The source image is used in all consecutive learning/inspection operations.

◆ BatchLearn()

void eVision::Legacy::EChecker::BatchLearn ( eVision::ELearningMode mode )

Performs the learning sequence using the specified list of image files.

Parameters

mode	ELearningMode::ELearningMode_RmsDeviation or ELearningMode::ELearningMode_AbsDeviation, depending on the preferred method of computing the deviations.

◆ Drag()

void eVision::Legacy::EChecker::Drag	(	int32_t	x,
		int32_t	y )

Moves the relevant ROI by means of its handle.

Parameters

x	New horizontal cursor position.
y	New vertical cursor position.

◆ Draw() [1/18]

void eVision::Legacy::EChecker::Draw	(	eVision::EDrawAdapter *	graphicContext,
		eVision::EDrawingMode	drawingMode )

Draws one of the geometric items that define the EChecker::EChecker tool.

Parameters

graphicContext	Device context of the drawing window.
drawingMode	ROI to be drawn, as defined by EDrawingMode.

◆ Draw() [2/18]

void eVision::Legacy::EChecker::Draw	(	eVision::EDrawAdapter *	graphicContext,
		eVision::EDrawingMode	drawingMode,
		bool	handles )

Draws one of the geometric items that define the EChecker::EChecker tool.

Parameters

graphicContext	Device context of the drawing window.
drawingMode	ROI to be drawn, as defined by EDrawingMode.
handles	true if the dragging handles must be displayed.

◆ Draw() [3/18]

void eVision::Legacy::EChecker::Draw	(	eVision::EDrawAdapter *	graphicContext,
		eVision::EDrawingMode	drawingMode,
		bool	handles,
		float	zoomX )

Draws one of the geometric items that define the EChecker::EChecker tool.

Parameters

graphicContext	Device context of the drawing window.
drawingMode	ROI to be drawn, as defined by EDrawingMode.
handles	true if the dragging handles must be displayed.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

◆ Draw() [4/18]

void eVision::Legacy::EChecker::Draw	(	eVision::EDrawAdapter *	graphicContext,
		eVision::EDrawingMode	drawingMode,
		bool	handles,
		float	zoomX,
		float	zoomY )

Draws one of the geometric items that define the EChecker::EChecker tool.

Parameters

graphicContext	Device context of the drawing window.
drawingMode	ROI to be drawn, as defined by EDrawingMode.
handles	true if the dragging handles must be displayed.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

◆ Draw() [5/18]

void eVision::Legacy::EChecker::Draw	(	eVision::EDrawAdapter *	graphicContext,
		eVision::EDrawingMode	drawingMode,
		bool	handles,
		float	zoomX,
		float	zoomY,
		float	panX )

Draws one of the geometric items that define the EChecker::EChecker tool.

Parameters

graphicContext	Device context of the drawing window.
drawingMode	ROI to be drawn, as defined by EDrawingMode.
handles	true if the dragging handles must be displayed.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

◆ Draw() [6/18]

void eVision::Legacy::EChecker::Draw	(	eVision::EDrawAdapter *	graphicContext,
		eVision::EDrawingMode	drawingMode,
		bool	handles,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draws one of the geometric items that define the EChecker::EChecker tool.

Parameters

graphicContext	Device context of the drawing window.
drawingMode	ROI to be drawn, as defined by EDrawingMode.
handles	true if the dragging handles must be displayed.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

◆ Draw() [7/18]

void eVision::Legacy::EChecker::Draw	(	HDC	graphicContext,
		const eVision::ERGBColor &	color,
		eVision::EDrawingMode	drawingMode )

Draws one of the geometric items that define the EChecker::EChecker tool.

Parameters

graphicContext	Device context of the drawing window.
color	The color in which to draw the overlay.
drawingMode	ROI to be drawn, as defined by EDrawingMode.

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() [8/18]

void eVision::Legacy::EChecker::Draw	(	HDC	graphicContext,
		const eVision::ERGBColor &	color,
		eVision::EDrawingMode	drawingMode,
		bool	handles )

Draws one of the geometric items that define the EChecker::EChecker tool.

Parameters

graphicContext	Device context of the drawing window.
color	The color in which to draw the overlay.
drawingMode	ROI to be drawn, as defined by EDrawingMode.
handles	true if the dragging handles must be displayed.

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() [9/18]

void eVision::Legacy::EChecker::Draw	(	HDC	graphicContext,
		const eVision::ERGBColor &	color,
		eVision::EDrawingMode	drawingMode,
		bool	handles,
		float	zoomX )

Draws one of the geometric items that define the EChecker::EChecker tool.

Parameters

graphicContext	Device context of the drawing window.
color	The color in which to draw the overlay.
drawingMode	ROI to be drawn, as defined by EDrawingMode.
handles	true if the dragging handles must be displayed.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

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() [10/18]

void eVision::Legacy::EChecker::Draw	(	HDC	graphicContext,
		const eVision::ERGBColor &	color,
		eVision::EDrawingMode	drawingMode,
		bool	handles,
		float	zoomX,
		float	zoomY )

Draws one of the geometric items that define the EChecker::EChecker tool.

Parameters

graphicContext	Device context of the drawing window.
color	The color in which to draw the overlay.
drawingMode	ROI to be drawn, as defined by EDrawingMode.
handles	true if the dragging handles must be displayed.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

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() [11/18]

void eVision::Legacy::EChecker::Draw	(	HDC	graphicContext,
		const eVision::ERGBColor &	color,
		eVision::EDrawingMode	drawingMode,
		bool	handles,
		float	zoomX,
		float	zoomY,
		float	panX )

Draws one of the geometric items that define the EChecker::EChecker tool.

Parameters

graphicContext	Device context of the drawing window.
color	The color in which to draw the overlay.
drawingMode	ROI to be drawn, as defined by EDrawingMode.
handles	true if the dragging handles must be displayed.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

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/18]

void eVision::Legacy::EChecker::Draw	(	HDC	graphicContext,
		const eVision::ERGBColor &	color,
		eVision::EDrawingMode	drawingMode,
		bool	handles,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draws one of the geometric items that define the EChecker::EChecker tool.

Parameters

graphicContext	Device context of the drawing window.
color	The color in which to draw the overlay.
drawingMode	ROI to be drawn, as defined by EDrawingMode.
handles	true if the dragging handles must be displayed.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

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/18]

void eVision::Legacy::EChecker::Draw	(	HDC	graphicContext,
		eVision::EDrawingMode	drawingMode )

Draws one of the geometric items that define the EChecker::EChecker tool.

Parameters

graphicContext	Device context of the drawing window.
drawingMode	ROI to be drawn, as defined by EDrawingMode.

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/18]

void eVision::Legacy::EChecker::Draw	(	HDC	graphicContext,
		eVision::EDrawingMode	drawingMode,
		bool	handles )

Draws one of the geometric items that define the EChecker::EChecker tool.

Parameters

graphicContext	Device context of the drawing window.
drawingMode	ROI to be drawn, as defined by EDrawingMode.
handles	true if the dragging handles must be displayed.

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/18]

void eVision::Legacy::EChecker::Draw	(	HDC	graphicContext,
		eVision::EDrawingMode	drawingMode,
		bool	handles,
		float	zoomX )

Draws one of the geometric items that define the EChecker::EChecker tool.

Parameters

graphicContext	Device context of the drawing window.
drawingMode	ROI to be drawn, as defined by EDrawingMode.
handles	true if the dragging handles must be displayed.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

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/18]

void eVision::Legacy::EChecker::Draw	(	HDC	graphicContext,
		eVision::EDrawingMode	drawingMode,
		bool	handles,
		float	zoomX,
		float	zoomY )

Draws one of the geometric items that define the EChecker::EChecker tool.

Parameters

graphicContext	Device context of the drawing window.
drawingMode	ROI to be drawn, as defined by EDrawingMode.
handles	true if the dragging handles must be displayed.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

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/18]

void eVision::Legacy::EChecker::Draw	(	HDC	graphicContext,
		eVision::EDrawingMode	drawingMode,
		bool	handles,
		float	zoomX,
		float	zoomY,
		float	panX )

Draws one of the geometric items that define the EChecker::EChecker tool.

Parameters

graphicContext	Device context of the drawing window.
drawingMode	ROI to be drawn, as defined by EDrawingMode.
handles	true if the dragging handles must be displayed.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

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/18]

void eVision::Legacy::EChecker::Draw	(	HDC	graphicContext,
		eVision::EDrawingMode	drawingMode,
		bool	handles,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draws one of the geometric items that define the EChecker::EChecker tool.

Parameters

graphicContext	Device context of the drawing window.
drawingMode	ROI to be drawn, as defined by EDrawingMode.
handles	true if the dragging handles must be displayed.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

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/6]

void eVision::Legacy::EChecker::DrawWithCurrentPen	(	HDC	graphicContext,
		eVision::EDrawingMode	drawingMode )

Draws one of the geometric items that define the EChecker::EChecker tool.

Parameters

graphicContext	Device context of the drawing window.
drawingMode	ROI to be drawn, as defined by EDrawingMode.

Deprecated

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

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

◆ DrawWithCurrentPen() [2/6]

void eVision::Legacy::EChecker::DrawWithCurrentPen	(	HDC	graphicContext,
		eVision::EDrawingMode	drawingMode,
		bool	handles )

Draws one of the geometric items that define the EChecker::EChecker tool.

Parameters

graphicContext	Device context of the drawing window.
drawingMode	ROI to be drawn, as defined by EDrawingMode.
handles	true if the dragging handles must be displayed.

Deprecated

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

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

◆ DrawWithCurrentPen() [3/6]

void eVision::Legacy::EChecker::DrawWithCurrentPen	(	HDC	graphicContext,
		eVision::EDrawingMode	drawingMode,
		bool	handles,
		float	zoomX )

Draws one of the geometric items that define the EChecker::EChecker tool.

Parameters

graphicContext	Device context of the drawing window.
drawingMode	ROI to be drawn, as defined by EDrawingMode.
handles	true if the dragging handles must be displayed.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

Deprecated

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

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

◆ DrawWithCurrentPen() [4/6]

void eVision::Legacy::EChecker::DrawWithCurrentPen	(	HDC	graphicContext,
		eVision::EDrawingMode	drawingMode,
		bool	handles,
		float	zoomX,
		float	zoomY )

Draws one of the geometric items that define the EChecker::EChecker tool.

Parameters

graphicContext	Device context of the drawing window.
drawingMode	ROI to be drawn, as defined by EDrawingMode.
handles	true if the dragging handles must be displayed.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

Deprecated

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

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

◆ DrawWithCurrentPen() [5/6]

void eVision::Legacy::EChecker::DrawWithCurrentPen	(	HDC	graphicContext,
		eVision::EDrawingMode	drawingMode,
		bool	handles,
		float	zoomX,
		float	zoomY,
		float	panX )

Draws one of the geometric items that define the EChecker::EChecker tool.

Parameters

graphicContext	Device context of the drawing window.
drawingMode	ROI to be drawn, as defined by EDrawingMode.
handles	true if the dragging handles must be displayed.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

Deprecated

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

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

◆ DrawWithCurrentPen() [6/6]

void eVision::Legacy::EChecker::DrawWithCurrentPen	(	HDC	graphicContext,
		eVision::EDrawingMode	drawingMode,
		bool	handles,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draws one of the geometric items that define the EChecker::EChecker tool.

Parameters

graphicContext	Device context of the drawing window.
drawingMode	ROI to be drawn, as defined by EDrawingMode.
handles	true if the dragging handles must be displayed.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomY	Magnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

Deprecated

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

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

◆ EmptyPathNames()

void eVision::Legacy::EChecker::EmptyPathNames ( )

Clears the list of file pathnames.

◆ GetAverage()

float eVision::Legacy::EChecker::GetAverage ( ) const

Global intensity of the mother image.

Valid in mode ENormalizationMode::ENormalizationMode_Moments only.

◆ GetDarkGray()

float eVision::Legacy::EChecker::GetDarkGray ( ) const

Gray level in the dark areas of the mother image.

Valid in mode ENormalizationMode::ENormalizationMode_Threshold only.

◆ GetDegreesOfFreedom()

uint32_t eVision::Legacy::EChecker::GetDegreesOfFreedom ( ) const

Boolean combination of EDegreesOfFreedom members that indicates which degrees of freedom are to be considered.

◆ GetDeviation()

float eVision::Legacy::EChecker::GetDeviation ( ) const

Global contrast of the mother image.

Valid in mode ENormalizationMode::ENormalizationMode_Moments only.

◆ GetHigh()

eVision::EImageBW8 * eVision::Legacy::EChecker::GetHigh ( )

High threshold image for the adaptive segmentation.

◆ GetHitHandle()

eVision::EDragHandle eVision::Legacy::EChecker::GetHitHandle ( ) const

Handle currently hit.

◆ GetHitRoi()

eVision::ERoiHit eVision::Legacy::EChecker::GetHitRoi ( ) const

ROI currently hit.

◆ GetLightGray()

float eVision::Legacy::EChecker::GetLightGray ( ) const

Gray level in the light areas of the mother image.

Valid in mode ENormalizationMode::ENormalizationMode_Threshold only.

◆ GetLow()

eVision::EImageBW8 * eVision::Legacy::EChecker::GetLow ( )

Low threshold image for the adaptive segmentation.

◆ GetNormalize()

eVision::ENormalizationMode eVision::Legacy::EChecker::GetNormalize ( ) const

Current normalization mode.

◆ GetNumAverageSamples()

uint32_t eVision::Legacy::EChecker::GetNumAverageSamples ( ) const

Number of samples that were accumulated in the "average" phase of the training.

◆ GetNumDeviationSamples()

uint32_t eVision::Legacy::EChecker::GetNumDeviationSamples ( ) const

Number of samples that were accumulated in the "deviation" phase of the training.

◆ GetPanX()

float eVision::Legacy::EChecker::GetPanX ( ) const

Current horizontal panning value, expressed in pixels, for use in display operations.

◆ GetPanY()

float eVision::Legacy::EChecker::GetPanY ( ) const

Current vertical panning value, expressed in pixels, for use in display operations.

◆ GetRegistered()

eVision::EImageBW8 * eVision::Legacy::EChecker::GetRegistered ( )

Represents the source image, after it has been aligned with the reference image.

◆ GetRelativeTolerance()

float eVision::Legacy::EChecker::GetRelativeTolerance ( ) const

Current tolerance factor to be used for threshold image setup.

◆ GetToleranceX()

uint32_t eVision::Legacy::EChecker::GetToleranceX ( ) const

Current horizontal search tolerance, in pixels.

◆ GetToleranceY()

uint32_t eVision::Legacy::EChecker::GetToleranceY ( ) const

Current vertical search tolerance, in pixels.

◆ GetZoomX()

float eVision::Legacy::EChecker::GetZoomX ( ) const

Current horizontal zooming factor for use in display operations.

◆ GetZoomY()

float eVision::Legacy::EChecker::GetZoomY ( ) const

Current vertical zooming factor for use in display operations.

◆ HitTest()

bool eVision::Legacy::EChecker::HitTest	(	int32_t	x,
		int32_t	y )

Returns true if the cursor is over one of the dragging handles.

Parameters

x	Current horizontal cursor position.
y	Current vertical cursor position.

In this case, EChecker::GetHitRoi returns the name of the ROI that has been hit, and EChecker::GetHitHandle returns the name of the corresponding handle.

◆ Learn()

void eVision::Legacy::EChecker::Learn ( eVision::ELearningMode mode )

Accumulates a reference image, following a sequence of operations.

Parameters

mode	Current mode of operation in the learning sequence, as defined by ELearningMode.

First the model is reset; then the matching patterns are shown; next a series of images is presented to estimate the average gray levels; then a second series of images is presented to estimate the gray-level variations; finally, the threshold images are generated. A typical sequence with three reference images goes as follows:

For standard deviation estimation:

EChecker.Learn(ELearningMode::ELearningMode_Reset); initializes.
EChecker::Register; realigns and normalizes 1st source image.
EChecker.Learn(ELearningMode::ELearningMode_RmsDeviation); processes 1st image for deviation info.
EChecker::Register; realigns and normalizes 2nd source image.
EChecker.Learn(ELearningMode::ELearningMode_RmsDeviation); processes 2nd image for deviation info.
EChecker::Register; realigns and normalizes 3rd source image.
EChecker.Learn(ELearningMode::ELearningMode_RmsDeviation); processes 3rd image for deviation info.

For robust deviation estimation:

EChecker.Learn(ELearningMode::ELearningMode_Reset); initializes.
EChecker::Register; realigns and normalizes 1st source image.
EChecker.Learn(ELearningMode::ELearningMode_Average); processes 1st image for average info.
EChecker::Register; realigns and normalizes 2nd source image.
EChecker.Learn(ELearningMode::ELearningMode_Average); processes 2nd image for average info.
EChecker::Register; realigns and normalizes 3rd source image.
EChecker.Learn(ELearningMode::ELearningMode_Average); processes 3rd image for average info.

◆ Load() [1/2]

void eVision::Legacy::EChecker::Load ( const std::string & path )

Loads the EChecker. The given ESerializer must have been created for reading.

Parameters

path	The file path.

◆ Load() [2/2]

void eVision::Legacy::EChecker::Load ( eVision::ESerializer * serializer )

Loads the EChecker. The given ESerializer must have been created for reading.

Parameters

serializer The serializer.

◆ Register()

void eVision::Legacy::EChecker::Register ( )

Realigns and normalizes the source image.

Only the inspected ROI is processed. The first time this function is called, the current pattern ROI are used to define the search patterns. After registration, public member EChecker::GetRegistered contains the realigned, normalized contents of the inspected ROI.

◆ Save() [1/2]

void eVision::Legacy::EChecker::Save ( const std::string & path )

Saves the EChecker. The given ESerializer must have been created for writing.

Parameters

path	The file path.

◆ Save() [2/2]

void eVision::Legacy::EChecker::Save ( eVision::ESerializer * serializer )

Saves the EChecker. The given ESerializer must have been created for writing.

Parameters

serializer The serializer.

◆ SetDarkGray()

void eVision::Legacy::EChecker::SetDarkGray ( float f32DarkGray )

Gray level in the dark areas of the mother image.

Valid in mode ENormalizationMode::ENormalizationMode_Threshold only.

◆ SetDegreesOfFreedom()

void eVision::Legacy::EChecker::SetDegreesOfFreedom ( uint32_t un32DegreesOfFreedom )

Boolean combination of EDegreesOfFreedom members that indicates which degrees of freedom are to be considered.

◆ SetLightGray()

void eVision::Legacy::EChecker::SetLightGray ( float f32LightGray )

Gray level in the light areas of the mother image.

Valid in mode ENormalizationMode::ENormalizationMode_Threshold only.

◆ SetNormalize()

void eVision::Legacy::EChecker::SetNormalize ( eVision::ENormalizationMode eNormalize )

Current normalization mode.

◆ SetPan()

void eVision::Legacy::EChecker::SetPan	(	float	panX,
		float	panY )

Sets the panning value, expressed in pixels, for use in display operations.

Parameters

panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

◆ SetRelativeTolerance()

void eVision::Legacy::EChecker::SetRelativeTolerance ( float f32RelativeTolerance )

Current tolerance factor to be used for threshold image setup.

◆ SetTolerance()

void eVision::Legacy::EChecker::SetTolerance	(	uint32_t	toleranceX,
		uint32_t	toleranceY )

Sets the search margin, i.e. the width and height of the search area surrounding the alignment pattern(s).

Parameters

toleranceX	Horizontal search tolerance, in pixels.
toleranceY	Vertical search tolerance, in pixels.

◆ SetZoom() [1/2]

void eVision::Legacy::EChecker::SetZoom ( float zoom )

Sets the zooming factor for use in display operations.

Parameters

zoom	Magnification factor for zooming in or out in the horizontal and vertical directions (isotropic scaling).

◆ SetZoom() [2/2]

void eVision::Legacy::EChecker::SetZoom	(	float	zoomX,
		float	zoomY )

Sets the zooming factor for use in display operations.

Parameters

zoomX	Magnification factor for zooming in or out in the horizontal direction.
zoomY	Magnification factor for zooming in or out in the vertical direction.

Member Data Documentation

◆ wrappedClass_

CppWrapperInternal::WrappedClass eVision::Legacy::EChecker::wrappedClass_

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EChecker() [1/2]

◆ ~EChecker()

◆ EChecker() [2/2]

Member Function Documentation

◆ AddPathName()

◆ Attach()

◆ BatchLearn()

◆ Drag()

◆ Draw() [1/18]

◆ Draw() [2/18]

◆ Draw() [3/18]

◆ Draw() [4/18]

◆ Draw() [5/18]

◆ Draw() [6/18]

◆ Draw() [7/18]

◆ Draw() [8/18]

◆ Draw() [9/18]

◆ Draw() [10/18]

◆ Draw() [11/18]

◆ Draw() [12/18]

◆ Draw() [13/18]

◆ Draw() [14/18]

◆ Draw() [15/18]

◆ Draw() [16/18]

◆ Draw() [17/18]

◆ Draw() [18/18]

◆ DrawWithCurrentPen() [1/6]

◆ DrawWithCurrentPen() [2/6]

◆ DrawWithCurrentPen() [3/6]

◆ DrawWithCurrentPen() [4/6]

◆ DrawWithCurrentPen() [5/6]

◆ DrawWithCurrentPen() [6/6]

◆ EmptyPathNames()

◆ GetAverage()

◆ GetDarkGray()

◆ GetDegreesOfFreedom()

◆ GetDeviation()

◆ GetHigh()

◆ GetHitHandle()

◆ GetHitRoi()

◆ GetLightGray()

◆ GetLow()

◆ GetNormalize()

◆ GetNumAverageSamples()

◆ GetNumDeviationSamples()

◆ GetPanX()

◆ GetPanY()

◆ GetRegistered()

◆ GetRelativeTolerance()

◆ GetToleranceX()

◆ GetToleranceY()

◆ GetZoomX()

◆ GetZoomY()

◆ HitTest()

◆ Learn()

◆ Load() [1/2]

◆ Load() [2/2]

◆ Register()

◆ Save() [1/2]

◆ Save() [2/2]

◆ SetDarkGray()

◆ SetDegreesOfFreedom()

◆ SetLightGray()

◆ SetNormalize()

◆ SetPan()

◆ SetRelativeTolerance()

◆ SetTolerance()

◆ SetZoom() [1/2]

◆ SetZoom() [2/2]

Member Data Documentation

◆ wrappedClass_