KPG1_GTAXM

Selects Frame axes using an environment parameter

Description:

This routine returns the indices of selected axes in a supplied Frame. The axes to select are determined using the supplied environment parameter. Each axis can be specified either by giving its index within the Frame in the range 1 to the number of axes in the Frame, or by giving its symbol. Spectral, time and celestial longitude/latitude axes may also be specified using the options " SPEC" , " TIME" , " SKYLON" and " SKYLAT" . If the first value supplied in AXES is not zero, the supplied axes are used as the dynamic default for the parameter. The parameter value should be given as a GRP group expression, with default GRP control characters.

Invocation

CALL KPG1_GTAXM( PARAM, FRAME, MAXAX, AXES, NAX, STATUS )

Arguments

PARAM = CHARACTER ∗ ( ∗ ) (Given)
The name of the parameter to use.
FRAME = INTEGER (Given)
An AST pointer for the Frame from which axes may be chosen.
MAXAX = INTEGER (Given)
The maximum number of axes that can be be selected.
AXES( NAX ) = INTEGER (Given and Returned)
On entry, the axes to be specified as the dynamic default for the parameter (if AXES( 1 ) is not zero). On exit, it holds the indices of the selected axes. If AXES(1) is zero the supplied values are ignored and a PAR__NULL status value is returned if a null (!) value is supplied for the parameter. Otherwise, the PAR_NULL status is annulled if a null value is supplied, and the supplied axes are returned.
NAX = INTEGER (Given)
The number of axes actually selected.
STATUS = INTEGER (Given and Returned)
The global status.

Notes: