eVision C++ API 26.10.0-beta.2.dev
Loading...
Searching...
No Matches
eVision::Legacy::EChecker2 Class Reference

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

#include <eVision/EasyObject/Legacy/EChecker2.h>

Collaboration diagram for eVision::Legacy::EChecker2:

Public Member Functions

 EChecker2 ()
 Constructs an uninitialized golden template inspection context.
virtual ~EChecker2 () throw ()
void SetTrainingMode (eVision::ETrainingMode mode)
 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.
eVision::ETrainingMode GetTrainingMode () const
 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.
void SetFiducialMatchingMode (eVision::Legacy::EFiducialMatchingMode mode)
 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.
eVision::Legacy::EFiducialMatchingMode GetFiducialMatchingMode () const
 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.
eVision::ENormalizationMode GetNormalizationMode () const
 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.
void SetNormalizationMode (eVision::ENormalizationMode mode)
 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.
void Initialize (const eVision::EROIBW8 &referenceImage, const std::vector< eVision::ERegion * > &fiducialRegions, const eVision::ERegion &inspectionRegion)
 Initialize the training process.
int GetFiducialHorizontalTolerance () const
 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.
void SetFiducialHorizontalTolerance (int tolerance)
 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.
int GetFiducialVerticalTolerance () const
 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.
void SetFiducialVerticalTolerance (int tolerance)
 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.
void Train (const std::vector< const eVision::EROIBW8 * > &rois)
 Train.
void AddTrainingImageFile (const std::string &path)
 Add Training Image File.
void ClearTrainingImageFiles ()
 Clear Training Image Files.
void TrainFromImageFiles ()
 Train From Image Files.
void ResetTraining ()
 Reset training. Use this if you want to reset the state of the object without calling EChecker2::Initialize again.
float GetInspectionTolerance () const
 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.
void SetInspectionTolerance (float tolerance)
 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.
void Inspect (const eVision::EROIBW8 &roi, eVision::ECodedImage2 &defects)
 Inspect.
const eVision::EImageBW8 & GetLowThresholdImage () const
 Low threshold image.
const eVision::EImageBW8 & GetHighThresholdImage () const
 High threshold image.
const eVision::EImageBW8 & GetLastRegisteredImage () const
 Represents the last source image, after it has been aligned with the reference image and normalized.
bool GetIsInitialized ()
 Application state. Has the checker been initialized.
bool GetIsTrained ()
 Application state. Has the checker been trained.
void DrawReferenceSearchFields (eVision::EDrawAdapter *graphicContext, float zoomX, float zoomY, float panX, float panY) const
 Draws the reference search fields overlay.
void DrawReferenceSearchFields (eVision::EDrawAdapter *graphicContext, float zoomX, float zoomY, float panX) const
 Draws the reference search fields overlay.
void DrawReferenceSearchFields (eVision::EDrawAdapter *graphicContext, float zoomX, float zoomY) const
 Draws the reference search fields overlay.
void DrawReferenceSearchFields (eVision::EDrawAdapter *graphicContext, float zoomX) const
 Draws the reference search fields overlay.
void DrawReferenceSearchFields (eVision::EDrawAdapter *graphicContext) const
 Draws the reference search fields overlay.
void DrawReferenceSearchFields (HDC graphicContext, float zoomX, float zoomY, float panX, float panY) const
 Draws the reference search fields overlay.
void DrawReferenceSearchFields (HDC graphicContext, float zoomX, float zoomY, float panX) const
 Draws the reference search fields overlay.
void DrawReferenceSearchFields (HDC graphicContext, float zoomX, float zoomY) const
 Draws the reference search fields overlay.
void DrawReferenceSearchFields (HDC graphicContext, float zoomX) const
 Draws the reference search fields overlay.
void DrawReferenceSearchFields (HDC graphicContext) const
 Draws the reference search fields overlay.
