Rectangle gauge. More...

Inheritance diagram for eVision.ERectangleGauge:

Collaboration diagram for eVision.ERectangleGauge:

Public Member Functions
None	__init__ (self)
	Constructs a eVision.ERectangleGauge.
None	__init__ (self, eVision.ERectangle rect)
	Constructs a eVision.ERectangleGauge.
None	__init__ (self, eVision.ERectangleGauge other)
	Copy constructor.
None	CopyTo (self, eVision.ERectangleGauge dest)
	Copies all the data of the current eVision.ERectangleGauge object into another eVision.ERectangleGauge object.
None	DisableInnerFiltering (self)
	Disables inner sampled point filtering.
bool	IsInnerFilteringEnabled (self)
	Whether inner sampled point filtering is enabled.
eVision.ESamplePoint	GetSampleLeftEdge (self, int index)
	Allows to retrieve information on the samples found along the leftmost edge.
eVision.ESamplePoint	GetSampleLowerEdge (self, int index)
	Allows to retrieve information on the samples found along the lower edge.
eVision.ESamplePoint	GetSampleRightEdge (self, int index)
	Allows to retrieve information on the samples found along the rightmost edge.
eVision.ESamplePoint	GetSampleUpperEdge (self, int index)
	Allows to retrieve information on the samples found along the upper edge.
eVision.ERectangle	Measure (self, eVision.EROIBW8 sourceImage, eVision.EFrame frame)
	Performs the gauge measurement.
eVision.ERectangle	Measure (self, eVision.EROIBW8 sourceImage)
	Performs the gauge measurement.
eVision.ERectangle	Measure (self, eVision.EROIBW8 sourceImage, eVision.ERegion region, eVision.EFrame frame)
	Performs the gauge measurement.
eVision.ERectangle	Measure (self, eVision.EROIBW8 sourceImage, eVision.ERegion region)
	Performs the gauge measurement.
None	SetMinNumFitSamples (self, int topSide, int leftSide, int bottomSide, int rightSide)
	Sets the minimum number of samples required for fitting the shape.
None	SetMinNumFitSamples (self, eVision.ERectangleGaugeEdge edge, int newValue)
	Sets the minimum number of samples required for fitting the shape.
int	GetMinNumFitSamples (self, eVision.ERectangleGaugeEdge edge)
	Sets the minimum number of samples required for fitting the shape.
eVision.ERectangle	Rectangle (self)
	Nominal rectangle.
	Rectangle (self, eVision.ERectangle value)
	Nominal rectangle.
eVision.EShapeType	Type (self)
	Shape type.
eVision.EShape\|None	Nominal (self)
	Nominal shape of the gauge.
	Nominal (self, eVision.EShape\|None value)
	Nominal shape of the gauge.
float	InnerFilteringThreshold (self)
	Sampled point inner filtering threshold.
	InnerFilteringThreshold (self, float value)
	Sampled point inner filtering threshold.
eVision.EEditionMode	AvailableEditionModes (self)
	Returns all possible edition modes of the gauge.
int	ActiveEdges (self)
	Active edges as defined in eVision.ERectangleGaugeEdge.
	ActiveEdges (self, int value)
	Active edges as defined in eVision.ERectangleGaugeEdge.
float	Tolerance (self)
	Half thickness of the model fitting gauge.
	Tolerance (self, float value)
	Half thickness of the model fitting gauge.
bool	HVConstraint (self)
	Status of the restriction on the orientation of the point location gauge or model fitting sample paths.
	HVConstraint (self, bool value)
	Status of the restriction on the orientation of the point location gauge or model fitting sample paths.
eVision.ETransitionType	TransitionType (self)
	Transition type.
	TransitionType (self, eVision.ETransitionType value)
	Transition type.
eVision.ETransitionChoice	TransitionChoice (self)
	Transition choice.
	TransitionChoice (self, eVision.ETransitionChoice value)
	Transition choice.
int	TransitionIndex (self)
	Index (from 0 on) of the transition to be retained when the transition choice parameter is set to eVision.ETransitionChoice.NthFromBegin or eVision.ETransitionChoice.NthFromEnd.
	TransitionIndex (self, int value)
	Index (from 0 on) of the transition to be retained when the transition choice parameter is set to eVision.ETransitionChoice.NthFromBegin or eVision.ETransitionChoice.NthFromEnd.
