next up previous
Next: ARY_CLONE - Clone an array identifier
Up: Routine Descriptions
Previous: ARY_BASE - Obtain an identifier for a base array

ARY_BOUND  -  Enquire the pixel-index bounds of an array

Description:
The routine returns the lower and upper pixel-index bounds of each dimension of an array, together with the total number of dimensions.

Invocation:
CALL ARY_BOUND( IARY, NDIMX, LBND, UBND, NDIM, STATUS )

Arguments:
IARY = INTEGER (Given)
Array 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 array dimensions.
STATUS = INTEGER (Given and Returned)
The global status.

Notes:
  • If the array has fewer than NDIMX dimensions, then any remaining elements of the LBND and UBND arguments will be filled with 1 's.

  • If the array 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.

  • The symbolic constant ARY__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 array bounds that this routine can return. This constant is defined in the include file ARY_PAR.



next up previous
Next: ARY_CLONE - Clone an array identifier
Up: Routine Descriptions
Previous: ARY_BASE - Obtain an identifier for a base array



ARY A Subroutine Library for Accessing ARRAY Data Structures
Starlink User Note 11
R.F. Warren-Smith
28th April 1998
E-mail:rfws@star.rl.ac.uk