eVision.ESamplePath Class Reference

The class represents a sample path (eVision.ELine on which we sample the pixel values to find the strong edge-crossings). More...

Public Member Functions
None	__init__ (self, eVision.ELine line)
	Constructs a eVision.ESamplePath.
None	__init__ (self, eVision.EPoint center, float pathLength, float pathAngle)
	Constructs a eVision.ESamplePath.
None	__init__ (self, eVision.EPoint center, float pathLength)
	Constructs a eVision.ESamplePath.
None	__init__ (self, eVision.EPoint center)
	Constructs a eVision.ESamplePath.
None	__init__ (self)
	Constructs a eVision.ESamplePath.
None	__init__ (self, eVision.ESamplePath other)
	Constructs a eVision.ESamplePath.
None	CopyParametersTo (self, eVision.ESamplePath other)
	Copy the parameter to the other object.
bool	IsEqual (self, eVision.ESamplePath other)
	Compares this object with the other object.
eVision.EPoint	GetMeasuredPoint (self, int index)
	Coordinates of a sample point, measured along this sample path.
eVision.EPoint	GetMeasuredPoint (self)
	Coordinates of a sample point, measured along this sample path.
eVision.EPeak	GetMeasuredPeak (self, int index)
	Returns information pertaining to the default derivative peak, along one of the sample paths of the gauge.
eVision.EPeak	GetMeasuredPeak (self)
	Returns information pertaining to the default derivative peak, along one of the sample paths of the gauge.
None	Plot (self, eVision.EDrawAdapter|None graphicContext, eVision.EPlotItem plotItems, eVision.EPlotDecorationOptions opts, float width, float height, float originX, float originY)
	Draws the profile of the sample paths of the gauge, as defined by eVision.EPlotItem.
None	Plot (self, eVision.EDrawAdapter|None graphicContext, eVision.EPlotItem plotItems, eVision.EPlotDecorationOptions opts, float width, float height, float originX)
	Draws the profile of the sample paths of the gauge, as defined by eVision.EPlotItem.
None	Plot (self, eVision.EDrawAdapter|None graphicContext, eVision.EPlotItem plotItems, eVision.EPlotDecorationOptions opts, float width, float height)
	Draws the profile of the sample paths of the gauge, as defined by eVision.EPlotItem.
None	Measure (self, eVision.EROIBW8 pSrc, eVision.EFrame frame)
	Measure the peaks in the image, potentially applying normalization.
None	Measure (self, eVision.EROIBW8 pSrc)
	Measure the peaks in the image, potentially applying normalization.
None	Measure (self, eVision.EROIBW8 pSrc, eVision.ERegion region, eVision.EFrame frame)
	Measure the peaks in the image, potentially applying normalization.
None	Measure (self, eVision.EROIBW8 pSrc, eVision.ERegion region)
	Measure the peaks in the image, potentially applying normalization.
None	DrawTransition (self, eVision.EDrawAdapter|None graphicContext, eVision.EFrame frame, float zoomX, float zoomY, float panX, float panY)
	Draws the transition symbol between the points org and end if specified or between the origin and end of the eVision.ESamplePath.SamplePath.
None	DrawTransition (self, eVision.EDrawAdapter|None graphicContext, eVision.EFrame frame, float zoomX, float zoomY, float panX)
	Draws the transition symbol between the points org and end if specified or between the origin and end of the eVision.ESamplePath.SamplePath.
None	DrawTransition (self, eVision.EDrawAdapter|None graphicContext, eVision.EFrame frame, float zoomX, float zoomY)
	Draws the transition symbol between the points org and end if specified or between the origin and end of the eVision.ESamplePath.SamplePath.
None	DrawTransition (self, eVision.EDrawAdapter|None graphicContext, eVision.EFrame frame, float zoomX)
	Draws the transition symbol between the points org and end if specified or between the origin and end of the eVision.ESamplePath.SamplePath.
