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

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

heasarc.nasa.gov
from heasarc.nasa.gov More from this publisher
30.01.2013 Views

D.2. BATCELLDETECT 111 (nullborder=NO) [boolean ] Allow sources which fall on the border of the image? If no, then sources whose “source window” overlaps with the edge of the image are ignored. The edge of the image is defined by the partial coding threshold. These sources may still appear in the output catalog with a DETECT STATUS value of -3. (bkgwindowtype=“circle”) [string ] Background window type, one of “circle” or “square”. (bkgradius=30) [integer ] Background window radius in pixels. For a window of “circle”, the bkgradius parameter is the radius of the circle. For a “square” window, the bkgradius is the half-width of the square. Actual diameter of circle or square is 2*bkgradius+1. (regionfile=NONE) [string ] Optional name of source detection region file. Upon output, sources listed in the outfile catalog are also written to a standard “region” file, which can then be read into image display programs such as fv/POW or SAO ds9. Output units are degrees. The radius of the circle is twice the PSF gaussian sigma radius. (srcradius=6) [integer ] Source radius in pixels. If 0, then the full background window is used to estimate the background and its standard deviation. Actual diameter of circle or square is 2*srcradius+1. (srcdetect=YES) [boolean ] If srcdetect is set to “YES”, then batcelldetect will attempt to detect new sources. If “NO”, then source detection is disabled, but source fitting of previously cataloged sources may still be performed (depending on the value of ‘srcfit’). (srcfit=YES) [boolean ] If srcfit is set to “YES”, then batcelldetect will fit newly detected and previously cataloged sources (if any) as described above. If “NO”, then previously determined positions and intensities are output. See “Fitting For Position and Flux” above. (posfit=NO) [boolean ] Posfit specifies whether batcelldetect fits the position ofalready known sources. See “Fitting For Position and Flux” above. (bkgfit=NO) [boolean ] Fit the background for each source individually? If yes, then during the PSF fitting stage, each source has an independent background level. If no, a fixed background is subtracted. (psfshape=“GAUSSIAN”) [string ] Shape of the point spread function to use. It should be one of “GAUSSIAN”, “PYRAMID” or “TRUNCONE”. “GAUSSIAN” is a two-dimensional gaussian function (which more closely matches the Swift/BAT point spread function in a single image); “PYRAMID” is a twodimensional pyramidal frustum with a square base (no longer recommended); “TRUNCONE” is a truncated cone (no longer recommended).

112 APPENDIX D. BAT SOFTWARE TOOL REFERENCE (psffwhm=“0.37413”) [string ] Full-width at half maximum of the point spread function, in units of degrees. By default, this is held fixed, but if “:FIT” is appended, then the width is fitted. The default value listed above applies to the BAT point spread function. (psftopwidth=“0.04584”) [string ] For the pyramidal point spread function, the full width of the top of the truncated pyramid, in units of degrees. By default, this is held fixed, but if “:FIT” is appended, then the width is fitted. The default value listed above applies to the BAT point spread function. (newsrcname=“UNKNOWN”) [string ] Name to be used for newly detected sources. This can be a C format string, whose interpretation depends on the value of the newsrcind parameter. If newsrcind is greater than or equal to zero, then newsrcname may contain a single “%d”-style C format code. Each new source is given a unique source number, starting with index newsrcind. If newsrcind is -1, then newsrcname may contain two “%f” C format codes for the RA and DEC position, in degrees. (newsrcind=1) [integer ] Starting index number to be used to label new sources (see newsrcname). If -1, then sources are labeled by their position on the sky. (signifmap=NONE) [string ] Optional output file name for the significance map. (bkgmap=NONE) [string ] Optional output file name for the mean background map. (bkgvarmap=NONE) [string ] Optional output file name for the background fluctuation map. (inbkgmap=NONE) [string ] Optional background map which overrides the internally-calculated background. The map or maps must have exactly the same structure and number of images as the input image file. If inbkgmap=ZERO, then the background is explicitly set to zero in the source detection stage. (inbkgvarmap=NONE) [string ] Optional background variation map which overrides the internally-calculated variation map. The map or maps must have exactly the same structure and number of images as the input image file. (distfile=CALDB) [string ] The ‘distfile’ parameter should point to a FITS file containing an MxNx2 image (or CALDB to use the default instrument correction in the calibration database). The two planes of the image are the non-linear distortion of the BAT “plate scale” as a function of position in the sky image. The values are offsets in tangent plane coordinates (IMX,IMY), and therefore unitless. The first plane of the image cube is the IMX offset, and the second plane is the IMY offset. The sense of the offset is (TRUE-APPARENT), i.e. for a measured position in tangent plane coordinates, the offset values should be *added* to arrive at the true position in tangent plane coordinates. The images are low-resolution versions of the BAT field of view

