eVision .NET API
Loading...
Searching...
No Matches
eVision.EPolygonGauge Class Reference

Polygon gauge. More...

Inheritance diagram for eVision.EPolygonGauge:
Collaboration diagram for eVision.EPolygonGauge:

Public Member Functions

 EPolygonGauge ()
 Constructs a EPolygonGauge.
 EPolygonGauge (eVision.EPolygonGauge other)
 Copy constructor.
void CopyTo (eVision.EPolygonGauge dest)
 Copies all the data of the current EPolygonGauge object into another EPolygonGauge object.
uint GetNumSamples (int edgeIndex)
 Number of sample path of the specified edge of the nominal polygon.
new eVision.EPolygon Measure (eVision.EROIBW8 sourceImage, eVision.EFrame frame)
 Performs the gauge measurement.
new eVision.EPolygon Measure (eVision.EROIBW8 sourceImage)
 Performs the gauge measurement.
new eVision.EPolygon Measure (eVision.EROIBW8 sourceImage, eVision.ERegion region, eVision.EFrame frame)
 Performs the gauge measurement.
new eVision.EPolygon Measure (eVision.EROIBW8 sourceImage, eVision.ERegion region)
 Performs the gauge measurement.
Public Member Functions inherited from eVision.EBaseGauge
void Draw (eVision.EDrawAdapter graphicContext, eVision.EDrawingMode drawingMode, float zoomX, float zoomY, float panX, float panY)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EDrawingMode drawingMode, float zoomX, float zoomY, float panX)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EDrawingMode drawingMode, float zoomX, float zoomY)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EDrawingMode drawingMode, float zoomX)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EDrawingMode drawingMode)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
void Draw (eVision.EDrawAdapter 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 EDrawingMode.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EDrawingMode drawingMode, eVision.EFrame frame, float zoomX, float zoomY, float panX)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EDrawingMode drawingMode, eVision.EFrame frame, float zoomX, float zoomY)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EDrawingMode drawingMode, eVision.EFrame frame, float zoomX)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EDrawingMode drawingMode, eVision.EFrame frame)
 Draws a graphical representation of a shape, as defined by EDrawingMode.
