CogBeadInspectResult.GetCaliperBeadWidth Method

CogBeadInspectResult GetCaliperBeadWidth Method

Cognex VisionPro 9.21

Returns the width ratio measured by the caliper at the given index. The width ratio is computed by dividing the width measured at runtime by the width measured at train-time.

Namespace: Cognex.VisionPro.EdgeInspect
Assembly: Cognex.VisionPro.EdgeInspect (in Cognex.VisionPro.EdgeInspect.dll) Version: 83.0.0.0

Syntax

C++

Copy to Clipboard Print

public double GetCaliperBeadWidth(
	int index
)

public double GetCaliperBeadWidth(
	int index
)

Public Function GetCaliperBeadWidth ( 
	index As Integer
) As Double

Public Function GetCaliperBeadWidth ( 
	index As Integer
) As Double

public:
double GetCaliperBeadWidth(
	int index
)

public:
double GetCaliperBeadWidth(
	int index
)

Parameters

index: Type: System Int32
The index of the caliper along the bead path.

Return Value

Type: Double
The width ratio measured by the indexed caliper.

Exceptions

Exception	Condition
IndexOutOfRangeException	The given index is less than zero. Or it is equal to, or greater than, NumCalipers

Remarks

If the user disables both WidthMinEnabled and WidthMaxEnabled, the bead width will not be measured at run-time and GetCaliperBeadWidth(Int32), WidthMin, WidthMax, and WidthAvg will all be reported as zero.

If either edge of the bead is missing and not filled, GetCaliperBeadWidth(Int32) will be reported as zero for the calipers with a missing edge. If the missing edge is filled at run-time, the width is calculated and reported conventionally.