void DrawReferenceSearchFields (HDC graphicContext, const eVision::ERGBColor &color, float zoomX, float zoomY, float panX, float panY) const
 Draws the reference search fields overlay.
void DrawReferenceSearchFields (HDC graphicContext, const eVision::ERGBColor &color, float zoomX, float zoomY, float panX) const
 Draws the reference search fields overlay.
void DrawReferenceSearchFields (HDC graphicContext, const eVision::ERGBColor &color, float zoomX, float zoomY) const
 Draws the reference search fields overlay.
void DrawReferenceSearchFields (HDC graphicContext, const eVision::ERGBColor &color, float zoomX) const
 Draws the reference search fields overlay.
void DrawReferenceSearchFields (HDC graphicContext, const eVision::ERGBColor &color) const
 Draws the reference search fields overlay.
void DrawReferenceInspectionField (eVision::EDrawAdapter *graphicContext, float zoomX, float zoomY, float panX, float panY) const
 Draws the reference inspection field overlay.
void DrawReferenceInspectionField (eVision::EDrawAdapter *graphicContext, float zoomX, float zoomY, float panX) const
 Draws the reference inspection field overlay.
void DrawReferenceInspectionField (eVision::EDrawAdapter *graphicContext, float zoomX, float zoomY) const
 Draws the reference inspection field overlay.
void DrawReferenceInspectionField (eVision::EDrawAdapter *graphicContext, float zoomX) const
 Draws the reference inspection field overlay.
void DrawReferenceInspectionField (eVision::EDrawAdapter *graphicContext) const
 Draws the reference inspection field overlay.
void DrawReferenceInspectionField (HDC graphicContext, float zoomX, float zoomY, float panX, float panY) const
 Draws the reference inspection field overlay.
void DrawReferenceInspectionField (HDC graphicContext, float zoomX, float zoomY, float panX) const
 Draws the reference inspection field overlay.
void DrawReferenceInspectionField (HDC graphicContext, float zoomX, float zoomY) const
 Draws the reference inspection field overlay.
void DrawReferenceInspectionField (HDC graphicContext, float zoomX) const
 Draws the reference inspection field overlay.
void DrawReferenceInspectionField (HDC graphicContext) const
 Draws the reference inspection field overlay.
void DrawReferenceInspectionField (HDC graphicContext, const eVision::ERGBColor &color, float zoomX, float zoomY, float panX, float panY) const
 Draws the reference inspection field overlay.
void DrawReferenceInspectionField (HDC graphicContext, const eVision::ERGBColor &color, float zoomX, float zoomY, float panX) const
 Draws the reference inspection field overlay.
void DrawReferenceInspectionField (HDC graphicContext, const eVision::ERGBColor &color, float zoomX, float zoomY) const
 Draws the reference inspection field overlay.
void DrawReferenceInspectionField (HDC graphicContext, const eVision::ERGBColor &color, float zoomX) const
 Draws the reference inspection field overlay.
void DrawReferenceInspectionField (HDC graphicContext, const eVision::ERGBColor &color) const
 Draws the reference inspection field overlay.
void DrawInspectionField (eVision::EDrawAdapter *graphicContext, float zoomX, float zoomY, float panX, float panY) const
 Draws the inspection field overlay.
void DrawInspectionField (eVision::EDrawAdapter *graphicContext, float zoomX, float zoomY, float panX) const
 Draws the inspection field overlay.
void DrawInspectionField (eVision::EDrawAdapter *graphicContext, float zoomX, float zoomY) const
 Draws the inspection field overlay.
void DrawInspectionField (eVision::EDrawAdapter *graphicContext, float zoomX) const
 Draws the inspection field overlay.
void DrawInspectionField (eVision::EDrawAdapter *graphicContext) const
 Draws the inspection field overlay.
void DrawInspectionField (HDC graphicContext, float zoomX, float zoomY, float panX, float panY) const
 Draws the inspection field overlay.
void DrawInspectionField (HDC graphicContext, float zoomX, float zoomY, float panX) const
 Draws the inspection field overlay.
