Manages a line fitting gauge. More...

Inheritance diagram for eVision.Legacy.ELineGauge:

[legend]

Collaboration diagram for eVision.Legacy.ELineGauge:

[legend]

Public Member Functions
None	__init__ (self)
	Constructs a line measurement context.
None	__init__ (self, eVision.Legacy.ELineGauge other)
	Constructs a line measurement context.
eVision.EPeak	GetMeasuredPeak (self, int index)
	Returns information pertaining to the default derivative peak, along one of the sample paths of the gauge.
eVision.EPeak	GetMeasuredPeak (self)
	Returns information pertaining to the default derivative peak, along one of the sample paths of the gauge.
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 one of the sample paths of the 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 one of the sample paths of the 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 one of the sample paths of the gauge, as defined by eVision.EPlotItem.
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.ELineGauge.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.ELineGauge.AddSkipRange.
None	CopyTo (self, eVision.Legacy.ELineGauge other, bool recursive)
	Copies all the data of the current eVision.Legacy.ELineGauge object into another eVision.Legacy.ELineGauge object, and returns it.
None	CopyTo (self, eVision.Legacy.ELineGauge other)
	Copies all the data of the current eVision.Legacy.ELineGauge object into another eVision.Legacy.ELineGauge 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	MeasureWithoutFitting (self, eVision.EROIBW8\|None sourceImage)
	Triggers the point location without line fitting operation.
None	MeasureWithoutFitting (self, eVision.EROIBW8\|None sourceImage, eVision.ERegion region)
	Triggers the point location without line fitting operation.
None	MeasureSample (self, eVision.EROIBW8\|None sourceImage, int pathIndex)
	Computes the sample points along the sample path whose index in the list is given by the pathIndex parameter.
None	MeasureSample (self, eVision.EROIBW8\|None sourceImage, eVision.ERegion region, int pathIndex)
	Computes the sample points along the sample path whose index in the list is given by the pathIndex parameter.
bool	GetSample (self, eVision.EPoint pt, int index)
	Allows to retrieve the sample points found along the line.
None	GetSample (self, eVision.Legacy.ESamplePoint pt, int index)
	Allows to retrieve the sample points found along the line.
eVision.EPoint	GetMeasuredPoint (self, int index)
	Returns the coordinates of a sample point, measured along one of the sample paths of the gauge.
eVision.EPoint	GetMeasuredPoint (self)
	Returns the coordinates of a sample point, measured along one of the sample paths of the gauge.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, 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 graphicContext, 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 graphicContext)
	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	Tolerance (self)
	Searching area half thickness of the line fitting gauge.
	Tolerance (self, float value)
	Searching area half thickness of the line 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.
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.
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	NumMeasuredPoints (self)
	Number of edge-crossing points along the sample path of the gauge that was inspected with the last call to eVision.Legacy.ELineGauge.MeasureSample.
bool	Valid (self)
	Flag indicating if at least one valid transition has been found.
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	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)
	Sets/Gets the minimum number of samples required for fitting the shape.
	MinNumFitSamples (self, int value)
	Sets/Gets the minimum number of samples required for fitting the shape.
int	NumSkipRanges (self)
	Number of skip ranges in the gauge after a call to eVision.Legacy.ELineGauge.AddSkipRange.
eVision.EShapeType	Type (self)
	Shape type.
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.
eVision.Legacy.ELine	Shape (self)
bool	RectangularSamplingArea (self)
	Flag indicating whether the sampling area remains a rectangle when rotated, instead of becoming a parallelogram.
	RectangularSamplingArea (self, bool value)
	Flag indicating whether the sampling area remains a rectangle when rotated, instead of becoming a parallelogram.
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.
bool	KnownAngle (self)
	Flag indicating whether the slope of the line to be fitted is known or not.
	KnownAngle (self, bool value)
	Flag indicating whether the slope of the line to be fitted is known or not.
eVision.EClippingMode	ClippingMode (self)
	Clipping mode, that allows to choose how the fitted segment length and center are computed.
	ClippingMode (self, eVision.EClippingMode value)
	Clipping mode, that allows to choose how the fitted segment length and center are computed.
eVision.Legacy.ELine	MeasuredLine (self)
	Information pertaining to the fitted line.
