eVision::Legacy::ELineGauge Class Reference

Manages a line fitting gauge. More...

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

Inheritance diagram for eVision::Legacy::ELineGauge:

Collaboration diagram for eVision::Legacy::ELineGauge:

Public Member Functions
	ELineGauge ()
	Constructs a line measurement context.
	ELineGauge (const eVision::Legacy::ELineGauge &other)
	Constructs a line measurement context.
virtual	~ELineGauge () throw ()
eVision::Legacy::ELineGauge &	operator= (const eVision::Legacy::ELineGauge &other)
	Compares the instance with another ELineGauge object and returns true if they are identical.
void	SetTolerance (float tolerance)
	Searching area half thickness of the line fitting gauge.
float	GetTolerance ()
	Searching area half thickness of the line fitting gauge.
bool	GetHVConstraint () const
	Status of the restriction on the orientation of the point location gauge or model fitting sample paths.
void	SetHVConstraint (bool HVConstraint)
	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 thickness)
	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 smoothing)
	Number of pixels used for the low-pass filtering operation.
void	SetTransitionType (eVision::ETransitionType transitionType)
	Transition type.
eVision::ETransitionType	GetTransitionType () const
	Transition type.
void	SetTransitionChoice (eVision::ETransitionChoice transitionChoice)
	Transition choice.
eVision::ETransitionChoice	GetTransitionChoice () const
	Transition choice.
void	SetTransitionIndex (uint32_t transitionIndex)
	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	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	SetThreshold (uint32_t threshold)
	Threshold level used to delimit significant peaks in the data profile.
uint32_t	GetThreshold () const
	Threshold level used to delimit significant peaks in the data profile.
void	SetMinAmplitude (uint32_t un32MinAmplitude)
	Offset added to the Threshold when a peak is to be detected.
uint32_t	GetMinAmplitude () const
	Offset added to the Threshold when a peak is to be detected.
void	SetMinArea (uint32_t un32MinArea)
	Minimum area value.
uint32_t	GetMinArea () const
	Minimum area value.
uint32_t	GetNumMeasuredPoints () const
	Number of edge-crossing points along the sample path of the gauge that was inspected with the last call to ELineGauge::MeasureSample.
eVision::EPeak	GetMeasuredPeak (uint32_t index) const
	Returns information pertaining to the default derivative peak, along one of the sample paths of the gauge.
eVision::EPeak	GetMeasuredPeak () const
	Returns information pertaining to the default derivative peak, along one of the sample paths of the gauge.
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 one of the sample paths of the 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 one of the sample paths of the gauge, as defined by EPlotItem.
void	Plot (eVision::EDrawAdapter *graphicContext, eVision::EPlotItem drawItems, float width, float height)
	Draws the profile that is crossed by one of the sample paths of the 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 one of the sample paths of the 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 one of the sample paths of the gauge, as defined by EPlotItem.
void	Plot (HDC graphicContext, eVision::EPlotItem drawItems, float width, float height)
	Draws the profile that is crossed by one of the sample paths of the 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 one of the sample paths of the 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 one of the sample paths of the 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 one of the sample paths of the 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 one of the sample paths of the 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 one of the sample paths of the gauge, as defined by EPlotItem.
void	PlotWithCurrentPen (HDC graphicContext, eVision::EPlotItem drawItems, float width, float height)
	Draws the profile that is crossed by one of the sample paths of the gauge, as defined by EPlotItem.
float	GetFilteringThreshold () const
	Relative filtering threshold, that is the fraction of the average distance between the sampled points and the fitted model above which a point is filtered out.
void	SetFilteringThreshold (float f32FilteringThreshold)
	Relative filtering threshold, that is the fraction of the average distance between the sampled points and the fitted model above which a point is filtered out.
uint32_t	GetNumFilteringPasses () const
	Number of filtering passes for a model fitting operation.
void	SetNumFilteringPasses (uint32_t un32NumFilteringPasses)
	Number of filtering passes for a model fitting operation.
uint32_t	GetNumValidSamples () const
	Number of valid sample points remaining after a model fitting operation.
float	GetAverageDistance () const
	Average distance between the sampled points and the fitted model.
void	GetMinNumFitSamples (int32_t &side0, int32_t &side1, int32_t &side2, int32_t &side3)
	Returns the minimum number of samples required for fitting the shape.
void	SetMinNumFitSamples (int32_t side)
	Sets/Gets the minimum number of samples required for fitting the shape.
int32_t	GetMinNumFitSamples () const
	Sets/Gets the minimum number of samples required for fitting the shape.
uint32_t	AddSkipRange (const uint32_t start, const uint32_t end)
	Adds an item to the set of skip ranges and returns the index of the newly added range.
uint32_t	AddSkipRange (const eVision::EIntegerRange &range)
	Adds an item to the set of skip ranges and returns the index of the newly added range.
uint32_t	GetNumSkipRanges () const
	Number of skip ranges in the gauge after a call to ELineGauge::AddSkipRange.
