next up previous
Next: NDF_FORM - Obtain the storage form of an NDF array component
Up: FORTRAN ROUTINE DESCRIPTIONS
Previous: NDF_EXIST - See if an existing NDF is associated with an ADAM parameter

   
NDF_FIND - Find an NDF and import it into the NDF_ system

Description:
The routine finds an NDF within an HDS structure or container file, imports it into the NDF_ system and issues an identifier for it. The imported NDF may then be manipulated by the NDF_ routines.

Invocation:
CALL NDF_FIND( LOC, NAME, INDF, STATUS )

Arguments:
LOC = CHARACTER * ( * ) (Given)
Locator to the enclosing HDS structure.
NAME = CHARACTER * ( * ) (Given)
Name of the HDS structure component to be imported.
INDF = INTEGER (Returned)
NDF identifier.
STATUS = INTEGER (Given and Returned)
The global status.

Notes:
  • The value given for the NAME argument may be an HDS path name, consisting of several fields separated by '.', so that an NDF can be found in a sub-component (or a sub-sub-component...) of the structure identified by the locator LOC. Array subscripts may also be used in this component name. Thus a string such as 'MYSTRUC.ZONE(2).IMAGE' could be used as a valid NAME value.
  • An NDF can be accessed within an explicitly named container file by supplying the symbolic value DAT__ROOT for the LOC argument and specifying the container file within the value supplied for the NAME argument. Only READ access is available to an NDF accessed in this way (for other modes of access, see the NDF_OPEN routine).
  • If a blank value is given for the NAME argument, then the NDF to be imported will be the object identified directly by the locator LOC.
  • The locator supplied as input to this routine may later be annulled without affecting the behaviour of the NDF_ system.
  • If this routine is called with STATUS set, then a value of NDF__NOID will be returned for the INDF argument, although no further processing will occur. The same value will also be returned if the routine should fail for any reason.
  • The NDF__NOID constant is defined in the include file NDF_PAR. The DAT__ROOT constant is defined in the include file DAT_PAR (see SUN/92).



next up previous
Next: NDF_FORM - Obtain the storage form of an NDF array component
Up: FORTRAN ROUTINE DESCRIPTIONS
Previous: NDF_EXIST - See if an existing NDF is associated with an ADAM parameter


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