next up previous 530
Next: Unit(axis) - Axis physical units
Up: Frame Attributes
Previous: TimeScale - Time scale (TimeFrames only)


Title - Frame title

Description:
This attribute holds a string that is used as a title in (e.g.) graphical output to describe the co-ordinate system that a Frame represents. Examples might be "Detector Co-ordinates" or "Galactic Co-ordinates".

If a Title value has not been set for a Frame, then a suitable default is supplied.

The default supplied by the Frame class is "<n>-d co-ordinate system", where <n> is the number of Frame axes (Naxes  attribute).

Specialised Frames (SkyFrame, SpecFrame, etc.) re-define the default Title value to be appropriate to the particular co-ordinate system being represented.


Type:
String.

Examples:
wcsattrib my_data set Title "My own data"
This sets the Title for the current Frame in the NDF called my_data, to the string "My own data".

Notes:
  • A Frame's Title is intended purely for interpretation by human readers and not by software.




next up previous 530
Next: Unit(axis) - Axis physical units
Up: Frame Attributes
Previous: TimeScale - Time scale (TimeFrames 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