ESpotDetector is dedicated to the detection of spots, particles and scratches on images. It is especially efficient at detecting faint contaminations on noisy surface images. It produces a list of ESpot objects. More...

#include <eVision/EasySpotDetector/ESpotDetector.h>

Collaboration diagram for eVision::ESpotDetector:

Public Member Functions
	ESpotDetector ()
	Constructs an ESpotDetector with default configuration.
	ESpotDetector (const eVision::ESpotDetector &other)
	Copy constructor for ESpotDetector.
virtual	~ESpotDetector () throw ()
eVision::ESpotDetector &	operator= (const eVision::ESpotDetector &other)
	Assignment operator.
bool	operator== (const eVision::ESpotDetector &other) const
	Comparison operator.
void	Load (const std::string &path)
	Loads the ESpotDetector. The given ESerializer must have been created for reading.
void	Load (eVision::ESerializer *serializer)
	Loads the ESpotDetector. The given ESerializer must have been created for reading.
void	Save (const std::string &path)
	Saves the ESpotDetector. The given ESerializer must have been created for writing.
void	Save (eVision::ESerializer *serializer)
	Saves the ESpotDetector. The given ESerializer must have been created for writing.
void	SetEnableAlignment (bool state)
	Enables or disables the optional alignment process. The alignment area and the tolerance must be set as well, see ESpotDetector::SetAlignmentArea and ESpotDetector::SetAlignmentTolerance.
bool	GetEnableAlignment () const
	Enables or disables the optional alignment process. The alignment area and the tolerance must be set as well, see ESpotDetector::SetAlignmentArea and ESpotDetector::SetAlignmentTolerance.
void	SetAlignmentArea (const eVision::ERectangle &rectangle)
	Sets/Gets an initial estimate of the rectangle on which spots will be detected in the image. The alignment process is enabled with ESpotDetector::SetEnableAlignment. To perform the alignment, a tolerance must be set as well, see ESpotDetector::SetAlignmentTolerance.
const eVision::ERectangle &	GetAlignmentArea () const
	Sets/Gets an initial estimate of the rectangle on which spots will be detected in the image. The alignment process is enabled with ESpotDetector::SetEnableAlignment. To perform the alignment, a tolerance must be set as well, see ESpotDetector::SetAlignmentTolerance.
void	SetAlignmentTolerance (uint32_t tolerance)
	Sets/Gets the tolerance around the initial estimate of the alignment area, in pixels. The default is 100 pixels. See also ESpotDetector::SetAlignmentArea.
uint32_t	GetAlignmentTolerance () const
	Sets/Gets the tolerance around the initial estimate of the alignment area, in pixels. The default is 100 pixels. See also ESpotDetector::SetAlignmentArea.
void	SetGuardBand (const eVision::EGuardBand &guardBand)
	Sets/Gets the EGuardBand.
eVision::EGuardBand	GetGuardBand () const
	Sets/Gets the EGuardBand.
void	SetEnableParticleDetection (bool state)
	Sets/Gets the particle detection processing.
bool	GetEnableParticleDetection () const
	Sets/Gets the particle detection processing.
void	SetEnableScratchDetection (bool state)
	Sets/Gets the scratch detection processing.
bool	GetEnableScratchDetection () const
	Sets/Gets the scratch detection processing.
void	SetParticleDetectionParameters (const eVision::EParticleDetectionParameters &parameters)
	Sets the particle detection parameters.
void	GetParticleDetectionParameters (eVision::EParticleDetectionParameters &parameters) const
	Gets the particle detection parameters.
void	SetScratchDetectionParameters (const eVision::EScratchDetectionParameters &parameters)
	Sets the scratch detection parameters.
void	GetScratchDetectionParameters (eVision::EScratchDetectionParameters &parameters) const
	Gets the scratch detection parameters.
uint32_t	Detect (const eVision::EROIBW8 &sourceImage)
	Performs the spot detection in the given EROIBW8. It returns the number of spot detected. Use ESpotDetector::GetSpots the retrieve the list of detected spots.
