eVision.EBaseGauge Class Reference

EasyGauge base class. More...

Inheritance diagram for eVision.EBaseGauge:

Public Member Functions
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.
eVision.EShape|None	Measure (self, eVision.EROIBW8 sourceImage, eVision.EFrame frame)
	Performs the gauge measurement.
eVision.EShape|None	Measure (self, eVision.EROIBW8 sourceImage)
	Performs the gauge measurement.
eVision.EShape|None	Measure (self, eVision.EROIBW8 sourceImage, eVision.ERegion region, eVision.EFrame frame)
	Performs the gauge measurement.
eVision.EShape|None	Measure (self, eVision.EROIBW8 sourceImage, eVision.ERegion region)
	Performs the gauge measurement.
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.
eVision.EShapeType	Type (self)
	Shape type.
str	Name (self)
	Name of the eVision.EBaseGauge object.
	Name (self, str value)
	Name of the eVision.EBaseGauge object.
eVision.EShape|None	Nominal (self)
	Nominal shape of the gauge.
	Nominal (self, eVision.EShape|None value)
	Nominal shape of the gauge.
eVision.EEditionMode	EditionMode (self)
	Graphical edition mode (default: eVision.EBaseGauge.AvailableEditionModes).
	EditionMode (self, eVision.EEditionMode value)
	Graphical edition mode (default: eVision.EBaseGauge.AvailableEditionModes).
eVision.EEditionMode	AvailableEditionModes (self)
	Returns all possible edition modes of the gauge.
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	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.
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.
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.
list[int]	MinNumFitSamples (self)
	Sets/Gets the minimum number of samples required for fitting the shape.
	MinNumFitSamples (self, list[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.EBaseGauge.AddSkipRange.
eVision.EShape|None	Measured (self)
	Copy of the measured shape.

Static Public Member Functions
eVision.EBaseGauge|None	Make (str path)
	Creates a gauge of the correct type.

Detailed Description

EasyGauge base class.

Remarks:

License(s): EasyGauge

Member Function Documentation

AddSkipRange()

int eVision.EBaseGauge.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.EBaseGauge. 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 the current return value for eVision.EBaseGauge.NumSamples).

Parameters

range

The skip range.

AvailableEditionModes()

eVision.EEditionMode eVision.EBaseGauge.AvailableEditionModes

(

self

)

Returns all possible edition modes of the gauge.

Reimplemented in eVision.ECircleGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, and eVision.EWedgeGauge.

AverageDistance()

float eVision.EBaseGauge.AverageDistance

(

self

)

Average distance between the sampled points and the fitted model.

Remarks:

Irrelevant in case of a point location operation.

Drag() [1/8]

None eVision.EBaseGauge.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.

Parameters

x	Current cursor coordinates.
y	Current cursor coordinates.
frame	Frame of reference in which the gauge is located.
zoomX	Horizontal zoom factor. By default, true scale is used.

Drag() [2/8]

None eVision.EBaseGauge.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.

Parameters

x	Current cursor coordinates.
y	Current cursor coordinates.
frame	Frame of reference in which the gauge is located.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.

Drag() [3/8]

None eVision.EBaseGauge.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.

Parameters

x	Current cursor coordinates.
y	Current cursor coordinates.
frame	Frame of reference in which the gauge is located.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal pan offset. By default, no pan is added.

Drag() [4/8]

None eVision.EBaseGauge.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.

Parameters

x	Current cursor coordinates.
y	Current cursor coordinates.
frame	Frame of reference in which the gauge is located.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal pan offset. By default, no pan is added.
panY	Vertical pan offset. By default, no pan is added.

Drag() [5/8]

None eVision.EBaseGauge.Drag	(		self,
		int	x,
		int	y,
		float	zoomX )

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

Parameters

x	Current cursor coordinates.
y	Current cursor coordinates.
zoomX	Horizontal zoom factor. By default, true scale is used.

Drag() [6/8]

None eVision.EBaseGauge.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.

Parameters

x	Current cursor coordinates.
y	Current cursor coordinates.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.

Drag() [7/8]

None eVision.EBaseGauge.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.

Parameters

x	Current cursor coordinates.
y	Current cursor coordinates.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal pan offset. By default, no pan is added.

Drag() [8/8]

None eVision.EBaseGauge.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.

Parameters

x	Current cursor coordinates.
y	Current cursor coordinates.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal pan offset. By default, no pan is added.
panY	Vertical pan offset. By default, no pan is added.

Draw() [1/10]

None eVision.EBaseGauge.Draw	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		eVision.EDrawingMode	drawingMode )