Public Member Functions inherited from eVision.Legacy.ELineShape
None	__init__ (self)
	Constructs a eVision.Legacy.ELineShape object.
None	__init__ (self, eVision.EPoint origin, eVision.EPoint end)
	Constructs a eVision.Legacy.ELineShape object.
None	__init__ (self, eVision.EPoint center, float length, float angle)
	Constructs a eVision.Legacy.ELineShape object.
None	__init__ (self, eVision.EPoint center, float length)
	Constructs a eVision.Legacy.ELineShape object.
None	__init__ (self, eVision.EPoint center)
	Constructs a eVision.Legacy.ELineShape object.
None	__init__ (self, eVision.Legacy.ELineShape other)
	Constructs a eVision.Legacy.ELineShape object.
None	SetCenterXY (self, float centerX, float centerY)
	Sets the center coordinates of a eVision.Legacy.ELineShape object.
None	SetFromTwoPoints (self, eVision.EPoint origin, eVision.EPoint end)
	Sets the geometric parameters (center coordinates, length, and rotation angle) of a eVision.Legacy.ELineShape object.
None	SetFromOriginAndEnd (self, eVision.EPoint origin, eVision.EPoint end)
	Sets the geometric parameters (center coordinates, length, and rotation angle) of a eVision.Legacy.ELineShape object.
eVision.EPoint	GetPoint (self, float fraction)
	Returns the coordinates of a point along the line.
None	Closest (self)
	Find the daughter shape that is the closest to this shape.
eVision.EPoint	Center (self)
	Center point of the frame.
	Center (self, eVision.EPoint value)
	Center point of the frame.
float	CenterX (self)
	Abscissa of the origin point of the frame.
float	CenterY (self)
	Ordinate of the origin point of the frame.
float	Angle (self)
	Orientation of the shape.
	Angle (self, float value)
	Orientation of the shape.
float	Scale (self)
	Horizontal sensor resolution, in pixels per unit.
	Scale (self, float value)
	Horizontal sensor resolution, in pixels per unit.
float	Length (self)
	Length of the eVision.Legacy.ELineShape object.
	Length (self, float value)
	Length of the eVision.Legacy.ELineShape object.
eVision.EPoint	Org (self)
	Origin point coordinates of the eVision.Legacy.ELineShape object.
eVision.EPoint	End (self)
	End point coordinates of the eVision.Legacy.ELineShape object.
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.

Protected Member Functions
	_Line__setter (self, eVision.Legacy.ELine value)
	Sets the nominal position, length and rotation angle of the line fitting gauge, according to a known eVision.Legacy.ELine object.
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
	Line
Properties inherited from eVision.Legacy.ELineShape
	Line
Properties inherited from eVision.Legacy.EShape
	VisibleRecursive
	SelectedRecursive
	SelectableRecursive
	DragableRecursive
	ResizableRecursive
	RotatableRecursive
	LabeledRecursive
	ActiveRecursive
	ActualShapeRecursive

Detailed Description

Manages a line fitting gauge.

Remarks:

License(s): EasyGauge

Constructor & Destructor Documentation

◆ init() [1/2]

None eVision.Legacy.ELineGauge.__init__ ( self )

Constructs a line measurement context.

Remarks:

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 eVision.Legacy.ELineGauge.__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.ELineGauge.CopyTo method.

◆ init() [2/2]

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

Constructs a line measurement context.

Remarks:

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 eVision.Legacy.ELineGauge.__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.ELineGauge.CopyTo method.

Parameters

other Another eVision.Legacy.ELineGauge object to be copied in the new eVision.Legacy.ELineGauge object.

Member Function Documentation

◆ _Line__setter()

eVision.Legacy.ELineGauge._Line__setter	(		self,
		eVision.Legacy.ELine	value )

protected

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

Reimplemented from eVision.Legacy.ELineShape.

◆ Active() [1/2]

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

◆ Active() [2/2]

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

◆ AddSkipRange()

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

Parameters

range The skip range.

◆ AverageDistance()

float eVision.Legacy.ELineGauge.AverageDistance ( self )

Average distance between the sampled points and the fitted model.

Remarks:

Irrelevant in case of a point location operation.

◆ ClippingMode() [1/2]

eVision.EClippingMode eVision.Legacy.ELineGauge.ClippingMode ( self )

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

