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

Manages a point location gauge. More...

#include <eVision/EasyGauge/Legacy/EPointGauge.h>

Inheritance diagram for eVision::Legacy::EPointGauge:
Collaboration diagram for eVision::Legacy::EPointGauge:

Public Member Functions

 EPointGauge ()
 Constructs a point measurement context.
 EPointGauge (float centerX, float centerY)
 Constructs a point measurement context.
 EPointGauge (const eVision::Legacy::EPointGauge &other)
 Constructs a point measurement context.
virtual ~EPointGauge () throw ()
eVision::Legacy::EPointGauge & operator= (const eVision::Legacy::EPointGauge &other)
 Copies all the data from another EPointGauge object into the current EPointGauge object.
void SetTolerances (float tolerance, float angle)
 Sets the half length and the rotation angle of the point location gauge.
void SetTolerances (float tolerance)
 Sets the half length and the rotation angle of the point location gauge.
void SetTolerance (float tolerance)
 Half length of the point location gauge.
float GetTolerance ()
 Half length of the point location gauge.
void SetToleranceAngle (float toleranceAngle)
 Rotation angle of the point location gauge.
float GetToleranceAngle () const
 Rotation angle of the point location gauge.
bool GetHVConstraint () const
 Status of the restriction on the orientation of the point location gauge or model fitting sample paths.
void SetHVConstraint (bool bHVConstraint)
 Status of the restriction on the orientation of the point location gauge or model fitting sample paths.
uint32_t GetThickness () const
 Number of parallel segments used to extract the data profile.
void SetThickness (uint32_t un32Thickness)
 Number of parallel segments used to extract the data profile.
uint32_t GetSmoothing () const
 Number of pixels used for the low-pass filtering operation.
void SetSmoothing (uint32_t un32Smoothing)
 Number of pixels used for the low-pass filtering operation.
eVision::ETransitionType GetTransitionType () const
 Transition type.
void SetTransitionType (eVision::ETransitionType eTransitionType)
 Transition type.
eVision::ETransitionChoice GetTransitionChoice () const
 Transition choice.
void SetTransitionChoice (eVision::ETransitionChoice eTransitionChoice)
 Transition choice.
uint32_t GetTransitionIndex () const
 Index (from 0 on) of the transition to be retained when the transition choice parameter is set to ETransitionChoice::ETransitionChoice_NthFromBegin or ETransitionChoice::ETransitionChoice_NthFromEnd.
void SetTransitionIndex (uint32_t un32TransitionIndex)
 Index (from 0 on) of the transition to be retained when the transition choice parameter is set to ETransitionChoice::ETransitionChoice_NthFromBegin or ETransitionChoice::ETransitionChoice_NthFromEnd.
uint32_t GetThreshold () const
 Threshold level used to delimit significant peaks in the data profile.
void SetThreshold (uint32_t un32Threshold)
 Threshold level used to delimit significant peaks in the data profile.
uint32_t GetMinAmplitude () const
 Offset added to the Threshold when a peak is to be detected.
void SetMinAmplitude (uint32_t un32MinAmplitude)
 Offset added to the Threshold when a peak is to be detected.
uint32_t GetMinArea () const
 Minimum area value.
void SetMinArea (uint32_t un32MinArea)
 Minimum area value.
uint32_t GetNumMeasuredPoints () const
 Number of edge-crossing points along the point location gauge.
eVision::EPeak GetMeasuredPeak (uint32_t index) const
 Returns information pertaining to the derivative peak associated with the specified edge-crossing point, such as its area, amplitude, start, length and center.
eVision::EPeak GetMeasuredPeak () const
 Returns information pertaining to the derivative peak associated with the specified edge-crossing point, such as its area, amplitude, start, length and center.
std::vector< eVision::EPeak > GetMeasuredPeaks () const
 Returns information pertaining to the derivative peak associated with all of the edge-crossing point, such as its area, amplitude, start, length and center.
bool GetValid () const
 Flag indicating if at least one valid transition has been found.
void Plot (eVision::EDrawAdapter *graphicContext, eVision::EPlotItem drawItems, float width, float height, float originX, float originY)
 Draws the profile that is crossed by a point location gauge, as defined by EPlotItem.
void Plot (eVision::EDrawAdapter *graphicContext, eVision::EPlotItem drawItems, float width, float height, float originX)
 Draws the profile that is crossed by a point location gauge, as defined by EPlotItem.
void Plot (eVision::EDrawAdapter *graphicContext, eVision::EPlotItem drawItems, float width, float height)
 Draws the profile that is crossed by a point location gauge, as defined by EPlotItem.
void Plot (HDC graphicContext, eVision::EPlotItem drawItems, float width, float height, float originX, float originY)
 Draws the profile that is crossed by a point location gauge, as defined by EPlotItem.
void Plot (HDC graphicContext, eVision::EPlotItem drawItems, float width, float height, float originX)
 Draws the profile that is crossed by a point location gauge, as defined by EPlotItem.
void Plot (HDC graphicContext, eVision::EPlotItem drawItems, float width, float height)
 Draws the profile that is crossed by a point location gauge, as defined by EPlotItem.
void Plot (HDC graphicContext, const eVision::ERGBColor &color, eVision::EPlotItem drawItems, float width, float height, float originX, float originY)
 Draws the profile that is crossed by a point location gauge, as defined by EPlotItem.
void Plot (HDC graphicContext, const eVision::ERGBColor &color, eVision::EPlotItem drawItems, float width, float height, float originX)
 Draws the profile that is crossed by a point location gauge, as defined by EPlotItem.
void Plot (HDC graphicContext, const eVision::ERGBColor &color, eVision::EPlotItem drawItems, float width, float height)
 Draws the profile that is crossed by a point location gauge, as defined by EPlotItem.
void PlotWithCurrentPen (HDC graphicContext, eVision::EPlotItem drawItems, float width, float height, float originX, float originY)
 Draws the profile that is crossed by a point location gauge, as defined by EPlotItem.
void PlotWithCurrentPen (HDC graphicContext, eVision::EPlotItem drawItems, float width, float height, float originX)
 Draws the profile that is crossed by a point location gauge, as defined by EPlotItem.
void PlotWithCurrentPen (HDC graphicContext, eVision::EPlotItem drawItems, float width, float height)
 Draws the profile that is crossed by a point location gauge, as defined by EPlotItem.
void CopyTo (eVision::Legacy::EPointGauge &other, bool recursive) const
 Copies all the data of the current EPointGauge object into another EPointGauge object, and returns it.
void CopyTo (eVision::Legacy::EPointGauge &other) const
 Copies all the data of the current EPointGauge object into another EPointGauge object, and returns it.
eVision::Legacy::EPointGauge * CopyTo (eVision::Legacy::EPointGauge *other, bool recursive) const
 Copies all the data of the current EPointGauge object into another EPointGauge object, and returns it.
eVision::EPoint GetShape ()
virtual void SetCenter (const eVision::EPoint &center)
 Center coordinates of a EPointGauge object.
virtual void SetCenterXY (float centerX, float centerY)
 Sets the center coordinates of a EPointGauge object.
bool GetActive ()
 Sets the flag indicating whether the gauge is active or not.
virtual void SetActive (bool active)
 Sets the flag indicating whether the gauge is active or not.
bool GetRectangularSamplingArea ()
 Flag indicating whether the sampling area remains a rectangle when rotated, instead of becoming a parallelogram.
