NAME

USAGE

DESCRIPTION

The rslplsclip task determines whether Resolve event pulses are saturated based on a comparison of their raw pulse height recorded in the the LO_RES_PH column and an experimentally determined, pixel-dependent, threshold. The FLAG_CLIPPED column is set to 1 for saturated events, and 0 otherwise. Since the standard gain curves do not strictly apply to saturated events, the accuracy of energy assignment is compromised for events with FLAG_CLIPPED=1, and users requiring a precise energy scale above about 17 keV may want to exclude such events from extracted spectra.

PARAMETERS

infile [filename]

Input Resolve event file.

outfile = rslplsclip.evt [filename]

Output Resolve event file.

plsclipfile = CALDB [filename]

Input clipped pulse threshold file (or CALDB).

(buffer = -1) [integer -1|0|N]

Rows to buffer (-1=auto, 0=none, N>0=number of rows).

(clobber = no) [boolean yes|no]

Overwrites the existing output file if set to yes.

(chatter = 1) [integer 0|1|2|3]

Chatter level for output. Set to 0 to suppress output, or to 1, 2, or 3 for increasing the chatter of the output.

(logfile = !DEFAULT) [string DEFAULT|NONE|file name]

Log file name. If set to DEFAULT, uses the name of the task and, if preceded by "!", overwrites the file if it exists. If set to NONE, no log file is created.

(debug = no) [boolean yes|no]

Diagnostic output is printed to the screen if set to yes.

(history = yes) [boolean yes|no]

Records task parameters in HISTORY.

EXAMPLES

1. Calculate the pulse clipping flag in the Resolve event file rslin.evt, and store the values in the FLAG_CLIPPED column in rslout.evt.

   rslplsclip rslin.evt rslout.evt

SEE ALSO

LAST MODIFIED