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

Manages a point location gauge. More...

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

Public Member Functions

None __init__ (self)
 Constructs a point measurement context.
None __init__ (self, float centerX, float centerY)
 Constructs a point measurement context.
None __init__ (self, eVision.Legacy.EPointGauge other)
 Constructs a point measurement context.
None SetTolerances (self, float tolerance, float angle)
 Sets the half length and the rotation angle of the point location gauge.
None SetTolerances (self, float tolerance)
 Sets the half length and the rotation angle of the point location gauge.
eVision.EPeak GetMeasuredPeak (self, int index)
 Returns information pertaining to the derivative peak associated with the specified edge-crossing point, such as its area, amplitude, start, length and center.
eVision.EPeak GetMeasuredPeak (self)
 Returns information pertaining to the derivative peak associated with the specified edge-crossing point, such as its area, amplitude, start, length and center.
None Plot (self, eVision.EDrawAdapter|None graphicContext, eVision.EPlotItem drawItems, float width, float height, float originX, float originY)
 Draws the profile that is crossed by a point location gauge, as defined by eVision.EPlotItem.
None Plot (self, eVision.EDrawAdapter|None graphicContext, eVision.EPlotItem drawItems, float width, float height, float originX)
 Draws the profile that is crossed by a point location gauge, as defined by eVision.EPlotItem.
None Plot (self, eVision.EDrawAdapter|None graphicContext, eVision.EPlotItem drawItems, float width, float height)
 Draws the profile that is crossed by a point location gauge, as defined by eVision.EPlotItem.
None CopyTo (self, eVision.Legacy.EPointGauge other, bool recursive)
 Copies all the data of the current eVision.Legacy.EPointGauge object into another eVision.Legacy.EPointGauge object, and returns it.
None CopyTo (self, eVision.Legacy.EPointGauge other)
 Copies all the data of the current eVision.Legacy.EPointGauge object into another eVision.Legacy.EPointGauge object, and returns it.
None SetCenterXY (self, float centerX, float centerY)
 Sets the center coordinates of a eVision.Legacy.EPointGauge object.
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 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.
eVision.EPoint GetMeasuredPoint (self, int index)
 Returns the coordinates of an edge-crossing point, measured along the unique sample path of the point location gauge.
eVision.EPoint GetMeasuredPoint (self)
 Returns the coordinates of an edge-crossing point, measured along the unique sample path of the point location gauge.
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.
Public Member Functions inherited from eVision.Legacy.EPointShape
None Closest (self)
 Find the daughter shape that is the closest to this shape.
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.

Properties

 Tolerance = property(_Tolerance__getter, _Tolerance__setter)
 Half length of the point location gauge.
 ToleranceAngle = property(_ToleranceAngle__getter, _ToleranceAngle__setter)
 Rotation angle of the point location gauge.
 HVConstraint = property(_HVConstraint__getter, _HVConstraint__setter)
 Status of the restriction on the orientation of the point location gauge or model fitting sample paths.
 Thickness = property(_Thickness__getter, _Thickness__setter)
 Number of parallel segments used to extract the data profile.
 Smoothing = property(_Smoothing__getter, _Smoothing__setter)
 Number of pixels used for the low-pass filtering operation.
 TransitionType = property(_TransitionType__getter, _TransitionType__setter)
 Transition type.
 TransitionChoice = property(_TransitionChoice__getter, _TransitionChoice__setter)
 Transition choice.
 TransitionIndex = property(_TransitionIndex__getter, _TransitionIndex__setter)
 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.
 Threshold = property(_Threshold__getter, _Threshold__setter)
 Threshold level used to delimit significant peaks in the data profile.
 MinAmplitude = property(_MinAmplitude__getter, _MinAmplitude__setter)
 Offset added to the Threshold when a peak is to be detected.
 MinArea = property(_MinArea__getter, _MinArea__setter)
 Minimum area value.
 NumMeasuredPoints = property(_NumMeasuredPoints__getter, None)
 Number of edge-crossing points along the point location gauge.
 MeasuredPeaks = property(_MeasuredPeaks__getter, None)
 Returns information pertaining to the derivative peak associated with all of the edge-crossing point, such as its area, amplitude, start, length and center.
 Valid = property(_Valid__getter, None)
 Flag indicating if at least one valid transition has been found.
 Shape = property(_Shape__getter, None)
 Center = property(_Center__getter, _Center__setter)
 Center coordinates of a eVision.Legacy.EPointShape object.
 Active = property(_Active__getter, _Active__setter)
 Sets the flag indicating whether the gauge is active or not.
 RectangularSamplingArea = property(_RectangularSamplingArea__getter, _RectangularSamplingArea__setter)
 Flag indicating whether the sampling area remains a rectangle when rotated, instead of becoming a parallelogram.
 MeasuredPoints = property(_MeasuredPoints__getter, None)
 Returns the coordinates of all edge-crossing points, measured along the unique sample path of the point location gauge.
 Type = property(_Type__getter, None)
 Shape type.
