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

D.6. BATECONVERT 131
LIN GAIN and LIN OFFSET columns, contain the cubic fit itself rather than the residuals of
the cubic from the linear fit, and the GAINMETH keyword is FULLCUBIC. If zeroit==YES
or CALMODE==LINEAR then the residfile need not exist and residfile can be set to NONE
(or left off the command line).
(pulserfile=“CALDB”) [string ]
Name of the file that contains the pulser DAC to energy calibration coefficients, or “CALDB”
to search CALDB. These are the best known coefficients derived from ground calibration
efforts. Only used for QUADRATIC correction; pulsercal=NONE is allowed for the LINEAR
correction case.
(fltpulserfile=“CALDB”) [string ]
Name of the file that contains the pulser DAC to energy calibration coefficients, or CALDB;
this should be the as-flown coefficients at the time of the observation. Only used for
QUADRATIC correction; pulsercal=NONE is allowed for the LINEAR correction case.
(outfile) [filename ]
Output file name. If an output file name is given,bateconvert will create a new file which is a
copy of the input file with the PI and ENERGY columns filled in. The input file will remain
unchanged. Precede the output file name with an exclamation point, “!”, (or “\ !” on the
Unix command line), to overwrite a preexisting file with the same name (or set the clobber
parameter to YES).
(calmode=INDEF) [string ]
The calibration mode. The currently supported options are LINEAR, QUADRATIC, CUBIC,
DIRECTCUBIC, and FIXEDDAC. If LINEAR is chosen, no residfile is needed, otherwise, the
keyword GAINMETH in residfile must correspond to the calmode. If calmode == INDEF,
the mode will be chosen based on the keyword in the residfile. FIXEDDAC is the preferred
mode for accurate energy correction. LINEAR is provided to do the same correction as is
done by the flight software before the events are binned in a DPH. A linear fit applies two
parameters, gain and offset using the formula: ENERGY=GAIN*(OFFSET-PHA). The other
fits perform the linear fit and then adds in a residual to correct for the deviation of the true
fit from linearity, except for DIRECTCUBIC. DIRECTCUBIC computes the energy from
the cubic pre-flight DAC to ADU fit and the values in pulserfile alone, ignoring the changes
indicated by changes in the peaks of the pulser as a function of DAC value in flight.
(zeroit=NO) [boolean ]
An optional parameter requesting bateconvert to set all values in the PI and ENERGY
columns to zero instead of calculating the energy conversion. If zeroit==YES, then calfile
can equal NONE.
(scaled energy=YES) [boolean ]
If YES (default), then the ENERGY column is written as 16-bit integers with a TSCAL scale
factor which converts to keV. If NO, 32-bit floating point values are written directly. The
default is YES to conserve disk space.
(clobber = NO) [boolean ]
If the output file already exists, then setting “clobber = yes” will cause it to be overwritten.