next up previous
Next: AST_SLAADD - Add a celestial coordinate conversion to an SlaMap
Up: AST Routine Descriptions
Previous: AST_SIMPLIFY - Simplify a Mapping

AST_SKYFRAME - Create a SkyFrame   

Description:
This function creates a new SkyFrame and optionally initialises its attributes. A SkyFrame is a specialised form of Frame which describes celestial longitude/latitude coordinate systems. The particular celestial coordinate system to be represented is specified by setting the SkyFrame's System attribute (currently, the default is FK5) qualified, as necessary, by a mean Equinox value and/or an Epoch.

All the coordinate values used by a SkyFrame are in radians. These may be formatted in more conventional ways for display by using AST_FORMAT.

Invocation:
RESULT = AST_SKYFRAME( OPTIONS, STATUS )

Arguments:
OPTIONS = CHARACTER * ( * ) (Given)
A character string containing an optional comma-separated list of attribute assignments to be used for initialising the new SkyFrame. The syntax used is identical to that for the AST_SET routine. If no initialisation is required, a blank value may be supplied.
STATUS = INTEGER (Given and Returned)
The global status.

Returned Value:
AST_SKYFRAME = INTEGER
A pointer to the new SkyFrame.

Examples:
FRAME = AST_SKYFRAME( ' ', STATUS )

Creates a SkyFrame to describe the default FK5 celestial coordinate system, with the standard (default) mean Equinox of J2000.0.

FRAME = AST_SKYFRAME( 'Equinox = J2005, Digits = 10', STATUS )

Creates a SkyFrame to describe the default FK5 celestial coordinate system, but this time with a mean Equinox of J2005.0. Because especially accurate coordinates will be used, additional precision (10 digits) has been requested. This will be used when coordinate values are formatted for display.

FRAME = AST_SKYFRAME( 'System = FK4, Equinox = 1955-SEP-2', STATUS )

Creates a SkyFrame to describe the old FK4 celestial coordinate system. A default Epoch value (B1950.0) is used, but the mean Equinox value is given explicitly as "1955-SEP-2".

FRAME = AST_SKYFRAME( 'System = GAPPT, Epoch = ' // DATE, STATUS )

Creates a SkyFrame to describe the Geocentric Apparent celestial coordinate system. The Epoch value, which specifies the date of observation, is obtained from a date/time string contained in the character variable DATE.

Notes:
  • Currently, the default celestial coordinate system is FK5. However, this default may change in future as new astrometric standards evolve. The intention is to track the most modern appropriate standard. For this reason, you should use the default only if this is what you intend (and can tolerate any associated slight change in behaviour with future versions of this function). If you intend to use the FK5 system indefinitely, then you should specify it explicitly using an OPTIONS value of "System=FK5".
  • Whichever celestial coordinate system is represented, it will have two axes. The first of these will be the longitude axis and the second will be the latitude axis. This order can be changed using AST_PERMAXES if required.
  • When conversion between two SkyFrames is requested (as when supplying SkyFrames AST_CONVERT), account will be taken of the nature of the celestial coordinate systems they represent, together with any qualifying mean Equinox or Epoch values, etc. The AlignSystem attribute will also be taken into account. The results will therefore fully reflect the relationship between positions on the sky measured in the two systems.
  • A null Object pointer (AST__NULL) will be returned if this function is invoked with STATUS set to an error value, or if it should fail for any reason.



next up previous
Next: AST_SLAADD - Add a celestial coordinate conversion to an SlaMap
Up: AST Routine Descriptions
Previous: AST_SIMPLIFY - Simplify a Mapping

AST A Library for Handling World Coordinate Systems in Astronomy
Starlink User Note 210
R.F. Warren-Smith & D.S. Berry
30th April 2003
E-mail:ussc@star.rl.ac.uk

Copyright (C) 2003 Central Laboratory of the Research Councils