None	DrawTransition (self, eVision.EDrawAdapter|None graphicContext, eVision.EFrame frame)
	Draws the transition symbol between the points org and end if specified or between the origin and end of the eVision.ESamplePath.SamplePath.
None	DrawTransition (self, eVision.EDrawAdapter|None graphicContext, eVision.EPoint org, eVision.EPoint end, eVision.EFrame frame, float zoomX, float zoomY, float panX, float panY)
	Draws the transition symbol between the points org and end if specified or between the origin and end of the eVision.ESamplePath.SamplePath.
None	DrawTransition (self, eVision.EDrawAdapter|None graphicContext, eVision.EPoint org, eVision.EPoint end, eVision.EFrame frame, float zoomX, float zoomY, float panX)
	Draws the transition symbol between the points org and end if specified or between the origin and end of the eVision.ESamplePath.SamplePath.
None	DrawTransition (self, eVision.EDrawAdapter|None graphicContext, eVision.EPoint org, eVision.EPoint end, eVision.EFrame frame, float zoomX, float zoomY)
	Draws the transition symbol between the points org and end if specified or between the origin and end of the eVision.ESamplePath.SamplePath.
None	DrawTransition (self, eVision.EDrawAdapter|None graphicContext, eVision.EPoint org, eVision.EPoint end, eVision.EFrame frame, float zoomX)
	Draws the transition symbol between the points org and end if specified or between the origin and end of the eVision.ESamplePath.SamplePath.
None	DrawTransition (self, eVision.EDrawAdapter|None graphicContext, eVision.EPoint org, eVision.EPoint end, eVision.EFrame frame)
	Draws the transition symbol between the points org and end if specified or between the origin and end of the eVision.ESamplePath.SamplePath.
None	DrawPath (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX, float zoomY, float panX, float panY)
	Draws the sample path represented by the object.
None	DrawPath (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX, float zoomY, float panX)
	Draws the sample path represented by the object.
None	DrawPath (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX, float zoomY)
	Draws the sample path represented by the object.
None	DrawPath (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame, float zoomX)
	Draws the sample path represented by the object.
None	DrawPath (self, eVision.EDrawAdapter|None drawAdapter, eVision.EFrame frame)
	Draws the sample path represented by the object.

Static Public Member Functions
eVision.EPen	GetDrawingPen (eVision.EPlotItem plotItem)
	Gets a standard drawing pen for the specified plot item.

Properties
	SamplePath = property(_SamplePath__getter, _SamplePath__setter)
	Line along which the edge-crossing points are measured.
	Center = property(_Center__getter, _Center__setter)
	Center of the sample path.
	Length = property(_Length__getter, _Length__setter)
	Length of the path along which measure.
	Angle = property(_Angle__getter, _Angle__setter)
	Angle of the path along which we measure.
	Tolerance = property(_Tolerance__getter, _Tolerance__setter)
	Tolerance (half-length of the path).
	ToleranceAngle = property(_ToleranceAngle__getter, _ToleranceAngle__setter)
	Alias for eVision.ESamplePath.Angle.
	HVConstraint = property(_HVConstraint__getter, _HVConstraint__setter)
	Status of the restriction on the orientation of the sample path.
	Thickness = property(_Thickness__getter, _Thickness__setter)
	Number of parallel segments used to extract the data profile.
	Smoothing = property(_Smoothing__getter, _Smoothing__setter)
	Number of pixels used for the low-pass filtering operation.
	TransitionType = property(_TransitionType__getter, _TransitionType__setter)
	Transition type to measure.
	TransitionChoice = property(_TransitionChoice__getter, _TransitionChoice__setter)
	Transition choice used to select the sample point corresponding to eVision.ESamplePath.TransitionIndex.
	TransitionIndex = property(_TransitionIndex__getter, _TransitionIndex__setter)
	The sample point to select as default.
	Threshold = property(_Threshold__getter, _Threshold__setter)
	Threshold level used to delimit significant peaks in the data profile.
	MinAmplitude = property(_MinAmplitude__getter, _MinAmplitude__setter)
	Offset added to the Threshold when a peak is to be detected.
	MinArea = property(_MinArea__getter, _MinArea__setter)
	Minimum area value.
	TransitionRectangularSamplingArea = property(_TransitionRectangularSamplingArea__getter, _TransitionRectangularSamplingArea__setter)
	Flag indicating whether the sampling area remains a rectangle when rotated, instead of becoming a parallelogram.
	NumMeasuredPoints = property(_NumMeasuredPoints__getter, None)
	Number of edge-crossing points along the sample path.
	MeasuredPoints = property(_MeasuredPoints__getter, None)
	Coordinates of all edge-crossing points, measured along the sample path of a gauge.
	MeasuredPeaks = property(_MeasuredPeaks__getter, None)
	Returns information pertaining to the derivative peaks associated with all the edge-crossing point, such as their area, amplitude, start, length and center.
	DefaultPointIndex = property(_DefaultPointIndex__getter, None)
	The default edge-crossing point measured, chosen according to the transition choice parameter.
	Valid = property(_Valid__getter, None)
	Flag indicating if at least one valid transition has been found.