uint32_t	Detect (const eVision::EROIBW8 &sourceImage, const eVision::ERegion &region)
	Performs the spot detection in the given EROIBW8. It returns the number of spot detected. Use ESpotDetector::GetSpots the retrieve the list of detected spots.
uint32_t	Detect (const eVision::EROIBW8 &sourceImage, const eVision::EFrame &frame)
	Performs the spot detection in the given EROIBW8. It returns the number of spot detected. Use ESpotDetector::GetSpots the retrieve the list of detected spots.
uint32_t	Detect (const eVision::EROIBW8 &sourceImage, const eVision::ERegion &region, const eVision::EFrame &frame)
	Performs the spot detection in the given EROIBW8. It returns the number of spot detected. Use ESpotDetector::GetSpots the retrieve the list of detected spots.
std::vector< eVision::ESpot >	GetSpots () const
	Gets the spots detected by a previous call to ESpotDetector::Detect.
uint32_t	GetNumSpots () const
	Gets the number of spots detected by a previous call to ESpotDetector::Detect.
const eVision::EROIBW8 &	GetSourceROI () const
	Gets the last used Region Of Interest, after optionnal alignment and guard band clipping. No image is attached to that EROIBW8. See also ESpotDetector::SetEnableAlignment and ESpotDetector::SetGuardBand.
void	GenerateSegmentationMap (eVision::EImageBW8 &map) const
	Returns the last computed segmentation map.
void	Draw (eVision::EDrawAdapter *drawAdapter, const eVision::ERGBColor &color, float zoomX, float zoomY, float panX, float panY) const
	Draw the ESpotDetector.
void	Draw (eVision::EDrawAdapter *drawAdapter, const eVision::ERGBColor &color, float zoomX, float zoomY, float panX) const
	Draw the ESpotDetector.
void	Draw (eVision::EDrawAdapter *drawAdapter, const eVision::ERGBColor &color, float zoomX, float zoomY) const
	Draw the ESpotDetector.
void	Draw (eVision::EDrawAdapter *drawAdapter, const eVision::ERGBColor &color, float zoomX) const
	Draw the ESpotDetector.
void	Draw (eVision::EDrawAdapter *drawAdapter, const eVision::ERGBColor &color) const
	Draw the ESpotDetector.
void	Draw (eVision::EDrawAdapter *drawAdapter) const
	Draw the ESpotDetector.
void	Draw (HDC graphicContext, const eVision::ERGBColor &color, float zoomX, float zoomY, float panX, float panY) const
	Draw the ESpotDetector.
void	Draw (HDC graphicContext, const eVision::ERGBColor &color, float zoomX, float zoomY, float panX) const
	Draw the ESpotDetector.
void	Draw (HDC graphicContext, const eVision::ERGBColor &color, float zoomX, float zoomY) const
	Draw the ESpotDetector.
void	Draw (HDC graphicContext, const eVision::ERGBColor &color, float zoomX) const
	Draw the ESpotDetector.
void	Draw (HDC graphicContext, const eVision::ERGBColor &color) const
	Draw the ESpotDetector.
void	Draw (HDC graphicContext) const
	Draw the ESpotDetector.
uint32_t	AddDetectedSpotsToDLProject (const std::string &projectPath, uint32_t roiExtension, const std::string &imageName, uint32_t noDefectSamples, const std::string &noDefectLabel)
	To be called after ESpotDetector::Detect to add the detected spots to a new or existing EDeepLearningProject. This method returns the number of spots added.
uint32_t	AddDetectedSpotsToDLProject (const std::string &projectPath, uint32_t roiExtension, const std::string &imageName, uint32_t noDefectSamples)
	To be called after ESpotDetector::Detect to add the detected spots to a new or existing EDeepLearningProject. This method returns the number of spots added.
uint32_t	AddDetectedSpotsToDLProject (const std::string &projectPath, uint32_t roiExtension, const std::string &imageName)
	To be called after ESpotDetector::Detect to add the detected spots to a new or existing EDeepLearningProject. This method returns the number of spots added.
