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

D.3. BATCLEAN 119
• The user can also use this parameter to supply a file or list of files containing user-developed
background models to be fit. This can be input as either a comma-separated list of model
files or a text file (preceded by the “@” symbol) containing a list of input model files, one per
line. These model files must be image files in the same format as a BAT DPI (286 columns
by 173 rows). There are no required keywords. If a model file is not found or is not an
image file, the code will ignore it. The comment fields of the BGPARnn keywords contain
the model names. If an optional MODNAME is supplied, then its value becomes the model
name in the comment field. If this keyword is not present, then the model name is the name
of the file (not including the path). The default behavior of the code is to fit the simple
model in addition to any user supplied models. The user does not need to also include the
string “simple” in the bkgmodel parameter list. If, however, the user wishes to fit ONLY the
user-supplied models and not the simple model, then he can request this by adding the string
“useronly” to the bkgmodel parameter list. See examples below. Finally, it is possible not to
fit any model at all, but simply to balance the array (using the balance parameter below. To
do this set bkgmodel=none. Note that if the user selects outversion=“fit” or “bkgfit”, then
no balancing is performed regardless of the value of the balanceparameter.
(srcclean) = “YES” [boolean ]
Determines whether sources are cleaned from the input DPI or only background. If this
parameter is “YES,” then an incatalog andaperture file must be supplied.
(cleansnr) = 6.0 [real ]
Only sources with a signal-to-noise ratio as read from the incatalog higher than this value are
cleaned from the DPI. If no sources have a signal-to-noise ratio above the cleansnrvalue, then
only the background will be cleaned.
(snrcol = “SNR”) [string ]
Name of catalog column to be used with ‘cleansnr’ for signal to noise thresholding. By default
it is “SNR”, but any column can be used to trigger cleaning.
(ignore) = “UNKNOWN” [string ]
Unless this parameter is set to “NONE” or “none,” the cleaning code will not clean any
source in incatalog whose NAME matches theignore string. The user can either specify a
particular source name, the strings “IGNORE” or “NONE”, or the name of a file (preceded
by “@”). If a file name is supplied, then the file must contain a list of sources to be ignored,
once source per line. Note that source names to be ignored must match exactly (including
spaces, capitalization, etc.) the names in the catalog.
(balance) = “none” [string ]
Unless this parameter is set to “NONE” or “none,” the cleaning code will, after cleaning,
also balance the entire array or subsets of the array as specified below. Balancing means
subtracting the mean for a set of detectors from the values for that set of detectors. In other
words, it sets the average for the detectors to zero. If a detector mask (detmask) is given,
then only non-masked detectors are included in the balancing.
• The balancing that is requested is given by supplied a comma-separated list of any or all of
the following values. The balance is performed in the order in which the values are listed.
Balancing is not commutative, so order is significant. Allowed balance values:
– none: No balancing.