NAME

mxsgti - Generate coarse and fine GTI files for the Hitomi MXS, and populate the appropriate columns of an SXS HK file with MXS start and stop times for the different LED sources using mxstime; invert the GTI using gtiinvert, and create merged GTI.

USAGE

mxsgti infilehk outfilehk finegti coarsegti timfile delayfile

DESCRIPTION

The mxsgti task is a script that runs the mxstime and gtiinvert tasks. The mxstime task is used to take an input HK file, calculate MXS start and stop times that are inserted into the output HK file, and create coarse and fine GTI files for the time intervals when the MXS LED sources are switched on, and are within the duration of an LED pulse, respectively. The GTI are derived from the values of columns in the input SXS HK, TIM, and DELAY files. After running mxstime, mxsgti applies the gtiinvert task to the coarse and fine GTI in order to create time interval files for when the MXS LEDs are off, and for the intervals between LED pulses, respectively. The following MXS-on and MXS-off GTI extensions corresponding to each of the four LED sources, as well as the merged GTI for the direct (LED1 & LED3) or indirect (LED2 & LED4) LED sources that are created.

The output fine GTI file has twelve extensions:

The output coarse GTI file has twelve extensions:

PARAMETERS

infilehk = mxs.in [filename]
Input SXS HK file containing the MXS telemetry information.

outfilehk = mxs.out [filename]
Output HK file. This is a copy of the corresponding input file, with start and stop time columns in the appropriate extension populated for each MXS LED.

finegti = mxs_fn.gti [filename]
Output fine GTI file for MXS.

coarsegti = mxs_crs.gti [filename]
Output coarse GTI file for MXS.

timfile = test.tim [filename]
Input TIM file relating spacecraft time (TI) to time.

delayfile = CALDB [filename]
Input delay file specifying the time delay between the central processor and each MXS. If the parameter is set to CALDB, the file is read from the calibration database.

(leapsecfile = REFDATA) [filename REFDATA|CALDB|file name]
Name of the leap second file. If the parameter is set to CALDB or REFDATA, the file in CALDB or the REFDATA area respectively, is used.

(stimecol = S_TIME) [string]
Name of S_TIME column.

(tioncol = FWE_TI_LED#_ON) [string]
Input TI columns with LED turned on (the hash character, "#", takes values 1 to 4, inclusive).

(tioffcol = FWE_TI_LED#_OFF) [string]
Input TI columns with LED turned off ("#" takes values 1 to 4, inclusive).

(plslencol = FWE_LED#_PLS_LEN) [string]
Input pulse length columns ("#" takes values 1 to 4, inclusive).

(plsspccol = FWE_LED#_PLS_SPC) [string]
Input pulse spacing columns ("#" takes values 1 to 4, inclusive).

(timeoncol = TIME_LED#_ON) [string]
Output LED-on time columns ("#" takes values 1 to 4, inclusive).

(timeoffcol = TIME_LED#_OFF) [string]
Output LED-off time columns ("#" takes values 1 to 4, inclusive).

(calctime = yes) [boolean yes|no]
If 'calctime' is set to yes, time is assigned in the output HK file. Note that GTI cannot be calculated without the time assignment calculation.

(calcgti = yes) [boolean yes|no]
If 'calcgti' is set to yes, GTI files are produced.

(afterglow = no) [boolean yes|no]
If 'afterglow' is set to yes, the fine GTI intervals are extended by the afterglow decay time set by the parameter 'dtdecay'.

(dtdecay = CALDB) [string]
Afterglow decay time [s]. If the parameter is set to CALDB, the decay time is obtained from a file that is read from the calibration database.

(mxsoffset = 0.015625) [double]
Time offset [s] added to all start and stop times.

(interp = TWOPOINT) [string NEAREST|TWOPOINT]
Interpolation method used in time assignment.

(margingti = yes) [boolean yes|no]
If 'margingti' is set to yes, GTI for the intervals between TSTART and the earliest GTI START time, and between the last GTI STOP time and TSTOP, are created by the gtiinvert task.

(tstart = DEFAULT) [string]
Value (in seconds) to use for TSTART in the inverted (MXS off) GTI. The default is to use the value taken from the uninverted (MXS on) GTI.

(tstop = DEFAULT) [string]
Value (in seconds) to use for TSTOP in the inverted (MXS off) GTI. The default is to use the value taken from the uninverted (MXS on) GTI.

(dt = 0.0) [double]
Time gap [s] between input GTI times and corresponding inverted output GTI times. Output start times begin later than the input stop times by 'dt', and output stop times begin earlier than input start times by 'dt'.

(cleanup = yes) [boolean yes|no]
Delete temporary files if 'cleanup=yes'.

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

  1. The following command calculates GTI for the MXS using the default settings for mxsgti, mxstime, and gtiinvert. 
     mxsgti infilehk=sxs_a0.hk1 outfilehk=sxs_a0.hk1.out finegti=fine.gti coarsegti=coarse.gti \ 
timfile=hitomi_a0.tim delayfile=CALDB

SEE ALSO

mxstime, gtiinvert

LAST MODIFIED

August 2, 2024