next up previous 530
Next: LTOffset - The offset from UTC to Local Time, in hours (TimeFrames only)
Up: Frame Attributes
Previous: ImagFreq - The image sideband equivalent of the rest frequency (DSBSpecFrames only)


Label(axis) - Axis label

Description:
This attribute specifies a label to be attached to each axis of a Frame when it is represented (e.g.) in graphical output.

If a Label value has not been set for a Frame axis, then a suitable default is supplied, depending on whether or not the Frame is a SkyFrame.

The default for simple Frames is the string "Axis <n>", where <$ {\tt {n}}$ > is 1, 2, etc. for each successive axis.

The default labels for specialised Frames (SkyFrames, SpecFrames, etc.) depend on the particular co-ordinate system represented by the Frame (e.g. "Right ascension", "Galactic latitude", "Frequency", "Wavelength in air", etc.).


Type:
String.

Examples:
wcsattrib my_data set label(2) "IRAS data (marked in white)"
This sets the Label for Axis 2 in the current Frame in the NDF called my_data, to the string "IRAS data (marked in white)".

Notes:
  • Axis labels are intended purely for interpretation by human readers and not by software.

  • When specifying this attribute by name, it should be subscripted with the number of the Frame axis to which it applies.




next up previous 530
Next: LTOffset - The offset from UTC to Local Time, in hours (TimeFrames only)
Up: Frame Attributes
Previous: ImagFreq - The image sideband equivalent of the rest frequency (DSBSpecFrames only)

KAPPA --- Kernel Application Package
Starlink User Note 95
Malcolm J. Currie & David S. Berry
2013 February 14
E-mail:starlink@jiscmail.ac.uk

Copyright © 2013 Science and Technology Facilities Council