Remarks:

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

◆ ClippingMode() [2/2]

eVision.Legacy.ELineGauge.ClippingMode	(		self,
		eVision.EClippingMode	value )

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

Remarks:

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

◆ CopyTo() [1/2]

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

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

Remarks:

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

Parameters

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

Reimplemented from eVision.Legacy.ELineShape.

◆ CopyTo() [2/2]

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

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

Remarks:

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

Parameters

other	Pointer to the eVision.Legacy.ELineGauge object in which the current eVision.Legacy.ELineGauge object data have to be copied.
recursive	true if the children gauges have to be copied as well, false otherwise.

Reimplemented from eVision.Legacy.ELineShape.

◆ Drag()

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

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/3]

None eVision.Legacy.ELineGauge.Draw	(		self,
		eVision.EDrawAdapter \| None	graphicContext )

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

Parameters

graphicContext Handle of the device context on which to draw.

Reimplemented from eVision.Legacy.ELineShape.

◆ Draw() [2/3]

None eVision.Legacy.ELineGauge.Draw	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		eVision.EDrawingMode	drawingMode )

Draws a graphical representation of a point location or model fitting gauge, as defined by eVision.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 eVision.EDrawingMode.

Reimplemented from eVision.Legacy.ELineShape.

◆ Draw() [3/3]

None eVision.Legacy.ELineGauge.Draw	(		self,
		eVision.EDrawAdapter \| None	graphicContext,
		eVision.EDrawingMode	drawingMode,
		bool	daughters )

Draws a graphical representation of a point location or model fitting gauge, as defined by eVision.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 eVision.EDrawingMode.
daughters	true if the daughters gauges are to be displayed also.

Reimplemented from eVision.Legacy.ELineShape.

◆ FilteringThreshold() [1/2]

float eVision.Legacy.ELineGauge.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.ELineGauge.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).

◆ GetMeasuredPeak() [1/2]

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

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

Remarks:

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

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

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

◆ GetMeasuredPeak() [2/2]

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

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

Remarks:

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

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

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

Parameters

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

◆ GetMeasuredPoint() [1/2]

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

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

Remarks:

These coordinates pertain to the world space; they are expressed in the reference frame to which the current eVision.Legacy.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. eVision.Legacy.ELineGauge.GetMeasuredPoint returns the coordinates of the sample point that meets the following two requirements:

It lies on the sample path inspected with the last call to eVision.Legacy.ELineGauge.MeasureSample, and
Among all the sample points along the latter sample path, it is the one selected by the eVision.Legacy.ELineGauge.TransitionChoice property.

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

◆ GetMeasuredPoint() [2/2]

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

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

Remarks:

These coordinates pertain to the world space; they are expressed in the reference frame to which the current eVision.Legacy.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. eVision.Legacy.ELineGauge.GetMeasuredPoint returns the coordinates of the sample point that meets the following two requirements:

It lies on the sample path inspected with the last call to eVision.Legacy.ELineGauge.MeasureSample, and
Among all the sample points along the latter sample path, it is the one selected by the eVision.Legacy.ELineGauge.TransitionChoice property.

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

Parameters

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

◆ GetSample() [1/2]

bool eVision.Legacy.ELineGauge.GetSample	(		self,
		eVision.EPoint	pt,
		int	index )

Allows to retrieve the sample points found along the line.

Remarks:

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

Parameters

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

◆ GetSample() [2/2]

None eVision.Legacy.ELineGauge.GetSample	(		self,
		eVision.Legacy.ESamplePoint	pt,
		int	index )

Allows to retrieve the sample points found along the line.

Remarks:

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

Parameters

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

◆ GetSkipRange()

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

Remarks:

Start is guaranteed to be smaller or equal to end.

Parameters

index Index of the skip range.

◆ HitTest() [1/2]

bool eVision.Legacy.ELineGauge.HitTest ( self )

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	(		self,
		bool	daughters )

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.

◆ HVConstraint() [1/2]

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

◆ KnownAngle() [1/2]

bool eVision.Legacy.ELineGauge.KnownAngle ( self )

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

Remarks:

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 eVision.Legacy.ELineShape.Angle. 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.

◆ KnownAngle() [2/2]