112 APPENDIX D. <strong>BAT</strong> SOFTWARE TOOL REFERENCE<br />

(psffwhm=“0.37413”) [string ]<br />

Full-width at half maximum of the point spread function, in units of degrees. By default,<br />

this is held fixed, but if “:FIT” is appended, then the width is fitted. <strong>The</strong> default value listed<br />

above applies to the <strong>BAT</strong> point spread function.<br />

(psftopwidth=“0.04584”) [string ]<br />

For the pyramidal point spread function, the full width of the top of the truncated pyramid,<br />

in units of degrees. By default, this is held fixed, but if “:FIT” is appended, then the width<br />

is fitted. <strong>The</strong> default value listed above applies to the <strong>BAT</strong> point spread function.<br />

(newsrcname=“UNKNOWN”) [string ]<br />

Name to be used for newly detected sources. This can be a C format string, whose interpretation<br />

depends on the value of the newsrcind parameter. If newsrcind is greater than or<br />

equal to zero, then newsrcname may contain a single “%d”-style C format code. Each new<br />

source is given a unique source number, starting with index newsrcind. If newsrcind is -1,<br />

then newsrcname may contain two “%f” C format codes for the RA and DEC position, in<br />

degrees.<br />

(newsrcind=1) [integer ]<br />

Starting index number to be used to label new sources (see newsrcname). If -1, then sources<br />

are labeled by their position on the sky.<br />

(signifmap=NONE) [string ]<br />

Optional output file name for the significance map.<br />

(bkgmap=NONE) [string ]<br />

Optional output file name for the mean background map.<br />

(bkgvarmap=NONE) [string ]<br />

Optional output file name for the background fluctuation map.<br />

(inbkgmap=NONE) [string ]<br />

Optional background map which overrides the internally-calculated background. <strong>The</strong> map or<br />

maps must have exactly the same structure and number of images as the input image file. If<br />

inbkgmap=ZERO, then the background is explicitly set to zero in the source detection stage.<br />

(inbkgvarmap=NONE) [string ]<br />

Optional background variation map which overrides the internally-calculated variation map.<br />

<strong>The</strong> map or maps must have exactly the same structure and number of images as the input<br />

image file.<br />

(distfile=CALDB) [string ]<br />

<strong>The</strong> ‘distfile’ parameter should point to a FITS file containing an MxNx2 image (or CALDB<br />

to use the default instrument correction in the calibration database). <strong>The</strong> two planes of the<br />

image are the non-linear distortion of the <strong>BAT</strong> “plate scale” as a function of position in the<br />

sky image. <strong>The</strong> values are offsets in tangent plane coordinates (IMX,IMY), and therefore<br />

unitless. <strong>The</strong> first plane of the image cube is the IMX offset, and the second plane is the<br />

IMY offset. <strong>The</strong> sense of the offset is (TRUE-APPARENT), i.e. for a measured position in<br />

tangent plane coordinates, the offset values should be *added* to arrive at the true position<br />

in tangent plane coordinates. <strong>The</strong> images are low-resolution versions of the <strong>BAT</strong> field of view

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!