eVision.Legacy.EChecker2 Class Reference

Manages a complete context for the EChecker2 golden template inspection tool. More...

Public Member Functions
None	__init__ (self)
	Constructs an uninitialized golden template inspection context.
None	Initialize (self, eVision.EROIBW8 referenceImage, list[eVision._eVision.ERegion|None] fiducialRegions, eVision.ERegion inspectionRegion)
	Initialize the training process.
None	Train (self, list[eVision._eVision.EROIBW8|None] rois)
	Train.
None	AddTrainingImageFile (self, str path)
	Add Training Image File.
None	ClearTrainingImageFiles (self)
	Clear Training Image Files.
None	TrainFromImageFiles (self)
	Train From Image Files.
None	ResetTraining (self)
	Reset training.
None	Inspect (self, eVision.EROIBW8 roi, eVision.ECodedImage2 defects)
	Inspect.
None	DrawReferenceSearchFields (self, eVision.EDrawAdapter|None graphicContext, float zoomX, float zoomY, float panX, float panY)
	Draws the reference search fields overlay.
None	DrawReferenceSearchFields (self, eVision.EDrawAdapter|None graphicContext, float zoomX, float zoomY, float panX)
	Draws the reference search fields overlay.
None	DrawReferenceSearchFields (self, eVision.EDrawAdapter|None graphicContext, float zoomX, float zoomY)
	Draws the reference search fields overlay.
None	DrawReferenceSearchFields (self, eVision.EDrawAdapter|None graphicContext, float zoomX)
	Draws the reference search fields overlay.
None	DrawReferenceSearchFields (self, eVision.EDrawAdapter|None graphicContext)
	Draws the reference search fields overlay.
None	DrawReferenceInspectionField (self, eVision.EDrawAdapter|None graphicContext, float zoomX, float zoomY, float panX, float panY)
	Draws the reference inspection field overlay.
None	DrawReferenceInspectionField (self, eVision.EDrawAdapter|None graphicContext, float zoomX, float zoomY, float panX)
	Draws the reference inspection field overlay.
None	DrawReferenceInspectionField (self, eVision.EDrawAdapter|None graphicContext, float zoomX, float zoomY)
	Draws the reference inspection field overlay.
None	DrawReferenceInspectionField (self, eVision.EDrawAdapter|None graphicContext, float zoomX)
	Draws the reference inspection field overlay.
None	DrawReferenceInspectionField (self, eVision.EDrawAdapter|None graphicContext)
	Draws the reference inspection field overlay.
None	DrawInspectionField (self, eVision.EDrawAdapter|None graphicContext, float zoomX, float zoomY, float panX, float panY)
	Draws the inspection field overlay.
None	DrawInspectionField (self, eVision.EDrawAdapter|None graphicContext, float zoomX, float zoomY, float panX)
	Draws the inspection field overlay.
None	DrawInspectionField (self, eVision.EDrawAdapter|None graphicContext, float zoomX, float zoomY)
	Draws the inspection field overlay.
None	DrawInspectionField (self, eVision.EDrawAdapter|None graphicContext, float zoomX)
	Draws the inspection field overlay.
None	DrawInspectionField (self, eVision.EDrawAdapter|None graphicContext)
	Draws the inspection field overlay.
None	Load (self, str file)
	Load an inspection model.
None	Load (self, eVision.ESerializer|None serializer)
	Load an inspection model.
None	Save (self, eVision.ESerializer|None serializer)
	Save the inspection model.
None	Save (self, str file)
	Save the inspection model.
eVision.ETrainingMode	TrainingMode (self)
	Training mode.
	TrainingMode (self, eVision.ETrainingMode value)
	Training mode.
eVision.Legacy.EFiducialMatchingMode	FiducialMatchingMode (self)
	Fiducial matching mode.
	FiducialMatchingMode (self, eVision.Legacy.EFiducialMatchingMode value)
	Fiducial matching mode.
eVision.ENormalizationMode	NormalizationMode (self)
	Normalization mode.
	NormalizationMode (self, eVision.ENormalizationMode value)
	Normalization mode.
int	FiducialHorizontalTolerance (self)
	Horizontal positionning tolerance for fiducials.
	FiducialHorizontalTolerance (self, int value)
	Horizontal positionning tolerance for fiducials.
