next up previous
Next: ARY_SIZE - Determine the size of an array
Up: Routine Descriptions
Previous: ARY_SECT - Create an array section

ARY_SHIFT  -  Apply pixel-index shifts to an array

Description:
The routine applies pixel-index shifts to an array. An integer shift is applied to each dimension so that its pixel-index bounds, and the indices of each pixel, change by the amount of shift applied to the corresponding dimension. The array 's pixels retain their values and none are lost.

Invocation:
CALL ARY_SHIFT( NSHIFT, SHIFT, IARY, STATUS )

Arguments:
NSHIFT = INTEGER (Given)
Number of dimensions to which shifts are to be applied. This must not exceed the number of array dimensions. If fewer shifts are supplied than there are dimensions in the array, then the extra dimensions will not be shifted.
SHIFT( NSHIFT ) = INTEGER (Given)
The pixel-index shifts to be applied to each dimension.
IARY = INTEGER (Given)
Array identifier.
STATUS = INTEGER (Given and Returned)
The global status.

Notes:
  • Pixel-index shifts applied to a base array will affect the appearance of that array as seen by all base-array identifiers associated with it. However, array sections derived from that base array will remain unchanged (as regards both pixel-indices and data content).

  • Pixel-index shifts cannot be applied to a base array while any part of it is mapped for access (i.e. even through another identifier).

  • Pixel-index shifts applied to an array section only affect that section itself, and have no effect on other array identifiers.

  • Pixel-index shifts cannot be applied to an array section while it is mapped for access through the identifier supplied to this routine.



next up previous
Next: ARY_SIZE - Determine the size of an array
Up: Routine Descriptions
Previous: ARY_SECT - Create an array section



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