uint32_t	AddDetectedSpotsToDLProject (const std::string &projectPath, uint32_t roiExtension)
	To be called after ESpotDetector::Detect to add the detected spots to a new or existing EDeepLearningProject. This method returns the number of spots added.
uint32_t	AddDetectedSpotsToDLProject (const std::string &projectPath)
	To be called after ESpotDetector::Detect to add the detected spots to a new or existing EDeepLearningProject. This method returns the number of spots added.
void	SetDLClassifierPath (const std::string &classifierPath)
	Opens a DL classifier and use it to classify all further detected spots. The resulting class is stored in ESpot. Use ESpotDetector::UnsetDLClassifier to remove the Deep Learning classification. Setting a Deep Learning Classifier triggers an initialization of the model. The initialization can take a few milliseconds to several minutes depending on the engine and device selected.
std::string	GetDLClassifierPath () const
	Opens a DL classifier and use it to classify all further detected spots. The resulting class is stored in ESpot. Use ESpotDetector::UnsetDLClassifier to remove the Deep Learning classification. Setting a Deep Learning Classifier triggers an initialization of the model. The initialization can take a few milliseconds to several minutes depending on the engine and device selected.
void	UnsetDLClassifier ()
	Disable the usage of the Deep Learning classifier.
bool	IsDLClassifierSet () const
	Returns True if a classifier has been loaded.
void	SetDLExecutionSettings (const eVision::EasyDeepLearning::EDeepLearningExecutionSettings &settings)
	Controls the execution settings of the DL Classifier. Set the class EDeepLearningExecutionSettings to choose between engines, devices and other inference parameters. Changing the execution settings triggers an initialization of the deep learning model. The initialization can take a few milliseconds to several minutes depending on the engine and device selected.
eVision::EasyDeepLearning::EDeepLearningExecutionSettings	GetDLExecutionSettings () const
	Controls the execution settings of the DL Classifier. Set the class EDeepLearningExecutionSettings to choose between engines, devices and other inference parameters. Changing the execution settings triggers an initialization of the deep learning model. The initialization can take a few milliseconds to several minutes depending on the engine and device selected.
	ESpotDetector (CppWrapperInternal::InternalConstructor)

Public Attributes
CppWrapperInternal::WrappedClass	wrappedClass_

Detailed Description

ESpotDetector is dedicated to the detection of spots, particles and scratches on images. It is especially efficient at detecting faint contaminations on noisy surface images. It produces a list of ESpot objects.

License(s): EasySpotDetector

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

Constructor & Destructor Documentation

◆ ESpotDetector() [1/3]

eVision::ESpotDetector::ESpotDetector ( )

Constructs an ESpotDetector with default configuration.

◆ ESpotDetector() [2/3]

eVision::ESpotDetector::ESpotDetector ( const eVision::ESpotDetector & other )

Copy constructor for ESpotDetector.

Parameters

other The other ESpotDetector that we will copy into this one.

◆ ~ESpotDetector()

eVision::ESpotDetector::~ESpotDetector	(		)
throw	(	)

virtual

◆ ESpotDetector() [3/3]

eVision::ESpotDetector::ESpotDetector ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ AddDetectedSpotsToDLProject() [1/5]

uint32_t eVision::ESpotDetector::AddDetectedSpotsToDLProject ( const std::string & projectPath )

To be called after ESpotDetector::Detect to add the detected spots to a new or existing EDeepLearningProject. This method returns the number of spots added.

The image used by ESpotDetector::Detect is copied to a subdirectory 'Images' of the project file and linked in the project. All detected spots are added to the project as ROI of the image, with the label depending on the spot type ('Particle' or 'Scratch'). Optional parameter roiExtension can be used to increase the ROI size by a pixel amount. It could help the deep learning inference to have a 'context' around the ROI. Automatic image names are generated unless the parameter imageName is set. All images must have a different name. The optional parameter noDefectSamples sets the number of extra ROIs added to the project representing areas without defect. The label of these defects are given by parameter noDefectLabel.