void DrawInspectionField (HDC graphicContext, float zoomX, float zoomY) const
 Draws the inspection field overlay.
void DrawInspectionField (HDC graphicContext, float zoomX) const
 Draws the inspection field overlay.
void DrawInspectionField (HDC graphicContext) const
 Draws the inspection field overlay.
void DrawInspectionField (HDC graphicContext, const eVision::ERGBColor &color, float zoomX, float zoomY, float panX, float panY) const
 Draws the inspection field overlay.
void DrawInspectionField (HDC graphicContext, const eVision::ERGBColor &color, float zoomX, float zoomY, float panX) const
 Draws the inspection field overlay.
void DrawInspectionField (HDC graphicContext, const eVision::ERGBColor &color, float zoomX, float zoomY) const
 Draws the inspection field overlay.
void DrawInspectionField (HDC graphicContext, const eVision::ERGBColor &color, float zoomX) const
 Draws the inspection field overlay.
void DrawInspectionField (HDC graphicContext, const eVision::ERGBColor &color) const
 Draws the inspection field overlay.
void Load (const std::string &file)
 Load an inspection model.
void Load (eVision::ESerializer *serializer)
 Load an inspection model.
void Save (eVision::ESerializer *serializer)
 Save the inspection model.
void Save (const std::string &file)
 Save the inspection model.
 EChecker2 (CppWrapperInternal::InternalConstructor)

Public Attributes

CppWrapperInternal::WrappedClass wrappedClass_

Detailed Description

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

License(s): EasyObject

Deprecated

Use EChecker instead.

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

Constructor & Destructor Documentation

◆ EChecker2() [1/2]

eVision::Legacy::EChecker2::EChecker2 ( )

Constructs an uninitialized golden template inspection context.

◆ ~EChecker2()

eVision::Legacy::EChecker2::~EChecker2 ( )
throw ( )
virtual

◆ EChecker2() [2/2]

eVision::Legacy::EChecker2::EChecker2 ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ AddTrainingImageFile()

void eVision::Legacy::EChecker2::AddTrainingImageFile ( const std::string & path)

Add Training Image File.

Parameters
pathPath to File.

◆ ClearTrainingImageFiles()

void eVision::Legacy::EChecker2::ClearTrainingImageFiles ( )

Clear Training Image Files.

◆ DrawInspectionField() [1/15]

void eVision::Legacy::EChecker2::DrawInspectionField ( eVision::EDrawAdapter * graphicContext) const

Draws the inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.

◆ DrawInspectionField() [2/15]

void eVision::Legacy::EChecker2::DrawInspectionField ( eVision::EDrawAdapter * graphicContext,
float zoomX ) const

Draws the inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

◆ DrawInspectionField() [3/15]

void eVision::Legacy::EChecker2::DrawInspectionField ( eVision::EDrawAdapter * graphicContext,
float zoomX,
float zoomY ) const

Draws the inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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/15]

void eVision::Legacy::EChecker2::DrawInspectionField ( eVision::EDrawAdapter * graphicContext,
float zoomX,
float zoomY,
float panX ) const

Draws the inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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).
panXHorizontal panning factor. By default, no panning occurs.

◆ DrawInspectionField() [5/15]

void eVision::Legacy::EChecker2::DrawInspectionField ( eVision::EDrawAdapter * graphicContext,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draws the inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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).
panXHorizontal panning factor. By default, no panning occurs.
panYVertical panning factor. By default, no panning occurs.

◆ DrawInspectionField() [6/15]

void eVision::Legacy::EChecker2::DrawInspectionField ( HDC graphicContext) const

Draws the inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
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.

◆ DrawInspectionField() [7/15]

void eVision::Legacy::EChecker2::DrawInspectionField ( HDC graphicContext,
const eVision::ERGBColor & color ) const

Draws the inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
colorColor in which to draw the overlay
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.

◆ DrawInspectionField() [8/15]

