SPICE_DATA::get_wcs_coord

Source code: SPICE_DATA::get_wcs_coord

Class: SPICE_DATA

Description

Returns the coordinate(s) of one or more specified pixels or, if pixels is not provided, for all pixels. Returns coordinate(s) either for all dimensions or just the one specified.

Syntax

coords = spice_object->get_wcs_coord( window [, pixels] [, /x] [, /y] [, /lambda] [, /time] )

Return value

This function returns either a number or a number array, depending on input and keywords set.

• scalar: If one pixel is provided and one of the keywords is set
• 1D:
  • 1 pixel provided, no keywords set (4-element vector)
  • Several (n) pixels provided, one of the keywords set (n-element vector)
• 2D: Several (n) pixels provided, no keywords set (4 x n array)
• 4D: No pixels provided, one of the keywords set (NAXIS1 x NAXIS2 x NAXIS3 x NAZIS4 array)
• 5D: No pixels provided, no keywords set (4 x NAXIS1 x NAXIS2 x NAXIS3 x NAZIS4 array)

Arguments

window

The index or name of the window.

Optional Input

pixels

The pixel for which the coordinates should be returned. Values can be outside the actual data volume and can be floating point numbers. Must be either a 4-element vector, or a 2D array of the form (4,n) where n is the number of desired pixels.

Keywords

x

If set, only coordinates of the first dimension (x-direction) are returned.

y

If set, only coordinates of the second dimension (y-direction) are returned.

lambda

If set, only coordinates of the third dimension (wavelength) are returned.

time

If set, only coordinates of the fourth dimension (time) are returned.