Parameters

projectPath The path to the Deep Learning project (usually a file with edlproject extension).

◆ AddDetectedSpotsToDLProject() [2/5]

uint32_t eVision::ESpotDetector::AddDetectedSpotsToDLProject	(	const std::string &	projectPath,
		uint32_t	roiExtension )

To be called after ESpotDetector::Detect to add the detected spots to a new or existing EDeepLearningProject. This method returns the number of spots added.

The image used by ESpotDetector::Detect is copied to a subdirectory 'Images' of the project file and linked in the project. All detected spots are added to the project as ROI of the image, with the label depending on the spot type ('Particle' or 'Scratch'). Optional parameter roiExtension can be used to increase the ROI size by a pixel amount. It could help the deep learning inference to have a 'context' around the ROI. Automatic image names are generated unless the parameter imageName is set. All images must have a different name. The optional parameter noDefectSamples sets the number of extra ROIs added to the project representing areas without defect. The label of these defects are given by parameter noDefectLabel.

Parameters

projectPath	The path to the Deep Learning project (usually a file with edlproject extension).
roiExtension	The ROI extension in pixels. Default value is 5.

◆ AddDetectedSpotsToDLProject() [3/5]

uint32_t eVision::ESpotDetector::AddDetectedSpotsToDLProject	(	const std::string &	projectPath,
		uint32_t	roiExtension,
		const std::string &	imageName )

To be called after ESpotDetector::Detect to add the detected spots to a new or existing EDeepLearningProject. This method returns the number of spots added.

The image used by ESpotDetector::Detect is copied to a subdirectory 'Images' of the project file and linked in the project. All detected spots are added to the project as ROI of the image, with the label depending on the spot type ('Particle' or 'Scratch'). Optional parameter roiExtension can be used to increase the ROI size by a pixel amount. It could help the deep learning inference to have a 'context' around the ROI. Automatic image names are generated unless the parameter imageName is set. All images must have a different name. The optional parameter noDefectSamples sets the number of extra ROIs added to the project representing areas without defect. The label of these defects are given by parameter noDefectLabel.

Parameters

projectPath	The path to the Deep Learning project (usually a file with edlproject extension).
roiExtension	The ROI extension in pixels. Default value is 5.
imageName	Override the default image name.

◆ AddDetectedSpotsToDLProject() [4/5]

uint32_t eVision::ESpotDetector::AddDetectedSpotsToDLProject	(	const std::string &	projectPath,
		uint32_t	roiExtension,
		const std::string &	imageName,
		uint32_t	noDefectSamples )

To be called after ESpotDetector::Detect to add the detected spots to a new or existing EDeepLearningProject. This method returns the number of spots added.

The image used by ESpotDetector::Detect is copied to a subdirectory 'Images' of the project file and linked in the project. All detected spots are added to the project as ROI of the image, with the label depending on the spot type ('Particle' or 'Scratch'). Optional parameter roiExtension can be used to increase the ROI size by a pixel amount. It could help the deep learning inference to have a 'context' around the ROI. Automatic image names are generated unless the parameter imageName is set. All images must have a different name. The optional parameter noDefectSamples sets the number of extra ROIs added to the project representing areas without defect. The label of these defects are given by parameter noDefectLabel.

Parameters

projectPath	The path to the Deep Learning project (usually a file with edlproject extension).
roiExtension	The ROI extension in pixels. Default value is 5.
imageName	Override the default image name.
noDefectSamples	Number of extra ROI to be created to represent areas without defect. Default value is 0.

◆ AddDetectedSpotsToDLProject() [5/5]

uint32_t eVision::ESpotDetector::AddDetectedSpotsToDLProject	(	const std::string &	projectPath,
		uint32_t	roiExtension,
		const std::string &	imageName,
		uint32_t	noDefectSamples,
		const std::string &	noDefectLabel )

To be called after ESpotDetector::Detect to add the detected spots to a new or existing EDeepLearningProject. This method returns the number of spots added.