void SetRectangularSamplingArea (bool bRectangularSamplingArea)
 Flag indicating whether the sampling area remains a rectangle when rotated, instead of becoming a parallelogram.
void Measure (eVision::EROIBW8 *sourceImage)
 Triggers the point location or the model fitting operation.
void Measure (eVision::EROIBW8 *sourceImage, const eVision::ERegion &region)
 Triggers the point location or the model fitting operation.
virtual void Process (eVision::EROIBW8 *sourceImage, bool daughters)
 Triggers the process pertaining to a shape or gauge and all the daughter gauges attach to it.
virtual void Process (eVision::EROIBW8 *sourceImage)
 Triggers the process pertaining to a shape or gauge and all the daughter gauges attach to it.
virtual void Process (eVision::EROIBW8 *sourceImage, const eVision::ERegion &region, bool daughters)
 Triggers the process pertaining to a shape or gauge and all the daughter gauges attach to it.
virtual void Process (eVision::EROIBW8 *sourceImage, const eVision::ERegion &region)
 Triggers the process pertaining to a shape or gauge and all the daughter gauges attach to it.
eVision::EPoint GetMeasuredPoint (uint32_t index)
 Returns the coordinates of an edge-crossing point, measured along the unique sample path of the point location gauge.
eVision::EPoint GetMeasuredPoint ()
 Returns the coordinates of an edge-crossing point, measured along the unique sample path of the point location gauge.
std::vector< eVision::EPoint > GetMeasuredPoints () const
 Returns the coordinates of all edge-crossing points, measured along the unique sample path of the point location gauge.
virtual eVision::EShapeType GetType () const
 Shape type.
virtual void Draw (eVision::EDrawAdapter *drawAdapter, eVision::EDrawingMode drawingMode, bool daughters)
 Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.
virtual void Draw (eVision::EDrawAdapter *drawAdapter, eVision::EDrawingMode drawingMode)
 Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.
virtual void Draw (eVision::EDrawAdapter *drawAdapter)
 Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.
virtual void Draw (HDC graphicContext, eVision::EDrawingMode drawingMode, bool daughters)
 Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.
virtual void Draw (HDC graphicContext, eVision::EDrawingMode drawingMode)
 Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.
virtual void Draw (HDC graphicContext)
 Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.
virtual void Draw (HDC graphicContext, const eVision::ERGBColor &color, eVision::EDrawingMode drawingMode, bool daughters)
 Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.
virtual void Draw (HDC graphicContext, const eVision::ERGBColor &color, eVision::EDrawingMode drawingMode)
 Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.
virtual void Draw (HDC graphicContext, const eVision::ERGBColor &color)
 Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.
virtual void DrawWithCurrentPen (HDC graphicContext, eVision::EDrawingMode drawingMode, bool daughters)
 Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.
virtual void DrawWithCurrentPen (HDC graphicContext, eVision::EDrawingMode drawingMode)
 Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.
virtual void DrawWithCurrentPen (HDC graphicContext)
 Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.
virtual bool HitTest (bool daughters)
 Checks whether the cursor is positioned over a handle (true) or not (false).
virtual bool HitTest ()
 Checks whether the cursor is positioned over a handle (true) or not (false).
virtual void Drag (int32_t x, int32_t y)
 Moves a handle to a new position and updates the position parameters of the gauge.
 EPointGauge (CppWrapperInternal::InternalConstructor)
Public Member Functions inherited from eVision::Legacy::EPointShape
virtual ~EPointShape () throw ()
bool operator== (const eVision::Legacy::EPointShape &other) const
 Compares the instance another EPointShape object and returns true if they are identical.
bool operator!= (const eVision::Legacy::EPointShape &other) const
 Compares the instance another EPointShape object and returns true if they are not identical.
eVision::Legacy::EPointShape & operator= (const eVision::Legacy::EPointShape &other)
 Copies all the data from another EPointShape object into the current EPointShape object.
virtual eVision::EPoint GetCenter () const
 Center coordinates of a EPointShape object.
float GetCenterX () const
 Abscissa of the origin point of the frame.
float GetCenterY () const
 Ordinate of the origin point of the frame.
void SetScale (float scale)
float GetScale () const
void SetAngle (float angle)
float GetAngle () const
void CopyTo (eVision::Legacy::EPointShape &other, bool recursive) const
 Copies all the data of the current EPointShape object into another EPointShape object, and returns it.
void CopyTo (eVision::Legacy::EPointShape &other) const
 Copies all the data of the current EPointShape object into another EPointShape object, and returns it.
eVision::Legacy::EPointShape * CopyTo (eVision::Legacy::EPointShape *other, bool recursive) const
 Copies all the data of the current EPointShape object into another EPointShape object, and returns it.
virtual void Closest ()
 Find the daughter shape that is the closest to this shape. To retrieve the closest shape, use EShape::GetClosestShape.
 EPointShape (CppWrapperInternal::InternalConstructor)
Public Member Functions inherited from eVision::Legacy::EShape
virtual ~EShape () throw ()
std::string GetName () const
 Name of the EShape object.
void SetName (const std::string &name)
 Name of the EShape object.
eVision::Legacy::EShape * GetShapeNamed (const std::string &name)
 Returns a pointer to a daughter gauge or shape specified by its name.
bool GetVisible () const
 Flag indicating whether the shape is visible or not.
void SetVisible (bool visible)
 Flag indicating whether the shape is visible or not.
void SetVisibleRecursive (bool visible)
 Sets the flag indicating whether the shape and its daughter shapes are visible or not.
bool GetSelected () const
 Flag indicating whether the shape is selected or not.
void SetSelected (bool selected)
 Flag indicating whether the shape is selected or not.
void SetSelectedRecursive (bool selected)
 Sets the flag indicating whether the shape and all its daughters are selected or not.
bool GetSelectable () const
 Flag indicating whether the shape can be selected or not.
void SetSelectable (bool selectable)
 Flag indicating whether the shape can be selected or not.
void SetSelectableRecursive (bool selectable)
 Sets the flag indicating whether the shape and all its daughters can be selected or not.
bool GetDragable () const
 Flag indicating whether the shape can be dragged or not.
void SetDragable (bool dragable)
 Flag indicating whether the shape can be dragged or not.
void SetDragableRecursive (bool dragable)
 Sets the flag indicating whether the shape and all its daughters can be dragged or not.
bool GetResizable () const
 Flag indicating whether the shape can be resized or not.
void SetResizable (bool resizable)
 Flag indicating whether the shape can be resized or not.
void SetResizableRecursive (bool resizable)
 Sets the flag indicating whether the shape and all its daughters can be resized or not.
bool GetRotatable () const
 Flag indicating whether the shape can be rotated or not.
void SetRotatable (bool rotatable)
 Flag indicating whether the shape can be rotated or not.
void SetRotatableRecursive (bool rotatable)
 Sets the flag indicating whether the shape and all its daughters can be rotated or not.
bool GetLabeled () const
 Flag indicating whether the shape label should be displayed or not.
void SetLabeled (bool labeled)
 Flag indicating whether the shape label should be displayed or not.
void SetLabeledRecursive (bool labeled)
 Sets the flag indicating whether the shape label should be displayed or not. The flag is set in this shape and all its daughters.
virtual bool GetActive () const
 Flag indicating whether the shape is active or not.