Properties inherited from eVision.Legacy.EPointShape
 Center = property(_Center__getter, _Center__setter)
 Center coordinates of a eVision.Legacy.EPointShape object.
 CenterX = property(_CenterX__getter, None)
 Abscissa of the origin point of the frame.
 CenterY = property(_CenterY__getter, None)
 Ordinate of the origin point of the frame.
 Scale = property(_Scale__getter, _Scale__setter)
 Angle = property(_Angle__getter, _Angle__setter)
 Type = property(_Type__getter, None)
 Shape type.
Properties inherited from eVision.Legacy.EShape
 Type = property(_Type__getter, None)
 Shape type.
 Name = property(_Name__getter, _Name__setter)
 Name of the eVision.Legacy.EShape object.
 Visible = property(_Visible__getter, _Visible__setter)
 Flag indicating whether the shape is visible or not.
 VisibleRecursive = property(None, _VisibleRecursive__setter)
 Sets the flag indicating whether the shape and its daughter shapes are visible or not.
 Selected = property(_Selected__getter, _Selected__setter)
 Flag indicating whether the shape is selected or not.
 SelectedRecursive = property(None, _SelectedRecursive__setter)
 Sets the flag indicating whether the shape and all its daughters are selected or not.
 Selectable = property(_Selectable__getter, _Selectable__setter)
 Flag indicating whether the shape can be selected or not.
 SelectableRecursive = property(None, _SelectableRecursive__setter)
 Sets the flag indicating whether the shape and all its daughters can be selected or not.
 Dragable = property(_Dragable__getter, _Dragable__setter)
 Flag indicating whether the shape can be dragged or not.
 DragableRecursive = property(None, _DragableRecursive__setter)
 Sets the flag indicating whether the shape and all its daughters can be dragged or not.
 Resizable = property(_Resizable__getter, _Resizable__setter)
 Flag indicating whether the shape can be resized or not.
 ResizableRecursive = property(None, _ResizableRecursive__setter)
 Sets the flag indicating whether the shape and all its daughters can be resized or not.
 Rotatable = property(_Rotatable__getter, _Rotatable__setter)
 Flag indicating whether the shape can be rotated or not.
 RotatableRecursive = property(None, _RotatableRecursive__setter)
 Sets the flag indicating whether the shape and all its daughters can be rotated or not.
 Labeled = property(_Labeled__getter, _Labeled__setter)
 Flag indicating whether the shape label should be displayed or not.
 LabeledRecursive = property(None, _LabeledRecursive__setter)
 Sets the flag indicating whether the shape label should be displayed or not.
 Active = property(_Active__getter, _Active__setter)
 Flag indicating whether the shape is active or not.
 ActiveRecursive = property(None, _ActiveRecursive__setter)
 Sets the flag indicating whether the shape and all its daughters are active or not.
 ActualShape = property(_ActualShape__getter, _ActualShape__setter)
 Flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).
 ActualShapeRecursive = property(None, _ActualShapeRecursive__setter)
 Sets the flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).
 NumDaughters = property(_NumDaughters__getter, None)
 Number of daughters attached to the shape.
 Mother = property(_Mother__getter, None)
 Pointer to the mother shape.
 WorldShape = property(_WorldShape__getter, None)
 World ancestor.
 ZoomX = property(_ZoomX__getter, None)
 Current horizontal zooming factor for drawing operations.
 ZoomY = property(_ZoomY__getter, None)
 Current vertical zooming factor for drawing operations.
 PanX = property(_PanX__getter, None)
 Current horizontal panning value for drawing operations, expressed in pixels.
 PanY = property(_PanY__getter, None)
 Current vertical panning value for drawing operations, expressed in pixels.
 HitHandle = property(_HitHandle__getter, None)
 Handle currently under the cursor.
 HitShape = property(_HitShape__getter, None)
 Pointer to the shape currently under the cursor.
 ClosestShape = property(_ClosestShape__getter, None)
 Closest shape among the daughters.

Detailed Description

Manages a point location gauge.

Remarks:

License(s): EasyGauge

Constructor & Destructor Documentation

◆ __init__() [1/3]

