next up previous
Next: ARY_SBND - Set new pixel-index bounds for an array
Up: Routine Descriptions
Previous: ARY_SAME - Enquire if two arrays are part of the same base array

ARY_SBAD  -  Set the bad-pixel flag for an array

Description:
The routine sets the value of the bad-pixel flag for an array. A call to this routine with BAD set to .TRUE. declares that the specified array may contain bad pixel values for which checks must be made by algorithms which subsequently processes its values. A call with BAD set to .FALSE. declares that there are definitely no bad values present and that subsequent checks for such values may be omitted.

Invocation:
CALL ARY_SBAD( BAD, IARY, STATUS )

Arguments:
BAD = LOGICAL (Given)
Bad-pixel flag value to be set.
IARY = INTEGER (Given)
Array identifier.
STATUS = INTEGER (Given and Returned)
The global status.

Notes:
  • If the array is mapped for access when this routine is called, then the bad-pixel flag will be associated with the mapped values. This information will only be transferred to the actual data object when the array is unmapped (but only if it was mapped for UPDATE or WRITE access). The value transferred may be modified if conversion errors occur during the unmapping process.



next up previous
Next: ARY_SBND - Set new pixel-index bounds for an array
Up: Routine Descriptions
Previous: ARY_SAME - Enquire if two arrays are part of the same 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