NAME

USAGE

DESCRIPTION

The sxsperseus task adjusts the energy scale for Perseus Cluster SXS data. These observations were taken at an early stage of the Hitomi mission, before the detector reached thermal equilibrium. To set the energy scale, the PI values in the data should first be assigned in the standard way using the calpixel by the tasks sxsgain and sxspha2pi, and using a CALDB gain file containing the ground calibration gain coefficients. The sxsperseus task then calculates the gain adjustment, on a pixel-by-pixel basis, derived using the Hitomi data taken with the Fe55 source mounted on the Filter Wheel, appropriate for the time of the observation. The results of this calculation are written in the EPIPER and EPI2PER columns, where the latter is used to recompute the PI column. For data in the Hitomi archive, the sxsperseus task was run on all of the SXS data collected before 00:41 UT March 4th 2016.

PARAMETERS

infile [filename]

Input SXS event file.

outfile = sff_out.evt [filename]

Output SXS event file.

driftfile = driftfile.fits [filename]

Input drift correction (gain history) file created by the sxsgain task.

(dgfile = REFDATA) [filename]

Input differential gain coefficients file. This file is read from the REFDATA area of HEAsoft and should not be changed.

(offsetfile = REFDATA) [filename]

Input calibration pixel offsets file. This file is read from the REFDATA area of HEAsoft and should not be changed.

(outrange = NULL) [string NULL|CONST|EXTRAP]

Define how to handle events with TIME outside of the 'driftfile' TIME range. If 'outrange=NULL', assign EPIPER=EPI2PER=PI=NULL. If 'outrange=CONST', use the gain correction from the first or last time in 'driftfile'. If 'outrange=EXTRAP', linearly extrapolate the gain correction from 'driftfile'.

(method = FIT) [string FIT|AVERAGE]

Specifies the correction column to use from 'driftfile'. If 'method=FIT', the COR_FIT column is used; if 'method=AVERAGE', the COR_AVE column is used.

(extended = no) [boolean yes|no]

Use extended energy range. If 'extended' is set to yes, the task reads columns EPIE and EPI2E and writes the output of the gain correction calculation to columns EPIEPER and EPI2EPER, respectively. The extended energy channel value is written to the column PIE. Note: this option is used in conjunction with parameters 'binwidth', 'offset', and 'tlmax'.

(binwidth = 1.0) [double]

PI bin width for extended energy range [eV].

(offset = 1.0) [double]

Offset for first PI for extended energy range [eV].

(tlmax = 32767) [integer]

Maximum PI channel for extended energy range.

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

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

(clobber = no) [boolean yes|no]

Overwrite 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]

Record tool parameters in HISTORY.

EXAMPLES

1. Correct the energy scale in the perseus event file event_in.fits using the gain history file file drift_ghf.fits, and write to output file event_out.fits.

   sxsperseus event_in.fits event_out.fits driftfile=drift_ghf.fits

SEE ALSO

LAST MODIFIED