eVision Python API
Loading...
Searching...
No Matches
eVision.Legacy.EPolygonGauge Class Reference

Manages a polygon fitting gauge. More...

Inheritance diagram for eVision.Legacy.EPolygonGauge:
Collaboration diagram for eVision.Legacy.EPolygonGauge:

Public Member Functions

None __init__ (self)
 Constructs a polygon measurement context.
None __init__ (self, eVision.Legacy.EPolygonGauge other)
 Constructs a polygon measurement context.
int AddSkipRange (self, eVision.EIntegerRange range)
 Adds an item to the set of skip ranges and returns the index of the newly added range.
eVision.EIntegerRange GetSkipRange (self, int index)
 Allows to retrieve the start and end values of the skip range corresponding to the given index, if it is valid (i.e.
None RemoveSkipRange (self, int index)
 After a call to eVision.Legacy.EPolygonGauge.AddSkipRange, removes the skip range with the given index.
None RemoveAllSkipRanges (self)
 Removes all the skip ranges previously created by a call to eVision.Legacy.EPolygonGauge.AddSkipRange.
None CopyTo (self, eVision.Legacy.EPolygonGauge other, bool recursive)
 Copies all the data of the current eVision.Legacy.EPolygonGauge object into another eVision.Legacy.EPolygonGauge object, and returns it.
None CopyTo (self, eVision.Legacy.EPolygonGauge other)
 Copies all the data of the current eVision.Legacy.EPolygonGauge object into another eVision.Legacy.EPolygonGauge object, and returns it.
None Process (self, eVision.EROIBW8|None sourceImage, bool daughters)
 Triggers the process pertaining to a shape or gauge and all the daughter gauges attach to it.
None Process (self, eVision.EROIBW8|None sourceImage)
 Triggers the process pertaining to a shape or gauge and all the daughter gauges attach to it.
None Process (self, eVision.EROIBW8|None sourceImage, eVision.ERegion region, bool daughters)
 Triggers the process pertaining to a shape or gauge and all the daughter gauges attach to it.
None Process (self, eVision.EROIBW8|None sourceImage, eVision.ERegion region)
 Triggers the process pertaining to a shape or gauge and all the daughter gauges attach to it.
None Measure (self, eVision.EROIBW8|None sourceImage)
 Triggers the point location or the model fitting operation.
None Measure (self, eVision.EROIBW8|None sourceImage, eVision.ERegion region)
 Triggers the point location or the model fitting operation.
None MeasureSample (self, eVision.EROIBW8|None image, int edgeIndex, int sampleIndex)
 Computes the sample points along the sample path whose index in the list is given by the edgeIndex and sampleIndex parameters.
None MeasureSample (self, eVision.EROIBW8|None image, eVision.ERegion region, int edgeIndex, int sampleIndex)
 Computes the sample points along the sample path whose index in the list is given by the edgeIndex and sampleIndex parameters.
None Draw (self, eVision.EDrawAdapter|None drawAdapter, eVision.EDrawingMode drawingMode, bool daughters)
 Draws a graphical representation of a point location or model fitting gauge, as defined by eVision.EDrawingMode.
None Draw (self, eVision.EDrawAdapter|None drawAdapter, eVision.EDrawingMode drawingMode)
 Draws a graphical representation of a point location or model fitting gauge, as defined by eVision.EDrawingMode.
None Draw (self, eVision.EDrawAdapter|None drawAdapter)
 Draws a graphical representation of a point location or model fitting gauge, as defined by eVision.EDrawingMode.
bool HitTest (self, bool daughters)
 Checks whether the cursor is positioned over a handle (true) or not (false).
bool HitTest (self)
 Checks whether the cursor is positioned over a handle (true) or not (false).
None Drag (self, int x, int y)
 Moves a handle to a new position and updates the position parameters of the gauge.
float FilteringThreshold (self)
 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.
 FilteringThreshold (self, float value)
 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.
int NumFilteringPasses (self)
 Number of filtering passes for a model fitting operation.
 NumFilteringPasses (self, int value)
 Number of filtering passes for a model fitting operation.
int NumFilteringPassesInt (self)
 NumFilteringPassesInt (self, int value)
int NumValidSamples (self)
 Number of valid sample points remaining after a model fitting operation.
float AverageDistance (self)
 Average distance between the sampled points and the fitted model.
int MinNumFitSamples (self)
 Returns the minimum number of samples required for fitting on each edges of the polygon.
 MinNumFitSamples (self, int value)
 Returns the minimum number of samples required for fitting on each edges of the polygon.
int NumSkipRanges (self)
 Number of skip ranges in the gauge after a call to eVision.Legacy.EPolygonGauge.AddSkipRange.
eVision.EShapeType Type (self)
 Shape type.
eVision.Legacy.EPolygon Shape (self)
bool Active (self)
 Sets the flag indicating whether the gauge is active or not.
 Active (self, bool value)
 Sets the flag indicating whether the gauge is active or not.
float Tolerance (self)
 Searching area half thickness of the polygon fitting gauge.
 Tolerance (self, float value)
 Searching area half thickness of the polygon fitting gauge.
bool HVConstraint (self)
 Status of the restriction on the orientation of the point location gauge or model fitting sample paths.
 HVConstraint (self, bool value)
 Status of the restriction on the orientation of the point location gauge or model fitting sample paths.
eVision.ETransitionType TransitionType (self)
 Transition type.
 TransitionType (self, eVision.ETransitionType value)
 Transition type.
eVision.ETransitionChoice TransitionChoice (self)
 Transition choice.
 TransitionChoice (self, eVision.ETransitionChoice value)
 Transition choice.
int TransitionIndex (self)
 Index (from 0 on) of the transition to be retained when the transition choice parameter is set to eVision.ETransitionChoice.NthFromBegin or eVision.ETransitionChoice.NthFromEnd.
 TransitionIndex (self, int value)
 Index (from 0 on) of the transition to be retained when the transition choice parameter is set to eVision.ETransitionChoice.NthFromBegin or eVision.ETransitionChoice.NthFromEnd.
int Threshold (self)
 Threshold level used to delimit significant peaks in the data profile.
 Threshold (self, int value)
 Threshold level used to delimit significant peaks in the data profile.
int MinAmplitude (self)
 Offset added to the Threshold when a peak is to be detected.
 MinAmplitude (self, int value)
 Offset added to the Threshold when a peak is to be detected.
int MinArea (self)
 Minimum area value.
 MinArea (self, int value)
 Minimum area value.
int Thickness (self)
 Number of parallel segments used to extract the data profile.
 Thickness (self, int value)
 Number of parallel segments used to extract the data profile.
int Smoothing (self)
 Number of pixels used for the low-pass filtering operation.
 Smoothing (self, int value)
 Number of pixels used for the low-pass filtering operation.
float SamplingStep (self)
 Approximate distance between sampled points during a model fitting operation.
 SamplingStep (self, float value)
 Approximate distance between sampled points during a model fitting operation.
int NumSamples (self)
 Number of sampled points during the model fitting operation.
eVision.Legacy.EPolygonMeasurementMode MeasurementMode (self)
 The polygon gauge measurement mode, in eVision.Legacy.EPolygonMeasurementMode.
 MeasurementMode (self, eVision.Legacy.EPolygonMeasurementMode value)
 The polygon gauge measurement mode, in eVision.Legacy.EPolygonMeasurementMode.
bool EnableScaling (self)
 When using the eVision.Legacy.EPolygonMeasurementMode.Global mode, if eVision.Legacy.EPolygonGauge.EnableScaling is enable then the best scale is evaluated.
 EnableScaling (self, bool value)
 When using the eVision.Legacy.EPolygonMeasurementMode.Global mode, if eVision.Legacy.EPolygonGauge.EnableScaling is enable then the best scale is evaluated.
eVision.Legacy.EPolygon MeasuredPolygon (self)
 Returns the measured polygon (if found) or the nominal polygon otherwise.
Public Member Functions inherited from eVision.Legacy.EPolygonShape
None __init__ (self)
 Constructs a eVision.Legacy.EPolygonShape.
None __init__ (self, eVision.Legacy.EPolygonShape other)
 Constructs a eVision.Legacy.EPolygonShape.
None __init__ (self, list[eVision._eVision.EPoint] vertices, bool closed)
 Constructs a eVision.Legacy.EPolygonShape.
None __init__ (self, list[eVision._eVision.EPoint] vertices)
 Constructs a eVision.Legacy.EPolygonShape.
None AddVertexAtDisplayPosition (self, int x, int y)
 Add a vertex to the polygon at a position depending on a display coordinate.
None RemoveVertexAtDisplayPosition (self, int x, int y)
 Remove the closest vertex to the display position (x,y).
None SetCenterXY (self, float centerX, float centerY)
 Sets the center coordinates of a eVision.Legacy.EPolygonShape object.
eVision.EPoint GetVertex (self, int index)
 Gets a polygon vertex.
None SetVertex (self, int index, eVision.EPoint pt)
 Sets a polygon vertex.
None AppendVertex (self, eVision.EPoint pt)
 Append a polygon vertex after the last.
None Closest (self)
 Find the daughter shape that is the closest to this shape.
eVision.EPoint Center (self)
 Center point of the shape.
 Center (self, eVision.EPoint value)
 Center point of the shape.
float CenterX (self)
 Abscissa of the origin point of the shape.
float CenterY (self)
 Ordinate of the origin point of the shape.
float Angle (self)
 Orientation of the shape.
 Angle (self, float value)
 Orientation of the shape.
float Scale (self)
 Scale of the polygon.
 Scale (self, float value)
 Scale of the polygon.
float Length (self)
 Returns the length (perimeter) of the polygon.
bool IsClosed (self)
 The polygon close attribute.
 IsClosed (self, bool value)
 The polygon close attribute.
eVision.Legacy.EPolygon Polygon (self)
 Sets/Gets the polygon according to a known eVision.Legacy.EPolygon object.
 Polygon (self, eVision.Legacy.EPolygon value)
 Sets/Gets the polygon according to a known eVision.Legacy.EPolygon object.
int NumVertices (self)
 Returns the number of polygon's vertices.
int NumEdges (self)
 Returns the number of polygon's edges (or sides).
Public Member Functions inherited from eVision.Legacy.EShape
eVision.Legacy.EShape|None GetShapeNamed (self, str name)
 Returns a pointer to a daughter gauge or shape specified by its name.
bool GetFound (self)
 Flag indicating whether a measured shape has been found.
bool GetAutoArrange (self)
None SetAutoArrange (self, bool bAutoArrange, bool bDaughters)
None SetAutoArrange (self, bool bAutoArrange)
None SetFound (self, bool bFound, bool bDaughters)
None SetFound (self, bool bFound)
bool GetInspected (self)
None SetInspected (self, bool bFound, bool bDaughters)
None SetInspected (self, bool bFound)
bool GetPassed (self)
None SetPassed (self, bool bFound, bool bDaughters)
None SetPassed (self, bool bFound)
bool GetQuickDraw (self)
None SetQuickDraw (self, bool bFound, bool bDaughters)
None SetQuickDraw (self, bool bFound)
bool GetOptionalDraw (self)
None SetOptionalDraw (self, bool bFound, bool bDaughters)
None SetOptionalDraw (self, bool bFound)
bool GetUserFlag (self)
None SetUserFlag (self, bool bUserFlag, bool bDaughters)
None SetUserFlag (self, bool bUserFlag)
bool GetAllocated (self)
 Gets the allocated flag.
None EnableBehaviorFilter (self, 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.
None EnableBehaviorFilter (self, 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.
None DisableBehaviorFilter (self, eVision.EShapeBehavior behavior)
 Disables (i.e.
None Attach (self, eVision.Legacy.EShape|None mother)
 Attaches the gauge to a mother gauge or shape.
None Detach (self)
 Detaches the gauge from its mother gauge or shape.
None DetachDaughters (self)
 Detaches the daughter gauges or shapes.
eVision.Legacy.EShape|None GetDaughter (self, int index)
 Returns a pointer to the specified daughter gauge or shape.
bool IsWorld (self)
None InvalidateWorld (self)
 Invalidates the world shape for this shape and all its ancestors.
eVision.EPoint LocalToSensor (self, eVision.EPoint LPoint)
 Transforms a point from local coordinates to sensor coordinates.
eVision.EPoint SensorToLocal (self, eVision.EPoint SPoint)
 Transforms a point from sensor coordinates to local coordinates.
None SetZoom (self, float zoomX, float zoomY)
 Sets the horizontal and vertical zooming factors for drawing operations.
None SetZoom (self, float zoomX)
 Sets the horizontal and vertical zooming factors for drawing operations.
None SetZoom (self)
 Sets the horizontal and vertical zooming factors for drawing operations.
None SetPan (self, float panX, float panY)
 Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.
None SetPan (self, float panX)
 Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.
None SetPan (self)
 Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.
None SetDraggingMode (self, eVision.EDraggingMode eDraggingMode, bool bDaughters)
 Sets the dragging mode which defines how the shape could be dragged.
None SetDraggingMode (self, eVision.EDraggingMode eDraggingMode)
 Sets the dragging mode which defines how the shape could be dragged.
eVision.EDraggingMode GetDraggingMode (self)
 Gets the dragging mode which defines how the shape could be dragged.
None SetCursor (self, int x, int y)
 Sets the cursor current coordinates.
None Save (self, str path, bool daughters)
 Loads a Shape.The given eVision.ESerializer must have been created for writing.
None Save (self, str path)
 Loads a Shape.The given eVision.ESerializer must have been created for writing.
None Save (self, eVision.ESerializer|None serializer, bool daughters)
 Loads a Shape.The given eVision.ESerializer must have been created for writing.
None Save (self, eVision.ESerializer|None serializer)
 Loads a Shape.The given eVision.ESerializer must have been created for writing.
None Load (self, str path, bool daughters)
 Loads a Shape.The given eVision.ESerializer must have been created for reading.
None Load (self, str path)
 Loads a Shape.The given eVision.ESerializer must have been created for reading.
None Load (self, eVision.ESerializer|None serializer, bool daughters)
 Loads a Shape.The given eVision.ESerializer must have been created for reading.
None Load (self, eVision.ESerializer|None serializer)
 Loads a Shape.The given eVision.ESerializer must have been created for reading.
bool HasProperty (self, str aProperty)
 Returns whether a eVision.Legacy.EShape has a property named aProperty.
str GetProperty (self, str aProperty)
 Gets the value of property aProperty.
None SetProperty (self, str aProperty, str aValue)
 Sets the value of property aProperty to aValue for this eVision.Legacy.EShape.
None SetPropertyRecursive (self, str aProperty, str aValue)
 Sets the value of property aProperty to aValue for this eVision.Legacy.EShape and all of its daughters.
None RemoveProperty (self, str aProperty)
 Removes the property name aProperty from the eVision.Legacy.EShape.
bool HasValidPolarityProperty (self)
 Returns whether the eVision.Legacy.EShape has a valid polarity property.
None EnableTypeFilter (self, int un32Types)
 Enables the filter of the specified shape type.
None DisableTypeFilter (self)
 Enables all shape types.
str Name (self)
 Name of the eVision.Legacy.EShape object.
 Name (self, str value)
 Name of the eVision.Legacy.EShape object.
bool Visible (self)
 Flag indicating whether the shape is visible or not.
 Visible (self, bool value)
 Flag indicating whether the shape is visible or not.
bool Selected (self)
 Flag indicating whether the shape is selected or not.
 Selected (self, bool value)
 Flag indicating whether the shape is selected or not.
bool Selectable (self)
 Flag indicating whether the shape can be selected or not.
 Selectable (self, bool value)
 Flag indicating whether the shape can be selected or not.
bool Dragable (self)
 Flag indicating whether the shape can be dragged or not.
 Dragable (self, bool value)
 Flag indicating whether the shape can be dragged or not.
bool Resizable (self)
 Flag indicating whether the shape can be resized or not.
 Resizable (self, bool value)
 Flag indicating whether the shape can be resized or not.
bool Rotatable (self)
 Flag indicating whether the shape can be rotated or not.
 Rotatable (self, bool value)
 Flag indicating whether the shape can be rotated or not.
bool Labeled (self)
 Flag indicating whether the shape label should be displayed or not.
 Labeled (self, bool value)
 Flag indicating whether the shape label should be displayed or not.
bool ActualShape (self)
 Flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).
 ActualShape (self, bool value)
 Flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).
int NumDaughters (self)
 Number of daughters attached to the shape.
eVision.Legacy.EShape|None Mother (self)
 Pointer to the mother shape.
eVision.Legacy.EWorldShape|None WorldShape (self)
 World ancestor.
float ZoomX (self)
 Current horizontal zooming factor for drawing operations.
float ZoomY (self)
 Current vertical zooming factor for drawing operations.
float PanX (self)
 Current horizontal panning value for drawing operations, expressed in pixels.
float PanY (self)
 Current vertical panning value for drawing operations, expressed in pixels.
eVision.EDragHandle HitHandle (self)
 Handle currently under the cursor.
eVision.Legacy.EShape|None HitShape (self)
 Pointer to the shape currently under the cursor.
eVision.Legacy.EShape|None ClosestShape (self)
 Closest shape among the daughters.

Additional Inherited Members

Protected Member Functions inherited from eVision.Legacy.EShape
 _VisibleRecursive__setter (self, bool value)
 Sets the flag indicating whether the shape and its daughter shapes are visible or not.
 _SelectedRecursive__setter (self, bool value)
 Sets the flag indicating whether the shape and all its daughters are selected or not.
 _SelectableRecursive__setter (self, bool value)
 Sets the flag indicating whether the shape and all its daughters can be selected or not.
 _DragableRecursive__setter (self, bool value)
 Sets the flag indicating whether the shape and all its daughters can be dragged or not.
 _ResizableRecursive__setter (self, bool value)
 Sets the flag indicating whether the shape and all its daughters can be resized or not.
 _RotatableRecursive__setter (self, bool value)
 Sets the flag indicating whether the shape and all its daughters can be rotated or not.
 _LabeledRecursive__setter (self, bool value)
 Sets the flag indicating whether the shape label should be displayed or not.
 _ActiveRecursive__setter (self, bool value)
 Sets the flag indicating whether the shape and all its daughters are active or not.
 _ActualShapeRecursive__setter (self, bool value)
 Sets the flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).
Properties inherited from eVision.Legacy.EShape
 VisibleRecursive
 SelectedRecursive
 SelectableRecursive
 DragableRecursive
 ResizableRecursive
 RotatableRecursive
 LabeledRecursive
 ActiveRecursive
 ActualShapeRecursive

Detailed Description

Manages a polygon fitting gauge.

Remarks:

License(s): EasyGauge

Constructor & Destructor Documentation

◆ __init__() [1/2]

None eVision.Legacy.EPolygonGauge.__init__ ( self)

Constructs a polygon measurement context.

Remarks:

With the default constructor, all the parameters are initialized to their respective default values.

With the copy constructor, the constructed polygon measurement context is based on a pre-existing eVision.Legacy.EPolygonGauge object. The gauge children are also copied. Hierarchy copying through a copy constructor is always recursive. To disable this recursion, use instead the eVision.Legacy.EPolygonGauge.CopyTo method.

◆ __init__() [2/2]

None eVision.Legacy.EPolygonGauge.__init__ ( self,
eVision.Legacy.EPolygonGauge other )

Constructs a polygon measurement context.

Remarks:

With the default constructor, all the parameters are initialized to their respective default values.

With the copy constructor, the constructed polygon measurement context is based on a pre-existing eVision.Legacy.EPolygonGauge object. The gauge children are also copied. Hierarchy copying through a copy constructor is always recursive. To disable this recursion, use instead the eVision.Legacy.EPolygonGauge.CopyTo method.

Parameters
otherAnother eVision.Legacy.EPolygonGauge object to be copied in the new eVision.Legacy.EPolygonGauge object.

Member Function Documentation

◆ Active() [1/2]

bool eVision.Legacy.EPolygonGauge.Active ( self)

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

Remarks:

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

◆ Active() [2/2]

eVision.Legacy.EPolygonGauge.Active ( self,
bool value )

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

Remarks:

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

◆ AddSkipRange()

int eVision.Legacy.EPolygonGauge.AddSkipRange ( self,
eVision.EIntegerRange range )

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

Remarks:

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 eVision.Legacy.EPolygonGauge. 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 eVision.Legacy.EPolygonGauge.NumSamples).