int	Threshold (self)
	Threshold level used to delimit significant peaks in the data profile.
	Threshold (self, int value)
	Threshold level used to delimit significant peaks in the data profile.
int	MinAmplitude (self)
	Offset added to the Threshold when a peak is to be detected.
	MinAmplitude (self, int value)
	Offset added to the Threshold when a peak is to be detected.
int	MinArea (self)
	Minimum area value.
	MinArea (self, int value)
	Minimum area value.
int	Thickness (self)
	Number of parallel segments used to extract the data profile.
	Thickness (self, int value)
	Number of parallel segments used to extract the data profile.
int	Smoothing (self)
	Number of pixels used for the low-pass filtering operation.
	Smoothing (self, int value)
	Number of pixels used for the low-pass filtering operation.
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.
int	NumSamples (self)
	Number of sampled points during the model fitting operation.
int	NumSamplesLeftEdge (self)
	Number of sampled points found on leftmost edge during the measure operation.
int	NumSamplesRightEdge (self)
	Number of sampled points found on rightmost edge during the measure operation.
int	NumSamplesLowerEdge (self)
	Number of sampled points found on lower edge during the measure operation.
int	NumSamplesUpperEdge (self)
	Number of sampled points found on upper edge during the measure operation.
bool	KnownAngle (self)
	Flag indicating whether the rotation angle of the rectangle to be fitted is known or not.
	KnownAngle (self, bool value)
	Flag indicating whether the rotation angle of the rectangle to be fitted is known or not.
eVision.ERectangle	MeasuredRectangle (self)
	Information pertaining to the fitted rectangle.
eVision.EShape\|None	Measured (self)
	Copy of the measured shape.
list[int]	MinNumFitSamples (self)
	Sets the minimum number of samples required for fitting the shape.
	MinNumFitSamples (self, list[int] value)
	Sets the minimum number of samples required for fitting the shape.
Public Member Functions inherited from eVision.EBaseGauge
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, eVision.EDrawingMode drawingMode, float zoomX, float zoomY, float panX, float panY)
	Draws a graphical representation of a shape, as defined by eVision.EDrawingMode.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, eVision.EDrawingMode drawingMode, float zoomX, float zoomY, float panX)
	Draws a graphical representation of a shape, as defined by eVision.EDrawingMode.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, eVision.EDrawingMode drawingMode, float zoomX, float zoomY)
	Draws a graphical representation of a shape, as defined by eVision.EDrawingMode.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, eVision.EDrawingMode drawingMode, float zoomX)
	Draws a graphical representation of a shape, as defined by eVision.EDrawingMode.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, eVision.EDrawingMode drawingMode)
	Draws a graphical representation of a shape, as defined by eVision.EDrawingMode.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, eVision.EDrawingMode drawingMode, eVision.EFrame frame, float zoomX, float zoomY, float panX, float panY)
	Draws a graphical representation of a shape, as defined by eVision.EDrawingMode.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, eVision.EDrawingMode drawingMode, eVision.EFrame frame, float zoomX, float zoomY, float panX)
	Draws a graphical representation of a shape, as defined by eVision.EDrawingMode.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, eVision.EDrawingMode drawingMode, eVision.EFrame frame, float zoomX, float zoomY)
	Draws a graphical representation of a shape, as defined by eVision.EDrawingMode.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, eVision.EDrawingMode drawingMode, eVision.EFrame frame, float zoomX)
	Draws a graphical representation of a shape, as defined by eVision.EDrawingMode.
None	Draw (self, eVision.EDrawAdapter\|None graphicContext, eVision.EDrawingMode drawingMode, eVision.EFrame frame)
	Draws a graphical representation of a shape, as defined by eVision.EDrawingMode.
eVision.EEditionMode	HitTest (self, int x, int y, float zoomX, float zoomY, float panX, float panY)
	Checks if there is a handle under the cursor and returns the corresponding edition mode.
eVision.EEditionMode	HitTest (self, int x, int y, float zoomX, float zoomY, float panX)
	Checks if there is a handle under the cursor and returns the corresponding edition mode.
eVision.EEditionMode	HitTest (self, int x, int y, float zoomX, float zoomY)
	Checks if there is a handle under the cursor and returns the corresponding edition mode.