void eVision::Legacy::EChecker2::DrawInspectionField ( HDC graphicContext,
const eVision::ERGBColor & color,
float zoomX ) const

Draws the inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
colorColor in which to draw the overlay
zoomXMagnification 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.

◆ DrawInspectionField() [9/15]

void eVision::Legacy::EChecker2::DrawInspectionField ( HDC graphicContext,
const eVision::ERGBColor & color,
float zoomX,
float zoomY ) const

Draws the inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
colorColor in which to draw the overlay
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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.

◆ DrawInspectionField() [10/15]

void eVision::Legacy::EChecker2::DrawInspectionField ( HDC graphicContext,
const eVision::ERGBColor & color,
float zoomX,
float zoomY,
float panX ) const

Draws the inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
colorColor in which to draw the overlay
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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).
panXHorizontal panning factor. 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.

◆ DrawInspectionField() [11/15]

void eVision::Legacy::EChecker2::DrawInspectionField ( HDC graphicContext,
const eVision::ERGBColor & color,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draws the inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
colorColor in which to draw the overlay
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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).
panXHorizontal panning factor. By default, no panning occurs.
panYVertical panning factor. 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.

◆ DrawInspectionField() [12/15]

void eVision::Legacy::EChecker2::DrawInspectionField ( HDC graphicContext,
float zoomX ) const

Draws the inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
zoomXMagnification 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.

◆ DrawInspectionField() [13/15]

void eVision::Legacy::EChecker2::DrawInspectionField ( HDC graphicContext,
float zoomX,
float zoomY ) const

Draws the inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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.

◆ DrawInspectionField() [14/15]

void eVision::Legacy::EChecker2::DrawInspectionField ( HDC graphicContext,
float zoomX,
float zoomY,
float panX ) const

Draws the inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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).
panXHorizontal panning factor. 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.

◆ DrawInspectionField() [15/15]

void eVision::Legacy::EChecker2::DrawInspectionField ( HDC graphicContext,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draws the inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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).
panXHorizontal panning factor. By default, no panning occurs.
panYVertical panning factor. 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.

◆ DrawReferenceInspectionField() [1/15]

void eVision::Legacy::EChecker2::DrawReferenceInspectionField ( eVision::EDrawAdapter * graphicContext) const

Draws the reference inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.

◆ DrawReferenceInspectionField() [2/15]

void eVision::Legacy::EChecker2::DrawReferenceInspectionField ( eVision::EDrawAdapter * graphicContext,
float zoomX ) const

Draws the reference inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

◆ DrawReferenceInspectionField() [3/15]

void eVision::Legacy::EChecker2::DrawReferenceInspectionField ( eVision::EDrawAdapter * graphicContext,
float zoomX,
float zoomY ) const

Draws the reference inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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/15]

void eVision::Legacy::EChecker2::DrawReferenceInspectionField ( eVision::EDrawAdapter * graphicContext,
float zoomX,
float zoomY,
float panX ) const

Draws the reference inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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).
panXHorizontal panning factor. By default, no panning occurs.

◆ DrawReferenceInspectionField() [5/15]

void eVision::Legacy::EChecker2::DrawReferenceInspectionField ( eVision::EDrawAdapter * graphicContext,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draws the reference inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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).
panXHorizontal panning factor. By default, no panning occurs.
panYVertical panning factor. By default, no panning occurs.

◆ DrawReferenceInspectionField() [6/15]

void eVision::Legacy::EChecker2::DrawReferenceInspectionField ( HDC graphicContext) const

Draws the reference inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
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.

◆ DrawReferenceInspectionField() [7/15]

void eVision::Legacy::EChecker2::DrawReferenceInspectionField ( HDC graphicContext,
const eVision::ERGBColor & color ) const

Draws the reference inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
colorColor in which to draw the overlay
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.

◆ DrawReferenceInspectionField() [8/15]

void eVision::Legacy::EChecker2::DrawReferenceInspectionField ( HDC graphicContext,
const eVision::ERGBColor & color,
float zoomX ) const

