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

110 APPENDIX D. BAT SOFTWARE TOOL REFERENCE
map need not be an actual partial coding map; any quantity that can be thresholded (even
a map of 0s and 1s) can be used. If pcode file is “NONE”, then the entire image is searched.
(pcodethresh=0.01) [real ]
Partial coding threshold for source detection. This threshold is applied to the map specified
in pcodefile. Any partial coding value greater than pcodethresh is considered active for the
purposes of source detection.
(bkgpcodethresh=-1) [real ]
Partial coding threshold for background analysis. This threshold is applied to the map specified
in pcodefile. Any partial coding value greater than bkgpcodethresh is considered active
for the purposes of measuring the backgroud and its variance. A value of -1 indicates that
bkgpcodethresh should be set to pcodethresh. The “source” and “background” thresholds
are kept separately so that background analysis can be done over a wider area than the source
acceptance region.
(pospeaks=YES) [boolean ]
Constrain newly detected peaks to be positve. If NO, then significant positive or negative
deviations will be searched for. Known catalogged sources are permitted to have a negative
fitted flux regardless of pospeaks.
(vectorflux=NO) [boolean ]
If YES, then output flux values for a given source as a vector, one element for each input
image. If NO, then output one catalog rows for each source in each input image. Note, for
vectorflux=YES, the input images must all match their coordinate systems, exposure, and
instrument configuration exactly.
(rows = “-”) [string ]
An index list of images to operate on. This is a standard comma-separated list of image
ranges, starting with image number 1. Image number 1 corresponds to the primary extension
of the input FITS file, 2 to the next extension, and so on. A range of “-” indicates all
images should be processed. Thus, this parameter really selectsimage extension numbers
to operate on rather than binary table rows.
(niter=2) [integer ]
Number of iterations of source detection to perform. niter=0 is allowed; in that case the
sources in the input catalog (if any) which are in the field of view are transferred to the
output catalog.
(carryover=YES) [boolean ]
For the analysis of multiple images. If YES, then carry over the sources detected in the
analysis of earlier images to the analysis of later images. Positions of previously detected
new sources are held fixed as described above. If NO, then the analysis of each image begins
from scratch, excluding any previously detected sources. Note that carryover=NO and
vectorflux=YES are contradictory.
(nadjpix=3) [integer ]
Minimum number of adjacent pixels required for source detection. This serves to decrease the
number of false detections. This quantity is somewhat dependent on the image oversampling
used.