int	FiducialVerticalTolerance (self)
	Vertical positionning tolerance for fiducials.
	FiducialVerticalTolerance (self, int value)
	Vertical positionning tolerance for fiducials.
float	InspectionTolerance (self)
	Inspection Tolerance factor.
	InspectionTolerance (self, float value)
	Inspection Tolerance factor.
eVision.EImageBW8	LowThresholdImage (self)
	Low threshold image.
eVision.EImageBW8	HighThresholdImage (self)
	High threshold image.
eVision.EImageBW8	LastRegisteredImage (self)
	Represents the last source image, after it has been aligned with the reference image and normalized.
bool	IsInitialized (self)
	Application state.
bool	IsTrained (self)
	Application state.

Detailed Description

Manages a complete context for the EChecker2 golden template inspection tool.

Remarks:

License(s): EasyObject

Deprecated

Use eVision.Legacy.EChecker instead.

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

Constructor & Destructor Documentation

__init__()

None eVision.Legacy.EChecker2.__init__

(

self

)

Constructs an uninitialized golden template inspection context.

Member Function Documentation

AddTrainingImageFile()

None eVision.Legacy.EChecker2.AddTrainingImageFile	(		self,
		str	path )

Add Training Image File.

Parameters

path	Path to File.

ClearTrainingImageFiles()

None eVision.Legacy.EChecker2.ClearTrainingImageFiles

(

self

)

Clear Training Image Files.

DrawInspectionField() [1/5]

None eVision.Legacy.EChecker2.DrawInspectionField	(		self,
		eVision.EDrawAdapter | None	graphicContext )

Draws the inspection field overlay.

Parameters

graphicContext

Device context of the drawing window.

DrawInspectionField() [2/5]

None eVision.Legacy.EChecker2.DrawInspectionField	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		float	zoomX )

Draws the inspection field overlay.

Parameters

graphicContext	Device context of the drawing window.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

DrawInspectionField() [3/5]

None eVision.Legacy.EChecker2.DrawInspectionField	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		float	zoomX,
		float	zoomY )

Draws the inspection field overlay.

Parameters

graphicContext	Device context of the drawing window.
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).

DrawInspectionField() [4/5]

None eVision.Legacy.EChecker2.DrawInspectionField	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		float	zoomX,
		float	zoomY,
		float	panX )

Draws the inspection field overlay.

Parameters

graphicContext	Device context of the drawing window.
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 factor. By default, no panning occurs.

DrawInspectionField() [5/5]

None eVision.Legacy.EChecker2.DrawInspectionField	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draws the inspection field overlay.

Parameters

graphicContext	Device context of the drawing window.
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 factor. By default, no panning occurs.
panY	Vertical panning factor. By default, no panning occurs.

DrawReferenceInspectionField() [1/5]

None eVision.Legacy.EChecker2.DrawReferenceInspectionField	(		self,
		eVision.EDrawAdapter | None	graphicContext )

Draws the reference inspection field overlay.

Parameters

graphicContext

Device context of the drawing window.

DrawReferenceInspectionField() [2/5]

None eVision.Legacy.EChecker2.DrawReferenceInspectionField	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		float	zoomX )

Draws the reference inspection field overlay.

Parameters

graphicContext	Device context of the drawing window.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

DrawReferenceInspectionField() [3/5]

None eVision.Legacy.EChecker2.DrawReferenceInspectionField	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		float	zoomX,
		float	zoomY )

Draws the reference inspection field overlay.

Parameters

graphicContext	Device context of the drawing window.
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).

DrawReferenceInspectionField() [4/5]

None eVision.Legacy.EChecker2.DrawReferenceInspectionField	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		float	zoomX,
		float	zoomY,
		float	panX )

Draws the reference inspection field overlay.

Parameters

graphicContext	Device context of the drawing window.
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 factor. By default, no panning occurs.

DrawReferenceInspectionField() [5/5]

None eVision.Legacy.EChecker2.DrawReferenceInspectionField	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draws the reference inspection field overlay.

Parameters

graphicContext	Device context of the drawing window.
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 factor. By default, no panning occurs.
panY	Vertical panning factor. By default, no panning occurs.

DrawReferenceSearchFields() [1/5]

