The ConvertCoord function method transforms one or more sets of coordinates to and from the coordinate systems supported by IDL.

Syntax

Result = graphic.CONVERTCOORD( X, [Y [, Z]] [, /DATA] [, /DEVICE] [, /NORMAL, /RELATIVE] [, /TO_DATA] [, /TO_DEVICE] [, /TO_NORMAL, /TO_RELATIVE])

Return Value

The result of the function is a (3, n) vector containing the (x, y, z) components of the n output coordinates.

Arguments

X

A vector or scalar value that provides the X components of the input coordinates.

If only one argument is specified, X must be an array of either two or three vectors. For example, [2,*] or [3,*]. In this special case, X[0,*] are the X values, X[1,*] are the Y values, and (if present) X[2,*] are the Z values.

Y

An optional vector or scalar value that provides the Y input coordinate(s).

Z

An optional vector or scalar value that provides the Z input coordinate(s).

Keywords

DATA

Set this keyword if the input arguments are specified in data coordinates.

DEVICE

Set this keyword if the input arguments are specified in device coordinates. These coordinates are based on the virtual window, taking into account any canvas zoom that may be applied to the window.

NORMAL

Set this keyword if the input arguments are specified in normalized [0, 1] coordinates (the default). These coordinates are view-specific.

RELATIVE

Set this keyword to indicate that the input arguments are specified in normalized [0, 1] coordinates, relative to the axis range of the graphic's dataspace.

TO_DATA

Set this keyword to convert the result to data space coordinates.

TO_DEVICE

Set this keyword to convert the result to device space coordinates. These coordinates are based on the virtual window, and take into account any canvas zoom that may be applied to the window.

TO_NORMAL

Set this keyword to convert the result to normalized [0, 1] space coordinates (the default). These coordinates are view-specific.

TO_RELATIVE

Set this keyword to convert the result to normalized [0, 1] coordinates, relative to the axis range of the graphic's dataspace. For coordinates relative to the entire window, use the /TO_NORMAL keyword.

Version History

8.0

Introduced
8.2.1 Added RELATIVE and TO_RELATIVE keywords