Detailed Description

The class represents a sample path (eVision.ELine on which we sample the pixel values to find the strong edge-crossings).

The sample path can be directly specified as a eVision.ELine object though eVision.ESamplePath.SamplePath or through eVision.ESamplePath.Center, eVision.ESamplePath.Length and eVision.ESamplePath.Angle.

The measurement of the sample path is done with eVision.ESamplePath.Measure. It will find eVision.ESamplePath.NumMeasuredPoints whose positions can be accessed with eVision.ESamplePath.GetMeasuredPoint or eVision.ESamplePath.MeasuredPoints. The characteristics of the edge-crossing can be accessed with eVision.ESamplePath.GetMeasuredPeak or eVision.ESamplePath.MeasuredPeaks.

The profile and derivatives of the sample path can be plotted with eVision.ESamplePath.Plot.

Remarks:

License(s): EasyGauge

Constructor & Destructor Documentation

__init__() [1/6]

None eVision.ESamplePath.__init__	(		self,
		eVision.ELine	line )

Constructs a eVision.ESamplePath.

Parameters

line	Line segment representing the sample path

__init__() [2/6]

None eVision.ESamplePath.__init__	(		self,
		eVision.EPoint	center,
		float	pathLength,
		float	pathAngle )

Constructs a eVision.ESamplePath.

Parameters

center	Center of the sample path
pathLength	Length of the sample path
pathAngle	Angle of the sample path

__init__() [3/6]

None eVision.ESamplePath.__init__	(		self,
		eVision.EPoint	center,
		float	pathLength )

Constructs a eVision.ESamplePath.

Parameters

center	Center of the sample path
pathLength	Length of the sample path

__init__() [4/6]

None eVision.ESamplePath.__init__	(		self,
		eVision.EPoint	center )

Constructs a eVision.ESamplePath.

Parameters

center

Center of the sample path

__init__() [5/6]

None eVision.ESamplePath.__init__

(

self

)

Constructs a eVision.ESamplePath.

__init__() [6/6]

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

Constructs a eVision.ESamplePath.

Parameters

other

Other eVision.ESamplePath object to copy from.

Member Function Documentation

CopyParametersTo()

None eVision.ESamplePath.CopyParametersTo	(		self,
		eVision.ESamplePath	other )

Copy the parameter to the other object.

Parameters

other

Object to copy the parameters to.

DrawPath() [1/5]

None eVision.ESamplePath.DrawPath	(		self,
		eVision.EDrawAdapter | None	drawAdapter,
		eVision.EFrame	frame )

Draws the sample path represented by the object.

Parameters

drawAdapter	Handle of the device context on which to draw.
frame	Frame of reference in which the gauge is located.

DrawPath() [2/5]