The image used by ESpotDetector::Detect is copied to a subdirectory 'Images' of the project file and linked in the project. All detected spots are added to the project as ROI of the image, with the label depending on the spot type ('Particle' or 'Scratch'). Optional parameter roiExtension can be used to increase the ROI size by a pixel amount. It could help the deep learning inference to have a 'context' around the ROI. Automatic image names are generated unless the parameter imageName is set. All images must have a different name. The optional parameter noDefectSamples sets the number of extra ROIs added to the project representing areas without defect. The label of these defects are given by parameter noDefectLabel.

Parameters

projectPath	The path to the Deep Learning project (usually a file with edlproject extension).
roiExtension	The ROI extension in pixels. Default value is 5.
imageName	Override the default image name.
noDefectSamples	Number of extra ROI to be created to represent areas without defect. Default value is 0.
noDefectLabel	The label for the extra ROI (if noDefectSamples>0). Default value is 'NotADefect'.

◆ Detect() [1/4]

uint32_t eVision::ESpotDetector::Detect ( const eVision::EROIBW8 & sourceImage )

Performs the spot detection in the given EROIBW8. It returns the number of spot detected. Use ESpotDetector::GetSpots the retrieve the list of detected spots.

Parameters

sourceImage The image in which the spots are detected.

◆ Detect() [2/4]

uint32_t eVision::ESpotDetector::Detect	(	const eVision::EROIBW8 &	sourceImage,
		const eVision::EFrame &	frame )

Performs the spot detection in the given EROIBW8. It returns the number of spot detected. Use ESpotDetector::GetSpots the retrieve the list of detected spots.

Parameters

sourceImage	The image in which the spots are detected.
frame	Reference frame of the input region

◆ Detect() [3/4]

uint32_t eVision::ESpotDetector::Detect	(	const eVision::EROIBW8 &	sourceImage,
		const eVision::ERegion &	region )

Performs the spot detection in the given EROIBW8. It returns the number of spot detected. Use ESpotDetector::GetSpots the retrieve the list of detected spots.

Parameters

sourceImage	The image in which the spots are detected.
region	The region on which the image is processed.

◆ Detect() [4/4]

uint32_t eVision::ESpotDetector::Detect	(	const eVision::EROIBW8 &	sourceImage,
		const eVision::ERegion &	region,
		const eVision::EFrame &	frame )

Performs the spot detection in the given EROIBW8. It returns the number of spot detected. Use ESpotDetector::GetSpots the retrieve the list of detected spots.

Parameters

sourceImage	The image in which the spots are detected.
region	The region on which the image is processed.
frame	Reference frame of the input region

◆ Draw() [1/12]

void eVision::ESpotDetector::Draw ( eVision::EDrawAdapter * drawAdapter ) const

Draw the ESpotDetector.

Parameters

drawAdapter EDrawAdapter that will be used to draw.

◆ Draw() [2/12]

void eVision::ESpotDetector::Draw	(	eVision::EDrawAdapter *	drawAdapter,
		const eVision::ERGBColor &	color ) const

Draw the ESpotDetector.

Parameters

drawAdapter	EDrawAdapter that will be used to draw.
color	Color of the drawn rectangle.

◆ Draw() [3/12]

void eVision::ESpotDetector::Draw	(	eVision::EDrawAdapter *	drawAdapter,
		const eVision::ERGBColor &	color,
		float	zoomX ) const

Draw the ESpotDetector.

Parameters

drawAdapter	EDrawAdapter that will be used to draw.
color	Color of the drawn rectangle.
zoomX	Horizontal zooming factor. By default, true scale is used.

◆ Draw() [4/12]

void eVision::ESpotDetector::Draw	(	eVision::EDrawAdapter *	drawAdapter,
		const eVision::ERGBColor &	color,
		float	zoomX,
		float	zoomY ) const

Draw the ESpotDetector.

Parameters

drawAdapter	EDrawAdapter that will be used to draw.
color	Color of the drawn rectangle.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.

◆ Draw() [5/12]