Draws a graphical representation of a shape, 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.

Draw() [2/10]

None eVision.EBaseGauge.Draw	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		eVision.EDrawingMode	drawingMode,
		eVision.EFrame	frame )

Draws a graphical representation of a shape, 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.
frame	Frame of reference in which the gauge is located.

Draw() [3/10]

None eVision.EBaseGauge.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.

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.
frame	Frame of reference in which the gauge is located.
zoomX	Horizontal zoom factor. By default, true scale is used.

Draw() [4/10]

None eVision.EBaseGauge.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.

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.
frame	Frame of reference in which the gauge is located.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.

Draw() [5/10]

None eVision.EBaseGauge.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.

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.
frame	Frame of reference in which the gauge is located.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal pan offset. By default, no pan is added.

Draw() [6/10]

None eVision.EBaseGauge.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.

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.
frame	Frame of reference in which the gauge is located.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal pan offset. By default, no pan is added.
panY	Vertical pan offset. By default, no pan is added.

Draw() [7/10]

None eVision.EBaseGauge.Draw	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		eVision.EDrawingMode	drawingMode,
		float	zoomX )

Draws a graphical representation of a shape, 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.
zoomX	Horizontal zoom factor. By default, true scale is used.

Draw() [8/10]

None eVision.EBaseGauge.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.

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.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.

Draw() [9/10]

None eVision.EBaseGauge.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.

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.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal pan offset. By default, no pan is added.

Draw() [10/10]

None eVision.EBaseGauge.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.

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.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal pan offset. By default, no pan is added.
panY	Vertical pan offset. By default, no pan is added.

EditionMode() [1/2]

eVision.EEditionMode eVision.EBaseGauge.EditionMode

(

self

)

Graphical edition mode (default: eVision.EBaseGauge.AvailableEditionModes).

Remarks:

This also sets the same graphical edition mode to the nominal shape.

EditionMode() [2/2]

eVision.EBaseGauge.EditionMode	(		self,
		eVision.EEditionMode	value )

Graphical edition mode (default: eVision.EBaseGauge.AvailableEditionModes).

Remarks:

This also sets the same graphical edition mode to the nominal shape.

FilteringThreshold() [1/2]

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

GetProperty()

str eVision.EBaseGauge.GetProperty	(		self,
		str	aProperty )

Gets the value of property aProperty.

Throws an exception if no such property exists.

Parameters

aProperty

The name of the property.

GetSample()

eVision.ESamplePoint eVision.EBaseGauge.GetSample	(		self,
		int	index )

Retrieves sampled points used during the model fitting operation.

Parameters

index

Index of the point between 0 and eVision.EBaseGauge.NumSamples

GetSkipRange()

eVision.EIntegerRange eVision.EBaseGauge.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.EBaseGauge.AddSkipRange method).

Remarks:

Start is guaranteed to be smaller or equal to end.

Parameters

index

Index of the skip range.

HasProperty()

bool eVision.EBaseGauge.HasProperty	(		self,
		str	aProperty )

Returns whether a eVision.EBaseGauge has a property named aProperty.

Parameters

aProperty

The name of the property.

HasSamples()

bool eVision.EBaseGauge.HasSamples

(

self

)

Whether the samples are available or not.