virtual void SetActiveRecursive (bool active)
 Sets the flag indicating whether the shape and all its daughters are active or not.
bool GetActualShape () const
 Flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).
void SetActualShape (bool actualShape)
 Flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).
void SetActualShapeRecursive (bool actualShape)
 Sets the flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true). The flag is set in this shape and all its daughters.
bool GetFound () const
 Flag indicating whether a measured shape has been found.
bool GetAutoArrange () const
void SetAutoArrange (bool bAutoArrange, bool bDaughters)
void SetAutoArrange (bool bAutoArrange)
virtual void SetFound (bool bFound, bool bDaughters)
virtual void SetFound (bool bFound)
bool GetInspected () const
void SetInspected (bool bFound, bool bDaughters)
void SetInspected (bool bFound)
bool GetPassed () const
void SetPassed (bool bFound, bool bDaughters)
void SetPassed (bool bFound)
bool GetQuickDraw () const
void SetQuickDraw (bool bFound, bool bDaughters)
void SetQuickDraw (bool bFound)
bool GetOptionalDraw () const
void SetOptionalDraw (bool bFound, bool bDaughters)
void SetOptionalDraw (bool bFound)
bool GetUserFlag () const
void SetUserFlag (bool bUserFlag, bool bDaughters)
void SetUserFlag (bool bUserFlag)
bool GetAllocated () const
 Gets the allocated flag.
void EnableBehaviorFilter (eVision::EShapeBehavior behavior, bool value)
 Modifies the so-called behavior filter that is a conjunction of conditions specifying when a shape or a gauge should be displayed or taken into consideration when monitoring the mouse interactions.
void EnableBehaviorFilter (eVision::EShapeBehavior behavior)
 Modifies the so-called behavior filter that is a conjunction of conditions specifying when a shape or a gauge should be displayed or taken into consideration when monitoring the mouse interactions.
void DisableBehaviorFilter (eVision::EShapeBehavior behavior)
 Disables (i.e. removes) a condition from the list of conditions in the behavior filter.
void Attach (eVision::Legacy::EShape *mother)
 Attaches the gauge to a mother gauge or shape.
void Detach ()
 Detaches the gauge from its mother gauge or shape.
void DetachDaughters ()
 Detaches the daughter gauges or shapes.
uint32_t GetNumDaughters () const
 Number of daughters attached to the shape.
eVision::Legacy::EShape * GetMother () const
 Pointer to the mother shape.
virtual eVision::Legacy::EShape * GetDaughter (uint32_t index) const
 Returns a pointer to the specified daughter gauge or shape.
eVision::Legacy::EWorldShape * GetWorldShape () const
 World ancestor.
bool IsWorld () const
void InvalidateWorld ()
 Invalidates the world shape for this shape and all its ancestors.
eVision::EPoint LocalToSensor (const eVision::EPoint &LPoint)
 Transforms a point from local coordinates to sensor coordinates.
eVision::EPoint SensorToLocal (const eVision::EPoint &SPoint)
 Transforms a point from sensor coordinates to local coordinates.
virtual float GetZoomX () const
 Current horizontal zooming factor for drawing operations.
virtual float GetZoomY () const
 Current vertical zooming factor for drawing operations.
virtual float GetPanX () const
 Current horizontal panning value for drawing operations, expressed in pixels. By default, no panning occurs.
virtual float GetPanY () const
 Current vertical panning value for drawing operations, expressed in pixels. By default, no panning occurs.
virtual void SetZoom (float zoomX, float zoomY)
 Sets the horizontal and vertical zooming factors for drawing operations.
virtual void SetZoom (float zoomX)
 Sets the horizontal and vertical zooming factors for drawing operations.
virtual void SetZoom ()
 Sets the horizontal and vertical zooming factors for drawing operations.
virtual void SetPan (float panX, float panY)
 Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.
virtual void SetPan (float panX)
 Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.
virtual void SetPan ()
 Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.
eVision::EDragHandle GetHitHandle () const
 Handle currently under the cursor.
eVision::Legacy::EShape * GetHitShape () const
 Pointer to the shape currently under the cursor.
void SetDraggingMode (eVision::EDraggingMode eDraggingMode, bool bDaughters)
 Sets the dragging mode which defines how the shape could be dragged.
void SetDraggingMode (eVision::EDraggingMode eDraggingMode)
 Sets the dragging mode which defines how the shape could be dragged.
eVision::EDraggingMode GetDraggingMode () const
 Gets the dragging mode which defines how the shape could be dragged.
void SetCursor (int32_t x, int32_t y)
 Sets the cursor current coordinates.
eVision::Legacy::EShape * GetClosestShape () const
 Closest shape among the daughters.
void Save (const std::string &path, bool daughters)
 Loads a Shape.The given ESerializer must have been created for writing.
void Save (const std::string &path)
 Loads a Shape.The given ESerializer must have been created for writing.
void Save (eVision::ESerializer *serializer, bool daughters)
 Loads a Shape.The given ESerializer must have been created for writing.
void Save (eVision::ESerializer *serializer)
 Loads a Shape.The given ESerializer must have been created for writing.
void Load (const std::string &path, bool daughters)
 Loads a Shape.The given ESerializer must have been created for reading.
void Load (const std::string &path)
 Loads a Shape.The given ESerializer must have been created for reading.
void Load (eVision::ESerializer *serializer, bool daughters)
 Loads a Shape.The given ESerializer must have been created for reading.
void Load (eVision::ESerializer *serializer)
 Loads a Shape.The given ESerializer must have been created for reading.
bool HasProperty (const std::string &aProperty) const
 Returns whether a EShape has a property named aProperty.
std::string GetProperty (const std::string &aProperty) const
 Gets the value of property aProperty. Throws an exception if no such property exists.
void SetProperty (const std::string &aProperty, const std::string &aValue)
 Sets the value of property aProperty to aValue for this EShape.
void SetPropertyRecursive (const std::string &aProperty, const std::string &aValue)
 Sets the value of property aProperty to aValue for this EShape and all of its daughters.
void RemoveProperty (const std::string &aProperty)
 Removes the property name aProperty from the EShape.
bool HasValidPolarityProperty () const
 Returns whether the EShape has a valid polarity property.
virtual void EnableTypeFilter (uint32_t un32Types)
 Enables the filter of the specified shape type.
virtual void DisableTypeFilter ()
 Enables all shape types.
 EShape (CppWrapperInternal::InternalConstructor)

Additional Inherited Members

Public Attributes inherited from eVision::Legacy::EShape
CppWrapperInternal::WrappedClass wrappedClass_

Detailed Description

Manages a point location gauge.

License(s): EasyGauge

Constructor & Destructor Documentation

◆ EPointGauge() [1/4]

eVision::Legacy::EPointGauge::EPointGauge ( )

Constructs a point measurement context.

With the default constructor, all the parameters are initialized to their respective default values. With the copy constructor, the constructed point measurement context is based on a pre-existing EPointGauge::EPointGauge object. The gauge children are also copied. Hierarchy copying through a copy constructor is always recursive. To disable this recursion, use instead the EPointGauge::CopyTo method.

◆ EPointGauge() [2/4]

eVision::Legacy::EPointGauge::EPointGauge ( float centerX,
float centerY )

Constructs a point measurement context.

Parameters
centerXPoint X coordinate.
centerYPoint Y coordinate.