Parameters
rangeThe skip range.

◆ AverageDistance()

float eVision.Legacy.EPolygonGauge.AverageDistance ( self)

Average distance between the sampled points and the fitted model.

Remarks:

Irrelevant in case of a point location operation.

◆ CopyTo() [1/2]

None eVision.Legacy.EPolygonGauge.CopyTo ( self,
eVision.Legacy.EPolygonGauge other )

Copies all the data of the current eVision.Legacy.EPolygonGauge object into another eVision.Legacy.EPolygonGauge object, and returns it.

Remarks:

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

Parameters
otherPointer to the eVision.Legacy.EPolygonGauge object in which the current eVision.Legacy.EPolygonGauge object data have to be copied.

Reimplemented from eVision.Legacy.EPolygonShape.

◆ CopyTo() [2/2]

None eVision.Legacy.EPolygonGauge.CopyTo ( self,
eVision.Legacy.EPolygonGauge other,
bool recursive )

Copies all the data of the current eVision.Legacy.EPolygonGauge object into another eVision.Legacy.EPolygonGauge object, and returns it.

Remarks:

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

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

Reimplemented from eVision.Legacy.EPolygonShape.

◆ Drag()

None eVision.Legacy.EPolygonGauge.Drag ( self,
int x,
int y )

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

