CogBeadInspectResult.GetCaliperLeftEdge Method

CogBeadInspectResult GetCaliperLeftEdge Method

Cognex VisionPro 9.23

Provides a description of the edge found on the left side of the bead path by the caliper at the given index.

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

Syntax

C++

Copy to Clipboard Print

public void GetCaliperLeftEdge(
	int index,
	out bool found,
	out bool filled,
	out double edgePosX,
	out double edgePosY,
	out double contrast
)

public void GetCaliperLeftEdge(
	int index,
	out bool found,
	out bool filled,
	out double edgePosX,
	out double edgePosY,
	out double contrast
)

Public Sub GetCaliperLeftEdge ( 
	index As Integer,
	<OutAttribute> ByRef found As Boolean,
	<OutAttribute> ByRef filled As Boolean,
	<OutAttribute> ByRef edgePosX As Double,
	<OutAttribute> ByRef edgePosY As Double,
	<OutAttribute> ByRef contrast As Double
)

Public Sub GetCaliperLeftEdge ( 
	index As Integer,
	<OutAttribute> ByRef found As Boolean,
	<OutAttribute> ByRef filled As Boolean,
	<OutAttribute> ByRef edgePosX As Double,
	<OutAttribute> ByRef edgePosY As Double,
	<OutAttribute> ByRef contrast As Double
)

public:
void GetCaliperLeftEdge(
	int index, 
	[OutAttribute] bool% found, 
	[OutAttribute] bool% filled, 
	[OutAttribute] double% edgePosX, 
	[OutAttribute] double% edgePosY, 
	[OutAttribute] double% contrast
)

public:
void GetCaliperLeftEdge(
	int index, 
	[OutAttribute] bool% found, 
	[OutAttribute] bool% filled, 
	[OutAttribute] double% edgePosX, 
	[OutAttribute] double% edgePosY, 
	[OutAttribute] double% contrast
)

Parameters

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

found: Type: System Boolean
This Boolean output will be false if the caliper could not find a left edge and was not configured to create a left fill edge. It will be true if an edge was detected, or was created as a fill edge.

filled

Type: System Boolean
This Boolean output will be true if the left edge was artificially created as a fill edge. This can only happen if:

this caliper cannot find a left edge in the image, and
this caliper is configured to create a left fill edge (by setting a true value for its index in the LeftFillList).

edgePosX: Type: System Double
This output is the X coordinate of the edge, if found. Otherwise, zero. A non-zero edge position always lies along the centerline of the caliper.

edgePosY: Type: System Double
This output is the Y coordinate of the edge, if found. Otherwise, zero. A non-zero edge position always lies along the centerline of the caliper.

contrast: Type: System Double
This output is the contrast of the edge, if found. Otherwise, zero.

Exceptions

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

Remarks

The left and right edges of the bead are defined relative to the direction of the bead path. If you imagine that you are travelling along the path, from its start to its end, the left edge will be on your left-hand side. The right edge will be on your right-hand side.

If an edge of the bead is missing, GetCaliperLeftEdge(Int32, Boolean , Boolean , Double , Double , Double ) and/or GetCaliperRightEdge(Int32, Boolean , Boolean , Double , Double , Double ) will report as outputs:

Position as zero for the missing edge.
Contrast as zero for the missing edge.

If an edge of the bead is missing, but is filled at run-time, GetCaliperLeftEdge(Int32, Boolean , Boolean , Double , Double , Double ) and/or GetCaliperRightEdge(Int32, Boolean , Boolean , Double , Double , Double ) will report as outputs:

Position of the filled edge: This position is interpolated from the edges found by nearby calipers.
Contrast as zero for the filled edge.