eVision.Legacy.ELineGauge.KnownAngle	(		self,
		bool	value )

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

Remarks:

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 eVision.Legacy.ELineShape.Angle. 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.

◆ Measure() [1/2]

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

sourceImage Pointer to the source image.

◆ Measure() [2/2]

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

sourceImage	Pointer to the source image.
region	Region to use with the source image.

◆ MeasuredLine()

eVision.Legacy.ELine eVision.Legacy.ELineGauge.MeasuredLine ( self )

Information pertaining to the fitted line.

Remarks:

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

◆ MeasureSample() [1/2]

None eVision.Legacy.ELineGauge.MeasureSample	(		self,
		eVision.EROIBW8 \| None	sourceImage,
		eVision.ERegion	region,
		int	pathIndex )

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

Remarks:

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

Parameters

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

◆ MeasureSample() [2/2]

None eVision.Legacy.ELineGauge.MeasureSample	(		self,
		eVision.EROIBW8 \| None	sourceImage,
		int	pathIndex )

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

Remarks:

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

Parameters

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

◆ MeasureWithoutFitting() [1/2]

None eVision.Legacy.ELineGauge.MeasureWithoutFitting	(		self,
		eVision.EROIBW8 \| None	sourceImage )

Triggers the point location without line fitting operation.

Remarks:

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

Parameters

sourceImage Source image.

◆ MeasureWithoutFitting() [2/2]

None eVision.Legacy.ELineGauge.MeasureWithoutFitting	(		self,
		eVision.EROIBW8 \| None	sourceImage,
		eVision.ERegion	region )

Triggers the point location without line fitting operation.

Remarks:

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

Parameters

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

◆ MinAmplitude() [1/2]

int eVision.Legacy.ELineGauge.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.ELineGauge.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.ELineGauge.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.ELineGauge.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.ELineGauge.MinNumFitSamples ( self )

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

Remarks:

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

◆ MinNumFitSamples() [2/2]

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

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

Remarks:

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

◆ NumFilteringPasses() [1/2]

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

◆ NumMeasuredPoints()

int eVision.Legacy.ELineGauge.NumMeasuredPoints ( self )

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

Remarks:

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

◆ NumSamples()

int eVision.Legacy.ELineGauge.NumSamples ( self )

Number of sampled points during the 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).

◆ NumSkipRanges()

int eVision.Legacy.ELineGauge.NumSkipRanges ( self )

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

◆ NumValidSamples()

int eVision.Legacy.ELineGauge.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).

◆ Plot() [1/3]