The samples are available after a call to eVision.EBaseGauge.Measure, even if the shape was not found.

HasValidPolarityProperty()

bool eVision.EBaseGauge.HasValidPolarityProperty

(

self

)

Returns whether the eVision.EBaseGauge has a valid polarity property.

I.e. if it has a property named "polarity" whose value is either "inverted" or "direct".

Remarks:

The "polarity" property is mostly used to define the orientation of the gradient in a shape of a eVision.EVectorModel.

HitTest() [1/10]

eVision.EEditionMode eVision.EBaseGauge.HitTest	(		self,
		int	x,
		int	y )

Checks if there is a handle under the cursor and returns the corresponding edition mode.

Parameters

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

HitTest() [2/10]

eVision.EEditionMode eVision.EBaseGauge.HitTest	(		self,
		int	x,
		int	y,
		eVision.EFrame	frame )

Checks if there is a handle under the cursor and returns the corresponding edition mode.

Parameters

x	Cursor current X coordinate.
y	Cursor current Y coordinate.
frame	Frame of reference in which the gauge is located.

HitTest() [3/10]

eVision.EEditionMode eVision.EBaseGauge.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.

Parameters

x	Cursor current X coordinate.
y	Cursor current Y coordinate.
frame	Frame of reference in which the gauge is located.
zoomX	Horizontal zoom factor. By default, true scale is used.

HitTest() [4/10]

eVision.EEditionMode eVision.EBaseGauge.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.

Parameters

x	Cursor current X coordinate.
y	Cursor current Y coordinate.
frame	Frame of reference in which the gauge is located.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.

HitTest() [5/10]

eVision.EEditionMode eVision.EBaseGauge.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.

Parameters

x	Cursor current X coordinate.
y	Cursor current Y coordinate.
frame	Frame of reference in which the gauge is located.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal pan offset. By default, no pan is added.

HitTest() [6/10]

eVision.EEditionMode eVision.EBaseGauge.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.

Parameters

x	Cursor current X coordinate.
y	Cursor current Y coordinate.
frame	Frame of reference in which the gauge is located.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal pan offset. By default, no pan is added.
panY	Vertical pan offset. By default, no pan is added.

HitTest() [7/10]

eVision.EEditionMode eVision.EBaseGauge.HitTest	(		self,
		int	x,
		int	y,
		float	zoomX )

Checks if there is a handle under the cursor and returns the corresponding edition mode.

Parameters

x	Cursor current X coordinate.
y	Cursor current Y coordinate.
zoomX	Horizontal zoom factor. By default, true scale is used.

HitTest() [8/10]

eVision.EEditionMode eVision.EBaseGauge.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.

Parameters

x	Cursor current X coordinate.
y	Cursor current Y coordinate.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.

HitTest() [9/10]

eVision.EEditionMode eVision.EBaseGauge.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.

Parameters

x	Cursor current X coordinate.
y	Cursor current Y coordinate.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal pan offset. By default, no pan is added.

HitTest() [10/10]

eVision.EEditionMode eVision.EBaseGauge.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.

Parameters

x	Cursor current X coordinate.
y	Cursor current Y coordinate.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.
panX	Horizontal pan offset. By default, no pan is added.
panY	Vertical pan offset. By default, no pan is added.

HVConstraint() [1/2]

bool eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

HVConstraint() [2/2]

eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

IsFound()

bool eVision.EBaseGauge.IsFound

(

self

)

Flag indicating whether a measured shape has been found.

Remarks:

After calling Measure() on a gauge object, use IsFound() to get the status of the measurement.

Labeled() [1/2]

bool eVision.EBaseGauge.Labeled

(

self

)

Whether to draw a label describing the gauge (default: no).

Labeled() [2/2]

eVision.EBaseGauge.Labeled	(		self,
		bool	value )

Whether to draw a label describing the gauge (default: no).

Load() [1/2]

