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

D.3. BATCLEAN 121
• original: Write the input DPI filtered by the detector mask.
• fit: Write the fit DPI.
• bkgcleaned: Write the background cleaned DPI (input minus fit to background only).
• bkgfit: Write the fit to the background only.
• Choice of outversion parameter dictates what value is written to the HDUCLAS2 keyword.
Possible values are:
– original: HDUCLAS2 is unchanged
– cleaned or bkgcleaned: HDUCLAS2 = RESIDUAL
– fit or bkgfit: HDUCLAS2 = PREDICTED
(clobber = NO) [boolean ]
If the output file already exists, then setting “clobber = yes” will cause it to be overwritten.
(chatter = 1) [integer, 0 - 5 ]
Controls the amount of informative text written to standard output. Setting chatter = 4
or higher will produce detailed diagnostic output; chatter = 2 prints out a basic diagnostic
message. The default is to produce no printed output.
(history = NO) [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 ftcopy task parameters that
were used to produce the output file.
D.3.5 EXAMPLES
Note that when commands are issued on the Unix command line, strings containing special characters
such as ‘[’ or ‘]’ must be enclosed in single or double quotes.The following examples illustrate
ways in which batclean can be used.
1. Fit the simple background model to a DPI with a detector mask file. Output the cleaned
DPI and a background exposure map.
batclean input.dpi cleaned.dpi detmask=bat.mask backexp=backexp2.dph
srcclean=NO
2. Fit a set of source models along with a simple background model to a DPI, using the default
aperture file. Output the fit to the focal plane instead of the cleaned focal plane. A flat-fielding
correction is applied in the forward projection.
batclean input.dpi fit.dpi catalog.tbl detmask=bat.mask outversion="fit"
corrections="flatfield"
3. Fit two user-supplied background models in addition to the hard-coded model.