void eVision::ESpotDetector::Draw	(	eVision::EDrawAdapter *	drawAdapter,
		const eVision::ERGBColor &	color,
		float	zoomX,
		float	zoomY,
		float	panX ) const

Draw the ESpotDetector.

Parameters

drawAdapter	EDrawAdapter that will be used to draw.
color	Color of the drawn rectangle.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

◆ Draw() [6/12]

void eVision::ESpotDetector::Draw	(	eVision::EDrawAdapter *	drawAdapter,
		const eVision::ERGBColor &	color,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY ) const

Draw the ESpotDetector.

Parameters

drawAdapter	EDrawAdapter that will be used to draw.
color	Color of the drawn rectangle.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

◆ Draw() [7/12]

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

Draw the ESpotDetector.

Parameters

graphicContext Handle of the graphics context on which to draw.

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

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

Draw the ESpotDetector.

Parameters

graphicContext	Handle of the graphics context on which to draw.
color	Color of the drawn rectangle.

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

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

Draw the ESpotDetector.

Parameters

graphicContext	Handle of the graphics context on which to draw.
color	Color of the drawn rectangle.
zoomX	Horizontal zooming factor. By default, true scale is used.

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

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

Draw the ESpotDetector.

Parameters

graphicContext	Handle of the graphics context on which to draw.
color	Color of the drawn rectangle.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.

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

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

Draw the ESpotDetector.

Parameters

graphicContext	Handle of the graphics context on which to draw.
color	Color of the drawn rectangle.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
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/12]

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

Draw the ESpotDetector.

Parameters

graphicContext	Handle of the graphics context on which to draw.
color	Color of the drawn rectangle.
zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

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.

◆ GenerateSegmentationMap()

void eVision::ESpotDetector::GenerateSegmentationMap ( eVision::EImageBW8 & map ) const

Returns the last computed segmentation map.

Parameters

map	The destination image for the segmentation map.

◆ GetAlignmentArea()

const eVision::ERectangle & eVision::ESpotDetector::GetAlignmentArea ( ) const

Sets/Gets an initial estimate of the rectangle on which spots will be detected in the image. The alignment process is enabled with ESpotDetector::SetEnableAlignment. To perform the alignment, a tolerance must be set as well, see ESpotDetector::SetAlignmentTolerance.

◆ GetAlignmentTolerance()

uint32_t eVision::ESpotDetector::GetAlignmentTolerance ( ) const

Sets/Gets the tolerance around the initial estimate of the alignment area, in pixels. The default is 100 pixels. See also ESpotDetector::SetAlignmentArea.

◆ GetDLClassifierPath()

std::string eVision::ESpotDetector::GetDLClassifierPath ( ) const

Opens a DL classifier and use it to classify all further detected spots. The resulting class is stored in ESpot. Use ESpotDetector::UnsetDLClassifier to remove the Deep Learning classification. Setting a Deep Learning Classifier triggers an initialization of the model. The initialization can take a few milliseconds to several minutes depending on the engine and device selected.

◆ GetDLExecutionSettings()

eVision::EasyDeepLearning::EDeepLearningExecutionSettings eVision::ESpotDetector::GetDLExecutionSettings ( ) const

Controls the execution settings of the DL Classifier. Set the class EDeepLearningExecutionSettings to choose between engines, devices and other inference parameters. Changing the execution settings triggers an initialization of the deep learning model. The initialization can take a few milliseconds to several minutes depending on the engine and device selected.

◆ GetEnableAlignment()

bool eVision::ESpotDetector::GetEnableAlignment ( ) const

Enables or disables the optional alignment process. The alignment area and the tolerance must be set as well, see ESpotDetector::SetAlignmentArea and ESpotDetector::SetAlignmentTolerance.

◆ GetEnableParticleDetection()

bool eVision::ESpotDetector::GetEnableParticleDetection ( ) const

Sets/Gets the particle detection processing.

◆ GetEnableScratchDetection()

bool eVision::ESpotDetector::GetEnableScratchDetection ( ) const

Sets/Gets the scratch detection processing.