None eVision.EBaseGauge.Load	(		self,
		eVision.ESerializer | None	serializer )

Loads a gauge.The given eVision.ESerializer must have been created for reading.

Parameters

serializer

Pointer to the eVision.ESerializer created for reading.

Load() [2/2]

None eVision.EBaseGauge.Load	(		self,
		str	path )

Loads a gauge.The given eVision.ESerializer must have been created for reading.

Parameters

path	The file path.

Make()

eVision.EBaseGauge | None eVision.EBaseGauge.Make ( str path )

static

Creates a gauge of the correct type.

Parameters

path

File path

Measure() [1/4]

eVision.EShape | None eVision.EBaseGauge.Measure	(		self,
		eVision.EROIBW8	sourceImage )

Performs the gauge measurement.

For a point gauge, it locates the points along the defined path. For other gauges, it performs the model fitting operation.

Parameters

sourceImage

Source image.

Reimplemented in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, eVision.EWedgeGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

Measure() [2/4]

eVision.EShape | None eVision.EBaseGauge.Measure	(		self,
		eVision.EROIBW8	sourceImage,
		eVision.EFrame	frame )

Performs the gauge measurement.

For a point gauge, it locates the points along the defined path. For other gauges, it performs the model fitting operation.

Parameters

sourceImage	Source image.
frame	Frame of reference

Reimplemented in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, eVision.EWedgeGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

Measure() [3/4]

eVision.EShape | None eVision.EBaseGauge.Measure	(		self,
		eVision.EROIBW8	sourceImage,
		eVision.ERegion	region )

Performs the gauge measurement.

For a point gauge, it locates the points along the defined path. For other gauges, it performs the model fitting operation.

Parameters

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

Reimplemented in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, eVision.EWedgeGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

Measure() [4/4]

eVision.EShape | None eVision.EBaseGauge.Measure	(		self,
		eVision.EROIBW8	sourceImage,
		eVision.ERegion	region,
		eVision.EFrame	frame )

Performs the gauge measurement.

For a point gauge, it locates the points along the defined path. For other gauges, it performs the model fitting operation.

Parameters

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

Reimplemented in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, eVision.EWedgeGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

Measured()

eVision.EShape | None eVision.EBaseGauge.Measured

(

self

)

Copy of the measured shape.

Reimplemented in eVision.ECircleGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, and eVision.EWedgeGauge.

MeasureSamplePath() [1/4]

eVision.ESamplePath eVision.EBaseGauge.MeasureSamplePath	(		self,
		eVision.EROIBW8	sourceImage,
		int	pathIndex )

Measures the specified sample path.

The sample path contains all the detected transitions along that path and can be used to plot the profile and derivatives of that path.

Parameters

sourceImage	Source image.
pathIndex	Index of the path to measure between 0 and eVision.EBaseGauge.NumSamples.

MeasureSamplePath() [2/4]

eVision.ESamplePath eVision.EBaseGauge.MeasureSamplePath	(		self,
		eVision.EROIBW8	sourceImage,
		int	pathIndex,
		eVision.EFrame	frame )

Measures the specified sample path.

The sample path contains all the detected transitions along that path and can be used to plot the profile and derivatives of that path.

Parameters

sourceImage	Source image.
pathIndex	Index of the path to measure between 0 and eVision.EBaseGauge.NumSamples.
frame	Frame of reference

MeasureSamplePath() [3/4]

eVision.ESamplePath eVision.EBaseGauge.MeasureSamplePath	(		self,
		eVision.EROIBW8	sourceImage,
		int	pathIndex,
		eVision.ERegion	region )

Measures the specified sample path.

The sample path contains all the detected transitions along that path and can be used to plot the profile and derivatives of that path.

Parameters

sourceImage	Source image.
pathIndex	Index of the path to measure between 0 and eVision.EBaseGauge.NumSamples.
region	Region to use with the source image.

MeasureSamplePath() [4/4]