With the default constructor, all the parameters are initialized to their respective default values. With the copy constructor, the constructed point measurement context is based on a pre-existing EPointGauge::EPointGauge object. The gauge children are also copied. Hierarchy copying through a copy constructor is always recursive. To disable this recursion, use instead the EPointGauge::CopyTo method.

◆ EPointGauge() [3/4]

eVision::Legacy::EPointGauge::EPointGauge ( const eVision::Legacy::EPointGauge & other)

Constructs a point measurement context.

Parameters
otherAnother EPointGauge object to be copied in the new EPointGauge object.

With the default constructor, all the parameters are initialized to their respective default values. With the copy constructor, the constructed point measurement context is based on a pre-existing EPointGauge::EPointGauge object. The gauge children are also copied. Hierarchy copying through a copy constructor is always recursive. To disable this recursion, use instead the EPointGauge::CopyTo method.

◆ ~EPointGauge()

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

◆ EPointGauge() [4/4]

eVision::Legacy::EPointGauge::EPointGauge ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ CopyTo() [1/3]

void eVision::Legacy::EPointGauge::CopyTo ( eVision::Legacy::EPointGauge & other) const

Copies all the data of the current EPointGauge object into another EPointGauge object, and returns it.

Parameters
otherPointer to the EPointGauge object in which the current EPointGauge object data have to be copied.

In the overload taking a pointer, in case of a NULL pointer, a new EPointGauge object will be created and returned.

◆ CopyTo() [2/3]

void eVision::Legacy::EPointGauge::CopyTo ( eVision::Legacy::EPointGauge & other,
bool recursive ) const

Copies all the data of the current EPointGauge object into another EPointGauge object, and returns it.

Parameters
otherPointer to the EPointGauge object in which the current EPointGauge object data have to be copied.
recursivetrue if the children gauges have to be copied as well, false otherwise.

In the overload taking a pointer, in case of a NULL pointer, a new EPointGauge object will be created and returned.

◆ CopyTo() [3/3]

eVision::Legacy::EPointGauge * eVision::Legacy::EPointGauge::CopyTo ( eVision::Legacy::EPointGauge * other,
bool recursive ) const

Copies all the data of the current EPointGauge object into another EPointGauge object, and returns it.

Parameters
otherPointer to the EPointGauge object in which the current EPointGauge object data have to be copied.
recursivetrue if the children gauges have to be copied as well, false otherwise.

In the overload taking a pointer, in case of a NULL pointer, a new EPointGauge object will be created and returned.

Deprecated

Use the overload taking a reference.

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

◆ Drag()

void eVision::Legacy::EPointGauge::Drag ( int32_t x,
int32_t y )
virtual

Moves a handle to a new position and updates the position parameters of the gauge.

Parameters
xCursor current X coordinate.
yCursor current Y coordinate.

Reimplemented from eVision::Legacy::EPointShape.

◆ Draw() [1/9]

void eVision::Legacy::EPointGauge::Draw ( eVision::EDrawAdapter * drawAdapter)
virtual

Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.

Parameters
drawAdapterA pointer to an EDrawAdapter (like the EWindowsDrawAdapter).

Reimplemented from eVision::Legacy::EPointShape.

◆ Draw() [2/9]

void eVision::Legacy::EPointGauge::Draw ( eVision::EDrawAdapter * drawAdapter,
eVision::EDrawingMode drawingMode )
virtual

Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.

Parameters
drawAdapterA pointer to an EDrawAdapter (like the EWindowsDrawAdapter).
drawingModeIndicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.

Reimplemented from eVision::Legacy::EPointShape.

◆ Draw() [3/9]

void eVision::Legacy::EPointGauge::Draw ( eVision::EDrawAdapter * drawAdapter,
eVision::EDrawingMode drawingMode,
bool daughters )
virtual

Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.

Parameters
drawAdapterA pointer to an EDrawAdapter (like the EWindowsDrawAdapter).
drawingModeIndicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.
daughterstrue if the daughters gauges are to be displayed also.

Reimplemented from eVision::Legacy::EPointShape.

◆ Draw() [4/9]

void eVision::Legacy::EPointGauge::Draw ( HDC graphicContext)
virtual

Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.

Parameters
graphicContextHandle of the device 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.

Reimplemented from eVision::Legacy::EPointShape.

◆ Draw() [5/9]

void eVision::Legacy::EPointGauge::Draw ( HDC graphicContext,
const eVision::ERGBColor & color )
virtual

Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.

Parameters
graphicContextHandle of the device context on which to draw.
colorThe color in which to draw the overlay.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

Reimplemented from eVision::Legacy::EPointShape.

◆ Draw() [6/9]

void eVision::Legacy::EPointGauge::Draw ( HDC graphicContext,
const eVision::ERGBColor & color,
eVision::EDrawingMode drawingMode )
virtual

Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.

Parameters
graphicContextHandle of the device context on which to draw.
colorThe color in which to draw the overlay.
drawingModeIndicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.
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.

Reimplemented from eVision::Legacy::EPointShape.

◆ Draw() [7/9]

void eVision::Legacy::EPointGauge::Draw ( HDC graphicContext,
const eVision::ERGBColor & color,
eVision::EDrawingMode drawingMode,
bool daughters )
virtual

Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.

Parameters
graphicContextHandle of the device context on which to draw.
colorThe color in which to draw the overlay.
drawingModeIndicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.
daughterstrue if the daughters gauges are to be displayed also.
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.

Reimplemented from eVision::Legacy::EPointShape.

◆ Draw() [8/9]

void eVision::Legacy::EPointGauge::Draw ( HDC graphicContext,
eVision::EDrawingMode drawingMode )
virtual

Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.

Parameters
graphicContextHandle of the device context on which to draw.
drawingModeIndicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.
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.

Reimplemented from eVision::Legacy::EPointShape.

◆ Draw() [9/9]

void eVision::Legacy::EPointGauge::Draw ( HDC graphicContext,
eVision::EDrawingMode drawingMode,
bool daughters )
virtual

Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.

Parameters
graphicContextHandle of the device context on which to draw.
drawingModeIndicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.
daughterstrue if the daughters gauges are to be displayed also.
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.

Reimplemented from eVision::Legacy::EPointShape.

◆ DrawWithCurrentPen() [1/3]

void eVision::Legacy::EPointGauge::DrawWithCurrentPen ( HDC graphicContext)
virtual

Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.

Parameters
graphicContextHandle of the device context on which to draw.
Deprecated

Use the overload of EPointGauge::Draw taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

Reimplemented from eVision::Legacy::EPointShape.

◆ DrawWithCurrentPen() [2/3]

void eVision::Legacy::EPointGauge::DrawWithCurrentPen ( HDC graphicContext,
eVision::EDrawingMode drawingMode )
virtual

Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.

Parameters
graphicContextHandle of the device context on which to draw.
drawingModeIndicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.
Deprecated

Use the overload of EPointGauge::Draw taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

Reimplemented from eVision::Legacy::EPointShape.

◆ DrawWithCurrentPen() [3/3]

void eVision::Legacy::EPointGauge::DrawWithCurrentPen ( HDC graphicContext,
eVision::EDrawingMode drawingMode,
bool daughters )
virtual

Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.

Parameters
graphicContextHandle of the device context on which to draw.
drawingModeIndicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.
daughterstrue if the daughters gauges are to be displayed also.
Deprecated

Use the overload of EPointGauge::Draw taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

Reimplemented from eVision::Legacy::EPointShape.

