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

114 APPENDIX D. BAT SOFTWARE TOOL REFERENCE
Controls the sort order of the table displayed on the console. Note that this does not affect
the FITS table, which can be sorted using ftsort or fsort. The string should be a commaseparated
list of sort keys, or “NONE” for arbitrary printed order. The first key listed is
the primary sort key, the next is the secondary and so on. By default, values are printed
from lowest to highest, but a preceding ‘-’ sign indicates highest to lowest. The following sort
keys are available: NAME; RA OBJ; DEC OBJ; SNR; RATE; COUNTS; FLUX (all three
of these keys are synonymous); KNOWN (if the sources appears in the input catalog or not);
IMX; IMY; PCODEFR; CATNUM; THETA; PHI; SNR/UNKNOWN. Most sort keys are
identical to their corresponding catalog column, described above. “SNR/UNKNOWN” is a
special sort key, indicating to sort only previously unknown columns by SNR. The default
sortcolumns indicate to arrange the table by printing the known sources first, sorted by RA,
and then the unknown sources, arranged in descending order by signal to noise ratio.
(keepbadsources = NO) [boolean ]
If yes, then individual sources are kept in the output catalog, even if DETECT STATUS
is non-zero, indicating a failure of some kind. If no, then any output catalog entry with
DETECT STATUS non-zero is removed.
(ptcorrel = “NONE”) [string ]
Account for pixel to pixel correlations during the fit. Either NONE (straight PSF fitting); PSF
(use PSF for correlations); or GAUSSIAN[x] (where x is the FWHM of the correlation function
in degrees).NOTE: This parameter is not tested and may produce unexpected
results!
(clobber = NO) [boolean ]
If the output file already exists, then setting “clobber = yes” will cause it to be overwritten.
(chatter = 2) [integer, 0 - 5 ]
Controls the amount of informative text written to standard output. Setting chatter = 1 produces
a basic summary, including a list of detected sources; chatter = 2 (default) additionally
prints a summary of input parameters; chatter = 5 prints debugging information.
(history = YES) [boolean ]
If history = YES, then a set of HISTORY keywords will be written to the header of the
specified HDU in the output file to record the value of all the task parameters that were used
to produce the output file.
D.2.7 EXAMPLES
1. Performs source detection on skyimage.img, finding those sources which exceed the background
by 6 sigma. The output is written to srclist.fits. The default circular background window is used.
batcelldetect skyimage.img srclist.fits 6.0
2. Same as example 1, but use a square background window of half-width 10 pixels.
batcelldetect skyimage.img srclist.fits 6.0 \
bkgwindowtype=square bkgradius=10