HEADAS help file

NAME

sxiphas - Merge inner 3x3 and outer 5x5 pulse height columns in a Hitomi SXI event list

USAGE

sxiphas infile outfile

DESCRIPTION

The task sxiphas reads an SXI FITS event list and merges pixel pulse height data from the inner 3x3 event island (9 pixels in the column PHAS_INNER3X3) and the outer 5x5 ring (16 pixels in the column PHAS_OUTER5X5) for each event. Since data from the inner 3x3 pixels are telemetered separately from the the data in the outer 5x5 ring, the data must be combined into a single column. Also, depending on the telemetry bandwidth available, one of the sets of pulse heights (3x3 or 5x5) might be missing.

The merged pulse height data from all 25 pixels are recorded in the column PHASALL. The contents of PHAS_INNER3X3 are also copied to the PHAS column. If the 3x3 data are present but the 5x5 data are missing, the outer pixel values of PHASALL are set to TNULL and STATUS flag 24 is set. If the inner 3x3 data are missing (which is abnormal), then regardless of whether the outer 5x5 ring is present, all of the values for PHAS and PHASALL are set to TNULL and STATUS flag 25 is set.

PARAMETERS

infile = in.fits [filename]: Name of input SXI FITS event list.
outfile = out.fits [filename]: Name of output SXI FITS event list.
(colbound = -32768,-32767,32767) [string]: Values to use for TNULL, TLMIN, and TLMAX respectively in the output columns PHASALL and PHAS. TNULL is the value used for a row/column position with no data.
(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

Merge 3x3 and 5x5 pulse height columns, using the default TNULL, TLMIN, and TLMAX values for the output pulse height amplitude columns, PHAS and PHASALL.
```
   sxiphas infile=sxi_fff_test_20130418.fits outfile=sxi_sff_test_20130418.fits
```

LAST MODIFIED