NAME
sxsperseus - Adjust the gain for the Perseus observations
USAGE
sxsperseus infile outfile driftfile
DESCRIPTION
'sxsperseus' adjusts the energy scale for the Perseus data.
These observations were taken at the very early stage of the mission when the SXS detector was not
in thermal equilibrium. To correct the energy scale, these data are first corrected as for all
other data with the tasks 'sxsgain' and 'sxspha2pi' using the CALDB gain file that do not include
the additional pixel-to-pixel derived from the Fe55 observation. As second step the task 'sxsperseus'
calculates the proper gain adjustment derived from the Fe55 to the time of the Perseus observation.
The resuls of this calculation are written in the EPIPER and EPI2PER columns. The EPI2PER is used
to recompute the PI column. 'sxsperseus' run to all the data collected before 00:41 UT March 4th 2016.
PARAMETERS
- infile [file]
- Input SXS event file.
- outfile [file]
- Output SXS event file
- driftfile [file]
- Input calibration pixel gain file. This is the output of the task 'sxsgain'
- (dgfile = REFDATA) [file]
- Input gain coefficients file. This file is read from the REFDATA area of HEAsoft and should not be changed.
- (offsetfile = REFDATA) [file]
- Input calibration offset file. This file is read from the REFDATA area of HEAsoft and should not be changed.
- (outrange = NULL) [string]
- Define how to handle events with TIMEs outside of the driftfile TIME range.
If outrange = NULL, then assign EPIPER=EPI2PER+PI=NULL; if outrange=CONST, then use
the gain correction from the first or last time in driftfile; if
outrange=EXTRAP, then extrapolate the gain correction from driftfile.
- (method = FIT) [string]
- Specifies the correction column to use from driftfile. If method=FIT,
use the COR_FIT column, if method="AVERAGE", use the COR_AVE column.
- (extended = no) [bool]
- Use extended energy range (yes/[no]).If the parameter is set to yes, the task read from the column EPIE and EPI2E and write the
output of the gain calculation in the EPIEPER and EPI2EPER columns. The channel is written in the column PIE.
NOTE: This option should be used in conjunction with parameters 'binwidth', 'offset' and 'tlmax'.
It is advised to use the values recommended in the Hitomi user guide or step by step guide
- (binwidth = 1.0) [real]
- PI bin width for extended energy range [eV]
- (offset = 0.5) [real]
- Offset for first PI for extended energy range [eV]
- (tlmax = 32767) [int]
- Maximum PI channel for extended energy range
- (buffer = -1) [int]
- Rows to buffer (-1=auto, 0=none, >0=numrows)
- (clobber = no) [bool]
- Overwrite existing output file (yes/[no])
- (chatter = 1) [int]
- Chatter level for output
- (logfile = !DEFAULT) [string]
- Output log file (DEFAULT, NONE; '!' to clobber)
- (debug = no) [bool]
- Enable debug mode (yes/[no])
- (history = yes) [bool]
- Record tool parameters in HISTORY ([yes]/no)
- (mode = ql) [string]
- Mode of automatic parameters
LAST MODIFIED
December 2016