CogFitLineResult.GetXYUsedDistance Method

CogFitLineResult GetXYUsedDistance Method

Cognex VisionPro

Returns X and Y for the given point, whether it was used, and the distance to the fitted Line.

Namespace: Cognex.VisionPro
Assembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 65.1.0.0

Syntax

public void GetXYUsedDistance(
	int index,
	out double x,
	out double y,
	out bool used,
	out double distance
)

public void GetXYUsedDistance(
	int index,
	out double x,
	out double y,
	out bool used,
	out double distance
)

Public Sub GetXYUsedDistance ( 
	index As Integer,
	<OutAttribute> ByRef x As Double,
	<OutAttribute> ByRef y As Double,
	<OutAttribute> ByRef used As Boolean,
	<OutAttribute> ByRef distance As Double
)

Public Sub GetXYUsedDistance ( 
	index As Integer,
	<OutAttribute> ByRef x As Double,
	<OutAttribute> ByRef y As Double,
	<OutAttribute> ByRef used As Boolean,
	<OutAttribute> ByRef distance As Double
)

public:
void GetXYUsedDistance(
	int index, 
	[OutAttribute] double% x, 
	[OutAttribute] double% y, 
	[OutAttribute] bool% used, 
	[OutAttribute] double% distance
)

public:
void GetXYUsedDistance(
	int index, 
	[OutAttribute] double% x, 
	[OutAttribute] double% y, 
	[OutAttribute] bool% used, 
	[OutAttribute] double% distance
)

Parameters

index: Type: System Int32
The index of the point.

x: Type: System Double
The x-coordinate of the point.

y: Type: System Double
The y-coordinate of the point.

used: Type: System Boolean
True if the point was used in the fit, false otherwise.

distance: Type: System Double
The distance from the point to the fitted shape.

Exceptions

Exception	Condition
ArgumentException	index is less than 0 or greater than or equal to NumPoints.

Remarks

Returns the location of the given point, whether it was used in the fit, and the distance to the fitted CogLine.