void	GetSkipRange (const uint32_t index, uint32_t &start, uint32_t &end) const
	Allows to retrieve the start and end values of the skip range corresponding to the given index, if it is valid (i.e. if it has previously been created by a call to the ELineGauge::AddSkipRange method.
eVision::EIntegerRange	GetSkipRange (uint32_t index) const
	Allows to retrieve the start and end values of the skip range corresponding to the given index, if it is valid (i.e. if it has previously been created by a call to the ELineGauge::AddSkipRange method.
void	RemoveSkipRange (const uint32_t index)
	After a call to ELineGauge::AddSkipRange, removes the skip range with the given index.
void	RemoveAllSkipRanges ()
	Removes all the skip ranges previously created by a call to ELineGauge::AddSkipRange.
void	CopyTo (eVision::Legacy::ELineGauge &other, bool recursive) const
	Copies all the data of the current ELineGauge object into another ELineGauge object, and returns it.
void	CopyTo (eVision::Legacy::ELineGauge &other) const
	Copies all the data of the current ELineGauge object into another ELineGauge object, and returns it.
eVision::Legacy::ELineGauge *	CopyTo (eVision::Legacy::ELineGauge *other, bool recursive) const
	Copies all the data of the current ELineGauge object into another ELineGauge object, and returns it.
virtual eVision::EShapeType	GetType () const
	Shape type.
virtual void	SetLine (const eVision::Legacy::ELine &line)
	Sets the nominal position, length and rotation angle of the line fitting gauge, according to a known ELine 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.
eVision::Legacy::ELine	GetShape ()
void	SetRectangularSamplingArea (bool bRectangularSamplingArea)
	Flag indicating whether the sampling area remains a rectangle when rotated, instead of becoming a parallelogram.
bool	GetRectangularSamplingArea () const
	Flag indicating whether the sampling area remains a rectangle when rotated, instead of becoming a parallelogram.
float	GetSamplingStep () const
	Approximate distance between sampled points during a model fitting operation.
void	SetSamplingStep (float f32SamplingStep)
	Approximate distance between sampled points during a model fitting operation.
uint32_t	GetNumSamples () const
	Number of sampled points during 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.
bool	GetKnownAngle () const
	Flag indicating whether the slope of the line to be fitted is known or not.
void	SetKnownAngle (bool bKnownAngle)
	Flag indicating whether the slope of the line to be fitted is known or not.
void	SetClippingMode (eVision::EClippingMode clippingMode)
	Clipping mode, that allows to choose how the fitted segment length and center are computed.
eVision::EClippingMode	GetClippingMode () const
	Clipping mode, that allows to choose how the fitted segment length and center are computed.
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.
void	MeasureWithoutFitting (eVision::EROIBW8 *sourceImage)
	Triggers the point location without line fitting operation.
void	MeasureWithoutFitting (eVision::EROIBW8 *sourceImage, const eVision::ERegion &region)
	Triggers the point location without line fitting operation.
void	MeasureSample (eVision::EROIBW8 *sourceImage, uint32_t pathIndex)
	Computes the sample points along the sample path whose index in the list is given by the pathIndex parameter.
void	MeasureSample (eVision::EROIBW8 *sourceImage, const eVision::ERegion &region, uint32_t pathIndex)
	Computes the sample points along the sample path whose index in the list is given by the pathIndex parameter.
eVision::Legacy::ELine	GetMeasuredLine ()
	Information pertaining to the fitted line.
bool	GetSample (eVision::EPoint &pt, uint32_t index)
	Allows to retrieve the sample points found along the line.
void	GetSample (eVision::Legacy::ESamplePoint &pt, uint32_t index)
	Allows to retrieve the sample points found along the line.
eVision::EPoint	GetMeasuredPoint (uint32_t index)
	Returns the coordinates of a sample point, measured along one of the sample paths of the gauge.
eVision::EPoint	GetMeasuredPoint ()
	Returns the coordinates of a sample point, measured along one of the sample paths of the gauge.
virtual void	Draw (eVision::EDrawAdapter *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 (eVision::EDrawAdapter *graphicContext, eVision::EDrawingMode drawingMode)
	Draws a graphical representation of a point location or model fitting gauge, as defined by EDrawingMode.
virtual void	Draw (eVision::EDrawAdapter *graphicContext)
	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.
	ELineGauge (CppWrapperInternal::InternalConstructor)
Public Member Functions inherited from eVision::Legacy::ELineShape
	ELineShape ()
	Constructs a ELineShape object.
	ELineShape (const eVision::EPoint &origin, const eVision::EPoint &end)
	Constructs a ELineShape object.
	ELineShape (const eVision::EPoint &center, float length, float angle)
	Constructs a ELineShape object.
	ELineShape (const eVision::EPoint &center, float length)
	Constructs a ELineShape object.
	ELineShape (const eVision::EPoint &center)
	Constructs a ELineShape object.
	ELineShape (const eVision::Legacy::ELineShape &other)
	Constructs a ELineShape object.
virtual	~ELineShape () throw ()
eVision::Legacy::ELineShape &	operator= (const eVision::Legacy::ELineShape &other)
	Assignment operator.
eVision::EPoint	GetCenter () const
	Center point of the frame.
void	SetCenter (const eVision::EPoint &center)
	Center point of the frame.
void	SetCenterXY (float centerX, float centerY)
	Sets the center coordinates of a ELineShape object.
float	GetCenterX () const
	Abscissa of the origin point of the frame.
float	GetCenterY () const
	Ordinate of the origin point of the frame.
float	GetAngle () const
	Orientation of the shape.
void	SetAngle (float f32Angle)
	Orientation of the shape.
float	GetScale () const
	Horizontal sensor resolution, in pixels per unit.
void	SetScale (float f32Scale)
	Horizontal sensor resolution, in pixels per unit.
void	SetFromTwoPoints (const eVision::EPoint &origin, const eVision::EPoint &end)
	Sets the geometric parameters (center coordinates, length, and rotation angle) of a ELineShape object.
void	SetFromOriginAndEnd (const eVision::EPoint &origin, const eVision::EPoint &end)
	Sets the geometric parameters (center coordinates, length, and rotation angle) of a ELineShape object.
void	SetLength (float length)
	Length of the ELineShape object.
float	GetLength () const
	Length of the ELineShape object.
eVision::EPoint	GetOrg () const
	Origin point coordinates of the ELineShape object.
eVision::EPoint	GetEnd () const
	End point coordinates of the ELineShape object.
eVision::EPoint	GetPoint (float fraction) const
	Returns the coordinates of a point along the line.
void	CopyTo (eVision::Legacy::ELineShape &other, bool bRecursive) const
	Copies all the data of the current ELineShape object into another ELineShape object and returns it.
void	CopyTo (eVision::Legacy::ELineShape &other) const
	Copies all the data of the current ELineShape object into another ELineShape object and returns it.
eVision::Legacy::ELineShape *	CopyTo (eVision::Legacy::ELineShape *dest, bool bRecursive) const
	Copies all the data of the current ELineShape object into another ELineShape 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.
	ELineShape (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 line fitting gauge.

License(s): EasyGauge

Constructor & Destructor Documentation

ELineGauge() [1/3]

eVision::Legacy::ELineGauge::ELineGauge

(

)

Constructs a line measurement context.

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

ELineGauge() [2/3]

eVision::Legacy::ELineGauge::ELineGauge

(

const eVision::Legacy::ELineGauge &

other

)

Constructs a line measurement context.

Parameters

other

Another ELineGauge object to be copied in the new ELineGauge object.

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

~ELineGauge()

eVision::Legacy::ELineGauge::~ELineGauge ( ) throw (  )

virtual

ELineGauge() [3/3]

eVision::Legacy::ELineGauge::ELineGauge

(

CppWrapperInternal::InternalConstructor

)

Member Function Documentation

AddSkipRange() [1/2]

uint32_t eVision::Legacy::ELineGauge::AddSkipRange

(

const eVision::EIntegerRange &

range

)

Adds an item to the set of skip ranges and returns the index of the newly added range.

Parameters

range

The skip range.

The samples indices between start and end (including the boundaries) will be discarded during the measurement process. This method allows to define skip ranges in an ELineGauge. This means that, at measure time, samples belonging to these ranges will not be taken into account. A sample may belong to more than one skip range; to be discarded, a sample has to pertain to at least one range. Moreover, the skip ranges are allowed to overlap one another. The range is allowed to be reversed (i.e. end is not required to be greater than start). Also, start and end are not required to reference valid indices at the time of the call (i.e. the range may lie outside of the current return value for ELineGauge::GetNumSamples).

AddSkipRange() [2/2]

uint32_t eVision::Legacy::ELineGauge::AddSkipRange	(	const uint32_t	start,
		const uint32_t	end )

Adds an item to the set of skip ranges and returns the index of the newly added range.

Parameters

start	Beginning of the skip range.
end	End of the skip range.

The samples indices between start and end (including the boundaries) will be discarded during the measurement process. This method allows to define skip ranges in an ELineGauge. This means that, at measure time, samples belonging to these ranges will not be taken into account. A sample may belong to more than one skip range; to be discarded, a sample has to pertain to at least one range. Moreover, the skip ranges are allowed to overlap one another. The range is allowed to be reversed (i.e. end is not required to be greater than start). Also, start and end are not required to reference valid indices at the time of the call (i.e. the range may lie outside of the current return value for ELineGauge::GetNumSamples).

Deprecated

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

CopyTo() [1/3]

void eVision::Legacy::ELineGauge::CopyTo

(

eVision::Legacy::ELineGauge &

other

)

const

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

Parameters

other

Pointer to the ELineGauge object in which the current ELineGauge object data have to be copied.

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

CopyTo() [2/3]

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

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

Parameters

other	Pointer to the ELineGauge object in which the current ELineGauge object data have to be copied.
recursive	true 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 ELineGauge object will be created and returned.

CopyTo() [3/3]

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

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

Parameters

other	Pointer to the ELineGauge object in which the current ELineGauge object data have to be copied.
recursive	true 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 ELineGauge 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::ELineGauge::Drag ( int32_t x, int32_t y )

virtual

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

Parameters

x	Cursor current X coordinate.
y	Cursor current Y coordinate.

Reimplemented from eVision::Legacy::ELineShape.

Draw() [1/9]

void eVision::Legacy::ELineGauge::Draw ( eVision::EDrawAdapter * graphicContext )

virtual

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

Parameters

graphicContext

Handle of the device context on which to draw.

Reimplemented from eVision::Legacy::ELineShape.

Draw() [2/9]

void eVision::Legacy::ELineGauge::Draw ( eVision::EDrawAdapter * graphicContext, eVision::EDrawingMode drawingMode )

virtual

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

Parameters

graphicContext	Handle of the device context on which to draw.
drawingMode	Indicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.

Reimplemented from eVision::Legacy::ELineShape.

Draw() [3/9]

void eVision::Legacy::ELineGauge::Draw ( eVision::EDrawAdapter * graphicContext, eVision::EDrawingMode drawingMode, bool daughters )

virtual

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

Parameters

graphicContext	Handle of the device context on which to draw.
drawingMode	Indicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.
daughters	true if the daughters gauges are to be displayed also.

Reimplemented from eVision::Legacy::ELineShape.

Draw() [4/9]

void eVision::Legacy::ELineGauge::Draw ( HDC graphicContext )

virtual

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

Parameters

graphicContext

Handle of the device context on which to draw.

Deprecated

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

Reimplemented from eVision::Legacy::ELineShape.

Draw() [5/9]

void eVision::Legacy::ELineGauge::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

graphicContext	Handle of the device context on which to draw.
color	The color in which to draw the overlay.

Deprecated

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

Reimplemented from eVision::Legacy::ELineShape.

Draw() [6/9]

void eVision::Legacy::ELineGauge::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

graphicContext	Handle of the device context on which to draw.
color	The color in which to draw the overlay.
drawingMode	Indicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.

Deprecated

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

Reimplemented from eVision::Legacy::ELineShape.

Draw() [7/9]

void eVision::Legacy::ELineGauge::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

graphicContext	Handle of the device context on which to draw.
color	The color in which to draw the overlay.
drawingMode	Indicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.
daughters	true if the daughters gauges are to be displayed also.

Deprecated

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

Reimplemented from eVision::Legacy::ELineShape.

Draw() [8/9]

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

virtual

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

Parameters

graphicContext	Handle of the device context on which to draw.
drawingMode	Indicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.

Deprecated

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

Reimplemented from eVision::Legacy::ELineShape.

Draw() [9/9]

void eVision::Legacy::ELineGauge::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

graphicContext	Handle of the device context on which to draw.
drawingMode	Indicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.
daughters	true if the daughters gauges are to be displayed also.

Deprecated

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

Reimplemented from eVision::Legacy::ELineShape.

DrawWithCurrentPen() [1/3]

void eVision::Legacy::ELineGauge::DrawWithCurrentPen ( HDC graphicContext )

virtual

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

Parameters

graphicContext

Handle of the device context on which to draw.

Deprecated

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

Reimplemented from eVision::Legacy::ELineShape.

DrawWithCurrentPen() [2/3]

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

virtual

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

Parameters

graphicContext	Handle of the device context on which to draw.
drawingMode	Indicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.

Deprecated

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

Reimplemented from eVision::Legacy::ELineShape.

DrawWithCurrentPen() [3/3]

void eVision::Legacy::ELineGauge::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

graphicContext	Handle of the device context on which to draw.
drawingMode	Indicates how the point location or model fitting gauge must be displayed, as defined by EDrawingMode.
daughters	true if the daughters gauges are to be displayed also.

Deprecated

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

Reimplemented from eVision::Legacy::ELineShape.

GetActive()

bool eVision::Legacy::ELineGauge::GetActive

(

)

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

When complex gauging is required, several gauges can be grouped together. Applying ELineGauge::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).

GetAverageDistance()

float eVision::Legacy::ELineGauge::GetAverageDistance

(

)

const

Average distance between the sampled points and the fitted model.

Irrelevant in case of a point location operation.

GetClippingMode()

eVision::EClippingMode eVision::Legacy::ELineGauge::GetClippingMode

(

)

const

Clipping mode, that allows to choose how the fitted segment length and center are computed.

By default, the clipping mode is EClippingMode::EClippingMode_CenteredNominal, which corresponds to the behavior appearing in eVision version 6.4 and before.

GetFilteringThreshold()

float eVision::Legacy::ELineGauge::GetFilteringThreshold

(

)

const

Relative filtering threshold, that is the fraction of the average distance between the sampled points and the fitted model above which a point is filtered out.

Irrelevant in case of a point location operation. During a model fitting operation, the "filtering" process can be invoked to remove outliers, i.e. points that were located significantly far away from the fitted model (so that their position is dubious).

GetHVConstraint()

bool eVision::Legacy::ELineGauge::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.

GetKnownAngle()

bool eVision::Legacy::ELineGauge::GetKnownAngle

(

)

const

Flag indicating whether the slope of the line to be fitted is known or not.

A line model to be fitted may have a well-known slope. It is possible to impose the value of this slope, thus removing one degree of freedom. The line fitting gauge slope is set by means of ELineShape::GetAngle. 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.

GetMeasuredLine()

eVision::Legacy::ELine eVision::Legacy::ELineGauge::GetMeasuredLine

(

)

Information pertaining to the fitted line.

Use method EShape::GetFound to get the status of the measurement. ELineGauge::GetMeasuredLine returns a successful fitted line if EShape::GetFound is true, otherwise it returns the orginal (nominal) line.

GetMeasuredPeak() [1/2]

eVision::EPeak eVision::Legacy::ELineGauge::GetMeasuredPeak

(

)

const

Returns information pertaining to the default derivative peak, along one of the sample paths of the gauge.

ELineGauge::GetMeasuredPeak returns the information about the derivative peak that meets the following two requirements:

1. It lies on the sample path inspected with the last call to ELineGauge::MeasureSample, and
2. It is associated with the edge-crossing point along the latter sample path that is selected by the transition choice parameter (cf. ELineGauge::SetTransitionChoice).

Note

For this method to succeed, it is necessary to previously call ELineGauge::MeasureSample.

GetMeasuredPeak() [2/2]

eVision::EPeak eVision::Legacy::ELineGauge::GetMeasuredPeak

(

uint32_t

index

)

const

Returns information pertaining to the default derivative peak, along one of the sample paths of the gauge.

Parameters

index

This argument must be left unchanged from its default value, i.e. ~0 (= 0xFFFFFFFF).

ELineGauge::GetMeasuredPeak returns the information about the derivative peak that meets the following two requirements:

1. It lies on the sample path inspected with the last call to ELineGauge::MeasureSample, and
2. It is associated with the edge-crossing point along the latter sample path that is selected by the transition choice parameter (cf. ELineGauge::SetTransitionChoice).

Note

For this method to succeed, it is necessary to previously call ELineGauge::MeasureSample.

GetMeasuredPoint() [1/2]

eVision::EPoint eVision::Legacy::ELineGauge::GetMeasuredPoint

(

)

Returns the coordinates of a sample point, measured along one of the sample paths of the gauge.

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

The gauging process uses a list of sample points to find the shape position and size that best fit a given image. These sample points are measured along the sample paths defined by the gauge geometry. ELineGauge::GetMeasuredPoint returns the coordinates of the sample point that meets the following two requirements:

1. It lies on the sample path inspected with the last call to ELineGauge::MeasureSample, and
2. Among all the sample points along the latter sample path, it is the one selected by the ELineGauge::SetTransitionChoice property.

Note

For this method to succeed, it is necessary to previously call ELineGauge::MeasureSample.

GetMeasuredPoint() [2/2]

eVision::EPoint eVision::Legacy::ELineGauge::GetMeasuredPoint

(

uint32_t

index

)

Returns the coordinates of a sample point, measured along one of the sample paths of the gauge.

Parameters

index

This argument must be left unchanged from its default value, i.e. ~0 (= 0xFFFFFFFF).

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

The gauging process uses a list of sample points to find the shape position and size that best fit a given image. These sample points are measured along the sample paths defined by the gauge geometry. ELineGauge::GetMeasuredPoint returns the coordinates of the sample point that meets the following two requirements:

1. It lies on the sample path inspected with the last call to ELineGauge::MeasureSample, and
2. Among all the sample points along the latter sample path, it is the one selected by the ELineGauge::SetTransitionChoice property.

Note

For this method to succeed, it is necessary to previously call ELineGauge::MeasureSample.

GetMinAmplitude()

uint32_t eVision::Legacy::ELineGauge::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::ELineGauge::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.

GetMinNumFitSamples() [1/2]

int32_t eVision::Legacy::ELineGauge::GetMinNumFitSamples

(

)

const

Sets/Gets the minimum number of samples required for fitting the shape.

In case of a ELineGauge, a single value is returned. When the ELineGauge::Measure 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.

GetMinNumFitSamples() [2/2]

void eVision::Legacy::ELineGauge::GetMinNumFitSamples	(	int32_t &	side0,
		int32_t &	side1,
		int32_t &	side2,
		int32_t &	side3 )

Returns the minimum number of samples required for fitting the shape.

Parameters

side0	Minimum number of samples to fit the line.
side1	Unused.
side2	Unused.
side3	Unused.

Deprecated

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

GetNumFilteringPasses()

uint32_t eVision::Legacy::ELineGauge::GetNumFilteringPasses

(

)

const

Number of filtering passes for a model fitting operation.

Irrelevant in case of a point location operation. During a filtering pass, the points that are too distant from the model are discarded. During a model fitting operation, the "filtering" process can be invoked to remove outliers, i.e. points that were located significantly far away from the fitted model (so that their position is dubious). By default (the number of filtering passes is 0), the outliers rejection process is disabled.

GetNumMeasuredPoints()

uint32_t eVision::Legacy::ELineGauge::GetNumMeasuredPoints

(

)

const

Number of edge-crossing points along the sample path of the gauge that was inspected with the last call to ELineGauge::MeasureSample.

Note

For this method to succeed, it is necessary to previously call ELineGauge::MeasureSample.

GetNumSamples()

uint32_t eVision::Legacy::ELineGauge::GetNumSamples

(

)

const

Number of sampled points during the model fitting operation.

Irrelevant in case of a point location operation. After a model fitting operation, a number of points have been fitted along the model. Among them, some are not reliable because of their Area value. Among the remaining ones, some are filtered out (NumFilteringPasses, FilteringThreshold).

GetNumSkipRanges()

uint32_t eVision::Legacy::ELineGauge::GetNumSkipRanges

(

)

const

Number of skip ranges in the gauge after a call to ELineGauge::AddSkipRange.

GetNumValidSamples()

uint32_t eVision::Legacy::ELineGauge::GetNumValidSamples

(

)

const

Number of valid sample points remaining after a model fitting operation.

Irrelevant in case of a point location operation. After a model fitting operation, a number of points have been fitted along the model. Among them, some are not reliable because of their Area value. Among the remaining ones, some are filtered out (NumFilteringPasses, FilteringThreshold).

GetRectangularSamplingArea()

bool eVision::Legacy::ELineGauge::GetRectangularSamplingArea

(

)

const

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.

GetSample() [1/2]

bool eVision::Legacy::ELineGauge::GetSample	(	eVision::EPoint &	pt,
		uint32_t	index )

Allows to retrieve the sample points found along the line.

Parameters

pt	EPoint structure that will contain the sample position.
index	The sample index

The method provides the sample point corresponding to the supplied index. The returned value corresponds to the sample validity.

GetSample() [2/2]

void eVision::Legacy::ELineGauge::GetSample	(	eVision::Legacy::ESamplePoint &	pt,
		uint32_t	index )

Allows to retrieve the sample points found along the line.

Parameters

pt	EPoint structure that will contain the sample position.
index	The sample index

The method provides the sample point corresponding to the supplied index. The returned value corresponds to the sample validity.

GetSamplingStep()

float eVision::Legacy::ELineGauge::GetSamplingStep

(

)

const

Approximate distance between sampled points during a model fitting operation.

Irrelevant in case of a point location operation. To fit a model, a series of point location operations are performed along the model. The point location gauges spacing is given by the sampling step. By default, the sampling step is set to 5, which means 5 pixels when the field of view is not calibrated, and 5 physical units in case of a calibrated field of view. Be aware that if the sampling step is too large, the number of sampled points along the model will not be sufficient enough to accurately locate it.

GetShape()

eVision::Legacy::ELine eVision::Legacy::ELineGauge::GetShape

(

)

GetSkipRange() [1/2]

void eVision::Legacy::ELineGauge::GetSkipRange	(	const uint32_t	index,
		uint32_t &	start,
		uint32_t &	end ) const

Allows to retrieve the start and end values of the skip range corresponding to the given index, if it is valid (i.e. if it has previously been created by a call to the ELineGauge::AddSkipRange method.

Parameters

index	Index of the skip range.
start	Beginning of the skip range.
end	End of the skip range.

Start is guaranteed to be smaller or equal to end.

Deprecated

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

GetSkipRange() [2/2]

eVision::EIntegerRange eVision::Legacy::ELineGauge::GetSkipRange

(

uint32_t

index

)

const

Allows to retrieve the start and end values of the skip range corresponding to the given index, if it is valid (i.e. if it has previously been created by a call to the ELineGauge::AddSkipRange method.

Parameters

index

Index of the skip range.

Start is guaranteed to be smaller or equal to end.

GetSmoothing()

uint32_t eVision::Legacy::ELineGauge::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::ELineGauge::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::ELineGauge::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::ELineGauge::GetTolerance

(

)

Searching area half thickness of the line fitting gauge.

By default, the searching area thickness of the line fitting 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.

GetTransitionChoice()

eVision::ETransitionChoice eVision::Legacy::ELineGauge::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 ELineGauge::SetTransitionIndex 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::ELineGauge::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::ELineGauge::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::ELineGauge::GetType ( ) const

virtual

Shape type.

Reimplemented from eVision::Legacy::ELineShape.

GetValid()

bool eVision::Legacy::ELineGauge::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 inspected with the last call to ELineGauge::MeasureSample, and thus a point has been measured.

HitTest() [1/2]

bool eVision::Legacy::ELineGauge::HitTest ( )

virtual

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

Reimplemented from eVision::Legacy::ELineShape.

HitTest() [2/2]

bool eVision::Legacy::ELineGauge::HitTest ( bool daughters )

virtual

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

Parameters

daughters

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

Reimplemented from eVision::Legacy::ELineShape.

Measure() [1/2]

void eVision::Legacy::ELineGauge::Measure

(

eVision::EROIBW8 *

sourceImage

)

Triggers the point location or the model fitting operation.

Parameters

sourceImage

Pointer 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::ELineGauge::Measure	(	eVision::EROIBW8 *	sourceImage,
		const eVision::ERegion &	region )

Triggers the point location or the model fitting operation.

Parameters

sourceImage	Pointer to the source image.
region	Region 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.

MeasureSample() [1/2]

void eVision::Legacy::ELineGauge::MeasureSample	(	eVision::EROIBW8 *	sourceImage,
		const eVision::ERegion &	region,
		uint32_t	pathIndex )

Computes the sample points along the sample path whose index in the list is given by the pathIndex parameter.

Parameters

sourceImage	Pointer to the source image/ROI.
region	Region on which to measure.
pathIndex	Sample path index.

This method stores its results into a temporary variable inside the ELineGauge object.

MeasureSample() [2/2]

void eVision::Legacy::ELineGauge::MeasureSample	(	eVision::EROIBW8 *	sourceImage,
		uint32_t	pathIndex )

Computes the sample points along the sample path whose index in the list is given by the pathIndex parameter.

Parameters

sourceImage	Pointer to the source image/ROI.
pathIndex	Sample path index.

This method stores its results into a temporary variable inside the ELineGauge object.

MeasureWithoutFitting() [1/2]

void eVision::Legacy::ELineGauge::MeasureWithoutFitting

(

eVision::EROIBW8 *

sourceImage

)

Triggers the point location without line fitting operation.

Parameters

sourceImage

Source image.

This method performs the actual measurement for each transition, but does not perform the line fitting. This means that individual samples will be available through the ELineGauge::GetSample method, but the gauge position will not be changed. Please note that the filtering will not be performed in this method, since it relies upon the fitting process. The filtering parameters will thus be unused.

MeasureWithoutFitting() [2/2]

void eVision::Legacy::ELineGauge::MeasureWithoutFitting	(	eVision::EROIBW8 *	sourceImage,
		const eVision::ERegion &	region )

Triggers the point location without line fitting operation.

Parameters

sourceImage	Source image.
region	The region on which to measure.

This method performs the actual measurement for each transition, but does not perform the line fitting. This means that individual samples will be available through the ELineGauge::GetSample method, but the gauge position will not be changed. Please note that the filtering will not be performed in this method, since it relies upon the fitting process. The filtering parameters will thus be unused.

operator=()

eVision::Legacy::ELineGauge & eVision::Legacy::ELineGauge::operator=

(

const eVision::Legacy::ELineGauge &

other

)

Compares the instance with another ELineGauge object and returns true if they are identical.

Parameters

other

ELineGauge object to be compared

Plot() [1/9]

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

Draws the profile that is crossed by one of the sample paths of the gauge, as defined by EPlotItem.

Parameters

graphicContext	Handle of the device context on which to draw.
drawItems	Boolean combination of EPlotItem members, that indicates which items must be displayed.
width	Width of the plot.
height	Height of the plot.

The sample path that is taken into considered is the one inspected with the last call to ELineGauge::MeasureSample.

Note

For this method to succeed, it is necessary to previously call ELineGauge::MeasureSample.

Plot() [2/9]

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

Draws the profile that is crossed by one of the sample paths of the gauge, as defined by EPlotItem.

Parameters

graphicContext	Handle of the device context on which to draw.
drawItems	Boolean combination of EPlotItem members, that indicates which items must be displayed.
width	Width of the plot.
height	Height of the plot.
originX	Origin point coordinates of the plot along the X axis.

The sample path that is taken into considered is the one inspected with the last call to ELineGauge::MeasureSample.

Note

For this method to succeed, it is necessary to previously call ELineGauge::MeasureSample.

Plot() [3/9]

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

Draws the profile that is crossed by one of the sample paths of the gauge, as defined by EPlotItem.

Parameters

graphicContext	Handle of the device context on which to draw.
drawItems	Boolean combination of EPlotItem members, that indicates which items must be displayed.
width	Width of the plot.
height	Height of the plot.
originX	Origin point coordinates of the plot along the X axis.
originY	Origin point coordinates of the plot along the Y axis.

The sample path that is taken into considered is the one inspected with the last call to ELineGauge::MeasureSample.

Note

For this method to succeed, it is necessary to previously call ELineGauge::MeasureSample.

Plot() [4/9]

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

Draws the profile that is crossed by one of the sample paths of the gauge, as defined by EPlotItem.

Parameters

graphicContext	Handle of the device context on which to draw.
color	The color in which to draw the overlay.
drawItems	Boolean combination of EPlotItem members, that indicates which items must be displayed.
width	Width of the plot.
height	Height of the plot.

The sample path that is taken into considered is the one inspected with the last call to ELineGauge::MeasureSample.

Note

For this method to succeed, it is necessary to previously call ELineGauge::MeasureSample.

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::ELineGauge::Plot	(	HDC	graphicContext,
		const eVision::ERGBColor &	color,
		eVision::EPlotItem	drawItems,
		float	width,
		float	height,
		float	originX )

Draws the profile that is crossed by one of the sample paths of the gauge, as defined by EPlotItem.

Parameters

graphicContext	Handle of the device context on which to draw.
color	The color in which to draw the overlay.
drawItems	Boolean combination of EPlotItem members, that indicates which items must be displayed.
width	Width of the plot.
height	Height of the plot.
originX	Origin point coordinates of the plot along the X axis.

The sample path that is taken into considered is the one inspected with the last call to ELineGauge::MeasureSample.

Note

For this method to succeed, it is necessary to previously call ELineGauge::MeasureSample.

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::ELineGauge::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 one of the sample paths of the gauge, as defined by EPlotItem.

Parameters

graphicContext	Handle of the device context on which to draw.
color	The color in which to draw the overlay.
drawItems	Boolean combination of EPlotItem members, that indicates which items must be displayed.
width	Width of the plot.
height	Height of the plot.
originX	Origin point coordinates of the plot along the X axis.
originY	Origin point coordinates of the plot along the Y axis.

The sample path that is taken into considered is the one inspected with the last call to ELineGauge::MeasureSample.

Note

For this method to succeed, it is necessary to previously call ELineGauge::MeasureSample.

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::ELineGauge::Plot	(	HDC	graphicContext,
		eVision::EPlotItem	drawItems,
		float	width,
		float	height )

Draws the profile that is crossed by one of the sample paths of the gauge, as defined by EPlotItem.

Parameters

graphicContext	Handle of the device context on which to draw.
drawItems	Boolean combination of EPlotItem members, that indicates which items must be displayed.
width	Width of the plot.
height	Height of the plot.

The sample path that is taken into considered is the one inspected with the last call to ELineGauge::MeasureSample.

Note

For this method to succeed, it is necessary to previously call ELineGauge::MeasureSample.

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::ELineGauge::Plot	(	HDC	graphicContext,
		eVision::EPlotItem	drawItems,
		float	width,
		float	height,
		float	originX )

Draws the profile that is crossed by one of the sample paths of the gauge, as defined by EPlotItem.

Parameters

graphicContext	Handle of the device context on which to draw.
drawItems	Boolean combination of EPlotItem members, that indicates which items must be displayed.
width	Width of the plot.
height	Height of the plot.
originX	Origin point coordinates of the plot along the X axis.

The sample path that is taken into considered is the one inspected with the last call to ELineGauge::MeasureSample.

Note

For this method to succeed, it is necessary to previously call ELineGauge::MeasureSample.

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::ELineGauge::Plot	(	HDC	graphicContext,
		eVision::EPlotItem	drawItems,
		float	width,
		float	height,
		float	originX,
		float	originY )

Draws the profile that is crossed by one of the sample paths of the gauge, as defined by EPlotItem.

Parameters

graphicContext	Handle of the device context on which to draw.
drawItems	Boolean combination of EPlotItem members, that indicates which items must be displayed.
width	Width of the plot.
height	Height of the plot.
originX	Origin point coordinates of the plot along the X axis.
originY	Origin point coordinates of the plot along the Y axis.

The sample path that is taken into considered is the one inspected with the last call to ELineGauge::MeasureSample.

Note

For this method to succeed, it is necessary to previously call ELineGauge::MeasureSample.

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::ELineGauge::PlotWithCurrentPen	(	HDC	graphicContext,
		eVision::EPlotItem	drawItems,
		float	width,
		float	height )

Draws the profile that is crossed by one of the sample paths of the gauge, as defined by EPlotItem.

Parameters

graphicContext	Handle of the device context on which to draw.
drawItems	Boolean combination of EPlotItem members, that indicates which items must be displayed.
width	Width of the plot.
height	Height of the plot.

The sample path that is taken into considered is the one inspected with the last call to ELineGauge::MeasureSample.

Note

For this method to succeed, it is necessary to previously call ELineGauge::MeasureSample.

Deprecated

Use the overload of ELineGauge::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::ELineGauge::PlotWithCurrentPen	(	HDC	graphicContext,
		eVision::EPlotItem	drawItems,
		float	width,
		float	height,
		float	originX )

Draws the profile that is crossed by one of the sample paths of the gauge, as defined by EPlotItem.

Parameters

graphicContext	Handle of the device context on which to draw.
drawItems	Boolean combination of EPlotItem members, that indicates which items must be displayed.
width	Width of the plot.
height	Height of the plot.
originX	Origin point coordinates of the plot along the X axis.

The sample path that is taken into considered is the one inspected with the last call to ELineGauge::MeasureSample.

Note

For this method to succeed, it is necessary to previously call ELineGauge::MeasureSample.

Deprecated

Use the overload of ELineGauge::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::ELineGauge::PlotWithCurrentPen	(	HDC	graphicContext,
		eVision::EPlotItem	drawItems,
		float	width,
		float	height,
		float	originX,
		float	originY )

Draws the profile that is crossed by one of the sample paths of the gauge, as defined by EPlotItem.

Parameters

graphicContext	Handle of the device context on which to draw.
drawItems	Boolean combination of EPlotItem members, that indicates which items must be displayed.
width	Width of the plot.
height	Height of the plot.
originX	Origin point coordinates of the plot along the X axis.
originY	Origin point coordinates of the plot along the Y axis.

The sample path that is taken into considered is the one inspected with the last call to ELineGauge::MeasureSample.

Note

For this method to succeed, it is necessary to previously call ELineGauge::MeasureSample.

Deprecated

Use the overload of ELineGauge::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::ELineGauge::Process ( eVision::EROIBW8 * sourceImage )

virtual

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

Parameters

sourceImage

Pointer to the BW8 roi 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::ELineGauge::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

sourceImage	Pointer to the BW8 roi source image.
daughters	Flag 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::ELineGauge::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

sourceImage	Pointer to the BW8 roi source image.
region	Region inside of which the processing is limited.

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::ELineGauge::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

sourceImage	Pointer to the BW8 roi source image.
region	Region inside of which the processing is limited.
daughters	Flag 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.

RemoveAllSkipRanges()

void eVision::Legacy::ELineGauge::RemoveAllSkipRanges

(

)

Removes all the skip ranges previously created by a call to ELineGauge::AddSkipRange.

RemoveSkipRange()

void eVision::Legacy::ELineGauge::RemoveSkipRange

(

const uint32_t

index

)

After a call to ELineGauge::AddSkipRange, removes the skip range with the given index.

Parameters

index

Index of the skip range to remove, as returned by ELineGauge::AddSkipRange.

SetActive()

void eVision::Legacy::ELineGauge::SetActive ( bool active )

virtual

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

Parameters

active

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

When complex gauging is required, several gauges can be grouped together. Applying ELineGauge::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.

SetClippingMode()

void eVision::Legacy::ELineGauge::SetClippingMode

(

eVision::EClippingMode

clippingMode

)

Clipping mode, that allows to choose how the fitted segment length and center are computed.

By default, the clipping mode is EClippingMode::EClippingMode_CenteredNominal, which corresponds to the behavior appearing in eVision version 6.4 and before.

SetFilteringThreshold()

void eVision::Legacy::ELineGauge::SetFilteringThreshold

(

float

f32FilteringThreshold

)

Relative filtering threshold, that is the fraction of the average distance between the sampled points and the fitted model above which a point is filtered out.

Irrelevant in case of a point location operation. During a model fitting operation, the "filtering" process can be invoked to remove outliers, i.e. points that were located significantly far away from the fitted model (so that their position is dubious).

SetHVConstraint()

void eVision::Legacy::ELineGauge::SetHVConstraint

(

bool

HVConstraint

)

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.

SetKnownAngle()

void eVision::Legacy::ELineGauge::SetKnownAngle

(

bool

bKnownAngle

)

Flag indicating whether the slope of the line to be fitted is known or not.

A line model to be fitted may have a well-known slope. It is possible to impose the value of this slope, thus removing one degree of freedom. The line fitting gauge slope is set by means of ELineShape::GetAngle. 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.

SetLine()

void eVision::Legacy::ELineGauge::SetLine ( const eVision::Legacy::ELine & line )

virtual

Sets the nominal position, length and rotation angle of the line fitting gauge, according to a known ELine object.

Reimplemented from eVision::Legacy::ELineShape.

SetMinAmplitude()

void eVision::Legacy::ELineGauge::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::ELineGauge::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.

SetMinNumFitSamples()

void eVision::Legacy::ELineGauge::SetMinNumFitSamples

(

int32_t

side

)

Sets/Gets the minimum number of samples required for fitting the shape.

Parameters

side	Minimum number of samples to fit the line, default is 2.

In case of a ELineGauge, a single value is returned. When the ELineGauge::Measure 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.

SetNumFilteringPasses()

void eVision::Legacy::ELineGauge::SetNumFilteringPasses

(

uint32_t

un32NumFilteringPasses

)

Number of filtering passes for a model fitting operation.

Irrelevant in case of a point location operation. During a filtering pass, the points that are too distant from the model are discarded. During a model fitting operation, the "filtering" process can be invoked to remove outliers, i.e. points that were located significantly far away from the fitted model (so that their position is dubious). By default (the number of filtering passes is 0), the outliers rejection process is disabled.

SetRectangularSamplingArea()

void eVision::Legacy::ELineGauge::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.

SetSamplingStep()

void eVision::Legacy::ELineGauge::SetSamplingStep

(

float

f32SamplingStep

)

Approximate distance between sampled points during a model fitting operation.

Irrelevant in case of a point location operation. To fit a model, a series of point location operations are performed along the model. The point location gauges spacing is given by the sampling step. By default, the sampling step is set to 5, which means 5 pixels when the field of view is not calibrated, and 5 physical units in case of a calibrated field of view. Be aware that if the sampling step is too large, the number of sampled points along the model will not be sufficient enough to accurately locate it.

SetSmoothing()

void eVision::Legacy::ELineGauge::SetSmoothing

(

uint32_t

smoothing

)

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::ELineGauge::SetThickness

(

uint32_t

thickness

)

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::ELineGauge::SetThreshold

(

uint32_t

threshold

)

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::ELineGauge::SetTolerance

(

float

tolerance

)

Searching area half thickness of the line fitting gauge.

By default, the searching area thickness of the line fitting 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.

SetTransitionChoice()

void eVision::Legacy::ELineGauge::SetTransitionChoice

(

eVision::ETransitionChoice

transitionChoice

)

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 ELineGauge::SetTransitionIndex 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::ELineGauge::SetTransitionIndex

(

uint32_t

transitionIndex

)

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::ELineGauge::SetTransitionType

(

eVision::ETransitionType

transitionType

)

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