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

158 APPENDIX D. BAT SOFTWARE TOOL REFERENCE
D.13.4 IMPORTANT NOTES
The mask tagged light curves are invalid during spacecraft slews. Mask tagged data during slews
should be ignored.
The generation of the output file will fail if the file is too large to fit the available memory.
D.13.5 PARAMETERS
infile [filename ]
Name of the raw mask tagged rate file, as described above.
quadfile [filename ]
Name of the input quadrant rate file.
maskwt [string ]
Name of mask weight map file. Normally, users should set the value to “INFILE” or “FILE”,
to indicate that the mask weight map is attached to the raw mask tagged light curve.
outfile [filename ]
Output light curve file name.
(detmask = “none”) [string ]
Optional input detector plane mask. This is used to exclude detectors that are disabled
from contributing to the light curves and errors. This file should always be a flight code
generated detector mask which represents only detectors actually turned off, rather than a
mask derived from ground processing. Typically, these files are found in files named like
obsid/bat/hk/swNNNNNNNNNNNbdecb.fits.
(ebounds = “INFILE”) The location of the EBOUNDS file describing the energy ranges in
the light curves. The default is to use an EBOUNDS extension that is part of the infile (use
“INFILE” or “FILE”). One can also specify “CALDB” if the EBOUNDS extension is not
present.
(corrections = “default”) [string ]
Comma-separated list of corrections to apply to the mask weighting, or “none” if no corrections
are to be applied. Other possible correction types are: “flatfield” (basic flat fielding
correction accounting for both cosine-type and r-squared-type effects); “cosine” (cosine effects
of off-axis illumination only); “pcode” (partial coding effect only); “ndets” (correction
for disabled detectors). The “default” correction is pcode,flatfield,ndets.
(detdiv = “YES”) [string ]
Do you want the rate to be per detector (detdiv=“YES”) or for the whole array (detdiv=“NO”).
The division is only applied if the corrections parameter includes “ndets”. Note
that if no detector mask is supplied, then the rate will be divided by the total number of
detectors (32768).
(scale = 1.3) [real ]
The user is allowed to supply a scale factor to correct for any known errors in how the raw
mask-tagged light curve is calculated. The scale factor is multiplicative and scales all output
counts by the same factor. The default value of this parameter was determined empirically