The eVision.ESpot store information about the detections produced by eVision.ESpotDetector. More...

Public Member Functions
None	__init__ (self)
	Constructs an eVision.ESpot with default (invalid) values.
None	__init__ (self, eVision.ESpot other)
	Copy constructor for eVision.ESpot.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter, float extension, eVision.ERGBColor color, float zoomX, float zoomY, float panX, float panY)
	Draw the eVision.ESpot.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter, float extension, eVision.ERGBColor color, float zoomX, float zoomY, float panX)
	Draw the eVision.ESpot.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter, float extension, eVision.ERGBColor color, float zoomX, float zoomY)
	Draw the eVision.ESpot.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter, float extension, eVision.ERGBColor color, float zoomX)
	Draw the eVision.ESpot.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter, float extension, eVision.ERGBColor color)
	Draw the eVision.ESpot.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter, float extension)
	Draw the eVision.ESpot.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter)
	Draw the eVision.ESpot.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter, eVision.EFrame frame, float extension, eVision.ERGBColor color, float zoomX, float zoomY, float panX, float panY)
	Draw the eVision.ESpot.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter, eVision.EFrame frame, float extension, eVision.ERGBColor color, float zoomX, float zoomY, float panX)
	Draw the eVision.ESpot.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter, eVision.EFrame frame, float extension, eVision.ERGBColor color, float zoomX, float zoomY)
	Draw the eVision.ESpot.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter, eVision.EFrame frame, float extension, eVision.ERGBColor color, float zoomX)
	Draw the eVision.ESpot.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter, eVision.EFrame frame, float extension, eVision.ERGBColor color)
	Draw the eVision.ESpot.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter, eVision.EFrame frame, float extension)
	Draw the eVision.ESpot.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter, eVision.EFrame frame)
	Draw the eVision.ESpot.
None	Load (self, str path)
	Loads the eVision.ESpot.
None	Load (self, eVision.ESerializer\|None serializer)
	Loads the eVision.ESpot.
None	Save (self, str path)
	Saves the eVision.ESpot.
None	Save (self, eVision.ESerializer\|None serializer)
	Saves the eVision.ESpot.
eVision.ESpot	LocalToSensor (self, eVision.EFrame frame)
	Transforms a spot from local to sensor coordinates.
eVision.ESpot	SensorToLocal (self, eVision.EFrame frame)
	Transforms a spot from sensor to local coordinates.
eVision.ESpotType	Type (self)
	Get the type of the spot, i.e.
eVision.ESpotPolarity	Polarity (self)
	Get the polarity of the spot, i.e.
eVision.EPoint	Center (self)
	Get the center point of the spot.
float	Width (self)
	Get the width of the bounding box of spot.
float	Height (self)
	Get the height of the bounding box of spot.
int	Area (self)
	Get the area of the spot (in number of pixels).
float	Strength (self)
	Get the strength of the spot (the average grey scale value over the local image background).
eVision.ERotatedBoundingBox	Box (self)
	Returns the rotated rectangle representing the spot.
eVision.ERegion	Region (self)
	Returns the eVision.ERegion of the spot (the pixels composing the spot).
eVision.EROIBW8	ROI (self)
	Returns the eVision.EROIBW8 of the spot (axis aligned bounding box).
str	DLLabel (self)
	Returns the Deep Learning classification label.
float	DLProbability (self)
	Returns the Deep Learning classification probability.

Detailed Description

The eVision.ESpot store information about the detections produced by eVision.ESpotDetector.

A spot is defined by a type (particle or scratch), a polarity (black or white) and a geometry. The geometry is an arbitrary rectangle, represented by a eVision.ERotatedBoundingBox.

Remarks:

License(s): EasySpotDetector

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

Constructor & Destructor Documentation

◆ init() [1/2]

None eVision.ESpot.__init__ ( self )

Constructs an eVision.ESpot with default (invalid) values.

◆ init() [2/2]

None eVision.ESpot.__init__	(		self,
		eVision.ESpot	other )

Copy constructor for eVision.ESpot.

Parameters

other The other eVision.ESpot that we will copy into this one.

Member Function Documentation

◆ Area()

int eVision.ESpot.Area ( self )

Get the area of the spot (in number of pixels).

◆ Box()

eVision.ERotatedBoundingBox eVision.ESpot.Box ( self )

Returns the rotated rectangle representing the spot.

◆ Center()

eVision.EPoint eVision.ESpot.Center ( self )

Get the center point of the spot.

◆ DLLabel()

str eVision.ESpot.DLLabel ( self )

Returns the Deep Learning classification label.

This information is available when the Deep Learning classification has been activated by eVision.ESpotDetector.DLClassifierPath. See also eVision.ESpot.DLProbability.

◆ DLProbability()

float eVision.ESpot.DLProbability ( self )

Returns the Deep Learning classification probability.

