IRA_GETCO

Obtains a pair of sky co-ordinates from the ADAM environment

Description:

The ADAM parameters specified by arguments APAR and BPAR are used to acquire values for the first and second sky co-ordinates respectively, in the sky co-ordinate system specified by argument SCS. The parameters are obtained as literal character strings and decoded into floating point values. See routine IRA_CTOD for a description of the allowed formats of the strings associated with these parameters. The input values of arguments A and B can optionally be supplied to the user as default parameter values. The parameter prompt strings contained in the application’ s interface file can be overridden by giving a non-blank value for argument PRMAPP. In this case, the prompts are formed by appending the value of PRMAPP to the co-ordinate descriptions returned by routine IRA_SCNAM. For instance, if PRMAPP = " of the field centre" , and an equatorial sky co-ordinate system is in use, then the prompt for APAR will be " Right Ascension of the field centre" , and the prompt for BPAR will be " Declination of the field centre" . Note, the total length of the prompt strings is limited to 80 characters. If PRMAPP is blank, then the current prompt strings are used (initially equal to the values in the interface file).

Invocation

CALL IRA_GETCO( APAR, BPAR, PRMAPP, SCS, DEFLT, A, B, STATUS )

Arguments

CHARACTER = APAR (Given)
The name of the ADAM parameter (type LITERAL) to use for the sky longitude value.
CHARACTER = BPAR (Given)
The name of the ADAM parameter (type LITERAL) to use for the sky latitude value.
PRMAPP = CHARACTER ∗ ( ∗ ) (Given)
A string to append to each axis description to form the parameter prompt strings. If this is blank then the current prompt strings are used (i.e. initially set to the values in the interface file).
SCS = CHARACTER ∗ ( ∗ ) (Given)
The name of the sky co-ordinate system to use. Any unambiguous abbreviation will do (see ID2 section " Sky Coordinates" ).
DEFLT = LOGICAL (Given)
True if the input values of A and B are to be communicated to the environment as run-time defaults for the parameters specified by APAR and BPAR. If A or B is " BAD" on entry (i.e. equal to VAL__BADD ) then no default is set up for the corresponding parameter.
A = DOUBLE PRECISION (Given and Returned)
The value of the first sky co-ordinate. In radians.
B = DOUBLE PRECISION (Given and Returned)
The value of the second sky co-ordinate. In radians.
STATUS = INTEGER (Given and Returned)
The global status.