eVision.ESpotDetector Class Reference

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...

Inheritance diagram for eVision.ESpotDetector:

Collaboration diagram for eVision.ESpotDetector:

Public Member Functions
	ESpotDetector ()
	Constructs an ESpotDetector with default configuration.
	ESpotDetector (eVision.ESpotDetector other)
	Copy constructor for ESpotDetector.
void	Load (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 (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	GetParticleDetectionParameters (ref eVision.EParticleDetectionParameters parameters)
	Gets the particle detection parameters.
void	GetScratchDetectionParameters (ref eVision.EScratchDetectionParameters parameters)
	Gets the scratch detection parameters.
uint	Detect (eVision.EROIBW8 sourceImage)
	Performs the spot detection in the given EROIBW8. It returns the number of spot detected. Use ESpotDetector.Spots the retrieve the list of detected spots.
uint	Detect (eVision.EROIBW8 sourceImage, eVision.ERegion region)
	Performs the spot detection in the given EROIBW8. It returns the number of spot detected. Use ESpotDetector.Spots the retrieve the list of detected spots.
uint	Detect (eVision.EROIBW8 sourceImage, eVision.EFrame frame)
	Performs the spot detection in the given EROIBW8. It returns the number of spot detected. Use ESpotDetector.Spots the retrieve the list of detected spots.
uint	Detect (eVision.EROIBW8 sourceImage, eVision.ERegion region, eVision.EFrame frame)
	Performs the spot detection in the given EROIBW8. It returns the number of spot detected. Use ESpotDetector.Spots the retrieve the list of detected spots.
void	GenerateSegmentationMap (eVision.EImageBW8 map)
	Returns the last computed segmentation map.
void	Draw (eVision.EDrawAdapter drawAdapter, eVision.ERGBColor color, float zoomX, float zoomY, float panX, float panY)
	Draw the ESpotDetector.
void	Draw (eVision.EDrawAdapter drawAdapter, eVision.ERGBColor color, float zoomX, float zoomY, float panX)
	Draw the ESpotDetector.
void	Draw (eVision.EDrawAdapter drawAdapter, eVision.ERGBColor color, float zoomX, float zoomY)
	Draw the ESpotDetector.
void	Draw (eVision.EDrawAdapter drawAdapter, eVision.ERGBColor color, float zoomX)
	Draw the ESpotDetector.
void	Draw (eVision.EDrawAdapter drawAdapter, eVision.ERGBColor color)
	Draw the ESpotDetector.
void	Draw (eVision.EDrawAdapter drawAdapter)
	Draw the ESpotDetector.
void	Draw (IntPtr graphicContext, eVision.ERGBColor color, float zoomX, float zoomY, float panX, float panY)
	Draw the ESpotDetector.
void	Draw (IntPtr graphicContext, eVision.ERGBColor color, float zoomX, float zoomY, float panX)
	Draw the ESpotDetector.
void	Draw (IntPtr graphicContext, eVision.ERGBColor color, float zoomX, float zoomY)
	Draw the ESpotDetector.
void	Draw (IntPtr graphicContext, eVision.ERGBColor color, float zoomX)
	Draw the ESpotDetector.
void	Draw (IntPtr graphicContext, eVision.ERGBColor color)
	Draw the ESpotDetector.
void	Draw (IntPtr graphicContext)
	Draw the ESpotDetector.
uint	AddDetectedSpotsToDLProject (string projectPath, uint roiExtension, string imageName, uint noDefectSamples, 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.
uint	AddDetectedSpotsToDLProject (string projectPath, uint roiExtension, string imageName, uint 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.
uint	AddDetectedSpotsToDLProject (string projectPath, uint roiExtension, 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.
uint	AddDetectedSpotsToDLProject (string projectPath, uint 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.
uint	AddDetectedSpotsToDLProject (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	UnsetDLClassifier ()
	Disable the usage of the Deep Learning classifier.
bool	IsDLClassifierSet ()
	Returns True if a classifier has been loaded.
void	Draw (System.Drawing.Graphics graphicContext, eVision.ERGBColor color, float zoomX, float zoomY, float panX, float panY)
	Draw the ESpotDetector.
void	Draw (System.Drawing.Graphics graphicContext, eVision.ERGBColor color, float zoomX, float zoomY, float panX)
	Draw the ESpotDetector.
void	Draw (System.Drawing.Graphics graphicContext, eVision.ERGBColor color, float zoomX, float zoomY)
	Draw the ESpotDetector.
void	Draw (System.Drawing.Graphics graphicContext, eVision.ERGBColor color, float zoomX)
	Draw the ESpotDetector.
void	Draw (System.Drawing.Graphics graphicContext, eVision.ERGBColor color)
	Draw the ESpotDetector.
void	Draw (System.Drawing.Graphics graphicContext)
	Draw the ESpotDetector.

Properties
bool	EnableAlignment [get, set]
	Enables or disables the optional alignment process. The alignment area and the tolerance must be set as well, see ESpotDetector.AlignmentArea and ESpotDetector.AlignmentTolerance.
eVision.ERectangle	AlignmentArea [get, set]
	Sets/Gets an initial estimate of the rectangle on which spots will be detected in the image. The alignment process is enabled with ESpotDetector.EnableAlignment. To perform the alignment, a tolerance must be set as well, see ESpotDetector.AlignmentTolerance.
uint	AlignmentTolerance [get, set]
	Sets/Gets the tolerance around the initial estimate of the alignment area, in pixels. The default is 100 pixels. See also ESpotDetector.AlignmentArea.
eVision.EGuardBand	GuardBand [get, set]
	Sets/Gets the EGuardBand.
bool	EnableParticleDetection [get, set]
	Sets/Gets the particle detection processing.
bool	EnableScratchDetection [get, set]
	Sets/Gets the scratch detection processing.
eVision.EParticleDetectionParameters	ParticleDetectionParameters [set]
	Sets the particle detection parameters.
eVision.EScratchDetectionParameters	ScratchDetectionParameters [set]
	Sets the scratch detection parameters.
eVision.ESpot[]	Spots [get]
	Gets the spots detected by a previous call to ESpotDetector.Detect.
uint	NumSpots [get]
	Gets the number of spots detected by a previous call to ESpotDetector.Detect.
eVision.EROIBW8	SourceROI [get]
	Gets the last used Region Of Interest, after optionnal alignment and guard band clipping. No image is attached to that EROIBW8. See also ESpotDetector.EnableAlignment and ESpotDetector.GuardBand.
string	DLClassifierPath [get, set]
	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.
eVision.EasyDeepLearning.EDeepLearningExecutionSettings	DLExecutionSettings [get, set]
	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.

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

eVision.ESpotDetector.ESpotDetector

(

)

Constructs an ESpotDetector with default configuration.

ESpotDetector() [2/2]

eVision.ESpotDetector.ESpotDetector

(

eVision.ESpotDetector

other

)

Copy constructor for ESpotDetector.

Parameters

other

The other ESpotDetector that we will copy into this one.

Member Function Documentation

AddDetectedSpotsToDLProject() [1/5]

uint eVision.ESpotDetector.AddDetectedSpotsToDLProject

(

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]

uint eVision.ESpotDetector.AddDetectedSpotsToDLProject	(	string	projectPath,
		uint	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]

uint eVision.ESpotDetector.AddDetectedSpotsToDLProject	(	string	projectPath,
		uint	roiExtension,
		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]

uint eVision.ESpotDetector.AddDetectedSpotsToDLProject	(	string	projectPath,
		uint	roiExtension,
		string	imageName,
		uint	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]

uint eVision.ESpotDetector.AddDetectedSpotsToDLProject	(	string	projectPath,
		uint	roiExtension,
		string	imageName,
		uint	noDefectSamples,
		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]

uint eVision.ESpotDetector.Detect

(

eVision.EROIBW8

sourceImage

)

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

Parameters

sourceImage

The image in which the spots are detected.

Detect() [2/4]

uint eVision.ESpotDetector.Detect	(	eVision.EROIBW8	sourceImage,
		eVision.EFrame	frame )

Performs the spot detection in the given EROIBW8. It returns the number of spot detected. Use ESpotDetector.Spots 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]

uint eVision.ESpotDetector.Detect	(	eVision.EROIBW8	sourceImage,
		eVision.ERegion	region )

Performs the spot detection in the given EROIBW8. It returns the number of spot detected. Use ESpotDetector.Spots 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]

uint eVision.ESpotDetector.Detect	(	eVision.EROIBW8	sourceImage,
		eVision.ERegion	region,
		eVision.EFrame	frame )

Performs the spot detection in the given EROIBW8. It returns the number of spot detected. Use ESpotDetector.Spots 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/18]

void eVision.ESpotDetector.Draw

(

eVision.EDrawAdapter

drawAdapter

)

Draw the ESpotDetector.

Parameters

drawAdapter

EDrawAdapter that will be used to draw.

Draw() [2/18]

void eVision.ESpotDetector.Draw	(	eVision.EDrawAdapter	drawAdapter,
		eVision.ERGBColor	color )

Draw the ESpotDetector.

Parameters

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

Draw() [3/18]

void eVision.ESpotDetector.Draw	(	eVision.EDrawAdapter	drawAdapter,
		eVision.ERGBColor	color,
		float	zoomX )

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

void eVision.ESpotDetector.Draw	(	eVision.EDrawAdapter	drawAdapter,
		eVision.ERGBColor	color,
		float	zoomX,
		float	zoomY )

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

void eVision.ESpotDetector.Draw	(	eVision.EDrawAdapter	drawAdapter,
		eVision.ERGBColor	color,
		float	zoomX,
		float	zoomY,
		float	panX )

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

void eVision.ESpotDetector.Draw	(	eVision.EDrawAdapter	drawAdapter,
		eVision.ERGBColor	color,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

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

void eVision.ESpotDetector.Draw

(

IntPtr

graphicContext

)

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

void eVision.ESpotDetector.Draw	(	IntPtr	graphicContext,
		eVision.ERGBColor	color )

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

void eVision.ESpotDetector.Draw	(	IntPtr	graphicContext,
		eVision.ERGBColor	color,
		float	zoomX )

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

void eVision.ESpotDetector.Draw	(	IntPtr	graphicContext,
		eVision.ERGBColor	color,
		float	zoomX,
		float	zoomY )

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

void eVision.ESpotDetector.Draw	(	IntPtr	graphicContext,
		eVision.ERGBColor	color,
		float	zoomX,
		float	zoomY,
		float	panX )

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

void eVision.ESpotDetector.Draw	(	IntPtr	graphicContext,
		eVision.ERGBColor	color,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

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.

Draw() [13/18]

void eVision.ESpotDetector.Draw

(

System.Drawing.Graphics

graphicContext

)

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

void eVision.ESpotDetector.Draw	(	System.Drawing.Graphics	graphicContext,
		eVision.ERGBColor	color )

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

void eVision.ESpotDetector.Draw	(	System.Drawing.Graphics	graphicContext,
		eVision.ERGBColor	color,
		float	zoomX )

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

void eVision.ESpotDetector.Draw	(	System.Drawing.Graphics	graphicContext,
		eVision.ERGBColor	color,
		float	zoomX,
		float	zoomY )

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

void eVision.ESpotDetector.Draw	(	System.Drawing.Graphics	graphicContext,
		eVision.ERGBColor	color,
		float	zoomX,
		float	zoomY,
		float	panX )

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

void eVision.ESpotDetector.Draw	(	System.Drawing.Graphics	graphicContext,
		eVision.ERGBColor	color,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

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

)

Returns the last computed segmentation map.

Parameters

map	The destination image for the segmentation map.

GetParticleDetectionParameters()

void eVision.ESpotDetector.GetParticleDetectionParameters

(

ref eVision.EParticleDetectionParameters

parameters

)

Gets the particle detection parameters.

Parameters

parameters

From EParticleDetectionParameters.

GetScratchDetectionParameters()

void eVision.ESpotDetector.GetScratchDetectionParameters

(

ref eVision.EScratchDetectionParameters

parameters

)

Gets the scratch detection parameters.

Parameters

parameters

From EScratchDetectionParameters.

IsDLClassifierSet()

bool eVision.ESpotDetector.IsDLClassifierSet

(

)

Returns True if a classifier has been loaded.

See also ESpotDetector.DLClassifierPath and ESpotDetector.UnsetDLClassifier.

Load() [1/2]

void eVision.ESpotDetector.Load

(

eVision.ESerializer

serializer

)

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

Parameters

serializer

The serializer.

Load() [2/2]

void eVision.ESpotDetector.Load

(

string

path

)

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

Parameters

path	The file path.

Save() [1/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.

Save() [2/2]

void eVision.ESpotDetector.Save

(

string

path

)

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

Parameters

path	The file path.

UnsetDLClassifier()

void eVision.ESpotDetector.UnsetDLClassifier

(

)

Disable the usage of the Deep Learning classifier.

See also ESpotDetector.DLClassifierPath and ESpotDetector.IsDLClassifierSet.

Property Documentation

AlignmentArea

eVision.ERectangle eVision.ESpotDetector.AlignmentArea

getset

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

AlignmentTolerance

uint eVision.ESpotDetector.AlignmentTolerance

getset

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

DLClassifierPath

string eVision.ESpotDetector.DLClassifierPath

getset

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.

DLExecutionSettings

eVision.EasyDeepLearning.EDeepLearningExecutionSettings eVision.ESpotDetector.DLExecutionSettings

getset

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.

EnableAlignment

bool eVision.ESpotDetector.EnableAlignment

getset

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

EnableParticleDetection

bool eVision.ESpotDetector.EnableParticleDetection

getset

Sets/Gets the particle detection processing.

EnableScratchDetection

bool eVision.ESpotDetector.EnableScratchDetection

getset

Sets/Gets the scratch detection processing.

GuardBand

eVision.EGuardBand eVision.ESpotDetector.GuardBand

getset

Sets/Gets the EGuardBand.

NumSpots

uint eVision.ESpotDetector.NumSpots

get

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

ParticleDetectionParameters

eVision.EParticleDetectionParameters eVision.ESpotDetector.ParticleDetectionParameters

set

Sets the particle detection parameters.

ScratchDetectionParameters

eVision.EScratchDetectionParameters eVision.ESpotDetector.ScratchDetectionParameters

set

Sets the scratch detection parameters.

SourceROI

eVision.EROIBW8 eVision.ESpotDetector.SourceROI

get

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

Spots

eVision.ESpot [] eVision.ESpotDetector.Spots

get

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