NAME

hxisgddtime - Calculate and correct Hitomi HXI and SGD spectra and light curves for deadtime.

USAGE

hxisgddtime infile inlcfile inspectfile outlcfile outspecfile gtifile

DESCRIPTION

The hxisgddtime task calculates the dead time for either HXI or SGD spectra or light curves. The task takes as input, a light curve or spectral file to be corrected, a file (or a list of files) containing the pseudo events, and the GTI file used to produce the input light curve or spectral file. The pseudo-event file (or list of files) is first screened using the science GTI to ensure simultaneity.

For the light curve correction the pseudo events are binned with the same bin time as for the science data. For each bin the dead time is calculated as dead time = (RATE*TIMEDEL*FRACEXP)/(PSEUDOHZ*TIMEDEL*FRACEXP), where the RATE is the count/s in the bin, TIMEDEL is the integration time, FRACEXP is the fractional exposure for each bin, and PSUEDOHZ is the frequency with which the pseudo events are injected in the data stream. The dead time values are applied to the RATE, ERROR, and FRACEXP columns of the science light curve, and the results are stored in the three new columns: RATE_CORR, ERROR_CORR, and FRAC_CORR, respectively.

For the spectral correction the dead time is derived as the total number of events in the pseudo files divided by PSUEDOHZ*GTI, where PSUEDOHZ is the frequency with which the pseudo events are injected in the data stream, and GTI is the sum of the science GTI. The dead time value is applied to the exposure time of the spectrum.

If parameter merge is set to yes (the default), the task merges the light curves and/or spectra

PARAMETERS

infile = in.fits [filename]
Input pseudo event file (or @ file list).

inlcfile = in.lc [filename]
Input light curve file (or @ file list).

inspecfile = in.pi [filename]
Input spectral file (or @ file list).

outlcfile = out [filename]
Output file root name for light curve.

outfile = out [filename]
Output file root name for spectra and response.

gtifile = in.gti [filename]
Input science GTI file (or @ file list).

(rspfile = in.rsp) [filename]
Input response file (or @ file list).

(phaseinfo = 400000,1.5,0-1) [string]
Phase filter information in spectra. The three values in order are: epoch, period, and phase. If 'phaseinfo=NONE", the phase filter information is not used.

(merge = yes) [boolean yes|no]
If 'merge=yes', the output light curves and/or spectra are merged.

(expr = NONE) [string]
Additional expression to select good events.

(mintimedel = 16) [double]
Minimum TIMEDEL for dead time using pseudo events.

(rspweight = 0.5,0.5) [string]
Weight factors for addrmf

(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 tool parameters in HISTORY.

EXAMPLES

1. Calculates dead time for HXI and creates a light curve and a spectrum.

   hxisgddtime infile=infile inlcfile=inlcfile inspecfile=inspectfile outlcfile=outlcfile outfile=outfile merge=no

SEE ALSO

LAST MODIFIED

February 22, 2024