next up previous
Next: NDF_MAPQL - Map the quality component of an NDF as an array of logical values
Up: FORTRAN ROUTINE DESCRIPTIONS
Previous: NDF_LOC - Obtain an HDS locator for an NDF

   
NDF_MAP - Obtain mapped access to an array component of an NDF

Description:
The routine obtains mapped access to an array component of an NDF, returning a pointer to the mapped values and a count of the number of elements mapped.

Invocation:
CALL NDF_MAP( INDF, COMP, TYPE, MMOD, PNTR, EL, STATUS )

Arguments:
INDF = INTEGER (Given)
NDF identifier.
COMP = CHARACTER * ( * ) (Given)
Name of the NDF array component to be mapped: 'DATA', 'QUALITY' or 'VARIANCE' (or 'ERROR').
TYPE = CHARACTER * ( * ) (Given)
Numeric type to be used for access (e.g. '_REAL').
MMOD = CHARACTER * ( * ) (Given)
Mapping mode for access to the array: 'READ', 'UPDATE' or 'WRITE', with an optional initialisation mode '/BAD' or '/ZERO' appended.
PNTR( * ) = INTEGER (Returned)
Pointer(s) to the mapped values (see the Notes section).
EL = INTEGER (Returned)
Number of elements mapped.
STATUS = INTEGER (Given and Returned)
The global status.

Notes:
  • A comma-separated list of component names may also be given, in which case the routine will map all the requested components using the same data type and mapping mode. Pointers to the values of these mapped components will be returned (in the specified order) in the elements of the array PNTR, which must be of sufficient size to accommodate them.
  • The result of mapping the QUALITY component with a data type other than '_UBYTE' is not defined and should not be used.
  • If this routine is called with STATUS set, then a value of 1 will be returned for the EL argument, although no further processing will occur. The same value will also be returned if the routine should fail for any reason.



next up previous
Next: NDF_MAPQL - Map the quality component of an NDF as an array of logical values
Up: FORTRAN ROUTINE DESCRIPTIONS
Previous: NDF_LOC - Obtain an HDS locator for an NDF


Starlink User Note 33
R.F. Warren-Smith
11th January 2000
E-mail:rfws@star.rl.ac.uk

Copyright © 2000 Council for the Central Laboratory of the Research Councils