eVision.ESamplePath eVision.EBaseGauge.MeasureSamplePath	(		self,
		eVision.EROIBW8	sourceImage,
		int	pathIndex,
		eVision.ERegion	region,
		eVision.EFrame	frame )

Measures the specified sample path.

The sample path contains all the detected transitions along that path and can be used to plot the profile and derivatives of that path.

Parameters

sourceImage	Source image.
pathIndex	Index of the path to measure between 0 and eVision.EBaseGauge.NumSamples.
region	Region to use with the source image.
frame	Frame of reference

MeasureWithoutFitting() [1/4]

None eVision.EBaseGauge.MeasureWithoutFitting	(		self,
		eVision.EROIBW8	sourceImage )

Triggers the point location without line fitting operation.

Remarks:

This method performs the actual measurement for each transition, but does not perform the gauge fitting. This means that individual samples will be available through the eVision.EBaseGauge.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.

For point gauge, this method is equivalent to eVision.EBaseGauge.Measure.

Parameters

sourceImage

Source image.

MeasureWithoutFitting() [2/4]

None eVision.EBaseGauge.MeasureWithoutFitting	(		self,
		eVision.EROIBW8	sourceImage,
		eVision.EFrame	frame )

Triggers the point location without line fitting operation.

Remarks:

This method performs the actual measurement for each transition, but does not perform the gauge fitting. This means that individual samples will be available through the eVision.EBaseGauge.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.

For point gauge, this method is equivalent to eVision.EBaseGauge.Measure.

Parameters

sourceImage	Source image.
frame	Frame of reference

MeasureWithoutFitting() [3/4]