eVision.EEditionMode	HitTest (self, int x, int y, float zoomX)
	Checks if there is a handle under the cursor and returns the corresponding edition mode.
eVision.EEditionMode	HitTest (self, int x, int y)
	Checks if there is a handle under the cursor and returns the corresponding edition mode.
eVision.EEditionMode	HitTest (self, int x, int y, eVision.EFrame frame, float zoomX, float zoomY, float panX, float panY)
	Checks if there is a handle under the cursor and returns the corresponding edition mode.
eVision.EEditionMode	HitTest (self, int x, int y, eVision.EFrame frame, float zoomX, float zoomY, float panX)
	Checks if there is a handle under the cursor and returns the corresponding edition mode.
eVision.EEditionMode	HitTest (self, int x, int y, eVision.EFrame frame, float zoomX, float zoomY)
	Checks if there is a handle under the cursor and returns the corresponding edition mode.
eVision.EEditionMode	HitTest (self, int x, int y, eVision.EFrame frame, float zoomX)
	Checks if there is a handle under the cursor and returns the corresponding edition mode.
eVision.EEditionMode	HitTest (self, int x, int y, eVision.EFrame frame)
	Checks if there is a handle under the cursor and returns the corresponding edition mode.
None	Drag (self, int x, int y, float zoomX, float zoomY, float panX, float panY)
	Moves a handle to a new position and updates the position parameters of the shape.
None	Drag (self, int x, int y, float zoomX, float zoomY, float panX)
	Moves a handle to a new position and updates the position parameters of the shape.
None	Drag (self, int x, int y, float zoomX, float zoomY)
	Moves a handle to a new position and updates the position parameters of the shape.
None	Drag (self, int x, int y, float zoomX)
	Moves a handle to a new position and updates the position parameters of the shape.
None	Drag (self, int x, int y, eVision.EFrame frame, float zoomX, float zoomY, float panX, float panY)
	Moves a handle to a new position and updates the position parameters of the shape.
None	Drag (self, int x, int y, eVision.EFrame frame, float zoomX, float zoomY, float panX)
	Moves a handle to a new position and updates the position parameters of the shape.
None	Drag (self, int x, int y, eVision.EFrame frame, float zoomX, float zoomY)
	Moves a handle to a new position and updates the position parameters of the shape.
None	Drag (self, int x, int y, eVision.EFrame frame, float zoomX)
	Moves a handle to a new position and updates the position parameters of the shape.
None	Save (self, str path)
	Saves a gauge.The given eVision.ESerializer must have been created for writing.
None	Save (self, eVision.ESerializer\|None serializer)
	Saves a gauge.The given eVision.ESerializer must have been created for writing.
None	Load (self, str path)
	Loads a gauge.The given eVision.ESerializer must have been created for reading.
None	Load (self, eVision.ESerializer\|None serializer)
	Loads a gauge.The given eVision.ESerializer must have been created for reading.
bool	HasProperty (self, str aProperty)
	Returns whether a eVision.EBaseGauge 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.EBaseGauge.
None	RemoveProperty (self, str aProperty)
	Removes the property name aProperty from the eVision.EBaseGauge.
bool	HasValidPolarityProperty (self)
	Returns whether the eVision.EBaseGauge has a valid polarity property.
eVision.ESamplePoint	GetSample (self, int index)
	Retrieves sampled points used during the model fitting operation.
bool	HasSamples (self)
	Whether the samples are available or not.
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.EBaseGauge.AddSkipRange, removes the skip range with the given index.
None	RemoveAllSkipRanges (self)
	Removes all the skip ranges previously created by a call to eVision.EBaseGauge.AddSkipRange.
None	MeasureWithoutFitting (self, eVision.EROIBW8 sourceImage, eVision.EFrame frame)
	Triggers the point location without line fitting operation.
None	MeasureWithoutFitting (self, eVision.EROIBW8 sourceImage)
	Triggers the point location without line fitting operation.
None	MeasureWithoutFitting (self, eVision.EROIBW8 sourceImage, eVision.ERegion region, eVision.EFrame frame)
	Triggers the point location without line fitting operation.
None	MeasureWithoutFitting (self, eVision.EROIBW8 sourceImage, eVision.ERegion region)
	Triggers the point location without line fitting operation.
bool	IsFound (self)
	Flag indicating whether a measured shape has been found.