◆ Draw() [1/3]

None eVision.Legacy.EPolygonGauge.Draw ( self,
eVision.EDrawAdapter | None drawAdapter )

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

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

Reimplemented from eVision.Legacy.EPolygonShape.

◆ Draw() [2/3]

None eVision.Legacy.EPolygonGauge.Draw ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.EDrawingMode drawingMode )

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

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

Reimplemented from eVision.Legacy.EPolygonShape.

◆ Draw() [3/3]

None eVision.Legacy.EPolygonGauge.Draw ( self,
eVision.EDrawAdapter | None drawAdapter,
eVision.EDrawingMode drawingMode,
bool daughters )

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

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

Reimplemented from eVision.Legacy.EPolygonShape.

◆ EnableScaling() [1/2]

bool eVision.Legacy.EPolygonGauge.EnableScaling ( self)

When using the eVision.Legacy.EPolygonMeasurementMode.Global mode, if eVision.Legacy.EPolygonGauge.EnableScaling is enable then the best scale is evaluated.

◆ EnableScaling() [2/2]

eVision.Legacy.EPolygonGauge.EnableScaling ( self,
bool value )

When using the eVision.Legacy.EPolygonMeasurementMode.Global mode, if eVision.Legacy.EPolygonGauge.EnableScaling is enable then the best scale is evaluated.

