NDF_AREST

Reset an NDF axis component to an undefined state

Description:

The routine resets an NDF axis component so that its value becomes undefined. It may be used to remove unwanted optional NDF axis components.

Invocation

CALL NDF_AREST( INDF, COMP, IAXIS, STATUS )

Arguments

NDF identifier.
COMP = CHARACTER $\ast$ ( $\ast$ ) (Given)
Name of the axis component to be reset: ’LABEL’, ’UNITS’, ’VARIANCE’ or ’WIDTH’.
IAXIS = INTEGER (Given)
Number of the NDF axis to be modified.
STATUS = INTEGER (Given and Returned)
The global status.

Notes:

• A comma-separated list of axis component names may also be supplied, in which case each component will be reset in turn.

• A value of zero may be supplied for the IAXIS argument, in which case the same component(s) will be reset on all the NDF’s axes.

• An axis component name of ’CENTRE’ may not be specified for this routine because the pixel centre information cannot be reset for each axis of an NDF individually. This information may only be removed from an NDF by resetting the entire axis component. This can be done by calling the routine NDF_RESET and specifying a component name of ’AXIS’.

• This routine may only be used to reset an axis component via a base NDF. If an NDF section is supplied, then it will return without action. No error will result.

• An NDF axis array component cannot be reset while it is mapped for access, even if this is via another NDF identifier. This routine will fail, and set a STATUS value, if this is the case.