eVision.ESamplePath	MeasureSamplePath (self, eVision.EROIBW8 sourceImage, int pathIndex, eVision.EFrame frame)
	Measures the specified sample path.
eVision.ESamplePath	MeasureSamplePath (self, eVision.EROIBW8 sourceImage, int pathIndex)
	Measures the specified sample path.
eVision.ESamplePath	MeasureSamplePath (self, eVision.EROIBW8 sourceImage, int pathIndex, eVision.ERegion region, eVision.EFrame frame)
	Measures the specified sample path.
eVision.ESamplePath	MeasureSamplePath (self, eVision.EROIBW8 sourceImage, int pathIndex, eVision.ERegion region)
	Measures the specified sample path.
str	Name (self)
	Name of the eVision.EBaseGauge object.
	Name (self, str value)
	Name of the eVision.EBaseGauge object.
eVision.EEditionMode	EditionMode (self)
	Graphical edition mode (default: eVision.EBaseGauge.AvailableEditionModes).
	EditionMode (self, eVision.EEditionMode value)
	Graphical edition mode (default: eVision.EBaseGauge.AvailableEditionModes).
bool	Labeled (self)
	Whether to draw a label describing the gauge (default: no).
	Labeled (self, bool value)
	Whether to draw a label describing the gauge (default: no).
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.
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.
int	SamplePointIndex (self)
	Sampled.
	SamplePointIndex (self, int value)
	Sampled.
float	AverageDistance (self)
	Average distance between the sampled points and the fitted model.
int	NumSkipRanges (self)
	Number of skip ranges in the gauge after a call to eVision.EBaseGauge.AddSkipRange.

Additional Inherited Members
Static Public Member Functions inherited from eVision.EBaseGauge
eVision.EBaseGauge\|None	Make (str path)
	Creates a gauge of the correct type.

Detailed Description

Rectangle gauge.

Remarks:

License(s): EasyGauge

Constructor & Destructor Documentation

◆ init() [1/3]

None eVision.ERectangleGauge.__init__ ( self )

Constructs a eVision.ERectangleGauge.

◆ init() [2/3]

None eVision.ERectangleGauge.__init__	(		self,
		eVision.ERectangle	rect )

Constructs a eVision.ERectangleGauge.

Parameters

rect	Nominal rectangle

◆ init() [3/3]

None eVision.ERectangleGauge.__init__	(		self,
		eVision.ERectangleGauge	other )

Copy constructor.

Parameters

other Other eVision.ERectangleGauge object.

Member Function Documentation

◆ ActiveEdges() [1/2]

int eVision.ERectangleGauge.ActiveEdges ( self )

Active edges as defined in eVision.ERectangleGaugeEdge.

◆ ActiveEdges() [2/2]

eVision.ERectangleGauge.ActiveEdges	(		self,
		int	value )

Active edges as defined in eVision.ERectangleGaugeEdge.

◆ AvailableEditionModes()

eVision.EEditionMode eVision.ERectangleGauge.AvailableEditionModes ( self )

Returns all possible edition modes of the gauge.

Reimplemented from eVision.EBaseGauge.

◆ CopyTo()

None eVision.ERectangleGauge.CopyTo	(		self,
		eVision.ERectangleGauge	dest )

Copies all the data of the current eVision.ERectangleGauge object into another eVision.ERectangleGauge object.

Parameters

dest	An eVision.ERectangleGauge object in which the current eVision.ERectangleGauge object data have to be copied.

◆ DisableInnerFiltering()

None eVision.ERectangleGauge.DisableInnerFiltering ( self )

Disables inner sampled point filtering.

Remarks:

The inner sampled point filtering is activated as soon as the corresponding eVision.ERectangleGauge.InnerFilteringThreshold is set.

◆ GetMinNumFitSamples()

int eVision.ERectangleGauge.GetMinNumFitSamples	(		self,
		eVision.ERectangleGaugeEdge	edge )

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

Parameters

edge	Related edge.

◆ GetSampleLeftEdge()

eVision.ESamplePoint eVision.ERectangleGauge.GetSampleLeftEdge	(		self,
		int	index )

Allows to retrieve information on the samples found along the leftmost edge.

Parameters

index The sample index

◆ GetSampleLowerEdge()