◆ FilteringThreshold() [1/2]

float eVision.Legacy.EPolygonGauge.FilteringThreshold ( self)

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.

Remarks:

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

◆ FilteringThreshold() [2/2]

eVision.Legacy.EPolygonGauge.FilteringThreshold ( self,
float value )

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.

Remarks:

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

◆ GetSkipRange()

eVision.EIntegerRange eVision.Legacy.EPolygonGauge.GetSkipRange ( self,
int index )

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 eVision.Legacy.EPolygonGauge.AddSkipRange method.

Remarks:

Start is guaranteed to be smaller or equal to end.

Parameters
indexIndex of the skip range.

◆ HitTest() [1/2]

bool eVision.Legacy.EPolygonGauge.HitTest ( self)

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

Reimplemented from eVision.Legacy.EPolygonShape.

◆ HitTest() [2/2]

bool eVision.Legacy.EPolygonGauge.HitTest ( self,
bool daughters )

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

◆ HVConstraint() [1/2]

bool eVision.Legacy.EPolygonGauge.HVConstraint ( self)

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

Remarks:

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

◆ HVConstraint() [2/2]

eVision.Legacy.EPolygonGauge.HVConstraint ( self,
bool value )

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

Remarks:

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

◆ Measure() [1/2]

None eVision.Legacy.EPolygonGauge.Measure ( self,
eVision.EROIBW8 | None sourceImage )