None eVision.Legacy.EChecker2.DrawReferenceSearchFields	(		self,
		eVision.EDrawAdapter | None	graphicContext )

Draws the reference search fields overlay.

Parameters

graphicContext

Device context of the drawing window.

DrawReferenceSearchFields() [2/5]

None eVision.Legacy.EChecker2.DrawReferenceSearchFields	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		float	zoomX )

Draws the reference search fields overlay.

Parameters

graphicContext	Device context of the drawing window.
zoomX	Magnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

DrawReferenceSearchFields() [3/5]

None eVision.Legacy.EChecker2.DrawReferenceSearchFields	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		float	zoomX,
		float	zoomY )

Draws the reference search fields overlay.

Parameters

graphicContext	Device context of the drawing window.
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).

DrawReferenceSearchFields() [4/5]

None eVision.Legacy.EChecker2.DrawReferenceSearchFields	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		float	zoomX,
		float	zoomY,
		float	panX )

Draws the reference search fields overlay.

Parameters

graphicContext	Device context of the drawing window.
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 factor. By default, no panning occurs.

DrawReferenceSearchFields() [5/5]

None eVision.Legacy.EChecker2.DrawReferenceSearchFields	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draws the reference search fields overlay.

Parameters

graphicContext	Device context of the drawing window.
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 factor. By default, no panning occurs.
panY	Vertical panning factor. By default, no panning occurs.

FiducialHorizontalTolerance() [1/2]

int eVision.Legacy.EChecker2.FiducialHorizontalTolerance

(

self

)

Horizontal positionning tolerance for fiducials.

The fiducials in the training and inspection images will be searched around the position of the fiducial given during the initialization process, with a tolerance in pixels set by this parameter. The default value is 30 pixels.

FiducialHorizontalTolerance() [2/2]

eVision.Legacy.EChecker2.FiducialHorizontalTolerance	(		self,
		int	value )

Horizontal positionning tolerance for fiducials.

The fiducials in the training and inspection images will be searched around the position of the fiducial given during the initialization process, with a tolerance in pixels set by this parameter. The default value is 30 pixels.

FiducialMatchingMode() [1/2]

eVision.Legacy.EFiducialMatchingMode eVision.Legacy.EChecker2.FiducialMatchingMode

(

self

)

Fiducial matching mode.

This setting allow you to select which type of finder is used to locate the fiducials in the training and inspection images. It can either be geometric (as per EasyFind) or area-based (as per EasyMatch). Default: Geometric finder.

FiducialMatchingMode() [2/2]

eVision.Legacy.EChecker2.FiducialMatchingMode	(		self,
		eVision.Legacy.EFiducialMatchingMode	value )

Fiducial matching mode.

This setting allow you to select which type of finder is used to locate the fiducials in the training and inspection images. It can either be geometric (as per EasyFind) or area-based (as per EasyMatch). Default: Geometric finder.

FiducialVerticalTolerance() [1/2]

int eVision.Legacy.EChecker2.FiducialVerticalTolerance

(

self

)

Vertical positionning tolerance for fiducials.

The fiducials in the training and inspection images will be searched around the position of the fiducial given during the initialization process, with a tolerance in pixels set by this parameter. The default value is 30 pixels.

FiducialVerticalTolerance() [2/2]

eVision.Legacy.EChecker2.FiducialVerticalTolerance	(		self,
		int	value )

Vertical positionning tolerance for fiducials.

The fiducials in the training and inspection images will be searched around the position of the fiducial given during the initialization process, with a tolerance in pixels set by this parameter. The default value is 30 pixels.

HighThresholdImage()

eVision.EImageBW8 eVision.Legacy.EChecker2.HighThresholdImage

(

self

)

High threshold image.

Initialize()

None eVision.Legacy.EChecker2.Initialize	(		self,
		eVision.EROIBW8	referenceImage,
		list[eVision._eVision.ERegion | None]	fiducialRegions,
		eVision.ERegion	inspectionRegion )

Initialize the training process.

Parameters

referenceImage	ROI or Image used as the reference for the training process.
fiducialRegions	Regions of the fiducials used for the registration process.
inspectionRegion	Region used for the inspection process.

Inspect()

None eVision.Legacy.EChecker2.Inspect	(		self,
		eVision.EROIBW8	roi,
		eVision.ECodedImage2	defects )