Draws the reference inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
colorColor in which to draw the overlay
zoomXMagnification 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.

◆ DrawReferenceInspectionField() [9/15]

void eVision::Legacy::EChecker2::DrawReferenceInspectionField ( HDC graphicContext,
const eVision::ERGBColor & color,
float zoomX,
float zoomY ) const

Draws the reference inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
colorColor in which to draw the overlay
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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.

◆ DrawReferenceInspectionField() [10/15]

void eVision::Legacy::EChecker2::DrawReferenceInspectionField ( HDC graphicContext,
const eVision::ERGBColor & color,
float zoomX,
float zoomY,
float panX ) const

Draws the reference inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
colorColor in which to draw the overlay
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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).
panXHorizontal panning factor. 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.

◆ DrawReferenceInspectionField() [11/15]

void eVision::Legacy::EChecker2::DrawReferenceInspectionField ( HDC graphicContext,
const eVision::ERGBColor & color,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draws the reference inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
colorColor in which to draw the overlay
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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).
panXHorizontal panning factor. By default, no panning occurs.
panYVertical panning factor. 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.

◆ DrawReferenceInspectionField() [12/15]

void eVision::Legacy::EChecker2::DrawReferenceInspectionField ( HDC graphicContext,
float zoomX ) const

Draws the reference inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
zoomXMagnification 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.

◆ DrawReferenceInspectionField() [13/15]

void eVision::Legacy::EChecker2::DrawReferenceInspectionField ( HDC graphicContext,
float zoomX,
float zoomY ) const

Draws the reference inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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.

◆ DrawReferenceInspectionField() [14/15]

void eVision::Legacy::EChecker2::DrawReferenceInspectionField ( HDC graphicContext,
float zoomX,
float zoomY,
float panX ) const

Draws the reference inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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).
panXHorizontal panning factor. 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.

◆ DrawReferenceInspectionField() [15/15]

void eVision::Legacy::EChecker2::DrawReferenceInspectionField ( HDC graphicContext,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draws the reference inspection field overlay.

Parameters
graphicContextDevice context of the drawing window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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).
panXHorizontal panning factor. By default, no panning occurs.
panYVertical panning factor. 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.

◆ DrawReferenceSearchFields() [1/15]

void eVision::Legacy::EChecker2::DrawReferenceSearchFields ( eVision::EDrawAdapter * graphicContext) const

Draws the reference search fields overlay.

Parameters
graphicContextDevice context of the drawing window.

◆ DrawReferenceSearchFields() [2/15]

void eVision::Legacy::EChecker2::DrawReferenceSearchFields ( eVision::EDrawAdapter * graphicContext,
float zoomX ) const

Draws the reference search fields overlay.

Parameters
graphicContextDevice context of the drawing window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

◆ DrawReferenceSearchFields() [3/15]

void eVision::Legacy::EChecker2::DrawReferenceSearchFields ( eVision::EDrawAdapter * graphicContext,
float zoomX,
float zoomY ) const

Draws the reference search fields overlay.

Parameters
graphicContextDevice context of the drawing window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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/15]

void eVision::Legacy::EChecker2::DrawReferenceSearchFields ( eVision::EDrawAdapter * graphicContext,
float zoomX,
float zoomY,
float panX ) const

Draws the reference search fields overlay.

Parameters
graphicContextDevice context of the drawing window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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).
panXHorizontal panning factor. By default, no panning occurs.

◆ DrawReferenceSearchFields() [5/15]

void eVision::Legacy::EChecker2::DrawReferenceSearchFields ( eVision::EDrawAdapter * graphicContext,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draws the reference search fields overlay.

Parameters
graphicContextDevice context of the drawing window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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).
panXHorizontal panning factor. By default, no panning occurs.
panYVertical panning factor. By default, no panning occurs.

◆ DrawReferenceSearchFields() [6/15]