Triggers the point location or the model fitting operation.

Remarks:

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.

Parameters
sourceImagePointer to the source image.

◆ Measure() [2/2]

None eVision.Legacy.EPolygonGauge.Measure ( self,
eVision.EROIBW8 | None sourceImage,
eVision.ERegion region )

Triggers the point location or the model fitting operation.

Remarks:

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.

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

◆ MeasuredPolygon()

eVision.Legacy.EPolygon eVision.Legacy.EPolygonGauge.MeasuredPolygon ( self)

Returns the measured polygon (if found) or the nominal polygon otherwise.

Remarks:

Use method eVision.Legacy.EShape.GetFound to get the status of the measurement. eVision.Legacy.EPolygonGauge.MeasuredPolygon returns a successful fitted polygon if eVision.Legacy.EShape.GetFound is true, otherwise it returns the orginal (nominal) polygon.

◆ MeasurementMode() [1/2]

eVision.Legacy.EPolygonMeasurementMode eVision.Legacy.EPolygonGauge.MeasurementMode ( self)

The polygon gauge measurement mode, in eVision.Legacy.EPolygonMeasurementMode.

The default mode is eVision.Legacy.EPolygonMeasurementMode.Global.

◆ MeasurementMode() [2/2]

eVision.Legacy.EPolygonGauge.MeasurementMode ( self,
eVision.Legacy.EPolygonMeasurementMode value )

