The ESpot store information about the detections produced by 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 ERotatedBoundingBox. More...
#include <eVision/EasySpotDetector/ESpot.h>
Public Member Functions | |
| ESpot () | |
| Constructs an ESpot with default (invalid) values. | |
| ESpot (const eVision::ESpot &other) | |
| Copy constructor for ESpot. | |
| virtual | ~ESpot () throw () |
| eVision::ESpot & | operator= (const eVision::ESpot &other) |
| Assignment operator. | |
| bool | operator== (const eVision::ESpot &other) const |
| Check if two ESpot are identical. | |
| bool | operator!= (const eVision::ESpot &other) const |
| Check if two ESpot are different. | |
| eVision::ESpotType | GetType () const |
| Get the type of the spot, i.e. whether it is a ESpotType::ESpotType_Scratch or a ESpotType::ESpotType_Particle. | |
| eVision::ESpotPolarity | GetPolarity () const |
| Get the polarity of the spot, i.e. whether it is ESpotPolarity::ESpotPolarity_White, ESpotPolarity::ESpotPolarity_Black or ESpotPolarity::ESpotPolarity_Any. A Spot's polarity is the same as the polarity setting of the detector when the spot was detected. | |
| eVision::EPoint | GetCenter () const |
| Get the center point of the spot. | |
| float | GetWidth () const |
| Get the width of the bounding box of spot. | |
| float | GetHeight () const |
| Get the height of the bounding box of spot. | |
| uint32_t | GetArea () const |
| Get the area of the spot (in number of pixels). | |
| float | GetStrength () const |
| Get the strength of the spot (the average grey scale value over the local image background). | |
| const eVision::ERotatedBoundingBox & | GetBox () const |
| Returns the rotated rectangle representing the spot. | |
| const eVision::ERegion & | GetRegion () const |
| Returns the ERegion of the spot (the pixels composing the spot). | |
| eVision::EROIBW8 | GetROI () const |
| Returns the EROIBW8 of the spot (axis aligned bounding box). The returned ROI is not attached to an image. | |
| std::string | GetDLLabel () const |
| Returns the Deep Learning classification label. | |
| float | GetDLProbability () const |
| Returns the Deep Learning classification probability. | |
| void | Draw (eVision::EDrawAdapter *drawAdapter, float extension, const eVision::ERGBColor &color, float zoomX, float zoomY, float panX, float panY) const |
| Draw the ESpot. | |
| void | Draw (eVision::EDrawAdapter *drawAdapter, float extension, const eVision::ERGBColor &color, float zoomX, float zoomY, float panX) const |
| Draw the ESpot. | |
| void | Draw (eVision::EDrawAdapter *drawAdapter, float extension, const eVision::ERGBColor &color, float zoomX, float zoomY) const |
| Draw the ESpot. | |
| void | Draw (eVision::EDrawAdapter *drawAdapter, float extension, const eVision::ERGBColor &color, float zoomX) const |
| Draw the ESpot. | |
| void | Draw (eVision::EDrawAdapter *drawAdapter, float extension, const eVision::ERGBColor &color) const |
| Draw the ESpot. | |
| void | Draw (eVision::EDrawAdapter *drawAdapter, float extension) const |
| Draw the ESpot. | |
| void | Draw (eVision::EDrawAdapter *drawAdapter) const |
| Draw the ESpot. | |
| void | Draw (eVision::EDrawAdapter *drawAdapter, const eVision::EFrame &frame, float extension, const eVision::ERGBColor &color, float zoomX, float zoomY, float panX, float panY) const |
| Draw the ESpot. | |
| void | Draw (eVision::EDrawAdapter *drawAdapter, const eVision::EFrame &frame, float extension, const eVision::ERGBColor &color, float zoomX, float zoomY, float panX) const |
| Draw the ESpot. | |
| void | Draw (eVision::EDrawAdapter *drawAdapter, const eVision::EFrame &frame, float extension, const eVision::ERGBColor &color, float zoomX, float zoomY) const |
| Draw the ESpot. | |
| void | Draw (eVision::EDrawAdapter *drawAdapter, const eVision::EFrame &frame, float extension, const eVision::ERGBColor &color, float zoomX) const |
| Draw the ESpot. | |
| void | Draw (eVision::EDrawAdapter *drawAdapter, const eVision::EFrame &frame, float extension, const eVision::ERGBColor &color) const |
| Draw the ESpot. | |
| void | Draw (eVision::EDrawAdapter *drawAdapter, const eVision::EFrame &frame, float extension) const |
| Draw the ESpot. | |
| void | Draw (eVision::EDrawAdapter *drawAdapter, const eVision::EFrame &frame) const |
| Draw the ESpot. | |
| void | Draw (HDC graphicsContext, float extension, const eVision::ERGBColor &color, float zoomX, float zoomY, float panX, float panY) const |
| Draw the ESpot. | |
| void | Draw (HDC graphicsContext, float extension, const eVision::ERGBColor &color, float zoomX, float zoomY, float panX) const |
| Draw the ESpot. | |
| void | Draw (HDC graphicsContext, float extension, const eVision::ERGBColor &color, float zoomX, float zoomY) const |
| Draw the ESpot. | |
| void | Draw (HDC graphicsContext, float extension, const eVision::ERGBColor &color, float zoomX) const |
| Draw the ESpot. | |
| void | Draw (HDC graphicsContext, float extension, const eVision::ERGBColor &color) const |
| Draw the ESpot. | |
| void | Draw (HDC graphicsContext, float extension) const |
| Draw the ESpot. | |
| void | Draw (HDC graphicsContext) const |
| Draw the ESpot. | |
| void | Load (const std::string &path) |
| Loads the ESpot. The given ESerializer must have been created for reading. | |
| void | Load (eVision::ESerializer *serializer) |
| Loads the ESpot. The given ESerializer must have been created for reading. | |
| void | Save (const std::string &path) |
| Saves the ESpot. The given ESerializer must have been created for writing. | |
| void | Save (eVision::ESerializer *serializer) |
| Saves the ESpot. The given ESerializer must have been created for writing. | |
| eVision::ESpot | LocalToSensor (const eVision::EFrame &frame) |
| Transforms a spot from local to sensor coordinates. | |
| eVision::ESpot | SensorToLocal (const eVision::EFrame &frame) |
| Transforms a spot from sensor to local coordinates. | |
| ESpot (CppWrapperInternal::InternalConstructor) | |
Public Attributes | |
| CppWrapperInternal::WrappedClass | wrappedClass_ |
The ESpot store information about the detections produced by 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 ERotatedBoundingBox.
License(s): EasySpotDetector
| eVision::ESpot::ESpot | ( | ) |
Constructs an ESpot with default (invalid) values.
| eVision::ESpot::ESpot | ( | const eVision::ESpot & | other | ) |
|
virtual | ||||||||||||
| eVision::ESpot::ESpot | ( | CppWrapperInternal::InternalConstructor | ) |
| void eVision::ESpot::Draw | ( | eVision::EDrawAdapter * | drawAdapter | ) | const |
Draw the ESpot.
| drawAdapter | EDrawAdapter that will be used to draw. |
| void eVision::ESpot::Draw | ( | eVision::EDrawAdapter * | drawAdapter, |
| const eVision::EFrame & | frame ) const |
Draw the ESpot.
| drawAdapter | EDrawAdapter that will be used to draw. |
| frame | Frame associated with the spot. Usually, frame used to detect the spot. |
| void eVision::ESpot::Draw | ( | eVision::EDrawAdapter * | drawAdapter, |
| const eVision::EFrame & | frame, | ||
| float | extension ) const |
Draw the ESpot.
| drawAdapter | 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 ESpotType::ESpotType_Particle. |
| void eVision::ESpot::Draw | ( | eVision::EDrawAdapter * | drawAdapter, |
| const eVision::EFrame & | frame, | ||
| float | extension, | ||
| const eVision::ERGBColor & | color ) const |
Draw the ESpot.
| drawAdapter | 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 ESpotType::ESpotType_Particle. |
| color | Color of the draw rectangle. |
| void eVision::ESpot::Draw | ( | eVision::EDrawAdapter * | drawAdapter, |
| const eVision::EFrame & | frame, | ||
| float | extension, | ||
| const eVision::ERGBColor & | color, | ||
| float | zoomX ) const |
Draw the ESpot.
| drawAdapter | 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 ESpotType::ESpotType_Particle. |
| color | Color of the draw rectangle. |
| zoomX | Horizontal zooming factor. By default, true scale is used. |
| void eVision::ESpot::Draw | ( | eVision::EDrawAdapter * | drawAdapter, |
| const eVision::EFrame & | frame, | ||
| float | extension, | ||
| const eVision::ERGBColor & | color, | ||
| float | zoomX, | ||
| float | zoomY ) const |
Draw the ESpot.
| drawAdapter | 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 ESpotType::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. |
| void eVision::ESpot::Draw | ( | eVision::EDrawAdapter * | drawAdapter, |
| const eVision::EFrame & | frame, | ||
| float | extension, | ||
| const eVision::ERGBColor & | color, | ||
| float | zoomX, | ||
| float | zoomY, | ||
| float | panX ) const |
Draw the ESpot.
| drawAdapter | 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 ESpotType::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. |
| void eVision::ESpot::Draw | ( | eVision::EDrawAdapter * | drawAdapter, |
| const eVision::EFrame & | frame, | ||
| float | extension, | ||
| const eVision::ERGBColor & | color, | ||
| float | zoomX, | ||
| float | zoomY, | ||
| float | panX, | ||
| float | panY ) const |
Draw the ESpot.
| drawAdapter | 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 ESpotType::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. |
| void eVision::ESpot::Draw | ( | eVision::EDrawAdapter * | drawAdapter, |
| float | extension ) const |
Draw the ESpot.
| drawAdapter | EDrawAdapter that will be used to draw. |
| extension | Extension in pixels of the draw rectangle around the spot. Only used for ESpotType::ESpotType_Particle. |
| void eVision::ESpot::Draw | ( | eVision::EDrawAdapter * | drawAdapter, |
| float | extension, | ||
| const eVision::ERGBColor & | color ) const |
Draw the ESpot.
| drawAdapter | EDrawAdapter that will be used to draw. |
| extension | Extension in pixels of the draw rectangle around the spot. Only used for ESpotType::ESpotType_Particle. |
| color | Color of the draw rectangle. |
| void eVision::ESpot::Draw | ( | eVision::EDrawAdapter * | drawAdapter, |
| float | extension, | ||
| const eVision::ERGBColor & | color, | ||
| float | zoomX ) const |
Draw the ESpot.
| drawAdapter | EDrawAdapter that will be used to draw. |
| extension | Extension in pixels of the draw rectangle around the spot. Only used for ESpotType::ESpotType_Particle. |
| color | Color of the draw rectangle. |
| zoomX | Horizontal zooming factor. By default, true scale is used. |
| void eVision::ESpot::Draw | ( | eVision::EDrawAdapter * | drawAdapter, |
| float | extension, | ||
| const eVision::ERGBColor & | color, | ||
| float | zoomX, | ||
| float | zoomY ) const |
Draw the ESpot.
| drawAdapter | EDrawAdapter that will be used to draw. |
| extension | Extension in pixels of the draw rectangle around the spot. Only used for ESpotType::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. |
| void eVision::ESpot::Draw | ( | eVision::EDrawAdapter * | drawAdapter, |
| float | extension, | ||
| const eVision::ERGBColor & | color, | ||
| float | zoomX, | ||
| float | zoomY, | ||
| float | panX ) const |
Draw the ESpot.
| drawAdapter | EDrawAdapter that will be used to draw. |
| extension | Extension in pixels of the draw rectangle around the spot. Only used for ESpotType::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. |
| void eVision::ESpot::Draw | ( | eVision::EDrawAdapter * | drawAdapter, |
| float | extension, | ||
| const eVision::ERGBColor & | color, | ||
| float | zoomX, | ||
| float | zoomY, | ||
| float | panX, | ||
| float | panY ) const |
Draw the ESpot.
| drawAdapter | EDrawAdapter that will be used to draw. |
| extension | Extension in pixels of the draw rectangle around the spot. Only used for ESpotType::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. |
| void eVision::ESpot::Draw | ( | HDC | graphicsContext | ) | const |
Draw the ESpot.
| graphicsContext | Handle of the graphics context on which to draw. |
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.
| void eVision::ESpot::Draw | ( | HDC | graphicsContext, |
| float | extension ) const |
Draw the ESpot.
| graphicsContext | Handle of the graphics context on which to draw. |
| extension | Extension in pixels of the draw rectangle around the spot. Only used for ESpotType::ESpotType_Particle. |
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.
| void eVision::ESpot::Draw | ( | HDC | graphicsContext, |
| float | extension, | ||
| const eVision::ERGBColor & | color ) const |
Draw the ESpot.
| graphicsContext | Handle of the graphics context on which to draw. |
| extension | Extension in pixels of the draw rectangle around the spot. Only used for ESpotType::ESpotType_Particle. |
| color | Color of the draw rectangle. |
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.
| void eVision::ESpot::Draw | ( | HDC | graphicsContext, |
| float | extension, | ||
| const eVision::ERGBColor & | color, | ||
| float | zoomX ) const |
Draw the ESpot.
| graphicsContext | Handle of the graphics context on which to draw. |
| extension | Extension in pixels of the draw rectangle around the spot. Only used for ESpotType::ESpotType_Particle. |
| color | Color of the draw rectangle. |
| zoomX | Horizontal zooming factor. By default, true scale is used. |
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.
| void eVision::ESpot::Draw | ( | HDC | graphicsContext, |
| float | extension, | ||
| const eVision::ERGBColor & | color, | ||
| float | zoomX, | ||
| float | zoomY ) const |
Draw the ESpot.
| graphicsContext | Handle of the graphics context on which to draw. |
| extension | Extension in pixels of the draw rectangle around the spot. Only used for ESpotType::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. |
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.
| void eVision::ESpot::Draw | ( | HDC | graphicsContext, |
| float | extension, | ||
| const eVision::ERGBColor & | color, | ||
| float | zoomX, | ||
| float | zoomY, | ||
| float | panX ) const |
Draw the ESpot.
| graphicsContext | Handle of the graphics context on which to draw. |
| extension | Extension in pixels of the draw rectangle around the spot. Only used for ESpotType::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. |
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.
| void eVision::ESpot::Draw | ( | HDC | graphicsContext, |
| float | extension, | ||
| const eVision::ERGBColor & | color, | ||
| float | zoomX, | ||
| float | zoomY, | ||
| float | panX, | ||
| float | panY ) const |
Draw the ESpot.
| graphicsContext | Handle of the graphics context on which to draw. |
| extension | Extension in pixels of the draw rectangle around the spot. Only used for ESpotType::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. |
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.
| uint32_t eVision::ESpot::GetArea | ( | ) | const |
Get the area of the spot (in number of pixels).
| const eVision::ERotatedBoundingBox & eVision::ESpot::GetBox | ( | ) | const |
Returns the rotated rectangle representing the spot.
| eVision::EPoint eVision::ESpot::GetCenter | ( | ) | const |
Get the center point of the spot.
| std::string eVision::ESpot::GetDLLabel | ( | ) | const |
Returns the Deep Learning classification label.
This information is available when the Deep Learning classification has been activated by ESpotDetector::SetDLClassifierPath. See also ESpot::GetDLProbability.
| float eVision::ESpot::GetDLProbability | ( | ) | const |
Returns the Deep Learning classification probability.
This information is available when the Deep Learning classification has been activated by ESpotDetector::SetDLClassifierPath. See also ESpot::GetDLLabel.
| float eVision::ESpot::GetHeight | ( | ) | const |
Get the height of the bounding box of spot.
| eVision::ESpotPolarity eVision::ESpot::GetPolarity | ( | ) | const |
Get the polarity of the spot, i.e. whether it is ESpotPolarity::ESpotPolarity_White, ESpotPolarity::ESpotPolarity_Black or ESpotPolarity::ESpotPolarity_Any. A Spot's polarity is the same as the polarity setting of the detector when the spot was detected.
| const eVision::ERegion & eVision::ESpot::GetRegion | ( | ) | const |
Returns the ERegion of the spot (the pixels composing the spot).
| eVision::EROIBW8 eVision::ESpot::GetROI | ( | ) | const |
Returns the EROIBW8 of the spot (axis aligned bounding box). The returned ROI is not attached to an image.
| float eVision::ESpot::GetStrength | ( | ) | const |
Get the strength of the spot (the average grey scale value over the local image background).
| eVision::ESpotType eVision::ESpot::GetType | ( | ) | const |
Get the type of the spot, i.e. whether it is a ESpotType::ESpotType_Scratch or a ESpotType::ESpotType_Particle.
| float eVision::ESpot::GetWidth | ( | ) | const |
Get the width of the bounding box of spot.
| void eVision::ESpot::Load | ( | const std::string & | path | ) |
Loads the ESpot. The given ESerializer must have been created for reading.
| path | The file path. |
| void eVision::ESpot::Load | ( | eVision::ESerializer * | serializer | ) |
Loads the ESpot. The given ESerializer must have been created for reading.
| serializer | The serializer. |
| eVision::ESpot eVision::ESpot::LocalToSensor | ( | const eVision::EFrame & | frame | ) |
Transforms a spot from local to sensor coordinates.
| frame | Reference frame in which the region is defined. |
| bool eVision::ESpot::operator!= | ( | const eVision::ESpot & | other | ) | const |
Check if two ESpot are different.
| other | The other object. |
| eVision::ESpot & eVision::ESpot::operator= | ( | const eVision::ESpot & | other | ) |
Assignment operator.
| other | The other ESpot that we will copy into this one. |
| bool eVision::ESpot::operator== | ( | const eVision::ESpot & | other | ) | const |
Check if two ESpot are identical.
| other | The other object. |
| void eVision::ESpot::Save | ( | const std::string & | path | ) |
Saves the ESpot. The given ESerializer must have been created for writing.
| path | The file path. |
| void eVision::ESpot::Save | ( | eVision::ESerializer * | serializer | ) |
Saves the ESpot. The given ESerializer must have been created for writing.
| serializer | The ESerializer object that is written to. |
| eVision::ESpot eVision::ESpot::SensorToLocal | ( | const eVision::EFrame & | frame | ) |
Transforms a spot from sensor to local coordinates.
| frame | Reference frame in which the region is defined. |
| CppWrapperInternal::WrappedClass eVision::ESpot::wrappedClass_ |