NAME

uvotflagqual

USAGE

uvotflagqual infile=<filename> outfile=<filename>

DESCRIPTION

This tool creates a source detection quality map.

The tool detects sources in the input raw image and outputs quality information. If outfile is requested, a map of detection quality flags will be created matching the raw image. Optionally, a source detection map and quality map for strong scattered-light features can be created. The flag definitions are written as comments to the quality map.

The tool swiftxform method=FLAG can be used to project a sky quality map as produced by this tool onto the sky. The tool uvotimsum method=FLAG can then be used to sum quality images.

PARAMETERS

infile [filename]
RAW UVOT image.

outfile [filename]
Map of quality flags in raw coordinates. The resulting image will match the infile image. The special NONE indicates that no map is desired.

(badpixfile = CALDB) [filename]
Bad pixel table filename. The special value CALDB automatically determines the appropriate bad pixel table for rawfile from the calibration database.

(smapbase = NONE) [filename]
Source detection map prefix (optional). The special value NONE disables this output.

(qmapbase = NONE) [filename]
Supplemental quality map for strong scattered-light features (optional). The special value NONE disables this output.

(psffwhm = 2.0) [real]
The PSF (Point Spread Function) FWHM (Full-Width Half-Maximum) [arcsec]. This parameter is exposed for tool calibration. A source is considered a point source if its minor axis is less than a constant (pntext parameter) times psffwhm.

(aperture = 5.0) [real]
Point source aperture [arcsec]. This parameter is exposed for tool calibration. When flags are set for a point source, all of the pixels within that aperture have the flag applied.

(pntext = 1.0) [real]
Source type determination scaling factor. See the psffwhm parameter. This parameter is exposed for tool calibration.

(extscale = 1.0) [real]
Ellipse size scaling factor for extended sources. This parameter is exposed for tool calibration. A scale of 1 corresponds to the ellipse given by Equation 26 in the SExtractor Users Guide with R = 3. The scaling is linear in each dimension.

(flagdet = yes) [boolean]
Flag detections? If true, the region associated with each detection object will have the point or extended source flag in outfile. This parameter is exposed for tool calibration.

(clobber = no) [boolean]
Overwrite existing output files?

(history = yes) [boolean]
Write history keywords?

(cleanup = yes) [boolean]
Remove temporary files?

(chatter = 2) [integer: 1-5]
Standard HEAdas chatter parameter.

EXAMPLES

The following examples illustrate running uvotflagqual.

1. create quality maps for all images in file:

      uvotflagqual infile=sw00123456001uwh_rw.img outfile=sw00123456001uwh_dq.img 

2. create a quality map for a specific raw image:

      uvotflagqual infile=swu_rw.img+3 outfile=dq.img 

SEE ALSO

swiftxform, uvotimsum

LAST MODIFIED

July 2019