void eVision::Legacy::EChecker2::DrawReferenceSearchFields ( HDC graphicContext) const

Draws the reference search fields overlay.

Parameters
graphicContextDevice context of the drawing window.
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.

◆ DrawReferenceSearchFields() [7/15]

void eVision::Legacy::EChecker2::DrawReferenceSearchFields ( HDC graphicContext,
const eVision::ERGBColor & color ) const

Draws the reference search fields overlay.

Parameters
graphicContextDevice context of the drawing window.
colorColor in which to draw the overlay
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.

◆ DrawReferenceSearchFields() [8/15]

void eVision::Legacy::EChecker2::DrawReferenceSearchFields ( HDC graphicContext,
const eVision::ERGBColor & color,
float zoomX ) const

Draws the reference search fields overlay.

Parameters
graphicContextDevice context of the drawing window.
colorColor in which to draw the overlay
zoomXMagnification 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.

◆ DrawReferenceSearchFields() [9/15]

void eVision::Legacy::EChecker2::DrawReferenceSearchFields ( HDC graphicContext,
const eVision::ERGBColor & color,
float zoomX,
float zoomY ) const

Draws the reference search fields overlay.

Parameters
graphicContextDevice context of the drawing window.
colorColor in which to draw the overlay
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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.

◆ DrawReferenceSearchFields() [10/15]

void eVision::Legacy::EChecker2::DrawReferenceSearchFields ( HDC graphicContext,
const eVision::ERGBColor & color,
float zoomX,
float zoomY,
float panX ) const

Draws the reference search fields overlay.

Parameters
graphicContextDevice context of the drawing window.
colorColor in which to draw the overlay
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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).
panXHorizontal panning factor. 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.

◆ DrawReferenceSearchFields() [11/15]

void eVision::Legacy::EChecker2::DrawReferenceSearchFields ( HDC graphicContext,
const eVision::ERGBColor & color,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draws the reference search fields overlay.

Parameters
graphicContextDevice context of the drawing window.
colorColor in which to draw the overlay
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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).
panXHorizontal panning factor. By default, no panning occurs.
panYVertical panning factor. 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.

◆ DrawReferenceSearchFields() [12/15]

void eVision::Legacy::EChecker2::DrawReferenceSearchFields ( HDC graphicContext,
float zoomX ) const

Draws the reference search fields overlay.

Parameters
graphicContextDevice context of the drawing window.
zoomXMagnification 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.

◆ DrawReferenceSearchFields() [13/15]

void eVision::Legacy::EChecker2::DrawReferenceSearchFields ( HDC graphicContext,
float zoomX,
float zoomY ) const

Draws the reference search fields overlay.

Parameters
graphicContextDevice context of the drawing window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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.

◆ DrawReferenceSearchFields() [14/15]

void eVision::Legacy::EChecker2::DrawReferenceSearchFields ( HDC graphicContext,
float zoomX,
float zoomY,
float panX ) const

Draws the reference search fields overlay.

Parameters
graphicContextDevice context of the drawing window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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).
panXHorizontal panning factor. 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.

◆ DrawReferenceSearchFields() [15/15]

void eVision::Legacy::EChecker2::DrawReferenceSearchFields ( HDC graphicContext,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draws the reference search fields overlay.

Parameters
graphicContextDevice context of the drawing window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification 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).
panXHorizontal panning factor. By default, no panning occurs.
panYVertical panning factor. 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.

◆ GetFiducialHorizontalTolerance()

int eVision::Legacy::EChecker2::GetFiducialHorizontalTolerance ( ) const

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.

◆ GetFiducialMatchingMode()

eVision::Legacy::EFiducialMatchingMode eVision::Legacy::EChecker2::GetFiducialMatchingMode ( ) const

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.

◆ GetFiducialVerticalTolerance()

int eVision::Legacy::EChecker2::GetFiducialVerticalTolerance ( ) const

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.

◆ GetHighThresholdImage()