◆ GetGuardBand()

eVision::EGuardBand eVision::ESpotDetector::GetGuardBand ( ) const

Sets/Gets the EGuardBand.

◆ GetNumSpots()

uint32_t eVision::ESpotDetector::GetNumSpots ( ) const

Gets the number of spots detected by a previous call to ESpotDetector::Detect.

◆ GetParticleDetectionParameters()

void eVision::ESpotDetector::GetParticleDetectionParameters ( eVision::EParticleDetectionParameters & parameters ) const

Gets the particle detection parameters.

Parameters

parameters From EParticleDetectionParameters.

◆ GetScratchDetectionParameters()

void eVision::ESpotDetector::GetScratchDetectionParameters ( eVision::EScratchDetectionParameters & parameters ) const

Gets the scratch detection parameters.

Parameters

parameters From EScratchDetectionParameters.

◆ GetSourceROI()

const eVision::EROIBW8 & eVision::ESpotDetector::GetSourceROI ( ) const

Gets the last used Region Of Interest, after optionnal alignment and guard band clipping. No image is attached to that EROIBW8. See also ESpotDetector::SetEnableAlignment and ESpotDetector::SetGuardBand.

◆ GetSpots()

std::vector< eVision::ESpot > eVision::ESpotDetector::GetSpots ( ) const

Gets the spots detected by a previous call to ESpotDetector::Detect.

◆ IsDLClassifierSet()

bool eVision::ESpotDetector::IsDLClassifierSet ( ) const

Returns True if a classifier has been loaded.

◆ Load() [1/2]

void eVision::ESpotDetector::Load ( const std::string & path )

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

Parameters

path	The file path.

◆ Load() [2/2]

void eVision::ESpotDetector::Load ( eVision::ESerializer * serializer )

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

Parameters

serializer The serializer.

◆ operator=()

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

Assignment operator.

Parameters

other The other ESpotDetector that we will copy into this one.

◆ operator==()

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

Comparison operator.

Parameters

other The other object.

◆ Save() [1/2]

void eVision::ESpotDetector::Save ( const std::string & path )

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

Parameters

path	The file path.

◆ Save() [2/2]

void eVision::ESpotDetector::Save ( eVision::ESerializer * serializer )

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

Parameters

serializer The ESerializer object that is written to.

◆ SetAlignmentArea()

void eVision::ESpotDetector::SetAlignmentArea ( const eVision::ERectangle & rectangle )

Sets/Gets an initial estimate of the rectangle on which spots will be detected in the image. The alignment process is enabled with ESpotDetector::SetEnableAlignment. To perform the alignment, a tolerance must be set as well, see ESpotDetector::SetAlignmentTolerance.

Parameters

rectangle The initial rectangle.

◆ SetAlignmentTolerance()

void eVision::ESpotDetector::SetAlignmentTolerance ( uint32_t tolerance )

Sets/Gets the tolerance around the initial estimate of the alignment area, in pixels. The default is 100 pixels. See also ESpotDetector::SetAlignmentArea.

Parameters

tolerance The tolerance around the initial estimate in pixels.

◆ SetDLClassifierPath()

void eVision::ESpotDetector::SetDLClassifierPath ( const std::string & classifierPath )

Opens a DL classifier and use it to classify all further detected spots. The resulting class is stored in ESpot. Use ESpotDetector::UnsetDLClassifier to remove the Deep Learning classification. Setting a Deep Learning Classifier triggers an initialization of the model. The initialization can take a few milliseconds to several minutes depending on the engine and device selected.

Parameters

classifierPath The path to an EasyClassify tool.

◆ SetDLExecutionSettings()

void eVision::ESpotDetector::SetDLExecutionSettings ( const eVision::EasyDeepLearning::EDeepLearningExecutionSettings & settings )

Controls the execution settings of the DL Classifier. Set the class EDeepLearningExecutionSettings to choose between engines, devices and other inference parameters. Changing the execution settings triggers an initialization of the deep learning model. The initialization can take a few milliseconds to several minutes depending on the engine and device selected.