◆ GetActive()

bool eVision::Legacy::EPointGauge::GetActive ( )

Sets the flag indicating whether the gauge is active or not.

When complex gauging is required, several gauges can be grouped together. Applying EPointGauge::Process to the mother gauge or shape triggers the measurement of the whole. Only the active gauges will participate in the process. By default, the gauge is active (true).

◆ GetHVConstraint()

bool eVision::Legacy::EPointGauge::GetHVConstraint ( ) const

Status of the restriction on the orientation of the point location gauge or model fitting sample paths.

Sample paths are the point location gauges placed along the model to be fitted.

◆ GetMeasuredPeak() [1/2]

eVision::EPeak eVision::Legacy::EPointGauge::GetMeasuredPeak ( ) const

Returns information pertaining to the derivative peak associated with the specified edge-crossing point, such as its area, amplitude, start, length and center.

If index is left unchanged from its default value (i.e. ~0 = 0xFFFFFFFF), the peak associated to the default edge-crossing point is inspected. This default point is chosen according to the transition choice parameter that is managed by the EPointGauge::GetTransitionChoice property.

If you want to query more than 10 peaks, using EPointGauge::GetMeasuredPeaks should be faster.

Note
For this method to succeed, it is necessary to previously call EPointGauge::Measure.

◆ GetMeasuredPeak() [2/2]

eVision::EPeak eVision::Legacy::EPointGauge::GetMeasuredPeak ( uint32_t index) const

Returns information pertaining to the derivative peak associated with the specified edge-crossing point, such as its area, amplitude, start, length and center.

Parameters
indexIndex of the edge-crossing point along the probed line segment, between 0 and EPointGauge::GetNumMeasuredPoints (excluded).

If index is left unchanged from its default value (i.e. ~0 = 0xFFFFFFFF), the peak associated to the default edge-crossing point is inspected. This default point is chosen according to the transition choice parameter that is managed by the EPointGauge::GetTransitionChoice property.

If you want to query more than 10 peaks, using EPointGauge::GetMeasuredPeaks should be faster.

Note
For this method to succeed, it is necessary to previously call EPointGauge::Measure.

◆ GetMeasuredPeaks()

std::vector< eVision::EPeak > eVision::Legacy::EPointGauge::GetMeasuredPeaks ( ) const

Returns information pertaining to the derivative peak associated with all of the edge-crossing point, such as its area, amplitude, start, length and center.

If you want to query less than 10 peaks, using EPointGauge::GetMeasuredPeak should be faster.

Note
For this method to succeed, it is necessary to previously call EPointGauge::Measure.

◆ GetMeasuredPoint() [1/2]

eVision::EPoint eVision::Legacy::EPointGauge::GetMeasuredPoint ( )

Returns the coordinates of an edge-crossing point, measured along the unique sample path of the point location gauge.

These coordinates pertain to the World space; they are expressed in the reference frame to which the current EPointGauge object belongs. An EPointGauge object features only one sample path, which contrasts with the other kinds of gauges. The argument index specifies the index of the edge-crossing point that is considered along this unique sample path. If index is left unchanged from its default value (i.e. ~0 = 0xFFFFFFFF), the default edge-crossing point is inspected. This default point is chosen according to the transition choice parameter that is managed by the EPointGauge::GetTransitionChoice property.

If you want to query more than 10 points, using EPointGauge::GetMeasuredPoints should be faster.

Note
For this method to succeed, it is necessary to previously call EPointGauge::Measure.

◆ GetMeasuredPoint() [2/2]

eVision::EPoint eVision::Legacy::EPointGauge::GetMeasuredPoint ( uint32_t index)

Returns the coordinates of an edge-crossing point, measured along the unique sample path of the point location gauge.

Parameters
indexIndex of the edge-crossing point along the probed line segment, between 0 and EPointGauge::GetNumMeasuredPoints (excluded).

These coordinates pertain to the World space; they are expressed in the reference frame to which the current EPointGauge object belongs. An EPointGauge object features only one sample path, which contrasts with the other kinds of gauges. The argument index specifies the index of the edge-crossing point that is considered along this unique sample path. If index is left unchanged from its default value (i.e. ~0 = 0xFFFFFFFF), the default edge-crossing point is inspected. This default point is chosen according to the transition choice parameter that is managed by the EPointGauge::GetTransitionChoice property.

If you want to query more than 10 points, using EPointGauge::GetMeasuredPoints should be faster.

Note
For this method to succeed, it is necessary to previously call EPointGauge::Measure.

◆ GetMeasuredPoints()

std::vector< eVision::EPoint > eVision::Legacy::EPointGauge::GetMeasuredPoints ( ) const

Returns the coordinates of all edge-crossing points, measured along the unique sample path of the point location gauge.

These coordinates pertain to the World space; they are expressed in the reference frame to which the current EPointGauge object belongs.

If you want to query less than 10 points, using EPointGauge::GetMeasuredPoint should be faster.

Note
For this method to succeed, it is necessary to previously call EPointGauge::Measure.

◆ GetMinAmplitude()

uint32_t eVision::Legacy::EPointGauge::GetMinAmplitude ( ) const

Offset added to the Threshold when a peak is to be detected.

When analyzing a derivative profile, a peak is made up of consecutive pixel values above Threshold. To detect weak [strong] transitions, lower [raise] the Threshold value. To avoid interference of noise, an additional parameter is provided. The MinAmplitude parameter is an offset added to Threshold when a peak is to be detected. When the pixel values of the derivative profile do not reach Threshold + MinAmplitude, the peak is not taken into account. Anyway, when a peak is taken into account, all the pixels with values above Threshold are considered (for more accuracy). Setting the MinAmplitude value to 0 merely cancels its effect.

◆ GetMinArea()

uint32_t eVision::Legacy::EPointGauge::GetMinArea ( ) const

Minimum area value.

A transition is detected if its derivative peak reaches Threshold + MinAmplitude value, and then declared valid if the area between the peak curve and the horizontal at level Threshold reaches the MinArea value.

◆ GetNumMeasuredPoints()

uint32_t eVision::Legacy::EPointGauge::GetNumMeasuredPoints ( ) const

Number of edge-crossing points along the point location gauge.

◆ GetRectangularSamplingArea()

bool eVision::Legacy::EPointGauge::GetRectangularSamplingArea ( )

Flag indicating whether the sampling area remains a rectangle when rotated, instead of becoming a parallelogram.

By default, this flag is set to true: the sampling area always remains a rectangle. Setting this property is only useful when the thickness transition parameter is greater than 1. In fact, when thickness transition parameter is equal to 1, rectangle and parallelogram reduce to the same segment.

◆ GetShape()

eVision::EPoint eVision::Legacy::EPointGauge::GetShape ( )

◆ GetSmoothing()

uint32_t eVision::Legacy::EPointGauge::GetSmoothing ( ) const

Number of pixels used for the low-pass filtering operation.

To reduce the effect of noise, the profile data can be low-pass filtered along the point location gauge direction.

◆ GetThickness()

uint32_t eVision::Legacy::EPointGauge::GetThickness ( ) const

Number of parallel segments used to extract the data profile.

To reduce the effect of noise and/or strengthen a transition, several parallel profiles can be accumulated.

◆ GetThreshold()

uint32_t eVision::Legacy::EPointGauge::GetThreshold ( ) const

Threshold level used to delimit significant peaks in the data profile.