eVision.ESamplePoint eVision.ERectangleGauge.GetSampleLowerEdge	(		self,
		int	index )

Allows to retrieve information on the samples found along the lower edge.

Parameters

index The sample index

◆ GetSampleRightEdge()

eVision.ESamplePoint eVision.ERectangleGauge.GetSampleRightEdge	(		self,
		int	index )

Allows to retrieve information on the samples found along the rightmost edge.

Parameters

index The sample index

◆ GetSampleUpperEdge()

eVision.ESamplePoint eVision.ERectangleGauge.GetSampleUpperEdge	(		self,
		int	index )

Allows to retrieve information on the samples found along the upper edge.

Parameters

index The sample index

◆ HVConstraint() [1/2]

bool eVision.ERectangleGauge.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.

Reimplemented from eVision.EBaseGauge.

◆ HVConstraint() [2/2]

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

Reimplemented from eVision.EBaseGauge.

◆ InnerFilteringThreshold() [1/2]

float eVision.ERectangleGauge.InnerFilteringThreshold ( self )

Sampled point inner filtering threshold.

Remarks:

If inner filtering is enabled, the sampled points that have been found inside the measured rectangle are filtered in regard of their distance to it. If this distance is greater than the threshold, the sampled point is set as invalid, and removed from the measure. This distance is in physical units.

The inner sampled point filtering is activated as soon as the corresponding threshold is set. To disable inner filtering, use the DisableInnerFiltering method.

◆ InnerFilteringThreshold() [2/2]

eVision.ERectangleGauge.InnerFilteringThreshold	(		self,
		float	value )

Sampled point inner filtering threshold.

Remarks:

If inner filtering is enabled, the sampled points that have been found inside the measured rectangle are filtered in regard of their distance to it. If this distance is greater than the threshold, the sampled point is set as invalid, and removed from the measure. This distance is in physical units.

The inner sampled point filtering is activated as soon as the corresponding threshold is set. To disable inner filtering, use the DisableInnerFiltering method.

◆ IsInnerFilteringEnabled()

bool eVision.ERectangleGauge.IsInnerFilteringEnabled ( self )

Whether inner sampled point filtering is enabled.

Remarks:

The inner sampled point filtering is activated as soon as the corresponding threshold is set, getting the eVision.ERectangleGauge.InnerFilteringThreshold property. To disable inner filtering, use the eVision.ERectangleGauge.DisableInnerFiltering method.

◆ KnownAngle() [1/2]

bool eVision.ERectangleGauge.KnownAngle ( self )

Flag indicating whether the rotation angle of the rectangle to be fitted is known or not.

Remarks:

A rectangle model to be fitted may have a well-known orientation. It is possible to impose the value of this rotation angle, thus removing one degree of freedom.

The sign of the rotation angle depends on 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.ERectangleGauge.KnownAngle	(		self,
		bool	value )

Flag indicating whether the rotation angle of the rectangle to be fitted is known or not.

Remarks:

A rectangle model to be fitted may have a well-known orientation. It is possible to impose the value of this rotation angle, thus removing one degree of freedom.

The sign of the rotation angle depends on 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/4]

eVision.ERectangle eVision.ERectangleGauge.Measure	(		self,
		eVision.EROIBW8	sourceImage )

Performs the gauge measurement.

Parameters

sourceImage Source image.

Reimplemented from eVision.EBaseGauge.

◆ Measure() [2/4]

eVision.ERectangle eVision.ERectangleGauge.Measure	(		self,
		eVision.EROIBW8	sourceImage,
		eVision.EFrame	frame )

Performs the gauge measurement.

Parameters

sourceImage	Source image.
frame	Frame of reference

Reimplemented from eVision.EBaseGauge.

◆ Measure() [3/4]

eVision.ERectangle eVision.ERectangleGauge.Measure	(		self,
		eVision.EROIBW8	sourceImage,
		eVision.ERegion	region )

Performs the gauge measurement.

Parameters

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

Reimplemented from eVision.EBaseGauge.

◆ Measure() [4/4]

eVision.ERectangle eVision.ERectangleGauge.Measure	(		self,
		eVision.EROIBW8	sourceImage,
		eVision.ERegion	region,
		eVision.EFrame	frame )

Performs the gauge measurement.

Parameters

sourceImage	Source image.
region	Region to use with the source image.
frame	Frame of reference