None eVision.ESamplePath.DrawPath	(		self,
		eVision.EDrawAdapter | None	drawAdapter,
		eVision.EFrame	frame,
		float	zoomX )

Draws the sample path represented by the object.

Parameters

drawAdapter	Handle of the device context on which to draw.
frame	Frame of reference in which the gauge is located.
zoomX	Horizontal zoom factor. By default, true scale is used.

DrawPath() [3/5]

None eVision.ESamplePath.DrawPath	(		self,
		eVision.EDrawAdapter | None	drawAdapter,
		eVision.EFrame	frame,
		float	zoomX,
		float	zoomY )

Draws the sample path represented by the object.

Parameters

drawAdapter	Handle of the device context on which to draw.
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.

DrawPath() [4/5]

None eVision.ESamplePath.DrawPath	(		self,
		eVision.EDrawAdapter | None	drawAdapter,
		eVision.EFrame	frame,
		float	zoomX,
		float	zoomY,
		float	panX )

Draws the sample path represented by the object.

Parameters

drawAdapter	Handle of the device context on which to draw.
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.

DrawPath() [5/5]

None eVision.ESamplePath.DrawPath	(		self,
		eVision.EDrawAdapter | None	drawAdapter,
		eVision.EFrame	frame,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draws the sample path represented by the object.

Parameters

drawAdapter	Handle of the device context on which to draw.
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.

DrawTransition() [1/10]

None eVision.ESamplePath.DrawTransition	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		eVision.EFrame	frame )

Draws the transition symbol between the points org and end if specified or between the origin and end of the eVision.ESamplePath.SamplePath.

Parameters

graphicContext	Handle of the device context on which to draw.
frame	Frame of reference in which the path is located.

DrawTransition() [2/10]

None eVision.ESamplePath.DrawTransition	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		eVision.EFrame	frame,
		float	zoomX )

Draws the transition symbol between the points org and end if specified or between the origin and end of the eVision.ESamplePath.SamplePath.

Parameters

graphicContext	Handle of the device context on which to draw.
frame	Frame of reference in which the path is located.
zoomX	Horizontal zoom factor. By default, true scale is used.

DrawTransition() [3/10]

None eVision.ESamplePath.DrawTransition	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		eVision.EFrame	frame,
		float	zoomX,
		float	zoomY )

Draws the transition symbol between the points org and end if specified or between the origin and end of the eVision.ESamplePath.SamplePath.

Parameters

graphicContext	Handle of the device context on which to draw.
frame	Frame of reference in which the path is located.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.

DrawTransition() [4/10]

None eVision.ESamplePath.DrawTransition	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		eVision.EFrame	frame,
		float	zoomX,
		float	zoomY,
		float	panX )

Draws the transition symbol between the points org and end if specified or between the origin and end of the eVision.ESamplePath.SamplePath.

Parameters

graphicContext	Handle of the device context on which to draw.
frame	Frame of reference in which the path 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.

DrawTransition() [5/10]

None eVision.ESamplePath.DrawTransition	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		eVision.EFrame	frame,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draws the transition symbol between the points org and end if specified or between the origin and end of the eVision.ESamplePath.SamplePath.

Parameters

graphicContext	Handle of the device context on which to draw.
frame	Frame of reference in which the path 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.

DrawTransition() [6/10]

None eVision.ESamplePath.DrawTransition	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		eVision.EPoint	org,
		eVision.EPoint	end,
		eVision.EFrame	frame )

Draws the transition symbol between the points org and end if specified or between the origin and end of the eVision.ESamplePath.SamplePath.

Parameters

graphicContext	Handle of the device context on which to draw.
org	Origin point used to specify the drawing position.
end	End point used to specify the drawing position.
frame	Frame of reference in which the path is located.

DrawTransition() [7/10]

None eVision.ESamplePath.DrawTransition	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		eVision.EPoint	org,
		eVision.EPoint	end,
		eVision.EFrame	frame,
		float	zoomX )

