masks out a region of an NDF by setting pixels to the bad value, or to a specified
constant value. The region to be masked is specified within a text file (see Parameter
REGION) that should contain a description of the region in the form of an
This is the system used by the AST library for describing regions (see SUN/211
). Such text files can, for instance, be created using the Starlink ATOOLS
package (a high-level interface to the facilities of the AST library).
CONST = LITERAL (Given)
numerical value to assign to the region, or the string
IN = NDF
The name of the input NDF.
INSIDE = _LOGICAL (Read)
If a TRUE value is
supplied, the constant value is assigned to the inside of the region. Otherwise, it is
assigned to the outside.
OUT = NDF (Write)
The name of the output NDF.
REGION = FILENAME (Read)
The name of the text file containing a text dump of
an AST Region. Any sub-class of Region may be supplied (e.g. Box, Polygon,
CmpRegion, Prism, etc.). If the axes spanned by this Region are not the same as
those of the current WCS Frame in the input NDF, an attempt will be made to
create an equivalent new Region that does match the current WCS Frame. An error
will be reported if this is not possible.
; ATOOLS: ASTBOX,
ASTCMPREGION, ASTELLIPSE, ASTINTERVAL, ASTPOLYGON.