When analyzing a derivative profile, a peak is made up of consecutive pixel values above Threshold. To detect weak [strong] transitions, lower [raise] the Threshold value. To avoid interference of noise, an additional parameter is provided. The MinAmplitude parameter is an offset added to Threshold when a peak is to be detected. When the pixel values of the derivative profile do not reach Threshold + MinAmplitude, the peak is not taken into account. Anyway, when a peak is taken into account, all the pixels with values above Threshold are considered (for more accuracy). Setting the MinAmplitude value to 0 merely cancels its effect.

◆ GetTolerance()

float eVision::Legacy::EPointGauge::GetTolerance ( )

Half length of the point location gauge.

By default, the length of the point location gauge is 20 (2x10), which means 20 pixels when the field of view is not calibrated, and 20 physical units in case of a calibrated field of view.

◆ GetToleranceAngle()

float eVision::Legacy::EPointGauge::GetToleranceAngle ( ) const

Rotation angle of the point location gauge.

By default, the rotation angle of the point location gauge is 0. The sign of the rotation angle depends whether the field of view is calibrated or not.

  • When the field of view is calibrated, the coordinate system is said to be direct, the abscissa extends rightwards and the ordinate extends upwards. In this case, an anticlockwise rotation leads to a positive angle value.
  • When the field of view is not calibrated, the coordinate system is said to be inverse, the abscissa extends rightwards and the ordinate extends downwards. In this case, a clockwise rotation leads to a positive angle value.

◆ GetTransitionChoice()

eVision::ETransitionChoice eVision::Legacy::EPointGauge::GetTransitionChoice ( ) const

Transition choice.

Several peaks may be detected along a point location gauge. This parameter helps to select the desired transition. In case of ETransitionChoice::ETransitionChoice_NthFromBegin or ETransitionChoice::ETransitionChoice_NthFromEnd transition choice, set EPointGauge::GetTransitionIndex to specify the desired transition. By default, the selected transition corresponds to the one with the largest amplitude (ETransitionChoice::ETransitionChoice_LargestAmplitude).

◆ GetTransitionIndex()

uint32_t eVision::Legacy::EPointGauge::GetTransitionIndex ( ) const

Index (from 0 on) of the transition to be retained when the transition choice parameter is set to ETransitionChoice::ETransitionChoice_NthFromBegin or ETransitionChoice::ETransitionChoice_NthFromEnd.

Several peaks may be detected along a point location gauge. This parameter helps to select the desired transition. By default, the first transition is retained (the index value is 0).

◆ GetTransitionType()

eVision::ETransitionType eVision::Legacy::EPointGauge::GetTransitionType ( ) const

Transition type.

The type of a transition tells whether it crosses increasing or decreasing gray-level values. This helps discriminate between nearby edges of an object. By default, the searched transition type is indifferently a black to white or a white to black transition (ETransitionType::ETransitionType_BwOrWb).

◆ GetType()

eVision::EShapeType eVision::Legacy::EPointGauge::GetType ( ) const
virtual

Shape type.

Reimplemented from eVision::Legacy::EPointShape.

◆ GetValid()

bool eVision::Legacy::EPointGauge::GetValid ( ) const

Flag indicating if at least one valid transition has been found.

A false value means that no measurement has been performed. A true value means that a transition was found along the sample path defined by the EPointGauge, and thus a point was measured.

◆ HitTest() [1/2]

bool eVision::Legacy::EPointGauge::HitTest ( )
virtual

Checks whether the cursor is positioned over a handle (true) or not (false).

Reimplemented from eVision::Legacy::EPointShape.

◆ HitTest() [2/2]

bool eVision::Legacy::EPointGauge::HitTest ( bool daughters)
virtual

Checks whether the cursor is positioned over a handle (true) or not (false).

Parameters
daughterstrue if the daughters gauges handles have to be considered as well.

Reimplemented from eVision::Legacy::EPointShape.

◆ Measure() [1/2]

void eVision::Legacy::EPointGauge::Measure ( eVision::EROIBW8 * sourceImage)

Triggers the point location or the model fitting operation.

Parameters
sourceImagePointer to the source image.

When this method is called, and if not enough valid points are detected, then the method returns directly, and the measured gauge is set to the nominal parameters.

◆ Measure() [2/2]

void eVision::Legacy::EPointGauge::Measure ( eVision::EROIBW8 * sourceImage,
const eVision::ERegion & region )

Triggers the point location or the model fitting operation.

Parameters
sourceImagePointer to the source image.
regionRegion to use with the source image.

When this method is called, and if not enough valid points are detected, then the method returns directly, and the measured gauge is set to the nominal parameters.

◆ operator=()

eVision::Legacy::EPointGauge & eVision::Legacy::EPointGauge::operator= ( const eVision::Legacy::EPointGauge & other)

Copies all the data from another EPointGauge object into the current EPointGauge object.

Parameters
otherEPointGauge object to be copied

◆ Plot() [1/9]

void eVision::Legacy::EPointGauge::Plot ( eVision::EDrawAdapter * graphicContext,
eVision::EPlotItem drawItems,
float width,
float height )

Draws the profile that is crossed by a point location gauge, as defined by EPlotItem.

Parameters
graphicContextHandle of the device context on which to draw.
drawItemsBoolean combination of EPlotItem members, that indicates which items must be displayed.
widthWidth of the plot.
heightHeight of the plot.

◆ Plot() [2/9]

void eVision::Legacy::EPointGauge::Plot ( eVision::EDrawAdapter * graphicContext,
eVision::EPlotItem drawItems,
float width,
float height,
float originX )

Draws the profile that is crossed by a point location gauge, as defined by EPlotItem.

Parameters
graphicContextHandle of the device context on which to draw.
drawItemsBoolean combination of EPlotItem members, that indicates which items must be displayed.
widthWidth of the plot.
heightHeight of the plot.
originXOrigin point coordinates of the plot along the X axis.

◆ Plot() [3/9]

void eVision::Legacy::EPointGauge::Plot ( eVision::EDrawAdapter * graphicContext,
eVision::EPlotItem drawItems,
float width,
float height,
float originX,
float originY )

Draws the profile that is crossed by a point location gauge, as defined by EPlotItem.

Parameters
graphicContextHandle of the device context on which to draw.
drawItemsBoolean combination of EPlotItem members, that indicates which items must be displayed.
widthWidth of the plot.
heightHeight of the plot.
originXOrigin point coordinates of the plot along the X axis.
originYOrigin point coordinates of the plot along the Y axis.

◆ Plot() [4/9]

void eVision::Legacy::EPointGauge::Plot ( HDC graphicContext,
const eVision::ERGBColor & color,
eVision::EPlotItem drawItems,
float width,
float height )

Draws the profile that is crossed by a point location gauge, as defined by EPlotItem.

Parameters
graphicContextHandle of the device context on which to draw.
colorThe color in which to draw the overlay.
drawItemsBoolean combination of EPlotItem members, that indicates which items must be displayed.
widthWidth of the plot.
heightHeight of the plot.
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.

◆ Plot() [5/9]

void eVision::Legacy::EPointGauge::Plot ( HDC graphicContext,
const eVision::ERGBColor & color,
eVision::EPlotItem drawItems,
float width,
float height,
float originX )

Draws the profile that is crossed by a point location gauge, as defined by EPlotItem.