This information is available when the Deep Learning classification has been activated by eVision.ESpotDetector.DLClassifierPath. See also eVision.ESpot.DLLabel.

◆ Draw() [1/14]

None eVision.ESpot.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter )

Draw the eVision.ESpot.

Parameters

drawAdapter eVision.EDrawAdapter that will be used to draw.

◆ Draw() [2/14]

None eVision.ESpot.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter,
		eVision.EFrame	frame )

Draw the eVision.ESpot.

Parameters

drawAdapter	eVision.EDrawAdapter that will be used to draw.
frame	Frame associated with the spot. Usually, frame used to detect the spot.

◆ Draw() [3/14]

None eVision.ESpot.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter,
		eVision.EFrame	frame,
		float	extension )

Draw the eVision.ESpot.

Parameters

drawAdapter	eVision.EDrawAdapter that will be used to draw.
frame	Frame associated with the spot. Usually, frame used to detect the spot.
extension	Extension in pixels of the draw rectangle around the spot. Only used for eVision.ESpotType.Particle.

◆ Draw() [4/14]

None eVision.ESpot.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter,
		eVision.EFrame	frame,
		float	extension,
		eVision.ERGBColor	color )

Draw the eVision.ESpot.

Parameters

drawAdapter	eVision.EDrawAdapter that will be used to draw.
frame	Frame associated with the spot. Usually, frame used to detect the spot.
extension	Extension in pixels of the draw rectangle around the spot. Only used for eVision.ESpotType.Particle.
color	Color of the draw rectangle.

◆ Draw() [5/14]

None eVision.ESpot.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter,
		eVision.EFrame	frame,
		float	extension,
		eVision.ERGBColor	color,
		float	zoomX )

Draw the eVision.ESpot.

Parameters

drawAdapter	eVision.EDrawAdapter that will be used to draw.
frame	Frame associated with the spot. Usually, frame used to detect the spot.
extension	Extension in pixels of the draw rectangle around the spot. Only used for eVision.ESpotType.Particle.
color	Color of the draw rectangle.
zoomX	Horizontal zooming factor. By default, true scale is used.

◆ Draw() [6/14]

None eVision.ESpot.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter,
		eVision.EFrame	frame,
		float	extension,
		eVision.ERGBColor	color,
		float	zoomX,
		float	zoomY )

Draw the eVision.ESpot.

Parameters

drawAdapter	eVision.EDrawAdapter that will be used to draw.
frame	Frame associated with the spot. Usually, frame used to detect the spot.
extension	Extension in pixels of the draw rectangle around the spot. Only used for eVision.ESpotType.Particle.
color	Color of the draw 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() [7/14]

None eVision.ESpot.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter,
		eVision.EFrame	frame,
		float	extension,
		eVision.ERGBColor	color,
		float	zoomX,
		float	zoomY,
		float	panX )

Draw the eVision.ESpot.

Parameters

drawAdapter	eVision.EDrawAdapter that will be used to draw.
frame	Frame associated with the spot. Usually, frame used to detect the spot.
extension	Extension in pixels of the draw rectangle around the spot. Only used for eVision.ESpotType.Particle.
color	Color of the draw 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() [8/14]

None eVision.ESpot.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter,
		eVision.EFrame	frame,
		float	extension,
		eVision.ERGBColor	color,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draw the eVision.ESpot.

Parameters

drawAdapter	eVision.EDrawAdapter that will be used to draw.
frame	Frame associated with the spot. Usually, frame used to detect the spot.
extension	Extension in pixels of the draw rectangle around the spot. Only used for eVision.ESpotType.Particle.
color	Color of the draw 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() [9/14]

None eVision.ESpot.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter,
		float	extension )

Draw the eVision.ESpot.

Parameters

drawAdapter	eVision.EDrawAdapter that will be used to draw.
extension	Extension in pixels of the draw rectangle around the spot. Only used for eVision.ESpotType.Particle.

◆ Draw() [10/14]

None eVision.ESpot.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter,
		float	extension,
		eVision.ERGBColor	color )

Draw the eVision.ESpot.

Parameters

drawAdapter	eVision.EDrawAdapter that will be used to draw.
extension	Extension in pixels of the draw rectangle around the spot. Only used for eVision.ESpotType.Particle.
color	Color of the draw rectangle.

◆ Draw() [11/14]

None eVision.ESpot.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter,
		float	extension,
		eVision.ERGBColor	color,
		float	zoomX )

Draw the eVision.ESpot.

Parameters

drawAdapter	eVision.EDrawAdapter that will be used to draw.
extension	Extension in pixels of the draw rectangle around the spot. Only used for eVision.ESpotType.Particle.
color	Color of the draw rectangle.
zoomX	Horizontal zooming factor. By default, true scale is used.

◆ Draw() [12/14]