Draws the transition symbol between the points org and end if specified or between the origin and end of the eVision.ESamplePath.SamplePath.

Parameters

graphicContext	Handle of the device context on which to draw.
org	Origin point used to specify the drawing position.
end	End point used to specify the drawing position.
frame	Frame of reference in which the path is located.
zoomX	Horizontal zoom factor. By default, true scale is used.

DrawTransition() [8/10]

None eVision.ESamplePath.DrawTransition	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		eVision.EPoint	org,
		eVision.EPoint	end,
		eVision.EFrame	frame,
		float	zoomX,
		float	zoomY )

Draws the transition symbol between the points org and end if specified or between the origin and end of the eVision.ESamplePath.SamplePath.

Parameters

graphicContext	Handle of the device context on which to draw.
org	Origin point used to specify the drawing position.
end	End point used to specify the drawing position.
frame	Frame of reference in which the path is located.
zoomX	Horizontal zoom factor. By default, true scale is used.
zoomY	Vertical zoom factor. By default, true scale is used.

DrawTransition() [9/10]

None eVision.ESamplePath.DrawTransition	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		eVision.EPoint	org,
		eVision.EPoint	end,
		eVision.EFrame	frame,
		float	zoomX,
		float	zoomY,
		float	panX )

Draws the transition symbol between the points org and end if specified or between the origin and end of the eVision.ESamplePath.SamplePath.

Parameters

graphicContext	Handle of the device context on which to draw.
org	Origin point used to specify the drawing position.
end	End point used to specify the drawing position.
frame	Frame of reference in which the path 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.

DrawTransition() [10/10]

None eVision.ESamplePath.DrawTransition	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		eVision.EPoint	org,
		eVision.EPoint	end,
		eVision.EFrame	frame,
		float	zoomX,
		float	zoomY,
		float	panX,
		float	panY )

Draws the transition symbol between the points org and end if specified or between the origin and end of the eVision.ESamplePath.SamplePath.

Parameters

graphicContext	Handle of the device context on which to draw.
org	Origin point used to specify the drawing position.
end	End point used to specify the drawing position.
frame	Frame of reference in which the path 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.

GetDrawingPen()

eVision.EPen eVision.ESamplePath.GetDrawingPen ( eVision.EPlotItem plotItem )

static

Gets a standard drawing pen for the specified plot item.

Parameters

plotItem

Plot item for which to get a standard pen.

GetMeasuredPeak() [1/2]

eVision.EPeak eVision.ESamplePath.GetMeasuredPeak

(

self

)

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

Remarks:

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

If you want to query more than 10 points, using eVision.ESamplePath.MeasuredPeaks should be faster.

GetMeasuredPeak() [2/2]

eVision.EPeak eVision.ESamplePath.GetMeasuredPeak	(		self,
		int	index )

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

Remarks:

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

If you want to query more than 10 points, using eVision.ESamplePath.MeasuredPeaks should be faster.

Parameters

index

Index of the edge-crossing point along the probed line segment, between 0 and eVision.ESamplePath.NumMeasuredPoints (excluded).

GetMeasuredPoint() [1/2]

eVision.EPoint eVision.ESamplePath.GetMeasuredPoint

(

self

)

Coordinates of a sample point, measured along this sample path.

Remarks:

These coordinates pertain to the World space.

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

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

GetMeasuredPoint() [2/2]

eVision.EPoint eVision.ESamplePath.GetMeasuredPoint	(		self,
		int	index )

Coordinates of a sample point, measured along this sample path.

Remarks:

These coordinates pertain to the World space.

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

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

Parameters

index

Index of the edge-crossing point along the probed line segment, between 0 and eVision.ESamplePath.NumMeasuredPoints (excluded).

IsEqual()

bool eVision.ESamplePath.IsEqual	(		self,
		eVision.ESamplePath	other )

Compares this object with the other object.

Note that the class only compares its parameters and not the computations dependent variables.

Parameters

other