None eVision.Legacy.EPointGauge.__init__ ( self)

Constructs a point measurement context.

Remarks:

With the default constructor, all the parameters are initialized to their respective default values. With the copy constructor, the constructed point measurement context is based on a pre-existing eVision.Legacy.EPointGauge.__init__ 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.EPointGauge.CopyTo method.

◆ __init__() [2/3]

None eVision.Legacy.EPointGauge.__init__ ( self,
float centerX,
float centerY )

Constructs a point measurement context.

Remarks:

With the default constructor, all the parameters are initialized to their respective default values. With the copy constructor, the constructed point measurement context is based on a pre-existing eVision.Legacy.EPointGauge.__init__ 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.EPointGauge.CopyTo method.

Parameters
centerXPoint X coordinate.
centerYPoint Y coordinate.

◆ __init__() [3/3]

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

Constructs a point measurement context.

Remarks:

With the default constructor, all the parameters are initialized to their respective default values. With the copy constructor, the constructed point measurement context is based on a pre-existing eVision.Legacy.EPointGauge.__init__ 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.EPointGauge.CopyTo method.

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

Member Function Documentation

◆ CopyTo() [1/2]

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

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

Remarks:

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

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

Reimplemented from eVision.Legacy.EPointShape.

◆ CopyTo() [2/2]

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

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

Remarks:

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

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

Reimplemented from eVision.Legacy.EPointShape.

◆ Drag()

None eVision.Legacy.EPointGauge.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.EPointShape.

◆ Draw() [1/3]

None eVision.Legacy.EPointGauge.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.EPointShape.

◆ Draw() [2/3]

None eVision.Legacy.EPointGauge.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.EPointShape.

◆ Draw() [3/3]

None eVision.Legacy.EPointGauge.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.EPointShape.

◆ GetMeasuredPeak() [1/2]

eVision.EPeak eVision.Legacy.EPointGauge.GetMeasuredPeak ( self)

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

Remarks:

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

If you want to query more than 10 peaks, using eVision.Legacy.EPointGauge.MeasuredPeaks should be faster.

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

◆ GetMeasuredPeak() [2/2]

eVision.EPeak eVision.Legacy.EPointGauge.GetMeasuredPeak ( self,
int index )

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

Remarks:

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

If you want to query more than 10 peaks, using eVision.Legacy.EPointGauge.MeasuredPeaks should be faster.

Note
For this method to succeed, it is necessary to previously call eVision.Legacy.EPointGauge.Measure.
Parameters
indexIndex of the edge-crossing point along the probed line segment, between 0 and eVision.Legacy.EPointGauge.NumMeasuredPoints (excluded).

◆ GetMeasuredPoint() [1/2]

eVision.EPoint eVision.Legacy.EPointGauge.GetMeasuredPoint ( self)

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

Remarks:

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

If you want to query more than 10 points, using eVision.Legacy.EPointGauge.MeasuredPoints should be faster.

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

◆ GetMeasuredPoint() [2/2]

eVision.EPoint eVision.Legacy.EPointGauge.GetMeasuredPoint ( self,
int index )

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

Remarks:

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

If you want to query more than 10 points, using eVision.Legacy.EPointGauge.MeasuredPoints should be faster.

Note
For this method to succeed, it is necessary to previously call eVision.Legacy.EPointGauge.Measure.
Parameters
indexIndex of the edge-crossing point along the probed line segment, between 0 and eVision.Legacy.EPointGauge.NumMeasuredPoints (excluded).

◆ HitTest() [1/2]

bool eVision.Legacy.EPointGauge.HitTest ( self)

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

Reimplemented from eVision.Legacy.EPointShape.

◆ HitTest() [2/2]