Parameters

settings The Deep Learning execution settings to use for inference.

◆ SetEnableAlignment()

void eVision::ESpotDetector::SetEnableAlignment ( bool state )

Enables or disables the optional alignment process. The alignment area and the tolerance must be set as well, see ESpotDetector::SetAlignmentArea and ESpotDetector::SetAlignmentTolerance.

Parameters

state The state of the alignment.

◆ SetEnableParticleDetection()

void eVision::ESpotDetector::SetEnableParticleDetection ( bool state )

Sets/Gets the particle detection processing.

Parameters

state The state of the detection.

◆ SetEnableScratchDetection()

void eVision::ESpotDetector::SetEnableScratchDetection ( bool state )

Sets/Gets the scratch detection processing.

Parameters

state The state of the detection.

◆ SetGuardBand()

void eVision::ESpotDetector::SetGuardBand ( const eVision::EGuardBand & guardBand )

Sets/Gets the EGuardBand.

Parameters

guardBand The guard band.

◆ SetParticleDetectionParameters()

void eVision::ESpotDetector::SetParticleDetectionParameters ( const eVision::EParticleDetectionParameters & parameters )

Sets the particle detection parameters.

Parameters

parameters From EParticleDetectionParameters.

◆ SetScratchDetectionParameters()

void eVision::ESpotDetector::SetScratchDetectionParameters ( const eVision::EScratchDetectionParameters & parameters )

Sets the scratch detection parameters.

Parameters

parameters From EScratchDetectionParameters.

◆ UnsetDLClassifier()

void eVision::ESpotDetector::UnsetDLClassifier ( )

Disable the usage of the Deep Learning classifier.

Member Data Documentation

◆ wrappedClass_

CppWrapperInternal::WrappedClass eVision::ESpotDetector::wrappedClass_

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ESpotDetector() [1/3]

◆ ESpotDetector() [2/3]

◆ ~ESpotDetector()

◆ ESpotDetector() [3/3]

Member Function Documentation

◆ AddDetectedSpotsToDLProject() [1/5]

◆ AddDetectedSpotsToDLProject() [2/5]

◆ AddDetectedSpotsToDLProject() [3/5]

◆ AddDetectedSpotsToDLProject() [4/5]

◆ AddDetectedSpotsToDLProject() [5/5]

◆ Detect() [1/4]

◆ Detect() [2/4]

◆ Detect() [3/4]

◆ Detect() [4/4]

◆ Draw() [1/12]

◆ Draw() [2/12]

◆ Draw() [3/12]

◆ Draw() [4/12]

◆ Draw() [5/12]

◆ Draw() [6/12]

◆ Draw() [7/12]

◆ Draw() [8/12]

◆ Draw() [9/12]

◆ Draw() [10/12]

◆ Draw() [11/12]

◆ Draw() [12/12]

◆ GenerateSegmentationMap()

◆ GetAlignmentArea()

◆ GetAlignmentTolerance()

◆ GetDLClassifierPath()

◆ GetDLExecutionSettings()

◆ GetEnableAlignment()

◆ GetEnableParticleDetection()

◆ GetEnableScratchDetection()

◆ GetGuardBand()

◆ GetNumSpots()

◆ GetParticleDetectionParameters()

◆ GetScratchDetectionParameters()

◆ GetSourceROI()

◆ GetSpots()

◆ IsDLClassifierSet()

◆ Load() [1/2]

◆ Load() [2/2]

◆ operator=()

◆ operator==()

◆ Save() [1/2]

◆ Save() [2/2]

◆ SetAlignmentArea()

◆ SetAlignmentTolerance()

◆ SetDLClassifierPath()

◆ SetDLExecutionSettings()

◆ SetEnableAlignment()

◆ SetEnableParticleDetection()

◆ SetEnableScratchDetection()

◆ SetGuardBand()

◆ SetParticleDetectionParameters()

◆ SetScratchDetectionParameters()

◆ UnsetDLClassifier()

Member Data Documentation

◆ wrappedClass_