imaqBuildCoordinateSystem

NI Vision for LabWindows/CVI Function

imaqBuildCoordinateSystem

Usage

int imaqBuildCoordinateSystem(const Point* points, ReferenceMode mode, AxisOrientation orientation, CoordinateSystem* system);

Purpose

Builds a reference for any arbitrary coordinate system with respect to the image plane. The reference of the coordinate system is specified as the position of the origin of the coordinate system, the orientation of its x-axis with respect to that of the image plane, and the direction of the y-axis, as shown in the following illustration.

Parameters

Name

Type

Description

points const Point* An array of points defining the coordinate system. If mode is IMAQ_COORD_X_Y, the points array must have three points. If mode is IMAQ_COORD_ORIGIN_X, the points array must have two points.
mode ReferenceMode Specifies the method that the function uses to calculate the coordinate system.
orientation AxisOrientation The direction of the y-axis of a coordinate system.
system CoordinateSystem* On return, contains the coordinate system defined by the point array. This parameter is required and cannot be NULL.

Return Value

Type

Description

int On success, this function returns a non-zero value. On failure, this function returns 0. To get extended error information, call imaqGetLastError().