NAME

uvotscreen - filter a UVOT event list

USAGE

uvotscreen infile=<filename> attorbfile=<filename> outfile=<filename> aoexpr=<filtering expression>

DESCRIPTION

This tool screens UVOT level 1 event files. It has an optional preprocessing step that sets the QUALITY flags for intrinsically bad pixels. The output file contains the filtered events table and GTI extensions corresponding to each input GTI extension intersected with the GTIs of the filtering expression applied to the orbital/attitude quantities. The output WINDOW extension is updated based on the filtering performed.

PARAMETERS

infile [filename]
UVOT level 1 events file (see SSC UVOT Data Handbook).

outfile [filename]
UVOT level 2 events file (see SSC UVOT Data Handbook).

attorbfile [filename]
Orbit and attitude quantities. This file is produced by prefilter.

badpixfile [filename or NONE]
Bad pixel list or NONE. If not NONE, used to update the QUALITY flags for hot, cold, dead, flickering bad pixels.

aoexpr [string]
Orbit/attitude filtering expression. Passed to maketime.

evexpr [string]
Event filtering expression. Applied to EVENT table.

(cleanup = yes) [boolean]
Clean up temporary files?

(chatter = 1) [enumerated integer]
Standard HEAdas chatter parameter. A range of 0 to 5 is enforced by the min and max fields in the parameter file.

(clobber = no) [boolean]
Standard HEAdas clobber parameter.

(history = yes) [boolean]
Standard HEAdas history parameter.

EXAMPLES

The following example illustrates running uvotscreen

1. run uvotscreen specifying input and output event files, orbit/attitude file, and filtering expression on command line

      uvotscreen infile=unfiltered.fits attorbfile=prefilter.fits \
		outfile=filtered.fits aoexpr=SAA_FLAG.eq.0.and.SUN_ANGLE.gt.15

SEE ALSO

prefilter, maketime, extractor

LAST MODIFIED

March 2008