The polygon gauge measurement mode, in eVision.Legacy.EPolygonMeasurementMode.

The default mode is eVision.Legacy.EPolygonMeasurementMode.Global.

◆ MeasureSample() [1/2]

None eVision.Legacy.EPolygonGauge.MeasureSample ( self,
eVision.EROIBW8 | None image,
eVision.ERegion region,
int edgeIndex,
int sampleIndex )

Computes the sample points along the sample path whose index in the list is given by the edgeIndex and sampleIndex parameters.

Remarks:

This method stores its results into a temporary variable inside the eVision.Legacy.EPolygonGauge object.

Parameters
imagePointer to the source image/ROI.
regionRegion on which to measure.
edgeIndexIndex of the edge to inspect within the edges of the polygon.
sampleIndexIndex of the sample to inspect within the selected edge.

◆ MeasureSample() [2/2]

None eVision.Legacy.EPolygonGauge.MeasureSample ( self,
eVision.EROIBW8 | None image,
int edgeIndex,
int sampleIndex )

Computes the sample points along the sample path whose index in the list is given by the edgeIndex and sampleIndex parameters.

Remarks:

This method stores its results into a temporary variable inside the eVision.Legacy.EPolygonGauge object.

Parameters
imagePointer to the source image/ROI.
edgeIndexIndex of the edge to inspect within the edges of the polygon.
sampleIndexIndex of the sample to inspect within the selected edge.

