Next: NDF_MBADN - Merge the bad-pixel flags of the array components of a number of NDFs
Up: FORTRAN ROUTINE DESCRIPTIONS
Previous: NDF_MAPZ - Obtain complex mapped access to an array component of an NDF
NDF_MBAD
- Merge the bad-pixel flags of the array components of a pair of
NDFs
- Description:
The routine merges the bad-pixel flag values of an array
component (or components) for a pair of NDFs, returning the
logical "OR" of the separate values for each NDF. In addition, if
bad pixels are found to be present in either NDF but the
application indicates that it cannot correctly handle such
values, then an error to this effect is reported and a STATUS
value is set.
- Invocation:
CALL NDF_MBAD( BADOK, INDF1, INDF2, COMP, CHECK, BAD, STATUS )
- Arguments:
-
BADOK = LOGICAL (Given)
-
Whether the application can correctly handle NDF array
components containing bad pixel values.
-
INDF1 = INTEGER (Given)
-
Identifier for the first NDF whose bad-pixel flag value is to
be merged.
-
INDF2 = INTEGER (Given)
-
Identifier for the second NDF.
-
COMP = CHARACTER * ( * ) (Given)
-
Name of the NDF array component: 'DATA', 'QUALITY' or
'VARIANCE'.
-
CHECK = LOGICAL (Given)
-
Whether to perform explicit checks to see whether bad pixels
are actually present. (This argument performs the same
function as in the routine NDF_BAD.)
-
BAD = LOGICAL (Returned)
-
The combined bad-pixel flag value (the logical "OR" of the
values obtained for each NDF).
-
STATUS = INTEGER (Given and Returned)
-
The global status.
- Notes:
-
A comma-separated list of component names may also be
supplied, in which case the routine will take the logical "OR" of
all the specified components when calculating the combined
bad-pixel flag value.
-
The effective value of the bad-pixel flag for each NDF array
component which this routine uses is the same as would be returned
by a call to the routine NDF_BAD.
-
If this routine detects the presence of bad pixels which the
application cannot support (as indicated by a .FALSE. value for
the BADOK argument), then an error will be reported to this
effect and a STATUS value of NDF__BADNS (bad pixels not
supported) will be returned. The value of the BAD argument will
be set to .TRUE. under these circumstances. The NDF__BADNS
constant is defined in the include file NDF_ERR.
Next: NDF_MBADN - Merge the bad-pixel flags of the array components of a number of NDFs
Up: FORTRAN ROUTINE DESCRIPTIONS
Previous: NDF_MAPZ - Obtain complex mapped access to an array component of an NDF
Starlink User Note 33
R.F. Warren-Smith
11th January 2000
E-mail:rfws@star.rl.ac.uk
Copyright © 2000 Council for the Central Laboratory of the Research Councils