eVision.EEditionMode HitTest (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 (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 (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 (int x, int y, float zoomX)
 Checks if there is a handle under the cursor and returns the corresponding edition mode.
eVision.EEditionMode HitTest (int x, int y)
 Checks if there is a handle under the cursor and returns the corresponding edition mode.
eVision.EEditionMode HitTest (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 (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 (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 (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 (int x, int y, eVision.EFrame frame)
 Checks if there is a handle under the cursor and returns the corresponding edition mode.
void Drag (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.
void Drag (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.
void Drag (int x, int y, float zoomX, float zoomY)
 Moves a handle to a new position and updates the position parameters of the shape.
void Drag (int x, int y, float zoomX)
 Moves a handle to a new position and updates the position parameters of the shape.
void Drag (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.
void Drag (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.
void Drag (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.
void Drag (int x, int y, eVision.EFrame frame, float zoomX)
 Moves a handle to a new position and updates the position parameters of the shape.
void Save (string path)
 Saves a gauge.The given ESerializer must have been created for writing.
void Save (eVision.ESerializer serializer)
 Saves a gauge.The given ESerializer must have been created for writing.
void Load (string path)
 Loads a gauge.The given ESerializer must have been created for reading.
void Load (eVision.ESerializer serializer)
 Loads a gauge.The given ESerializer must have been created for reading.
bool HasProperty (string aProperty)
 Returns whether a EBaseGauge has a property named aProperty.
string GetProperty (string aProperty)
 Gets the value of property aProperty. Throws an exception if no such property exists.
void SetProperty (string aProperty, string aValue)
 Sets the value of property aProperty to aValue for this EBaseGauge.
void RemoveProperty (string aProperty)
 Removes the property name aProperty from the EBaseGauge.
bool HasValidPolarityProperty ()
 Returns whether the EBaseGauge has a valid polarity property.
eVision.ESamplePoint GetSample (uint index)
 Retrieves sampled points used during the model fitting operation.
bool HasSamples ()
 Whether the samples are available or not.
uint AddSkipRange (eVision.EIntegerRange range)
 Adds an item to the set of skip ranges and returns the index of the newly added range.
eVision.EIntegerRange GetSkipRange (uint 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 EBaseGauge.AddSkipRange method).
void RemoveSkipRange (uint index)
 After a call to EBaseGauge.AddSkipRange, removes the skip range with the given index.
void RemoveAllSkipRanges ()
 Removes all the skip ranges previously created by a call to EBaseGauge.AddSkipRange.
eVision.EShape Measure (eVision.EROIBW8 sourceImage, eVision.EFrame frame)
 Performs the gauge measurement.
eVision.EShape Measure (eVision.EROIBW8 sourceImage)
 Performs the gauge measurement.
eVision.EShape Measure (eVision.EROIBW8 sourceImage, eVision.ERegion region, eVision.EFrame frame)
 Performs the gauge measurement.
eVision.EShape Measure (eVision.EROIBW8 sourceImage, eVision.ERegion region)
 Performs the gauge measurement.
void MeasureWithoutFitting (eVision.EROIBW8 sourceImage, eVision.EFrame frame)
 Triggers the point location without line fitting operation.
void MeasureWithoutFitting (eVision.EROIBW8 sourceImage)
 Triggers the point location without line fitting operation.
void MeasureWithoutFitting (eVision.EROIBW8 sourceImage, eVision.ERegion region, eVision.EFrame frame)
 Triggers the point location without line fitting operation.
void MeasureWithoutFitting (eVision.EROIBW8 sourceImage, eVision.ERegion region)
 Triggers the point location without line fitting operation.
bool IsFound ()
 Flag indicating whether a measured shape has been found.
virtual eVision.ESamplePath MeasureSamplePath (eVision.EROIBW8 sourceImage, uint pathIndex, eVision.EFrame frame)
 Measures the specified sample path.
virtual eVision.ESamplePath MeasureSamplePath (eVision.EROIBW8 sourceImage, uint pathIndex)
 Measures the specified sample path.
virtual eVision.ESamplePath MeasureSamplePath (eVision.EROIBW8 sourceImage, uint pathIndex, eVision.ERegion region, eVision.EFrame frame)
 Measures the specified sample path.
virtual eVision.ESamplePath MeasureSamplePath (eVision.EROIBW8 sourceImage, uint pathIndex, eVision.ERegion region)
 Measures the specified sample path.

Properties

override eVision.EShapeType Type [get]
 Shape type.
override eVision.EShape Nominal [get, set]
 Nominal shape of the gauge.
override eVision.EEditionMode AvailableEditionModes [get]
 Returns all possible edition modes of the gauge.
override float Tolerance [get, set]
 Half thickness of the model fitting gauge.
override bool HVConstraint [get, set]
 Status of the restriction on the orientation of the point location gauge or model fitting sample paths.
override eVision.ETransitionType TransitionType [get, set]
 Transition type.
override eVision.ETransitionChoice TransitionChoice [get, set]
 Transition choice.
override uint TransitionIndex [get, set]
 Index (from 0 on) of the transition to be retained when the transition choice parameter is set to ETransitionChoice.ETransitionChoice_NthFromBegin or ETransitionChoice.ETransitionChoice_NthFromEnd.
override uint Threshold [get, set]
 Threshold level used to delimit significant peaks in the data profile.
override uint MinAmplitude [get, set]
 Offset added to the Threshold when a peak is to be detected.
override uint MinArea [get, set]
 Minimum area value.
override uint Thickness [get, set]
 Number of parallel segments used to extract the data profile.
override uint Smoothing [get, set]
 Number of pixels used for the low-pass filtering operation.
override bool RectangularSamplingArea [get, set]
 Flag indicating whether the sampling area remains a rectangle when rotated, instead of becoming a parallelogram.
override uint NumSamples [get]
 Number of sampled points during the model fitting operation.
override eVision.EShape Measured [get]
 Copy of the measured shape.
new uint MinNumFitSamples [get, set]
 Gets the minimum number of samples required for fitting the shape.
eVision.EPolygon Polygon [get, set]
 Nominal polygon according to a known EPolygon object.
eVision.EPolygonMeasurementMode MeasurementMode [get, set]
 The polygon gauge measurement mode, in EPolygonMeasurementMode. The default mode is EPolygonMeasurementMode.EPolygonMeasurementMode_Global.
bool EnableScaling [get, set]
 When using the EPolygonMeasurementMode.EPolygonMeasurementMode_Global mode, if EPolygonGauge.EnableScaling is enabled then the best scale is evaluated.
eVision.EPolygon MeasuredPolygon [get]
 Returns the measured polygon (if found) or the nominal polygon otherwise.
float MeasuredScale [get]
 Scale of the EPolygonGauge.MeasuredPolygonTransformation (only available when the EPolygonGauge.MeasurementMode is EPolygonMeasurementMode.EPolygonMeasurementMode_Global).
eVision.EPoint MeasuredOffset [get]
 Offset of the EPolygonGauge.MeasuredPolygonTransformation (only available when the EPolygonGauge.MeasurementMode is EPolygonMeasurementMode.EPolygonMeasurementMode_Global).
float MeasuredAngle [get]
 Angle of the EPolygonGauge.MeasuredPolygonTransformation (only available when the EPolygonGauge.MeasurementMode is EPolygonMeasurementMode.EPolygonMeasurementMode_Global).
eVision.EFrame MeasuredPolygonTransformation [get]
 The transformation applied to the nominal polygon to get the measured polygon (only available when the EPolygonGauge.MeasurementMode is EPolygonMeasurementMode.EPolygonMeasurementMode_Global).
Properties inherited from eVision.EBaseGauge
eVision.EShapeType Type [get]
 Shape type.
string Name [get, set]
 Name of the EBaseGauge object.
eVision.EShape Nominal [get, set]
 Nominal shape of the gauge.
eVision.EEditionMode EditionMode [get, set]
 Graphical edition mode (default: EBaseGauge.AvailableEditionModes).
virtual eVision.EEditionMode AvailableEditionModes [get]
 Returns all possible edition modes of the gauge.
bool Labeled [get, set]
 Whether to draw a label describing the gauge (default: no).
float Tolerance [get, set]
 Half thickness of the model fitting gauge.
bool HVConstraint [get, set]
 Status of the restriction on the orientation of the point location gauge or model fitting sample paths.
eVision.ETransitionType TransitionType [get, set]
 Transition type.
eVision.ETransitionChoice TransitionChoice [get, set]
 Transition choice.
uint TransitionIndex [get, set]
 Index (from 0 on) of the transition to be retained when the transition choice parameter is set to ETransitionChoice.ETransitionChoice_NthFromBegin or ETransitionChoice.ETransitionChoice_NthFromEnd.
uint Threshold [get, set]
 Threshold level used to delimit significant peaks in the data profile.
uint MinAmplitude [get, set]
 Offset added to the Threshold when a peak is to be detected.
uint MinArea [get, set]
 Minimum area value.
uint Thickness [get, set]
 Number of parallel segments used to extract the data profile.
uint Smoothing [get, set]
 Number of pixels used for the low-pass filtering operation.
bool RectangularSamplingArea [get, set]
 Flag indicating whether the sampling area remains a rectangle when rotated, instead of becoming a parallelogram.
float SamplingStep [get, set]
 Approximate distance between sampled points during a model fitting operation.
uint NumSamples [get]
 Number of sampled points during the model fitting operation.
float FilteringThreshold [get, set]
 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.
uint NumFilteringPasses [get, set]
 Number of filtering passes for a model fitting operation.
uint NumValidSamples [get]
 Number of valid sample points remaining after a model fitting operation.
uint SamplePointIndex [get, set]
 Sampled.
float AverageDistance [get]
 Average distance between the sampled points and the fitted model.
int[] MinNumFitSamples [get, set]
 Sets/Gets the minimum number of samples required for fitting the shape.
uint NumSkipRanges [get]
 Number of skip ranges in the gauge after a call to EBaseGauge.AddSkipRange.
eVision.EShape Measured [get]
 Copy of the measured shape.

Additional Inherited Members

Static Public Member Functions inherited from eVision.EBaseGauge
static eVision.EBaseGauge Make (string path)
 Creates a gauge of the correct type.

Detailed Description

Polygon gauge.

License(s): EasyGauge

Constructor & Destructor Documentation

◆ EPolygonGauge() [1/2]

eVision.EPolygonGauge.EPolygonGauge ( )

Constructs a EPolygonGauge.

◆ EPolygonGauge() [2/2]

eVision.EPolygonGauge.EPolygonGauge ( eVision.EPolygonGauge other)

Copy constructor.

Parameters
otherOther EPolygonGauge

Member Function Documentation

◆ CopyTo()

void eVision.EPolygonGauge.CopyTo ( eVision.EPolygonGauge dest)

Copies all the data of the current EPolygonGauge object into another EPolygonGauge object.

Parameters
destEPolygonGauge object in which the current EPolygonGauge object data have to be copied.

◆ GetNumSamples()

uint eVision.EPolygonGauge.GetNumSamples ( int edgeIndex)

Number of sample path of the specified edge of the nominal polygon.

Parameters
edgeIndexEdge index.

◆ Measure() [1/4]

new eVision.EPolygon eVision.EPolygonGauge.Measure ( eVision.EROIBW8 sourceImage)

Performs the gauge measurement.

Parameters
sourceImageSource image.

◆ Measure() [2/4]

new eVision.EPolygon eVision.EPolygonGauge.Measure ( eVision.EROIBW8 sourceImage,
eVision.EFrame frame )

Performs the gauge measurement.

Parameters
sourceImageSource image.
frameFrame of reference

◆ Measure() [3/4]

new eVision.EPolygon eVision.EPolygonGauge.Measure ( eVision.EROIBW8 sourceImage,
eVision.ERegion region )

Performs the gauge measurement.

Parameters
sourceImageSource image.
regionRegion to use with the source image.

◆ Measure() [4/4]

new eVision.EPolygon eVision.EPolygonGauge.Measure ( eVision.EROIBW8 sourceImage,
eVision.ERegion region,
eVision.EFrame frame )

Performs the gauge measurement.

Parameters
sourceImageSource image.
regionRegion to use with the source image.
frameFrame of reference

Property Documentation

◆ AvailableEditionModes

override eVision.EEditionMode eVision.EPolygonGauge.AvailableEditionModes
get

Returns all possible edition modes of the gauge.

◆ EnableScaling

bool eVision.EPolygonGauge.EnableScaling
getset

When using the EPolygonMeasurementMode.EPolygonMeasurementMode_Global mode, if EPolygonGauge.EnableScaling is enabled then the best scale is evaluated.

◆ HVConstraint

override bool eVision.EPolygonGauge.HVConstraint
getset

Status of the restriction on the orientation of the point location gauge or model fitting sample paths.

Sample paths are the point location gauges placed along the model to be fitted.

◆ Measured

override eVision.EShape eVision.EPolygonGauge.Measured
get

Copy of the measured shape.

◆ MeasuredAngle

float eVision.EPolygonGauge.MeasuredAngle
get

◆ MeasuredOffset

◆ MeasuredPolygon

eVision.EPolygon eVision.EPolygonGauge.MeasuredPolygon
get

Returns the measured polygon (if found) or the nominal polygon otherwise.

Use method EBaseGauge.IsFound to get the status of the measurement. EPolygonGauge.MeasuredPolygon returns a successful fitted polygon if EBaseGauge.IsFound is true, otherwise it returns the original (nominal) polygon.

◆ MeasuredPolygonTransformation

eVision.EFrame eVision.EPolygonGauge.MeasuredPolygonTransformation
get

The transformation applied to the nominal polygon to get the measured polygon (only available when the EPolygonGauge.MeasurementMode is EPolygonMeasurementMode.EPolygonMeasurementMode_Global).

◆ MeasuredScale

float eVision.EPolygonGauge.MeasuredScale
get

◆ MeasurementMode

eVision.EPolygonMeasurementMode eVision.EPolygonGauge.MeasurementMode
getset

The polygon gauge measurement mode, in EPolygonMeasurementMode. The default mode is EPolygonMeasurementMode.EPolygonMeasurementMode_Global.

◆ MinAmplitude

override uint eVision.EPolygonGauge.MinAmplitude
getset

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

When analyzing a derivative profile, a peak is made up of consecutive pixel values above Threshold. To detect weak [strong] transitions, lower [raise] the Threshold value.

To avoid interference of noise, an additional parameter is provided. The MinAmplitude parameter is an offset added to Threshold when a peak is to be detected.

When the pixel values of the derivative profile do not reach Threshold + MinAmplitude, the peak is not taken into account. Anyway, when a peak is taken into account, all the pixels with values above Threshold are considered (for more accuracy). Setting the MinAmplitude value to 0 merely cancels its effect.

◆ MinArea

override uint eVision.EPolygonGauge.MinArea
getset

Minimum area value.

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

◆ MinNumFitSamples

new uint eVision.EPolygonGauge.MinNumFitSamples
getset

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

◆ Nominal

override eVision.EShape eVision.EPolygonGauge.Nominal
getset

Nominal shape of the gauge.

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

◆ NumSamples

override uint eVision.EPolygonGauge.NumSamples
get

Number of sampled points during the model fitting operation.

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

◆ Polygon

eVision.EPolygon eVision.EPolygonGauge.Polygon
getset

Nominal polygon according to a known EPolygon object.

◆ RectangularSamplingArea

override bool eVision.EPolygonGauge.RectangularSamplingArea
getset

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

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.

◆ Smoothing

override uint eVision.EPolygonGauge.Smoothing
getset

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

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

◆ Thickness

override uint eVision.EPolygonGauge.Thickness
getset

Number of parallel segments used to extract the data profile.

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

◆ Threshold

override uint eVision.EPolygonGauge.Threshold
getset

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

When analyzing a derivative profile, a peak is made up of consecutive pixel values above Threshold. To detect weak [strong] transitions, lower [raise] the Threshold value.

To avoid interference of noise, an additional parameter is provided. The MinAmplitude parameter is an offset added to Threshold when a peak is to be detected.

When the pixel values of the derivative profile do not reach Threshold + MinAmplitude, the peak is not taken into account. Anyway, when a peak is taken into account, all the pixels with values above Threshold are considered (for more accuracy). Setting the MinAmplitude value to 0 merely cancels its effect.

◆ Tolerance

override float eVision.EPolygonGauge.Tolerance
getset

Half thickness of the model fitting gauge.

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.

◆ TransitionChoice

override eVision.ETransitionChoice eVision.EPolygonGauge.TransitionChoice
getset

Transition choice.

Several peaks may be detected along a point location gauge. This parameter helps to select the desired transition.

In case of ETransitionChoice.ETransitionChoice_NthFromBegin or ETransitionChoice.ETransitionChoice_NthFromEnd transition choice, set EBaseGauge.TransitionIndex to specify the desired transition.

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

◆ TransitionIndex

override uint eVision.EPolygonGauge.TransitionIndex
getset

Index (from 0 on) of the transition to be retained when the transition choice parameter is set to ETransitionChoice.ETransitionChoice_NthFromBegin or ETransitionChoice.ETransitionChoice_NthFromEnd.

Several peaks may be detected along a point location gauge. This parameter helps to select the desired transition.

By default, the first transition is retained (the index value is 0).

◆ TransitionType

override eVision.ETransitionType eVision.EPolygonGauge.TransitionType
getset

Transition type.

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 (ETransitionType.ETransitionType_BwOrWb).

◆ Type

override eVision.EShapeType eVision.EPolygonGauge.Type
get

Shape type.