◆ MinAmplitude() [1/2]

int eVision.Legacy.EPolygonGauge.MinAmplitude ( self)

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

Remarks:

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.

◆ MinAmplitude() [2/2]

eVision.Legacy.EPolygonGauge.MinAmplitude ( self,
int value )

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

Remarks:

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.

◆ MinArea() [1/2]

int eVision.Legacy.EPolygonGauge.MinArea ( self)

Minimum area value.

Remarks:

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.

◆ MinArea() [2/2]

eVision.Legacy.EPolygonGauge.MinArea ( self,
int value )

Minimum area value.

Remarks:

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.

◆ MinNumFitSamples() [1/2]

int eVision.Legacy.EPolygonGauge.MinNumFitSamples ( self)

Returns the minimum number of samples required for fitting on each edges of the polygon.

◆ MinNumFitSamples() [2/2]

eVision.Legacy.EPolygonGauge.MinNumFitSamples ( self,
int value )

Returns the minimum number of samples required for fitting on each edges of the polygon.

◆ NumFilteringPasses() [1/2]

int eVision.Legacy.EPolygonGauge.NumFilteringPasses ( self)

Number of filtering passes for a model fitting operation.

Remarks:

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.

◆ NumFilteringPasses() [2/2]

eVision.Legacy.EPolygonGauge.NumFilteringPasses ( self,
int value )

Number of filtering passes for a model fitting operation.

Remarks:

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.

◆ NumFilteringPassesInt() [1/2]

int eVision.Legacy.EPolygonGauge.NumFilteringPassesInt ( self)

◆ NumFilteringPassesInt() [2/2]

eVision.Legacy.EPolygonGauge.NumFilteringPassesInt ( self,
int value )

◆ NumSamples()

int eVision.Legacy.EPolygonGauge.NumSamples ( self)

Number of sampled points during the model fitting operation.

The samples are distributed evenly on the polygon.

Remarks:

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

◆ NumSkipRanges()

int eVision.Legacy.EPolygonGauge.NumSkipRanges ( self)

Number of skip ranges in the gauge after a call to eVision.Legacy.EPolygonGauge.AddSkipRange.

◆ NumValidSamples()

int eVision.Legacy.EPolygonGauge.NumValidSamples ( self)

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

Remarks:

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

◆ Process() [1/4]

None eVision.Legacy.EPolygonGauge.Process ( self,
eVision.EROIBW8 | None sourceImage )

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

Remarks:

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.

Parameters
sourceImagePointer to the source image.

Reimplemented from eVision.Legacy.EShape.

◆ Process() [2/4]

None eVision.Legacy.EPolygonGauge.Process ( self,
eVision.EROIBW8 | None sourceImage,
bool daughters )

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

Remarks:

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.

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

Reimplemented from eVision.Legacy.EShape.

◆ Process() [3/4]

None eVision.Legacy.EPolygonGauge.Process ( self,
eVision.EROIBW8 | None sourceImage,
eVision.ERegion region )

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

Remarks:

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.

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

Reimplemented from eVision.Legacy.EShape.

◆ Process() [4/4]

None eVision.Legacy.EPolygonGauge.Process ( self,
eVision.EROIBW8 | None sourceImage,
eVision.ERegion region,
bool daughters )

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

Remarks:

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.

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

Reimplemented from eVision.Legacy.EShape.

◆ RemoveAllSkipRanges()

None eVision.Legacy.EPolygonGauge.RemoveAllSkipRanges ( self)

Removes all the skip ranges previously created by a call to eVision.Legacy.EPolygonGauge.AddSkipRange.

◆ RemoveSkipRange()

None eVision.Legacy.EPolygonGauge.RemoveSkipRange ( self,
int index )

After a call to eVision.Legacy.EPolygonGauge.AddSkipRange, removes the skip range with the given index.

Parameters
indexIndex of the skip range to remove, as returned by eVision.Legacy.EPolygonGauge.AddSkipRange.

