CogMath.InsidePointEllipse Method

CogMath InsidePointEllipse Method

Cognex VisionPro

Returns whether the given point is inside the given ellipse.

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

Syntax

public static bool InsidePointEllipse(
	double x,
	double y,
	CogEllipse ellipse,
	ICogImage image
)

public static bool InsidePointEllipse(
	double x,
	double y,
	CogEllipse ellipse,
	ICogImage image
)

Public Shared Function InsidePointEllipse ( 
	x As Double,
	y As Double,
	ellipse As CogEllipse,
	image As ICogImage
) As Boolean

Public Shared Function InsidePointEllipse ( 
	x As Double,
	y As Double,
	ellipse As CogEllipse,
	image As ICogImage
) As Boolean

public:
static bool InsidePointEllipse(
	double x, 
	double y, 
	CogEllipse^ ellipse, 
	ICogImage^ image
)

public:
static bool InsidePointEllipse(
	double x, 
	double y, 
	CogEllipse^ ellipse, 
	ICogImage^ image
)

Parameters

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

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

ellipse: Type: Cognex.VisionPro CogEllipse
The ellipse.

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

Return Value

Type: Boolean

True if the point (x,y) is in or on the ellipse.

Exceptions

Exception	Condition
ArgumentException	ellipse 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 true if the given point is on or in ellipse.

If you supply a value for the image parameter, then ellipse 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 ellipse, x, and y are presumed to be in the same coordinate space.