KPG1_KYHDS

Copies values from an AST KeyMap to a primitive HDS object

Description:

This function fills a specified HDS object with primitive values read from a vector entry in an AST KeyMap. It is the inverse of KPG1_HDSKY. The HDS object must already exist and must be a primitive array or scalar. The values to store in the HDS object are read from the KeyMap entry that has a key equal to the name of the HDS object. The vector read from the KeyMap is interpreted as an N-dimension array, where N is the number of dimensions in the HDS object. Array slices can be re-arranged as they are copied from KeyMap to HDS object. The AXIS argument specifies which axis is being re-arranged. Each array slice is perpendicular to this axis. The KeyMap array and the HDS array are assumed to have the same dimensions on all other axes.

Invocation

CALL KPG1_KYHDS( KEYMAP, MAP, AXIS, MODE, LOC, STATUS )

Arguments

KEYMAP = INTEGER (Given)
An AST pointer to the KeyMap.
MAP( ∗ ) = INTEGER (Given)
An array which indicates how to map slices in the KeyMap array onto slices in the HDS array. The length of the supplied array should be equal to the HDS array dimension specified by AXIS. Element J of this array says where the data for the J’ th slice of the HDS array should come from, where J is the index along the axis specified by AXIS. The value of element J is a zero-based index along axis AXIS of the array read from the KeyMap.
AXIS = INTEGER (Given)
The index of the axis to be re-arranged. The first axis is axis 1.
MODE = INTEGER (Given)
Specifies what happens if the supplied KeyMap does not contain an entry with the name of the supplied HDS object.

1 - Report an error.

2 - Do nothing

LOC = CHARACTER ∗ ( DAT__SZLOC ) (Given)
An HDS locator for a primitive scalar or array object.
STATUS = INTEGER (Given and Returned)
The global status.

Notes: