The SWIFT BAT Software Guide Version 6.3 30 ... - HEASARC - Nasa

98 APPENDIX D. BAT SOFTWARE TOOL REFERENCE
(ecol = PI) [string ]
Column name to use for the energy value. The default is the energy computed in the “PI”
column, but it is possible to choose another column name such as “PHA”.
(weighted = INDEF) [string ]
Set to boolean yes or no (or INDEF), depending on whether mask weighting should be applied
to the binning operation. A value of “no” indicates that all counts should be unweighted
(unity weight). A value of INDEF depends on outtype. If outtype is LC or PHA, then
INDEF signifies that “yes,” weighting should be applied; for output types DPH, DPI or
DPITAB, then INDEF means “no” weighting should be applied.
(outunits = INDEF) [string ]
Set to RATE, COUNTS or INDEF, depending on whether the output histogram units should
be “count/s”, “count”, or automatically determined (INDEF). When INDEF is specified,
outunit depends on outype. If outtype is LC or PHA, then INDEF signifies “RATE;” for
output types DPH, DPI or DPITAB, then INDEF means “COUNTS.” Note that not all
combinations are meaningful.
(timepixr = -1.0) [real ]
Determines the reference point of each time bin for light curves only. A value of 0.0 (0.5)
indicates that the TIME column refers to the start (center) of each time bin. A special
value of -1 (the default) specifies that timepixr=0.0 for uniformly binned light curves and
timepixr=0.5 for non-unformly binned light curves. This parameter does not have any affect
for spectra, images or DPHs.
(maskwt = NONE) [string ]
Mask weight map file. This file should contain a mask weight image for the detector plane,
and if given, overrides any mask weighting found in the infile.
(tstart = INDEF) [string ]
Start time of the accumulation, in seconds, expressed in Mission Elapsed Time. Default value
(INDEF) implies using the TSTART/TSTOP keywords from the input file.
(tstop = INDEF) [string ]
Stop time of the accumulation, in seconds, expressed in Mission Elapsed Time. Default value
(INDEF) implies using the TSTART/TSTOP keywords from the input file.
(snrthresh = 6.0) [real ]
For the constsnr binning method, the signal to noise ratio to require for each time bin. If
there is more than one energy bin selected, the threshold refers to the signal to noise ratio
for the sum of all energy bins.
(detmask = “NONE”) [string ]
Name of a detector quality map file. This should be an image file with the same dimensions
as the detector plane map. A pixel value of 0 indicates the detector is enabled for imaging,
and a non-zero value indicates disabled. A default value of NONE implies all detectors are
on, except for the BAT detector gap regions.
(tcol = “TIME”) [string ]
Name of TIME column in input file.