Next: NDF_CGET - Obtain the value of an NDF character component
Up: FORTRAN ROUTINE DESCRIPTIONS
Previous: NDF_BLOCK - Obtain an NDF section containing a block of adjacent pixels
- Description:
The routine returns the lower and upper pixel-index bounds of
each dimension of an NDF, together with the total number of
dimensions.
- Invocation:
CALL NDF_BOUND( INDF, NDIMX, LBND, UBND, NDIM, STATUS )
- Arguments:
-
INDF = INTEGER (Given)
-
NDF identifier.
-
NDIMX = INTEGER (Given)
-
Maximum number of pixel-index bounds to return (i.e. the
declared size of the LBND and UBND arguments).
-
LBND( NDIMX ) = INTEGER (Returned)
-
Lower pixel-index bounds for each dimension.
-
UBND( NDIMX ) = INTEGER (Returned)
-
Upper pixel-index bounds for each dimension.
-
NDIM = INTEGER (Returned)
-
Total number of NDF dimensions.
-
STATUS = INTEGER (Given and Returned)
-
The global status.
- Notes:
-
If the NDF has fewer than NDIMX dimensions, then any remaining
elements of the LBND and UBND arguments will be filled with 1's.
-
If the NDF has more than NDIMX dimensions, then the NDIM
argument will return the actual number of dimensions. In this
case only the first NDIMX sets of bounds will be returned, and an
error will result if the size of any of the remaining dimensions
exceeds 1.
-
If this routine is called with STATUS set, then a value of 1
will be returned for all elements of the LBND and UBND arrays and
for the NDIM argument, although no further processing will occur.
The same values will also be returned if the routine should fail
for any reason.
-
The symbolic constant NDF__MXDIM may be used to declare the
size of the LBND and UBND arguments so that they will be able to
hold the maximum number of NDF bounds that this routine can
return. This constant is defined in the include file NDF_PAR.
Next: NDF_CGET - Obtain the value of an NDF character component
Up: FORTRAN ROUTINE DESCRIPTIONS
Previous: NDF_BLOCK - Obtain an NDF section containing a block of adjacent pixels
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