None eVision.EBaseGauge.MeasureWithoutFitting	(		self,
		eVision.EROIBW8	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 gauge fitting. This means that individual samples will be available through the eVision.EBaseGauge.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.

For point gauge, this method is equivalent to eVision.EBaseGauge.Measure.

Parameters

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

MeasureWithoutFitting() [4/4]

None eVision.EBaseGauge.MeasureWithoutFitting	(		self,
		eVision.EROIBW8	sourceImage,
		eVision.ERegion	region,
		eVision.EFrame	frame )

Triggers the point location without line fitting operation.

Remarks:

This method performs the actual measurement for each transition, but does not perform the gauge fitting. This means that individual samples will be available through the eVision.EBaseGauge.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.

For point gauge, this method is equivalent to eVision.EBaseGauge.Measure.

Parameters

sourceImage	Source image.
region	The region on which to measure.
frame	Frame of reference

MinAmplitude() [1/2]

int eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

MinAmplitude() [2/2]

eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

MinArea() [1/2]

int eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

MinArea() [2/2]

eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

MinNumFitSamples() [1/2]

list[int] eVision.EBaseGauge.MinNumFitSamples

(

self

)

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

Remarks:

In case of a ERectangleGauge, 4 values are used, one for each side of the rectangle. Value 0 is used for line and circle gauge. Values 0,1,2,3 are used for rectangle and wedge gauge in the following manner: Rectangle : Top = 0, Left = 1, Bottom = 2, Right = 3 Wedge : Outer Circle = 0, Origin Border = 1, Inner Circle = 2, End Border = 3

Reimplemented in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, and eVision.ERectangleGauge.

MinNumFitSamples() [2/2]

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

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

Remarks:

In case of a ERectangleGauge, 4 values are used, one for each side of the rectangle. Value 0 is used for line and circle gauge. Values 0,1,2,3 are used for rectangle and wedge gauge in the following manner: Rectangle : Top = 0, Left = 1, Bottom = 2, Right = 3 Wedge : Outer Circle = 0, Origin Border = 1, Inner Circle = 2, End Border = 3

Reimplemented in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, and eVision.ERectangleGauge.

Name() [1/2]

str eVision.EBaseGauge.Name

(

self

)

Name of the eVision.EBaseGauge object.

Name() [2/2]

eVision.EBaseGauge.Name	(		self,
		str	value )

Name of the eVision.EBaseGauge object.

Nominal() [1/2]

eVision.EShape | None eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

Nominal() [2/2]

eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

NumFilteringPasses() [1/2]

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

NumSamples()

int eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, and eVision.EWedgeGauge.

NumSkipRanges()

int eVision.EBaseGauge.NumSkipRanges

(

self

)

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

NumValidSamples()

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

RectangularSamplingArea() [1/2]

bool eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

RectangularSamplingArea() [2/2]

eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

RemoveAllSkipRanges()

None eVision.EBaseGauge.RemoveAllSkipRanges

(

self

)

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

RemoveProperty()

None eVision.EBaseGauge.RemoveProperty	(		self,
		str	aProperty )

Removes the property name aProperty from the eVision.EBaseGauge.

Parameters

aProperty

The name of the property.

RemoveSkipRange()

None eVision.EBaseGauge.RemoveSkipRange	(		self,
		int	index )

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

Parameters

index

Index of the skip range to remove, as returned by eVision.EBaseGauge.AddSkipRange.

SamplePointIndex() [1/2]

int eVision.EBaseGauge.SamplePointIndex

(

self

)

Sampled.

SamplePointIndex() [2/2]

eVision.EBaseGauge.SamplePointIndex	(		self,
		int	value )

Sampled.

SamplingStep() [1/2]

float eVision.EBaseGauge.SamplingStep

(

self

)

Approximate distance between sampled points during a model fitting operation.

Remarks:

Irrelevant in case of a point gauge.

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 to accurately locate it.

SamplingStep() [2/2]

eVision.EBaseGauge.SamplingStep	(		self,
		float	value )

Approximate distance between sampled points during a model fitting operation.

Remarks:

Irrelevant in case of a point gauge.

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 to accurately locate it.

Save() [1/2]

None eVision.EBaseGauge.Save	(		self,
		eVision.ESerializer | None	serializer )

Saves a gauge.The given eVision.ESerializer must have been created for writing.

Parameters

serializer

Pointer to the eVision.ESerializer created for writing.

Save() [2/2]

None eVision.EBaseGauge.Save	(		self,
		str	path )

Saves a gauge.The given eVision.ESerializer must have been created for writing.

Parameters

path	The file path.

SetProperty()

None eVision.EBaseGauge.SetProperty	(		self,
		str	aProperty,
		str	aValue )

Sets the value of property aProperty to aValue for this eVision.EBaseGauge.

Remarks:

You may use a shape property to define the orientation of the gradient in a shape of a eVision.EVectorModel. This is done by setting a property named "polarity" to "inverted" or "direct".

Additionally, you may set any property to any value for your own needs.

Parameters

aProperty	The name of the property.
aValue	The value of the property.

Smoothing() [1/2]

int eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

Smoothing() [2/2]

eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

Thickness() [1/2]

int eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

Thickness() [2/2]

eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

Threshold() [1/2]

int eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

Threshold() [2/2]

eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

Tolerance() [1/2]

float eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

Tolerance() [2/2]

eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

TransitionChoice() [1/2]

eVision.ETransitionChoice eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

TransitionChoice() [2/2]

eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

TransitionIndex() [1/2]

int eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

TransitionIndex() [2/2]

eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

TransitionType() [1/2]

eVision.ETransitionType eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

TransitionType() [2/2]

eVision.EBaseGauge.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 in eVision.ECircleGauge, eVision.ECircleGauge, eVision.ELineGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, eVision.ERectangleGauge, eVision.EWedgeGauge, and eVision.EWedgeGauge.

Type()

eVision.EShapeType eVision.EBaseGauge.Type

(

self

)

Shape type.

Reimplemented in eVision.ECircleGauge, eVision.ELineGauge, eVision.EPointGauge, eVision.EPolygonGauge, eVision.ERectangleGauge, and eVision.EWedgeGauge.