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

120 APPENDIX D. BAT SOFTWARE TOOL REFERENCE
– All: The entire array is balanced (1 balancing of 32768 detectors).
– Module: Each of the 256 detector modules is separately balanced.
– InOut: Each module has its inner detectors balanced and in separate operations, its
outer detectors balanced.
– Edges: Each module has only its outer (or edge) detectors balanced.
– LongEdges: There are 32 balancings of the long edges of all modules in a row across the
array.
– ShortEdges: There are 32 balancings of the short edges of all modules in a column across
the array.
– flight: Reproduce the flight code balancing, by doing first the Edges, then the InOut
balancing.
There is further illumination of the balancing in the comments in the code.
(balfirst) = “no” [boolean ]
Normally, balancing is done after cleaning. However, by setting this parameter to “yes” then
balancing can be done before cleaning.
(maskfit) = “no” [boolean ]
If this parameter is set to “YES” and outversion=“fit” then the output file contains the fit
parameters for all detectors even those masked using a detmask. The default behavior is that
the fit is output only for unmasked detectors. Detectors will still masked for cleaning and
balancing when this option is selected.
(leadedge) = “NO” [boolean ]
If this parameter is set to “YES,” then the leading edge detectors (those on the two edges
of detector module sides facing toward the source) are fit separately from the rest of the
detectors. Since the current forward projection code does not correctly handle these edge
detectors, setting this parameter does not significantly affect the overall clean.
(eff edge) = 0.2 [float ]
The depth of edge (cm) to consider effective. Range from 0.03 to 0.2
(corrections = “none”) [string ]
Comma-separated list of corrections to apply to the mask weighting, or “none” if no corrections
are to be applied. Note that corrections are only applied to the forward projection for
sources. This parameter has no effect if only the background is to be cleaned.
• Possible correction types are: “flatfield” (basic flat fielding correction accounting for both
cosine-type and r-squared-type effects); “nearfield” (for ground testing results where the
source is at a finite distance – requires bat z != 0); “cosine” (cosine effects of off-axis illumination
only); “rsquare” (r-squared effects only); “opaque” (activates a new algorithm for
calculating the mask transmission function); “sides” (effects of sides of detectors XXX not
implemented).
(outversion) = “cleaned” [string ]
This optional parameter indicates what detector plane image is written to the outfile. The
default is to write the cleaned DPI (input minus fit). Other options are: