CogMath.DistancePointLine Method

CogMath DistancePointLine Method

Cognex VisionPro 9.8

Returns the shortest distance from the given point to the given line. Also provides the closest point on the line.

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

Syntax

public static double DistancePointLine(
	double x,
	double y,
	CogLine line,
	ICogImage image,
	out double lineX,
	out double lineY
)

public static double DistancePointLine(
	double x,
	double y,
	CogLine line,
	ICogImage image,
	out double lineX,
	out double lineY
)

Public Shared Function DistancePointLine ( 
	x As Double,
	y As Double,
	line As CogLine,
	image As ICogImage,
	<OutAttribute> ByRef lineX As Double,
	<OutAttribute> ByRef lineY As Double
) As Double

Public Shared Function DistancePointLine ( 
	x As Double,
	y As Double,
	line As CogLine,
	image As ICogImage,
	<OutAttribute> ByRef lineX As Double,
	<OutAttribute> ByRef lineY As Double
) As Double

public:
static double DistancePointLine(
	double x, 
	double y, 
	CogLine^ line, 
	ICogImage^ image, 
	[OutAttribute] double% lineX, 
	[OutAttribute] double% lineY
)

public:
static double DistancePointLine(
	double x, 
	double y, 
	CogLine^ line, 
	ICogImage^ image, 
	[OutAttribute] double% lineX, 
	[OutAttribute] double% lineY
)

Parameters

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

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

line: Type: Cognex.VisionPro CogLine
The line.

image: Type: Cognex.VisionPro ICogImage
An image that specifies the coordinate space to use.

lineX: Type: System Double
The x-coordinate of the nearest point on the line. If the point is on the line, this value is the same as x.

lineY: Type: System Double
The y-coordinate of the nearest point on the line. If the point is on the line, this value is the same as y.

Return Value

Type: Double

The shortest distance from the point (x,y) to the line. If the point is on the line, the distance is zero.

Exceptions

Exception	Condition
ArgumentException	line is NULL.
CogSpaceTreeInvalidNameSyntaxException	At least one shape's selected space names is not a legal space name.
CogSpaceTreeNotUniqueException	At least one shape's selected space names is a nonqualified space name and more than one instance of it exists in image's coordinate space tree.
CogSpaceTreeNotInTreeException	At least one shape does not exist in image's coordinate space tree.
CogImageNoTreeException	The coordinate space tree is missing from image.

Remarks

Returns the shortest distance from the given point to the given line and optionally the closest point on the line.

If you supply a value for the image parameter, then line is mapped to the selected space of image before the measurement is computed and the result is expressed in that space. x and y are presumed to be expressed in the selected space of image.

If you do not supply a value for image, then line, x, and y are presumed to be in the same coordinate space.