Reimplemented from eVision.EBaseGauge.

◆ Measured()

eVision.EShape | None eVision.ERectangleGauge.Measured ( self )

Copy of the measured shape.

Reimplemented from eVision.EBaseGauge.

◆ MeasuredRectangle()

eVision.ERectangle eVision.ERectangleGauge.MeasuredRectangle ( self )

Information pertaining to the fitted rectangle.

◆ MinAmplitude() [1/2]

int eVision.ERectangleGauge.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.

Reimplemented from eVision.EBaseGauge.

◆ MinAmplitude() [2/2]

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

Reimplemented from eVision.EBaseGauge.

◆ MinArea() [1/2]

int eVision.ERectangleGauge.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.

Reimplemented from eVision.EBaseGauge.

◆ MinArea() [2/2]

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

Reimplemented from eVision.EBaseGauge.

◆ MinNumFitSamples() [1/2]

list[int] eVision.ERectangleGauge.MinNumFitSamples ( self )

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

Reimplemented from eVision.EBaseGauge.

◆ MinNumFitSamples() [2/2]

eVision.ERectangleGauge.MinNumFitSamples	(		self,
		list[int]	value )

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

Reimplemented from eVision.EBaseGauge.

◆ Nominal() [1/2]

eVision.EShape | None eVision.ERectangleGauge.Nominal ( self )

Nominal shape of the gauge.

Remarks:

Note that the gauge stores a copy of the shape and returns a copy of the shape. The gauge applies its eVision.EBaseGauge.EditionMode to the shape.

Reimplemented from eVision.EBaseGauge.

◆ Nominal() [2/2]

eVision.ERectangleGauge.Nominal	(		self,
		eVision.EShape \| None	value )

Nominal shape of the gauge.

Remarks:

Note that the gauge stores a copy of the shape and returns a copy of the shape. The gauge applies its eVision.EBaseGauge.EditionMode to the shape.

Reimplemented from eVision.EBaseGauge.

◆ NumSamples()

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

Reimplemented from eVision.EBaseGauge.

◆ NumSamplesLeftEdge()

int eVision.ERectangleGauge.NumSamplesLeftEdge ( self )

Number of sampled points found on leftmost edge during the measure operation.

◆ NumSamplesLowerEdge()

int eVision.ERectangleGauge.NumSamplesLowerEdge ( self )

Number of sampled points found on lower edge during the measure operation.

◆ NumSamplesRightEdge()

int eVision.ERectangleGauge.NumSamplesRightEdge ( self )

Number of sampled points found on rightmost edge during the measure operation.

◆ NumSamplesUpperEdge()

int eVision.ERectangleGauge.NumSamplesUpperEdge ( self )

Number of sampled points found on upper edge during the measure operation.

◆ Rectangle() [1/2]

eVision.ERectangle eVision.ERectangleGauge.Rectangle ( self )

Nominal rectangle.

◆ Rectangle() [2/2]

eVision.ERectangleGauge.Rectangle	(		self,
		eVision.ERectangle	value )

Nominal rectangle.

◆ RectangularSamplingArea() [1/2]

bool eVision.ERectangleGauge.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.

Reimplemented from eVision.EBaseGauge.

◆ RectangularSamplingArea() [2/2]

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

Reimplemented from eVision.EBaseGauge.

◆ SetMinNumFitSamples() [1/2]

None eVision.ERectangleGauge.SetMinNumFitSamples	(		self,
		eVision.ERectangleGaugeEdge	edge,
		int	newValue )

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

Parameters

edge	Related edge to change the minimum number of samples.
newValue	New value for minimum number of samples for the specified edge.

◆ SetMinNumFitSamples() [2/2]

None eVision.ERectangleGauge.SetMinNumFitSamples	(		self,
		int	topSide,
		int	leftSide,
		int	bottomSide,
		int	rightSide )

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

Parameters

topSide	Minimum number of samples to fit the top side.
leftSide	Minimum number of samples to fit the left side.
bottomSide	Minimum number of samples to fit the bottom side.
rightSide	Minimum number of samples to fit the right side.

◆ Smoothing() [1/2]

int eVision.ERectangleGauge.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.

Reimplemented from eVision.EBaseGauge.

◆ Smoothing() [2/2]

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

Reimplemented from eVision.EBaseGauge.

