next up previous
Next: ARY_DUPE - Duplicate an array
Up: Routine Descriptions
Previous: ARY_DELET - Delete an array

ARY_DIM  -  Enquire the dimension sizes of an array

Description:
The routine returns the size in pixels of each dimension of an array, together with the total number of dimensions (the size of a dimension is the difference between that dimension 's upper and lower pixel-index bounds + 1).

Invocation:
CALL ARY_DIM( IARY, NDIMX, DIM, NDIM, STATUS )

Arguments:
IARY = INTEGER (Given)
Array identifier.
NDIMX = INTEGER (Given)
Maximum number of dimension sizes to return (i.e. the declared size of the DIM argument).
DIM( NDIMX ) = INTEGER (Returned)
Size of each dimension in pixels.
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 DIM argument 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 dimension sizes will be returned, and an error will result if the size of any of the excluded dimensions exceeds 1.

  • The symbolic constant ARY__MXDIM may be used to declare the size of the DIM argument so that it will be able to hold the maximum number of array dimension sizes that this routine can return. This constant is defined in the include file ARY_PAR.



next up previous
Next: ARY_DUPE - Duplicate an array
Up: Routine Descriptions
Previous: ARY_DELET - Delete an 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