Inspect.

Parameters

roi	ROI or Image to inspect.
defects	List of defects returned by the inspection.

InspectionTolerance() [1/2]

float eVision.Legacy.EChecker2.InspectionTolerance

(

self

)

Inspection Tolerance factor.

If you need to be more tolerant towards noise, texture or illumination irregularities, raise this value. If you have clean images, low texture and some defects are missed, lower this value. Default value: 4.0

InspectionTolerance() [2/2]

eVision.Legacy.EChecker2.InspectionTolerance	(		self,
		float	value )

Inspection Tolerance factor.

If you need to be more tolerant towards noise, texture or illumination irregularities, raise this value. If you have clean images, low texture and some defects are missed, lower this value. Default value: 4.0

IsInitialized()

bool eVision.Legacy.EChecker2.IsInitialized

(

self

)

Application state.

Has the checker been initialized.

IsTrained()

bool eVision.Legacy.EChecker2.IsTrained

(

self

)

Application state.

Has the checker been trained.

LastRegisteredImage()

eVision.EImageBW8 eVision.Legacy.EChecker2.LastRegisteredImage

(

self

)

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

Load() [1/2]

None eVision.Legacy.EChecker2.Load	(		self,
		eVision.ESerializer | None	serializer )

Load an inspection model.

Parameters

serializer

Serializer. Must be in read mode

Load() [2/2]

None eVision.Legacy.EChecker2.Load	(		self,
		str	file )

Load an inspection model.

Parameters

file

File path

LowThresholdImage()

eVision.EImageBW8 eVision.Legacy.EChecker2.LowThresholdImage

(

self

)

Low threshold image.

NormalizationMode() [1/2]

eVision.ENormalizationMode eVision.Legacy.EChecker2.NormalizationMode

(

self

)

Normalization mode.

This setting allows you to specify if you want to enable normalization, and if yes, which type. Normalization allows the training and inspection processes to automatically correct global illumination differences between the images. Default: Moments based normalization.

Remarks:

If you have consistent illumination between your images, using normalization can prove detrimental, as in that case the defect themselves might be enough to shift the global contrast.

NormalizationMode() [2/2]

eVision.Legacy.EChecker2.NormalizationMode	(		self,
		eVision.ENormalizationMode	value )

Normalization mode.

This setting allows you to specify if you want to enable normalization, and if yes, which type. Normalization allows the training and inspection processes to automatically correct global illumination differences between the images. Default: Moments based normalization.

Remarks:

If you have consistent illumination between your images, using normalization can prove detrimental, as in that case the defect themselves might be enough to shift the global contrast.

ResetTraining()

None eVision.Legacy.EChecker2.ResetTraining

(

self

)

Reset training.

Use this if you want to reset the state of the object without calling eVision.Legacy.EChecker2.Initialize again.

Save() [1/2]

None eVision.Legacy.EChecker2.Save	(		self,
		eVision.ESerializer | None	serializer )

Save the inspection model.

Parameters

serializer

Serializer. Must be in write mode

Save() [2/2]

None eVision.Legacy.EChecker2.Save	(		self,
		str	file )

Save the inspection model.

Parameters

file

File path

Train()

None eVision.Legacy.EChecker2.Train	(		self,
		list[eVision._eVision.EROIBW8 | None]	rois )

Train.

Parameters

rois	ROI or Images to train on.

TrainFromImageFiles()

None eVision.Legacy.EChecker2.TrainFromImageFiles

(

self

)

Train From Image Files.

TrainingMode() [1/2]

eVision.ETrainingMode eVision.Legacy.EChecker2.TrainingMode

(

self

)

Training mode.

The training mode determines which process will be used to build the threshold images used for inspection. EChecker2 has two training modes: A Quick mode, efficent for crude defects and stable images, and a Precise mode, designed for more subtle defects and handling more variability in the images. Default: Precise training mode.

TrainingMode() [2/2]

eVision.Legacy.EChecker2.TrainingMode	(		self,
		eVision.ETrainingMode	value )

Training mode.

The training mode determines which process will be used to build the threshold images used for inspection. EChecker2 has two training modes: A Quick mode, efficent for crude defects and stable images, and a Precise mode, designed for more subtle defects and handling more variability in the images. Default: Precise training mode.