bool eVision.Legacy.EPointGauge.HitTest ( 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.EPointShape.

◆ Measure() [1/2]

None eVision.Legacy.EPointGauge.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.EPointGauge.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.

◆ Plot() [1/3]

None eVision.Legacy.EPointGauge.Plot ( self,
eVision.EDrawAdapter | None graphicContext,
eVision.EPlotItem drawItems,
float width,
float height )

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

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

◆ Plot() [2/3]

None eVision.Legacy.EPointGauge.Plot ( self,
eVision.EDrawAdapter | None graphicContext,
eVision.EPlotItem drawItems,
float width,
float height,
float originX )

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

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

◆ Plot() [3/3]

None eVision.Legacy.EPointGauge.Plot ( self,
eVision.EDrawAdapter | None graphicContext,
eVision.EPlotItem drawItems,
float width,
float height,
float originX,
float originY )

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

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

◆ Process() [1/4]

None eVision.Legacy.EPointGauge.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.EPointGauge.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.EPointGauge.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.EPointGauge.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.

◆ SetCenterXY()

None eVision.Legacy.EPointGauge.SetCenterXY ( self,
float centerX,
float centerY )

Sets the center coordinates of a eVision.Legacy.EPointGauge object.

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

Reimplemented from eVision.Legacy.EPointShape.

◆ SetTolerances() [1/2]

None eVision.Legacy.EPointGauge.SetTolerances ( self,
float tolerance )

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

Remarks:

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

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

◆ SetTolerances() [2/2]

None eVision.Legacy.EPointGauge.SetTolerances ( self,
float tolerance,
float angle )

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

Remarks:

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

  • When the field of view is calibrated, the coordinate system is said to be direct, the abscissa extends rightwards and the ordinate extends upwards. In this case, an anticlockwise rotation leads to a positive angle value.
  • When the field of view is not calibrated, the coordinate system is said to be inverse, the abscissa extends rightwards and the ordinate extends downwards. In this case, a clockwise rotation leads to a positive angle value.
Parameters
toleranceHalf length of the point location gauge. The default value is 10.
angleRotation angle of the point location gauge. The default value is 0.

Property Documentation

◆ Active

eVision.Legacy.EPointGauge.Active = property(_Active__getter, _Active__setter)
static

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.EPointGauge.Process to the mother gauge or shape triggers the measurement of the whole. Only the active gauges will participate in the process. By default, the gauge is active (true).

◆ Center

eVision.Legacy.EPointGauge.Center = property(_Center__getter, _Center__setter)
static

Center coordinates of a eVision.Legacy.EPointShape object.

◆ HVConstraint

eVision.Legacy.EPointGauge.HVConstraint = property(_HVConstraint__getter, _HVConstraint__setter)
static

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.

◆ MeasuredPeaks

eVision.Legacy.EPointGauge.MeasuredPeaks = property(_MeasuredPeaks__getter, None)
static

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

Remarks:

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

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

◆ MeasuredPoints

eVision.Legacy.EPointGauge.MeasuredPoints = property(_MeasuredPoints__getter, None)
static

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

Remarks:

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

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

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

◆ MinAmplitude

eVision.Legacy.EPointGauge.MinAmplitude = property(_MinAmplitude__getter, _MinAmplitude__setter)
static

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

eVision.Legacy.EPointGauge.MinArea = property(_MinArea__getter, _MinArea__setter)
static

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.

◆ NumMeasuredPoints

eVision.Legacy.EPointGauge.NumMeasuredPoints = property(_NumMeasuredPoints__getter, None)
static

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

◆ RectangularSamplingArea

eVision.Legacy.EPointGauge.RectangularSamplingArea = property(_RectangularSamplingArea__getter, _RectangularSamplingArea__setter)
static

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

Remarks:

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.

◆ Shape

eVision.Legacy.EPointGauge.Shape = property(_Shape__getter, None)
static

◆ Smoothing

eVision.Legacy.EPointGauge.Smoothing = property(_Smoothing__getter, _Smoothing__setter)
static

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

eVision.Legacy.EPointGauge.Thickness = property(_Thickness__getter, _Thickness__setter)
static

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

eVision.Legacy.EPointGauge.Threshold = property(_Threshold__getter, _Threshold__setter)
static

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

eVision.Legacy.EPointGauge.Tolerance = property(_Tolerance__getter, _Tolerance__setter)
static

Half length of the point location gauge.

Remarks:

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

◆ ToleranceAngle

eVision.Legacy.EPointGauge.ToleranceAngle = property(_ToleranceAngle__getter, _ToleranceAngle__setter)
static

Rotation angle of the point location gauge.

Remarks:

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

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

◆ TransitionChoice

eVision.Legacy.EPointGauge.TransitionChoice = property(_TransitionChoice__getter, _TransitionChoice__setter)
static

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.EPointGauge.TransitionIndex to specify the desired transition. By default, the selected transition corresponds to the one with the largest amplitude (eVision.ETransitionChoice.LargestAmplitude).

◆ TransitionIndex

eVision.Legacy.EPointGauge.TransitionIndex = property(_TransitionIndex__getter, _TransitionIndex__setter)
static

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

eVision.Legacy.EPointGauge.TransitionType = property(_TransitionType__getter, _TransitionType__setter)
static

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.Legacy.EPointGauge.Type = property(_Type__getter, None)
static

Shape type.

◆ Valid

eVision.Legacy.EPointGauge.Valid = property(_Valid__getter, None)
static

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

Remarks:

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