CogMath.DistanceSegmentCircle Method

CogMath DistanceSegmentCircle Method

Cognex VisionPro

Returns the shortest distance from the given line segment to the given circle. Also provides the points on each shape that correspond to this shortest distance.

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

Syntax

C++

Copy to Clipboard Print

public static double DistanceSegmentCircle(
	CogLineSegment segment,
	CogCircle circle,
	ICogImage image,
	out double segmentX,
	out double segmentY,
	out double circleX,
	out double circleY
)

public static double DistanceSegmentCircle(
	CogLineSegment segment,
	CogCircle circle,
	ICogImage image,
	out double segmentX,
	out double segmentY,
	out double circleX,
	out double circleY
)

Public Shared Function DistanceSegmentCircle ( 
	segment As CogLineSegment,
	circle As CogCircle,
	image As ICogImage,
	<OutAttribute> ByRef segmentX As Double,
	<OutAttribute> ByRef segmentY As Double,
	<OutAttribute> ByRef circleX As Double,
	<OutAttribute> ByRef circleY As Double
) As Double

Public Shared Function DistanceSegmentCircle ( 
	segment As CogLineSegment,
	circle As CogCircle,
	image As ICogImage,
	<OutAttribute> ByRef segmentX As Double,
	<OutAttribute> ByRef segmentY As Double,
	<OutAttribute> ByRef circleX As Double,
	<OutAttribute> ByRef circleY As Double
) As Double

public:
static double DistanceSegmentCircle(
	CogLineSegment^ segment, 
	CogCircle^ circle, 
	ICogImage^ image, 
	[OutAttribute] double% segmentX, 
	[OutAttribute] double% segmentY, 
	[OutAttribute] double% circleX, 
	[OutAttribute] double% circleY
)

public:
static double DistanceSegmentCircle(
	CogLineSegment^ segment, 
	CogCircle^ circle, 
	ICogImage^ image, 
	[OutAttribute] double% segmentX, 
	[OutAttribute] double% segmentY, 
	[OutAttribute] double% circleX, 
	[OutAttribute] double% circleY
)

Parameters

segment: Type: Cognex.VisionPro CogLineSegment
The line segment.

circle: Type: Cognex.VisionPro CogCircle
The circle.

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

segmentX: Type: System Double
The x-coordinate of the nearest point on the line segment.

segmentY: Type: System Double
The x-coordinate of the nearest point on the line segment.

circleX: Type: System Double
The x-coordinate of the nearest point on the circle.

circleY: Type: System Double
The y-coordinate of the nearest point on the circle.

Return Value

Type: Double

The shortest distance between the circle and the line segment.

Exceptions

Exception	Condition
ArgumentException	segment or circle 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 line segment segment to circle and optionally the points on each shape that correspond to this shortest distance.

The following table describes how the relationship between segment and circle affects the out parameters.

ConditionDistance(segmentX,segmentY)(circleX,circleY)

Non-intersecting

Shortest distance between segment and circle.

The nearest point on segment

The nearest point on circle

Non-intersecting

The negative of the shortest distance between segment and circle.

The nearest endpoint on segment

The nearest point on circle

Tangent

(0,0)

Intersecting, endpoint on circle

(0,0)

Straddle

(0,0)

Intersecting

(0,0)

If you supply a value for the image parameter, then segment and circle are mapped to the selected space of image before the measurement is computed and the result is expressed in that space.

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