Parameters
graphicContextHandle of the device context on which to draw.
colorThe color in which to draw the overlay.
drawItemsBoolean combination of EPlotItem members, that indicates which items must be displayed.
widthWidth of the plot.
heightHeight of the plot.
originXOrigin point coordinates of the plot along the X axis.
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.

◆ Plot() [6/9]

void eVision::Legacy::EPointGauge::Plot ( HDC graphicContext,
const eVision::ERGBColor & color,
eVision::EPlotItem drawItems,
float width,
float height,
float originX,
float originY )

Draws the profile that is crossed by a point location gauge, as defined by EPlotItem.

Parameters
graphicContextHandle of the device context on which to draw.
colorThe color in which to draw the overlay.
drawItemsBoolean combination of EPlotItem members, that indicates which items must be displayed.
widthWidth of the plot.
heightHeight of the plot.
originXOrigin point coordinates of the plot along the X axis.
originYOrigin point coordinates of the plot along the Y axis.
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.

◆ Plot() [7/9]

void eVision::Legacy::EPointGauge::Plot ( HDC graphicContext,
eVision::EPlotItem drawItems,
float width,
float height )

Draws the profile that is crossed by a point location gauge, as defined by EPlotItem.

Parameters
graphicContextHandle of the device context on which to draw.
drawItemsBoolean combination of EPlotItem members, that indicates which items must be displayed.
widthWidth of the plot.
heightHeight of the plot.
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.

◆ Plot() [8/9]

void eVision::Legacy::EPointGauge::Plot ( HDC graphicContext,
eVision::EPlotItem drawItems,
float width,
float height,
float originX )

Draws the profile that is crossed by a point location gauge, as defined by EPlotItem.

Parameters
graphicContextHandle of the device context on which to draw.
drawItemsBoolean combination of EPlotItem members, that indicates which items must be displayed.
widthWidth of the plot.
heightHeight of the plot.
originXOrigin point coordinates of the plot along the X axis.
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.

◆ Plot() [9/9]

void eVision::Legacy::EPointGauge::Plot ( HDC graphicContext,
eVision::EPlotItem drawItems,
float width,
float height,
float originX,
float originY )

Draws the profile that is crossed by a point location gauge, as defined by EPlotItem.

Parameters
graphicContextHandle of the device context on which to draw.
drawItemsBoolean combination of EPlotItem members, that indicates which items must be displayed.
widthWidth of the plot.
heightHeight of the plot.
originXOrigin point coordinates of the plot along the X axis.
originYOrigin point coordinates of the plot along the Y axis.
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.

◆ PlotWithCurrentPen() [1/3]

void eVision::Legacy::EPointGauge::PlotWithCurrentPen ( HDC graphicContext,
eVision::EPlotItem drawItems,
float width,
float height )

Draws the profile that is crossed by a point location gauge, as defined by EPlotItem.

Parameters
graphicContextHandle of the device context on which to draw.
drawItemsBoolean combination of EPlotItem members, that indicates which items must be displayed.
widthWidth of the plot.
heightHeight of the plot.
Deprecated

Use the overload of EPointGauge::Plot taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ PlotWithCurrentPen() [2/3]

void eVision::Legacy::EPointGauge::PlotWithCurrentPen ( HDC graphicContext,
eVision::EPlotItem drawItems,
float width,
float height,
float originX )

Draws the profile that is crossed by a point location gauge, as defined by EPlotItem.

Parameters
graphicContextHandle of the device context on which to draw.
drawItemsBoolean combination of EPlotItem members, that indicates which items must be displayed.
widthWidth of the plot.
heightHeight of the plot.
originXOrigin point coordinates of the plot along the X axis.
Deprecated

Use the overload of EPointGauge::Plot taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ PlotWithCurrentPen() [3/3]

void eVision::Legacy::EPointGauge::PlotWithCurrentPen ( HDC graphicContext,
eVision::EPlotItem drawItems,
float width,
float height,
float originX,
float originY )

Draws the profile that is crossed by a point location gauge, as defined by EPlotItem.

Parameters
graphicContextHandle of the device context on which to draw.
drawItemsBoolean combination of EPlotItem members, that indicates which items must be displayed.
widthWidth of the plot.
heightHeight of the plot.
originXOrigin point coordinates of the plot along the X axis.
originYOrigin point coordinates of the plot along the Y axis.
Deprecated

Use the overload of EPointGauge::Plot taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ Process() [1/4]

void eVision::Legacy::EPointGauge::Process ( eVision::EROIBW8 * sourceImage)
virtual

Triggers the process pertaining to a shape or gauge and all the daughter gauges attach to it.

Parameters
sourceImagePointer to the source image.

When complex gauging is required, several gauges can be grouped together. Applying Process to the mother gauge or shape triggers the measurement of the whole. Only the active gauges will participate in the process.

Reimplemented from eVision::Legacy::EShape.

◆ Process() [2/4]

void eVision::Legacy::EPointGauge::Process ( eVision::EROIBW8 * sourceImage,
bool daughters )
virtual

Triggers the process pertaining to a shape or gauge and all the daughter gauges attach to it.

Parameters
sourceImagePointer to the source image.
daughtersFlag indicating whether the daughters shapes inherit of the same behavior.

When complex gauging is required, several gauges can be grouped together. Applying Process to the mother gauge or shape triggers the measurement of the whole. Only the active gauges will participate in the process.

Reimplemented from eVision::Legacy::EShape.

◆ Process() [3/4]

void eVision::Legacy::EPointGauge::Process ( eVision::EROIBW8 * sourceImage,
const eVision::ERegion & region )
virtual

Triggers the process pertaining to a shape or gauge and all the daughter gauges attach to it.

Parameters
sourceImagePointer to the source image.
regionRegion to use with the source image.

When complex gauging is required, several gauges can be grouped together. Applying Process to the mother gauge or shape triggers the measurement of the whole. Only the active gauges will participate in the process.

Reimplemented from eVision::Legacy::EShape.

◆ Process() [4/4]

void eVision::Legacy::EPointGauge::Process ( eVision::EROIBW8 * sourceImage,
const eVision::ERegion & region,
bool daughters )
virtual

Triggers the process pertaining to a shape or gauge and all the daughter gauges attach to it.

Parameters
sourceImagePointer to the source image.
regionRegion to use with the source image.
daughtersFlag indicating whether the daughters shapes inherit of the same behavior.

When complex gauging is required, several gauges can be grouped together. Applying Process to the mother gauge or shape triggers the measurement of the whole. Only the active gauges will participate in the process.

Reimplemented from eVision::Legacy::EShape.

◆ SetActive()

void eVision::Legacy::EPointGauge::SetActive ( bool active)
virtual

Sets the flag indicating whether the gauge is active or not.

Parameters
activeFlag indicating whether the gauge is active (true) or not (false).

When complex gauging is required, several gauges can be grouped together. Applying EPointGauge::Process to the mother gauge or shape triggers the measurement of the whole. Only the active gauges will participate in the process. By default, the gauge is active (true).

Reimplemented from eVision::Legacy::EShape.

◆ SetCenter()

void eVision::Legacy::EPointGauge::SetCenter ( const eVision::EPoint & center)
virtual

Center coordinates of a EPointGauge object.

Reimplemented from eVision::Legacy::EPointShape.

◆ SetCenterXY()

void eVision::Legacy::EPointGauge::SetCenterXY ( float centerX,
float centerY )
virtual