None eVision.ESpot.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter,
		float	extension,
		eVision.ERGBColor	color,
		float	zoomX,
		float	zoomY )

Draw the eVision.ESpot.

Parameters

drawAdapter	eVision.EDrawAdapter that will be used to draw.
extension	Extension in pixels of the draw rectangle around the spot. Only used for eVision.ESpotType.Particle.
color	Color of the draw 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() [13/14]

None eVision.ESpot.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter,
		float	extension,
		eVision.ERGBColor	color,
		float	zoomX,
		float	zoomY,
		float	panX )

Draw the eVision.ESpot.

Parameters

drawAdapter	eVision.EDrawAdapter that will be used to draw.
extension	Extension in pixels of the draw rectangle around the spot. Only used for eVision.ESpotType.Particle.
color	Color of the draw 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() [14/14]

None eVision.ESpot.Draw	(		self,
		eVision.EDrawAdapter \| None	drawAdapter,
		float	extension,
		eVision.ERGBColor	color,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draw the eVision.ESpot.

Parameters

drawAdapter	eVision.EDrawAdapter that will be used to draw.
extension	Extension in pixels of the draw rectangle around the spot. Only used for eVision.ESpotType.Particle.
color	Color of the draw 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.

◆ Height()

float eVision.ESpot.Height ( self )

Get the height of the bounding box of spot.

◆ Load() [1/2]

None eVision.ESpot.Load	(		self,
		eVision.ESerializer \| None	serializer )

Loads the eVision.ESpot.

The given eVision.ESerializer must have been created for reading.

Parameters

serializer The serializer.

◆ Load() [2/2]

None eVision.ESpot.Load	(		self,
		str	path )

Loads the eVision.ESpot.

The given eVision.ESerializer must have been created for reading.

Parameters

path	The file path.

◆ LocalToSensor()

eVision.ESpot eVision.ESpot.LocalToSensor	(		self,
		eVision.EFrame	frame )

Transforms a spot from local to sensor coordinates.

Parameters

frame Reference frame in which the region is defined.

◆ Polarity()

eVision.ESpotPolarity eVision.ESpot.Polarity ( self )

Get the polarity of the spot, i.e.

whether it is eVision.ESpotPolarity.White, eVision.ESpotPolarity.Black or eVision.ESpotPolarity.Any. A Spot's polarity is the same as the polarity setting of the detector when the spot was detected.

◆ Region()

eVision.ERegion eVision.ESpot.Region ( self )

Returns the eVision.ERegion of the spot (the pixels composing the spot).

◆ ROI()

eVision.EROIBW8 eVision.ESpot.ROI ( self )

Returns the eVision.EROIBW8 of the spot (axis aligned bounding box).

The returned ROI is not attached to an image.

◆ Save() [1/2]

None eVision.ESpot.Save	(		self,
		eVision.ESerializer \| None	serializer )

Saves the eVision.ESpot.

The given eVision.ESerializer must have been created for writing.

Parameters

serializer The eVision.ESerializer object that is written to.

◆ Save() [2/2]

None eVision.ESpot.Save	(		self,
		str	path )

Saves the eVision.ESpot.

The given eVision.ESerializer must have been created for writing.

Parameters

path	The file path.

◆ SensorToLocal()

eVision.ESpot eVision.ESpot.SensorToLocal	(		self,
		eVision.EFrame	frame )

Transforms a spot from sensor to local coordinates.

Parameters

frame Reference frame in which the region is defined.

◆ Strength()

float eVision.ESpot.Strength ( self )

Get the strength of the spot (the average grey scale value over the local image background).

◆ Type()

eVision.ESpotType eVision.ESpot.Type ( self )

Get the type of the spot, i.e.

whether it is a eVision.ESpotType.Scratch or a eVision.ESpotType.Particle.

◆ Width()

float eVision.ESpot.Width ( self )

Get the width of the bounding box of spot.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/2]

◆ __init__() [2/2]

Member Function Documentation

◆ Area()

◆ Box()

◆ Center()

◆ DLLabel()

◆ DLProbability()

◆ Draw() [1/14]

◆ Draw() [2/14]

◆ Draw() [3/14]

◆ Draw() [4/14]

◆ Draw() [5/14]

◆ Draw() [6/14]

◆ Draw() [7/14]

◆ Draw() [8/14]

◆ Draw() [9/14]

◆ Draw() [10/14]

◆ Draw() [11/14]

◆ Draw() [12/14]

◆ Draw() [13/14]

◆ Draw() [14/14]

◆ Height()

◆ Load() [1/2]

◆ Load() [2/2]

◆ LocalToSensor()

◆ Polarity()

◆ Region()

◆ ROI()

◆ Save() [1/2]

◆ Save() [2/2]

◆ SensorToLocal()

◆ Strength()

◆ Type()

◆ Width()

◆ init() [1/2]

◆ init() [2/2]