None eVision.Legacy.ELineGauge.Plot	(		self,
		eVision.EDrawAdapter \| None	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 eVision.EPlotItem.

Remarks:

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

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

Parameters

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

◆ Plot() [2/3]

None eVision.Legacy.ELineGauge.Plot	(		self,
		eVision.EDrawAdapter \| None	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 eVision.EPlotItem.

Remarks:

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

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

Parameters

graphicContext	Handle of the device context on which to draw.
drawItems	Boolean combination of eVision.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.

◆ Plot() [3/3]

None eVision.Legacy.ELineGauge.Plot	(		self,
		eVision.EDrawAdapter \| None	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 eVision.EPlotItem.

Remarks:

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

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

Parameters

graphicContext	Handle of the device context on which to draw.
drawItems	Boolean combination of eVision.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.

◆ Process() [1/4]

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

sourceImage Pointer to the BW8 roi source image.

Reimplemented from eVision.Legacy.EShape.

◆ Process() [2/4]

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

sourceImage	Pointer to the BW8 roi source image.
daughters	Flag indicating whether the daughters shapes inherit of the same behavior.

Reimplemented from eVision.Legacy.EShape.

◆ Process() [3/4]

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

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

Reimplemented from eVision.Legacy.EShape.

◆ Process() [4/4]

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

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.

Reimplemented from eVision.Legacy.EShape.

◆ RectangularSamplingArea() [1/2]

bool eVision.Legacy.ELineGauge.RectangularSamplingArea ( self )

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.

◆ RectangularSamplingArea() [2/2]

eVision.Legacy.ELineGauge.RectangularSamplingArea	(		self,
		bool	value )

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.

◆ RemoveAllSkipRanges()

None eVision.Legacy.ELineGauge.RemoveAllSkipRanges ( self )

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

◆ RemoveSkipRange()

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

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

Parameters

index Index of the skip range to remove, as returned by eVision.Legacy.ELineGauge.AddSkipRange.

◆ SamplingStep() [1/2]

float eVision.Legacy.ELineGauge.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.ELineGauge.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.ELine eVision.Legacy.ELineGauge.Shape ( self )

◆ Smoothing() [1/2]

int eVision.Legacy.ELineGauge.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.ELineGauge.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.ELineGauge.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.ELineGauge.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.ELineGauge.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.ELineGauge.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.ELineGauge.Tolerance ( self )

Searching area half thickness of the line fitting gauge.

Remarks:

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.

◆ Tolerance() [2/2]

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

Searching area half thickness of the line fitting gauge.

Remarks:

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.

◆ TransitionChoice() [1/2]

eVision.ETransitionChoice eVision.Legacy.ELineGauge.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.ELineGauge.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.ELineGauge.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.ELineGauge.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.ELineGauge.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.ELineGauge.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.ELineGauge.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.ELineGauge.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.ELineGauge.Type ( self )

Shape type.

Reimplemented from eVision.Legacy.ELineShape.

◆ Valid()

bool eVision.Legacy.ELineGauge.Valid ( self )

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

Property Documentation

◆ Line

eVision.Legacy.ELineGauge.Line

static

Initial value:

=  property(None, _Line__setter, None,
        
    )

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/2]

◆ __init__() [2/2]

Member Function Documentation

◆ _Line__setter()

◆ Active() [1/2]

◆ Active() [2/2]

◆ AddSkipRange()

◆ AverageDistance()

◆ ClippingMode() [1/2]

◆ ClippingMode() [2/2]

◆ CopyTo() [1/2]

◆ CopyTo() [2/2]

◆ Drag()

◆ Draw() [1/3]

◆ Draw() [2/3]

◆ Draw() [3/3]

◆ FilteringThreshold() [1/2]

◆ FilteringThreshold() [2/2]

◆ GetMeasuredPeak() [1/2]

◆ GetMeasuredPeak() [2/2]

◆ GetMeasuredPoint() [1/2]

◆ GetMeasuredPoint() [2/2]

◆ GetSample() [1/2]

◆ GetSample() [2/2]

◆ GetSkipRange()

◆ HitTest() [1/2]

◆ HitTest() [2/2]

◆ HVConstraint() [1/2]

◆ HVConstraint() [2/2]

◆ KnownAngle() [1/2]

◆ KnownAngle() [2/2]

◆ Measure() [1/2]

◆ Measure() [2/2]

◆ MeasuredLine()

◆ MeasureSample() [1/2]

◆ MeasureSample() [2/2]

◆ MeasureWithoutFitting() [1/2]

◆ MeasureWithoutFitting() [2/2]

◆ MinAmplitude() [1/2]

◆ MinAmplitude() [2/2]

◆ MinArea() [1/2]

◆ MinArea() [2/2]

◆ MinNumFitSamples() [1/2]

◆ MinNumFitSamples() [2/2]

◆ NumFilteringPasses() [1/2]

◆ NumFilteringPasses() [2/2]

◆ NumMeasuredPoints()

◆ NumSamples()

◆ NumSkipRanges()

◆ NumValidSamples()

◆ Plot() [1/3]

◆ Plot() [2/3]

◆ Plot() [3/3]

◆ Process() [1/4]

◆ Process() [2/4]

◆ Process() [3/4]

◆ Process() [4/4]

◆ RectangularSamplingArea() [1/2]

◆ RectangularSamplingArea() [2/2]

◆ RemoveAllSkipRanges()

◆ RemoveSkipRange()

◆ SamplingStep() [1/2]

◆ SamplingStep() [2/2]

◆ Shape()

◆ Smoothing() [1/2]

◆ Smoothing() [2/2]

◆ Thickness() [1/2]

◆ Thickness() [2/2]

◆ Threshold() [1/2]

◆ Threshold() [2/2]

◆ Tolerance() [1/2]

◆ Tolerance() [2/2]

◆ TransitionChoice() [1/2]

◆ TransitionChoice() [2/2]

◆ TransitionIndex() [1/2]

◆ init() [1/2]

◆ init() [2/2]