Sets the center coordinates of a EPointGauge object.

Parameters
centerXCenter coordinates of the EPointGauge object.
centerYCenter coordinates of the EPointGauge object.

Reimplemented from eVision::Legacy::EPointShape.

◆ SetHVConstraint()

void eVision::Legacy::EPointGauge::SetHVConstraint ( bool bHVConstraint)

Status of the restriction on the orientation of the point location gauge or model fitting sample paths.

Sample paths are the point location gauges placed along the model to be fitted.

◆ SetMinAmplitude()

void eVision::Legacy::EPointGauge::SetMinAmplitude ( uint32_t un32MinAmplitude)

Offset added to the Threshold when a peak is to be detected.

When analyzing a derivative profile, a peak is made up of consecutive pixel values above Threshold. To detect weak [strong] transitions, lower [raise] the Threshold value. To avoid interference of noise, an additional parameter is provided. The MinAmplitude parameter is an offset added to Threshold when a peak is to be detected. When the pixel values of the derivative profile do not reach Threshold + MinAmplitude, the peak is not taken into account. Anyway, when a peak is taken into account, all the pixels with values above Threshold are considered (for more accuracy). Setting the MinAmplitude value to 0 merely cancels its effect.

◆ SetMinArea()

void eVision::Legacy::EPointGauge::SetMinArea ( uint32_t un32MinArea)

Minimum area value.

A transition is detected if its derivative peak reaches Threshold + MinAmplitude value, and then declared valid if the area between the peak curve and the horizontal at level Threshold reaches the MinArea value.

◆ SetRectangularSamplingArea()

void eVision::Legacy::EPointGauge::SetRectangularSamplingArea ( bool bRectangularSamplingArea)

Flag indicating whether the sampling area remains a rectangle when rotated, instead of becoming a parallelogram.

By default, this flag is set to true: the sampling area always remains a rectangle. Setting this property is only useful when the thickness transition parameter is greater than 1. In fact, when thickness transition parameter is equal to 1, rectangle and parallelogram reduce to the same segment.

◆ SetSmoothing()

void eVision::Legacy::EPointGauge::SetSmoothing ( uint32_t un32Smoothing)

Number of pixels used for the low-pass filtering operation.

To reduce the effect of noise, the profile data can be low-pass filtered along the point location gauge direction.

◆ SetThickness()

void eVision::Legacy::EPointGauge::SetThickness ( uint32_t un32Thickness)

Number of parallel segments used to extract the data profile.

To reduce the effect of noise and/or strengthen a transition, several parallel profiles can be accumulated.

◆ SetThreshold()

void eVision::Legacy::EPointGauge::SetThreshold ( uint32_t un32Threshold)

Threshold level used to delimit significant peaks in the data profile.

When analyzing a derivative profile, a peak is made up of consecutive pixel values above Threshold. To detect weak [strong] transitions, lower [raise] the Threshold value. To avoid interference of noise, an additional parameter is provided. The MinAmplitude parameter is an offset added to Threshold when a peak is to be detected. When the pixel values of the derivative profile do not reach Threshold + MinAmplitude, the peak is not taken into account. Anyway, when a peak is taken into account, all the pixels with values above Threshold are considered (for more accuracy). Setting the MinAmplitude value to 0 merely cancels its effect.

◆ SetTolerance()

void eVision::Legacy::EPointGauge::SetTolerance ( float tolerance)

Half length of the point location gauge.

By default, the length of the point location gauge is 20 (2x10), which means 20 pixels when the field of view is not calibrated, and 20 physical units in case of a calibrated field of view.

◆ SetToleranceAngle()

void eVision::Legacy::EPointGauge::SetToleranceAngle ( float toleranceAngle)

Rotation angle of the point location gauge.

By default, the rotation angle of the point location gauge is 0. The sign of the rotation angle depends whether the field of view is calibrated or not.

  • When the field of view is calibrated, the coordinate system is said to be direct, the abscissa extends rightwards and the ordinate extends upwards. In this case, an anticlockwise rotation leads to a positive angle value.
  • When the field of view is not calibrated, the coordinate system is said to be inverse, the abscissa extends rightwards and the ordinate extends downwards. In this case, a clockwise rotation leads to a positive angle value.

◆ SetTolerances() [1/2]

void eVision::Legacy::EPointGauge::SetTolerances ( float tolerance)

Sets the half length and the rotation angle of the point location gauge.

Parameters
toleranceHalf length of the point location gauge. The default value is 10.

By default, the point location gauge length value is 20 (2x10), which means 20 pixels when the field of view is not calibrated and 20 "units" in case of a calibrated field of view. The sign of the rotation angle depends whether the field of view is calibrated or not.

  • When the field of view is calibrated, the coordinate system is said to be direct, the abscissa extends rightwards and the ordinate extends upwards. In this case, an anticlockwise rotation leads to a positive angle value.
  • When the field of view is not calibrated, the coordinate system is said to be inverse, the abscissa extends rightwards and the ordinate extends downwards. In this case, a clockwise rotation leads to a positive angle value.

◆ SetTolerances() [2/2]

void eVision::Legacy::EPointGauge::SetTolerances ( float tolerance,
float angle )

Sets the half length and the rotation angle of the point location gauge.

Parameters
toleranceHalf length of the point location gauge. The default value is 10.
angleRotation angle of the point location gauge. The default value is 0.

By default, the point location gauge length value is 20 (2x10), which means 20 pixels when the field of view is not calibrated and 20 "units" in case of a calibrated field of view. The sign of the rotation angle depends whether the field of view is calibrated or not.

  • When the field of view is calibrated, the coordinate system is said to be direct, the abscissa extends rightwards and the ordinate extends upwards. In this case, an anticlockwise rotation leads to a positive angle value.
  • When the field of view is not calibrated, the coordinate system is said to be inverse, the abscissa extends rightwards and the ordinate extends downwards. In this case, a clockwise rotation leads to a positive angle value.

◆ SetTransitionChoice()

void eVision::Legacy::EPointGauge::SetTransitionChoice ( eVision::ETransitionChoice eTransitionChoice)

Transition choice.

Several peaks may be detected along a point location gauge. This parameter helps to select the desired transition. In case of ETransitionChoice::ETransitionChoice_NthFromBegin or ETransitionChoice::ETransitionChoice_NthFromEnd transition choice, set EPointGauge::GetTransitionIndex to specify the desired transition. By default, the selected transition corresponds to the one with the largest amplitude (ETransitionChoice::ETransitionChoice_LargestAmplitude).

◆ SetTransitionIndex()

void eVision::Legacy::EPointGauge::SetTransitionIndex ( uint32_t un32TransitionIndex)

Index (from 0 on) of the transition to be retained when the transition choice parameter is set to ETransitionChoice::ETransitionChoice_NthFromBegin or ETransitionChoice::ETransitionChoice_NthFromEnd.

Several peaks may be detected along a point location gauge. This parameter helps to select the desired transition. By default, the first transition is retained (the index value is 0).

◆ SetTransitionType()

void eVision::Legacy::EPointGauge::SetTransitionType ( eVision::ETransitionType eTransitionType)

Transition type.

The type of a transition tells whether it crosses increasing or decreasing gray-level values. This helps discriminate between nearby edges of an object. By default, the searched transition type is indifferently a black to white or a white to black transition (ETransitionType::ETransitionType_BwOrWb).