Other eVision.ESamplePath object.

Measure() [1/4]

None eVision.ESamplePath.Measure	(		self,
		eVision.EROIBW8	pSrc )

Measure the peaks in the image, potentially applying normalization.

Parameters

pSrc

Image.

Measure() [2/4]

None eVision.ESamplePath.Measure	(		self,
		eVision.EROIBW8	pSrc,
		eVision.EFrame	frame )

Measure the peaks in the image, potentially applying normalization.

Parameters

pSrc	Image.
frame	Frame of reference in which the path is located.

Measure() [3/4]

None eVision.ESamplePath.Measure	(		self,
		eVision.EROIBW8	pSrc,
		eVision.ERegion	region )

Measure the peaks in the image, potentially applying normalization.

Parameters

pSrc	Image.
region	eVision.ERegion associated with the image.

Measure() [4/4]

None eVision.ESamplePath.Measure	(		self,
		eVision.EROIBW8	pSrc,
		eVision.ERegion	region,
		eVision.EFrame	frame )

Measure the peaks in the image, potentially applying normalization.

Parameters

pSrc	Image.
region	eVision.ERegion associated with the image.
frame	Frame of reference in which the path is located.

Plot() [1/3]

None eVision.ESamplePath.Plot	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		eVision.EPlotItem	plotItems,
		eVision.EPlotDecorationOptions	opts,
		float	width,
		float	height )

Draws the profile of the sample paths of the gauge, as defined by eVision.EPlotItem.

Remarks:

The data will be plotted with the current pen of the eVision.EDrawAdapter. If there is no pen set, then the following color will be used:

• Red for eVision.EPlotItem.Transitions
• Blue for eVision.EPlotItem.Peak
• Blue for eVision.EPlotItem.Thresholds
• Green for eVision.EPlotItem.Points
• Red for any combinations of eVision.EPlotItem

Parameters

graphicContext	Handle of the device context on which to draw.
plotItems	Boolean combination of eVision.EPlotItem members, that indicates which items must be displayed.
opts	Options to control the drawing of the plot decorations (axes, ticks, etc.).
width	Width of the plot.
height	Height of the plot.

Plot() [2/3]

None eVision.ESamplePath.Plot	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		eVision.EPlotItem	plotItems,
		eVision.EPlotDecorationOptions	opts,
		float	width,
		float	height,
		float	originX )

Draws the profile of the sample paths of the gauge, as defined by eVision.EPlotItem.

Remarks:

The data will be plotted with the current pen of the eVision.EDrawAdapter. If there is no pen set, then the following color will be used:

• Red for eVision.EPlotItem.Transitions
• Blue for eVision.EPlotItem.Peak
• Blue for eVision.EPlotItem.Thresholds
• Green for eVision.EPlotItem.Points
• Red for any combinations of eVision.EPlotItem

Parameters

graphicContext	Handle of the device context on which to draw.
plotItems	Boolean combination of eVision.EPlotItem members, that indicates which items must be displayed.
opts	Options to control the drawing of the plot decorations (axes, ticks, etc.).
width	Width of the plot.
height	Height of the plot.
originX	Origin point coordinates of the plot along the X axis.

Plot() [3/3]

None eVision.ESamplePath.Plot	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		eVision.EPlotItem	plotItems,
		eVision.EPlotDecorationOptions	opts,
		float	width,
		float	height,
		float	originX,
		float	originY )

Draws the profile of the sample paths of the gauge, as defined by eVision.EPlotItem.

Remarks:

The data will be plotted with the current pen of the eVision.EDrawAdapter. If there is no pen set, then the following color will be used:

• Red for eVision.EPlotItem.Transitions
• Blue for eVision.EPlotItem.Peak
• Blue for eVision.EPlotItem.Thresholds
• Green for eVision.EPlotItem.Points
• Red for any combinations of eVision.EPlotItem

Parameters

