NAME
rslseccor - Correct PHA values for mid-resolution secondary grade XRISM Resolve events
USAGE
rslseccor infile outfile
DESCRIPTION
The rslseccor task corrects the telemetered PHA values of the XRISM Resolve
mid-resolution secondary (Ms) events in an event file specified by the
'infile' parameter, based on the values of the TIME and PHA columns of
all preceding events that are members of the same group. A group is
defined as a primary event and all associated secondary events
occurring within a pixel, and groups for each event are designated and
written to the GROUPS column by the rslsecid task.
The secondary correction for each Ms event in a group is calculated
based on the Resolve pulse shape estimated at the PHA value of the
event, the time interval between the event and the preceding event
in the group, the PHA value of the event, and the
(already-corrected) PHA value of the preceding event. The pulse
shape is obtained from average pulse shapes over a number of PHA
ranges for each pixel stored in the calibration database (CalDB)
file specified by the parameter 'pulsefile' (using the extension
with event threshold identifier matching that in the header of
'infile'). CalDB data that match the event file DEVPTHRE and
SHPTEMPL keywords is used, unless the 'skipthre' parameter is set to
yes in which case only SHPTEMPL is queried (the first matching
extension will be used). The corrected PHA value is written to a new
column specified by the 'phaout' parameter ('phaout' may not be set
to PHA). No correction is applied to "orphan" events, defined as
secondaries not associated with any primary (the value in the
'phaout' column is the same as that in the PHA column). No
correction is applied to events where the primary is an Lp event.
PARAMETERS
- infile [filename]
- Input Resolve event file name. The file must have the TIME column assigned.
- outfile [filename]
- Name of the output FITS file. The output file is a copy of
the input file with a new column, whose name is specified by the 'phaout'
parameter, that is populated with the corrected PHA values.
- (pulsefile = CALDB) [filename CALDB|file name]
- Input file containing PHA pulse amplitude profiles over multiple
PHA ranges for each pixel. If this parameter is set to CALDB, the file
is read from the CalDB.
- (itypecol = ITYPE) [string]
- Name of the column used to identify grades, and associate secondary
events with the primary event in a group.
- (phaout = PHA2) [string]
- Name of the new column to populate with corrected PHA values. This
may not be set to PHA.
- (skipthre = no) [boolean yes|no]
- If set to yes, ignore trigger threshold in CALDB query.
- (buffer = -1) [integer -1|0|N]
- Rows to buffer (-1=auto, 0=none, N>0=numrows).
- (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 tool parameters in HISTORY.
EXAMPLES
- Correct PHA values for mid-resolution secondary events using the
pulse amplitude file in the CalDB. Event grades are derived from the
ITYPE column and the corrected PHA values are written to the
column PHA2.
rslseccor infile=xa100050020rsl_p0px1010_uf.evt outfile=xa100050020rsl_p0px1010_uf_rslseccor.evt
SEE ALSO
rslsecid
LAST MODIFIED
December 26, 2023