next up previous
Next: AST_SPECADD - Add a spectral coordinate conversion to a SpecMap
Up: AST Routine Descriptions
Previous: AST_SLAADD - Add a celestial coordinate conversion to an SlaMap

AST_SLAMAP - Create an SlaMap   

Description:
This function creates a new SlaMap and optionally initialises its attributes. An SlaMap is a specialised form of Mapping which can be used to represent a sequence of conversions between standard celestial (longitude, latitude) coordinate systems.

When an SlaMap is first created, it simply performs a unit (null) Mapping on a pair of coordinates. Using the AST_SLAADD routine, a series of coordinate conversion steps may then be added, selected from those provided by the SLALIB Positional Astronomy Library (Starlink User Note SUN/67). This allows multi-step conversions between a variety of celestial coordinate systems to be assembled out of the building blocks provided by SLALIB.

For details of the individual coordinate conversions available, see the description of the AST_SLAADD routine.

Invocation:
RESULT = AST_SLAMAP( FLAGS, OPTIONS, STATUS )

Arguments:
FLAGS = INTEGER (Given)
This argument is reserved for future use and should currently always be set to zero.
OPTIONS = CHARACTER * ( * ) (Given)
A character string containing an optional comma-separated list of attribute assignments to be used for initialising the new SlaMap. 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_SLAMAP = INTEGER
A pointer to the new SlaMap.

Notes:
  • The Nin and Nout attributes (number of input and output coordinates) for an SlaMap are both equal to 2. The first coordinate is the celestial longitude and the second coordinate is the celestial latitude. All coordinate values are in radians.
  • 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_SPECADD - Add a spectral coordinate conversion to a SpecMap
Up: AST Routine Descriptions
Previous: AST_SLAADD - Add a celestial coordinate conversion to an SlaMap

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