NAME

USAGE

DESCRIPTION

'sxsseccor' correct the telemetered PHA values of the medium secondary events using the time and the PHA information of all preceding events belonging to the same group. A group is defined as a primary event and all associated secondary events occurring within a pixel. The events are flags belonging to group by the task 'sxssecid' and the assignment written in the column GROUPS. The secondary correction depends on the SXS pulse shape, which depends on energy range and pixel number. The pulse shapes are stored in a CALDB file specified by the parameter 'pulsefile'.

PARAMETERS

infile [filename]

Input SXS event file name. The file must have time assigned.

outfile [filename]

Name of the output file. This is a copy of the input file with a new column added (see phaout parameter) filled with the corrected PHA values.

(pulsefile=CALDB) [filename]

Input file containing PHA pulse amplitudes for each pixel for multiple energy regions. If set to CALDB, the file is queried for in the calibration database.

(itypecol=ITYPE) [string]

Name of the column used to identify grades for the primary/secondary association and grade sequence.

(phaout=PHA2) [string]

Name of new column to fill with the corrected PHA values. An error occurs if this is set to "PHA".

(buffer = -1) [integer]

Rows to buffer (-1=auto, 0=none, >0=numrows).

(clobber = no) [boolean]

Overwrites the existing output file if set to yes (yes/[no]).

(chatter = 1) [integer]

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]

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

(debug = no) [boolean]

Diagnostic output is printed out on the screen if set to yes (yes/[no]).

(history = yes) [boolean]

Records tool parameters in HISTORY ([yes]/no).

(mode = ql) [string ql|hl|q]

Mode to query the parameter file. Acceptable values include: 'ql' (query and learn/remember), 'hl' (hidden and learn/remember), 'q' (query but don't remember), 'h' (hidden).(Optional)

EXAMPLES

1. Correct PHA values for mid-resolution secondary events using the pulse amplitude file in CALDB. Event grades are determined from the ITYPE column and the corrected PHA values are written to the column PHA2.

      sxsseccor infile=event_in.fits outfile=event_out.fits phaout=PHA2

SEE ALSO

LAST MODIFIED