◆ SamplingStep() [1/2]

float eVision.Legacy.EPolygonGauge.SamplingStep ( self)

Approximate distance between sampled points during a model fitting operation.

Remarks:

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.

◆ SamplingStep() [2/2]

eVision.Legacy.EPolygonGauge.SamplingStep ( self,
float value )

Approximate distance between sampled points during a model fitting operation.

Remarks:

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.

◆ Shape()

eVision.Legacy.EPolygon eVision.Legacy.EPolygonGauge.Shape ( self)

◆ Smoothing() [1/2]

int eVision.Legacy.EPolygonGauge.Smoothing ( self)

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

Remarks:

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

◆ Smoothing() [2/2]

eVision.Legacy.EPolygonGauge.Smoothing ( self,
int value )

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

Remarks:

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

◆ Thickness() [1/2]

int eVision.Legacy.EPolygonGauge.Thickness ( self)

Number of parallel segments used to extract the data profile.

Remarks:

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

◆ Thickness() [2/2]

eVision.Legacy.EPolygonGauge.Thickness ( self,
int value )

Number of parallel segments used to extract the data profile.

Remarks:

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

◆ Threshold() [1/2]

int eVision.Legacy.EPolygonGauge.Threshold ( self)

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

Remarks:

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.

◆ Threshold() [2/2]

eVision.Legacy.EPolygonGauge.Threshold ( self,
int value )

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

Remarks:

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.

◆ Tolerance() [1/2]

float eVision.Legacy.EPolygonGauge.Tolerance ( self)

Searching area half thickness of the polygon fitting gauge.

Remarks:

A polygon fitting gauge is fully defined knowing its nominal positions (vertices), its nominal origin, angle and scale, and its outline tolerance.

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

◆ Tolerance() [2/2]

eVision.Legacy.EPolygonGauge.Tolerance ( self,
float value )

Searching area half thickness of the polygon fitting gauge.

Remarks:

A polygon fitting gauge is fully defined knowing its nominal positions (vertices), its nominal origin, angle and scale, and its outline tolerance.

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

◆ TransitionChoice() [1/2]

eVision.ETransitionChoice eVision.Legacy.EPolygonGauge.TransitionChoice ( self)

Transition choice.

Remarks:

Several peaks may be detected along a point location gauge. This parameter helps to select the desired transition.

In case of eVision.ETransitionChoice.NthFromBegin or eVision.ETransitionChoice.NthFromEnd transition choice, set eVision.Legacy.EPolygonGauge.TransitionIndex to specify the desired transition.

By default, the selected transition corresponds to the one with the largest amplitude (eVision.ETransitionChoice.LargestAmplitude).

◆ TransitionChoice() [2/2]

eVision.Legacy.EPolygonGauge.TransitionChoice ( self,
eVision.ETransitionChoice value )

Transition choice.

Remarks:

Several peaks may be detected along a point location gauge. This parameter helps to select the desired transition.

In case of eVision.ETransitionChoice.NthFromBegin or eVision.ETransitionChoice.NthFromEnd transition choice, set eVision.Legacy.EPolygonGauge.TransitionIndex to specify the desired transition.

By default, the selected transition corresponds to the one with the largest amplitude (eVision.ETransitionChoice.LargestAmplitude).

◆ TransitionIndex() [1/2]

int eVision.Legacy.EPolygonGauge.TransitionIndex ( self)

Index (from 0 on) of the transition to be retained when the transition choice parameter is set to eVision.ETransitionChoice.NthFromBegin or eVision.ETransitionChoice.NthFromEnd.

Remarks:

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

◆ TransitionIndex() [2/2]

eVision.Legacy.EPolygonGauge.TransitionIndex ( self,
int value )

Index (from 0 on) of the transition to be retained when the transition choice parameter is set to eVision.ETransitionChoice.NthFromBegin or eVision.ETransitionChoice.NthFromEnd.

Remarks:

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

◆ TransitionType() [1/2]

eVision.ETransitionType eVision.Legacy.EPolygonGauge.TransitionType ( self)

Transition type.

Remarks:

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 (eVision.ETransitionType.BwOrWb).

◆ TransitionType() [2/2]

eVision.Legacy.EPolygonGauge.TransitionType ( self,
eVision.ETransitionType value )

Transition type.

Remarks:

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 (eVision.ETransitionType.BwOrWb).

◆ Type()

eVision.EShapeType eVision.Legacy.EPolygonGauge.Type ( self)

Shape type.

Reimplemented from eVision.Legacy.EPolygonShape.