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

184 APPENDIX D. BAT SOFTWARE TOOL REFERENCE
D.20 BATUPDATEPHAKW
D.20.1 NAME
batupdatephakw - update BAT ray tracing columns in spectral files
D.20.2 USAGE
batupdatephakw infile auxfile
D.20.3 DESCRIPTION
batupdatephakw updates the BAT ray tracing columns in a mask weighted spectrum. This is
important especially for gamma-ray bursts or other events where the spacecraft has slewed. Without
the update, the keywords will reflect the ray tracing status at the end of the event data set, which
will lead to an erroneous detector response matrix.
The ray tracing quantities that are updated are: MSKWTSQF, NGOODPIX, PCODEFR,
BAT XOBJ, BAT YOBJ, BAT ZOBJ.
This script modifies the spectral file in place. Thus, the spectrum must be writeable and not
compressed. New columns are created if they are not already present. If keywords with the same
name are present, then they are deleted (to prevent confusion with the columns).
This task requires the “auxiliary” file produce by batmaskwtevt, which contains the above
quantities as a function of time.
D.20.4 PARAMETERS
infile [filename ]
Input/output spectral file. The file should be a batbinevt-derived OGIP standard Type I or
Type II spectral file. The file should contain at least the TIME and EXPOSURE keywords.
The file is modified in place.
auxfile [filename ]
Name of the “auxiliary” ray trace file produced by batmaskwtevt. The times in the auxiliary
file should overlap with the times in the spectral file.
(chatter = 2) [integer, 0 - 5 ]
Controls the amount of informative text written to standard output.
D.20.5 EXAMPLES
1. Update the ray tracing columns in a spectral file named myspectrum.pha.