◆ Thickness() [1/2]

int eVision.ERectangleGauge.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.

Reimplemented from eVision.EBaseGauge.

◆ Thickness() [2/2]

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

Reimplemented from eVision.EBaseGauge.

◆ Threshold() [1/2]

int eVision.ERectangleGauge.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.

Reimplemented from eVision.EBaseGauge.

◆ Threshold() [2/2]

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

Reimplemented from eVision.EBaseGauge.

◆ Tolerance() [1/2]

float eVision.ERectangleGauge.Tolerance ( self )

Half thickness of the model fitting gauge.

Remarks:

By default, the tolerance 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.

The tolerance isn't taken into consideration for the point gauge.

Reimplemented from eVision.EBaseGauge.

◆ Tolerance() [2/2]

eVision.ERectangleGauge.Tolerance	(		self,
		float	value )

Half thickness of the model fitting gauge.

Remarks:

By default, the tolerance 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.

The tolerance isn't taken into consideration for the point gauge.

Reimplemented from eVision.EBaseGauge.

◆ TransitionChoice() [1/2]

eVision.ETransitionChoice eVision.ERectangleGauge.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.EBaseGauge.TransitionIndex to specify the desired transition.

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

Reimplemented from eVision.EBaseGauge.

◆ TransitionChoice() [2/2]

eVision.ERectangleGauge.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.EBaseGauge.TransitionIndex to specify the desired transition.

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

Reimplemented from eVision.EBaseGauge.

◆ TransitionIndex() [1/2]

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

Reimplemented from eVision.EBaseGauge.

◆ TransitionIndex() [2/2]

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

Reimplemented from eVision.EBaseGauge.

◆ TransitionType() [1/2]

eVision.ETransitionType eVision.ERectangleGauge.TransitionType ( self )

Transition type.

Remarks:

The type of 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).

Reimplemented from eVision.EBaseGauge.

◆ TransitionType() [2/2]

eVision.ERectangleGauge.TransitionType	(		self,
		eVision.ETransitionType	value )

Transition type.

Remarks:

The type of 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).

Reimplemented from eVision.EBaseGauge.

◆ Type()

eVision.EShapeType eVision.ERectangleGauge.Type ( self )

Shape type.

Reimplemented from eVision.EBaseGauge.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/3]

◆ __init__() [2/3]

◆ __init__() [3/3]

Member Function Documentation

◆ ActiveEdges() [1/2]

◆ ActiveEdges() [2/2]

◆ AvailableEditionModes()

◆ CopyTo()

◆ DisableInnerFiltering()

◆ GetMinNumFitSamples()

◆ GetSampleLeftEdge()

◆ GetSampleLowerEdge()

◆ GetSampleRightEdge()

◆ GetSampleUpperEdge()

◆ HVConstraint() [1/2]

◆ HVConstraint() [2/2]

◆ InnerFilteringThreshold() [1/2]

◆ InnerFilteringThreshold() [2/2]

◆ IsInnerFilteringEnabled()

◆ KnownAngle() [1/2]

◆ KnownAngle() [2/2]

◆ Measure() [1/4]

◆ Measure() [2/4]

◆ Measure() [3/4]

◆ Measure() [4/4]

◆ Measured()

◆ MeasuredRectangle()

◆ MinAmplitude() [1/2]

◆ MinAmplitude() [2/2]

◆ MinArea() [1/2]

◆ MinArea() [2/2]

◆ MinNumFitSamples() [1/2]

◆ MinNumFitSamples() [2/2]

◆ Nominal() [1/2]

◆ Nominal() [2/2]

◆ NumSamples()

◆ NumSamplesLeftEdge()

◆ NumSamplesLowerEdge()

◆ NumSamplesRightEdge()

◆ NumSamplesUpperEdge()

◆ Rectangle() [1/2]

◆ Rectangle() [2/2]

◆ RectangularSamplingArea() [1/2]

◆ RectangularSamplingArea() [2/2]

◆ SetMinNumFitSamples() [1/2]

◆ SetMinNumFitSamples() [2/2]

◆ 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]

◆ TransitionIndex() [2/2]

◆ TransitionType() [1/2]

◆ TransitionType() [2/2]

◆ Type()

◆ init() [1/3]

◆ init() [2/3]

◆ init() [3/3]