next up previous
Next: ARY_PLACE - Obtain an array placeholder
Up: Routine Descriptions
Previous: ARY_NOACC - Disable a specified type of access to an array

ARY_OFFS  -  Obtain the pixel offset between two arrays

Description:
The routine returns the pixel offset for each requested dimension between two arrays. These values are the offsets which should be added to the pixel indices of the first array to obtain the indices of the corresponding pixel in the second array.

Invocation:
CALL ARY_OFFS( IARY1, IARY2, MXOFFS, OFFS, STATUS )

Arguments:
IARY1 = INTEGER (Given)
First array identifier.
IARY2 = INTEGER (Given)
Second array identifier.
MXOFFS = INTEGER (Given)
Maximum number of pixel offsets to return (i.e. the declared size of the OFFS argument).
OFFS( MXOFFS ) = INTEGER (Returned)
Array of pixel offsets for each dimension.
STATUS = INTEGER (Given and Returned)
The global status.

Notes:
  • The two array identifiers supplied need not refer to the same base array (although they may often do so). If they do not, then the offset between the pixels in each array is determined by matching the pixel indices of their respective base arrays.

  • Note that non-zero pixel offsets may exist even for dimensions which exceed the dimensionality of either of the two arrays supplied. The symbolic constant ARY__MXDIM may be used to declare the size of the OFFS argument so that it will be able to hold the maximum number of non-zero offsets that this routine can return.



next up previous
Next: ARY_PLACE - Obtain an array placeholder
Up: Routine Descriptions
Previous: ARY_NOACC - Disable a specified type of access to 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