const eVision::EImageBW8 & eVision::Legacy::EChecker2::GetHighThresholdImage ( ) const

High threshold image.

◆ GetInspectionTolerance()

float eVision::Legacy::EChecker2::GetInspectionTolerance ( ) const

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.

◆ GetIsInitialized()

bool eVision::Legacy::EChecker2::GetIsInitialized ( )

Application state. Has the checker been initialized.

◆ GetIsTrained()

bool eVision::Legacy::EChecker2::GetIsTrained ( )

Application state. Has the checker been trained.

◆ GetLastRegisteredImage()

const eVision::EImageBW8 & eVision::Legacy::EChecker2::GetLastRegisteredImage ( ) const

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

◆ GetLowThresholdImage()

const eVision::EImageBW8 & eVision::Legacy::EChecker2::GetLowThresholdImage ( ) const

Low threshold image.

◆ GetNormalizationMode()

eVision::ENormalizationMode eVision::Legacy::EChecker2::GetNormalizationMode ( ) const

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.

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.

◆ GetTrainingMode()

eVision::ETrainingMode eVision::Legacy::EChecker2::GetTrainingMode ( ) const

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.

◆ Initialize()

void eVision::Legacy::EChecker2::Initialize ( const eVision::EROIBW8 & referenceImage,
const std::vector< eVision::ERegion * > & fiducialRegions,
const eVision::ERegion & inspectionRegion )

Initialize the training process.

Parameters
referenceImageROI or Image used as the reference for the training process.
fiducialRegionsRegions of the fiducials used for the registration process.
inspectionRegionRegion used for the inspection process.

◆ Inspect()

void eVision::Legacy::EChecker2::Inspect ( const eVision::EROIBW8 & roi,
eVision::ECodedImage2 & defects )

Inspect.

Parameters
roiROI or Image to inspect.
defectsList of defects returned by the inspection.

◆ Load() [1/2]

void eVision::Legacy::EChecker2::Load ( const std::string & file)

Load an inspection model.

Parameters
fileFile path

◆ Load() [2/2]

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

Load an inspection model.

Parameters
serializerSerializer. Must be in read mode

◆ ResetTraining()

void eVision::Legacy::EChecker2::ResetTraining ( )

Reset training. Use this if you want to reset the state of the object without calling EChecker2::Initialize again.

◆ Save() [1/2]

void eVision::Legacy::EChecker2::Save ( const std::string & file)

Save the inspection model.

Parameters
fileFile path

◆ Save() [2/2]

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

Save the inspection model.

Parameters
serializerSerializer. Must be in write mode

◆ SetFiducialHorizontalTolerance()

void eVision::Legacy::EChecker2::SetFiducialHorizontalTolerance ( int tolerance)

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.

◆ SetFiducialMatchingMode()

void eVision::Legacy::EChecker2::SetFiducialMatchingMode ( eVision::Legacy::EFiducialMatchingMode mode)

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.

◆ SetFiducialVerticalTolerance()

void eVision::Legacy::EChecker2::SetFiducialVerticalTolerance ( int tolerance)

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.

◆ SetInspectionTolerance()

void eVision::Legacy::EChecker2::SetInspectionTolerance ( float tolerance)

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.

◆ SetNormalizationMode()

void eVision::Legacy::EChecker2::SetNormalizationMode ( eVision::ENormalizationMode mode)

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.

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.

◆ SetTrainingMode()

void eVision::Legacy::EChecker2::SetTrainingMode ( eVision::ETrainingMode mode)

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.

◆ Train()

void eVision::Legacy::EChecker2::Train ( const std::vector< const eVision::EROIBW8 * > & rois)

Train.

Parameters
roisROI or Images to train on.

◆ TrainFromImageFiles()

void eVision::Legacy::EChecker2::TrainFromImageFiles ( )

Train From Image Files.

Member Data Documentation

◆ wrappedClass_

CppWrapperInternal::WrappedClass eVision::Legacy::EChecker2::wrappedClass_