graphicContext	Handle of the device context on which to draw.
plotItems	Boolean combination of eVision.EPlotItem members, that indicates which items must be displayed.
opts	Options to control the drawing of the plot decorations (axes, ticks, etc.).
width	Width of the plot.
height	Height of the plot.
originX	Origin point coordinates of the plot along the X axis.
originY	Origin point coordinates of the plot along the Y axis.

Property Documentation

Angle

eVision.ESamplePath.Angle = property(_Angle__getter, _Angle__setter)

static

Angle of the path along which we measure.

Center

eVision.ESamplePath.Center = property(_Center__getter, _Center__setter)

static

Center of the sample path.

DefaultPointIndex

eVision.ESamplePath.DefaultPointIndex = property(_DefaultPointIndex__getter, None)

static

The default edge-crossing point measured, chosen according to the transition choice parameter.

HVConstraint

eVision.ESamplePath.HVConstraint = property(_HVConstraint__getter, _HVConstraint__setter)

static

Status of the restriction on the orientation of the sample path.

Length

eVision.ESamplePath.Length = property(_Length__getter, _Length__setter)

static

Length of the path along which measure.

MeasuredPeaks

eVision.ESamplePath.MeasuredPeaks = property(_MeasuredPeaks__getter, None)

static

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

Remarks:

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

MeasuredPoints

eVision.ESamplePath.MeasuredPoints = property(_MeasuredPoints__getter, None)

static

Coordinates of all edge-crossing points, measured along the sample path of a gauge.

Remarks:

These coordinates pertain to the World space.

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

MinAmplitude

eVision.ESamplePath.MinAmplitude = property(_MinAmplitude__getter, _MinAmplitude__setter)

static

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

MinArea

eVision.ESamplePath.MinArea = property(_MinArea__getter, _MinArea__setter)

static

Minimum area value.

Remarks:

A transition is detected if its derivative peak reaches Threshold + MinAmplitude value, and then declared valid if the area between the peak curve and the horizontal at level Threshold reaches the MinArea value.

NumMeasuredPoints

eVision.ESamplePath.NumMeasuredPoints = property(_NumMeasuredPoints__getter, None)

static

Number of edge-crossing points along the sample path.

SamplePath

eVision.ESamplePath.SamplePath = property(_SamplePath__getter, _SamplePath__setter)

static

Line along which the edge-crossing points are measured.

Smoothing

eVision.ESamplePath.Smoothing = property(_Smoothing__getter, _Smoothing__setter)

static

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

Remarks:

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

Thickness

eVision.ESamplePath.Thickness = property(_Thickness__getter, _Thickness__setter)

static

Number of parallel segments used to extract the data profile.

Remarks:

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

Threshold

eVision.ESamplePath.Threshold = property(_Threshold__getter, _Threshold__setter)

static

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

Tolerance

eVision.ESamplePath.Tolerance = property(_Tolerance__getter, _Tolerance__setter)

static

Tolerance (half-length of the path).

ToleranceAngle

eVision.ESamplePath.ToleranceAngle = property(_ToleranceAngle__getter, _ToleranceAngle__setter)

static

Alias for eVision.ESamplePath.Angle.

TransitionChoice

eVision.ESamplePath.TransitionChoice = property(_TransitionChoice__getter, _TransitionChoice__setter)

static

Transition choice used to select the sample point corresponding to eVision.ESamplePath.TransitionIndex.

TransitionIndex

eVision.ESamplePath.TransitionIndex = property(_TransitionIndex__getter, _TransitionIndex__setter)

static

The sample point to select as default.

TransitionRectangularSamplingArea

eVision.ESamplePath.TransitionRectangularSamplingArea = property(_TransitionRectangularSamplingArea__getter, _TransitionRectangularSamplingArea__setter)

static

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

TransitionType

eVision.ESamplePath.TransitionType = property(_TransitionType__getter, _TransitionType__setter)

static

Transition type to measure.

Valid

eVision.ESamplePath.Valid = property(_Valid__getter, None)

static

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