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.1. BATBINEVT 99 (countscol = “DPH COUNTS”) [string ] Name of counts column column in input file (column ‘DPH COUNTS’ containing detector counts histogram when reading DPH data). (xcol = “DETX”) [string ] Name of X column in input file (event data). (ycol = “DETY”) [string ] Name of Y column in input file (event data). (maskwtcol = “MASK WEIGHT”) [string ] Name of MASK WEIGHT column in input file (event data). (ebinquant = 0.1) [real ] Default energy bin quantization, in keV, if none is specified in the input event file. Most BAT input events are quantized with 0.1 keV step sizes using the TSCALn keyword. If no such keywords are found, then ebinquant is used. This value should represent the minimum possible energy bin size of the instrument. (delzeroes = “NO”) [boolean ] Delete time bins with zero flux? If yes, then any bin which has no counts, or all counts with zero weights, will be removed from the output. For multi-channel output data types, the time bin will only be deleted if all spatial/spectral bins contain zero. If delzeroes=“NO”, then the output may contain bins with zero flux. The error bars will be zero too for those cases, which may cause subsequent processing to fail. (minfracexp = 0.1) [real ] The minimum fractional exposure. Time bins with smaller fractional exposure are deleted before creating the output. To preserve all time bins, even bins with zero exposure, set minfracexp=0. Bins with no exposure will have null COUNTS / RATE. (min dph frac overlap = 0.999) [real ] The minimum fractional exposure per individual DPH in the input file. The combined set of all good time intervals must fractionally overlap with a DPH by at least mindphfracoverlap, or else the DPH row is rejected. The default value of 0.999 allows for a small non-overlap as well as numerical round-off issues. (min dph time overlap = 0) [real ] The minimum time overlap, in seconds, per individual DPH in the input file. The combined set of all good time intervals must overlap with the DPH by at least mindphtimeoverlap duration, or else the DPH row is rejected. This is also equivalent to a filter on the minimum exposure time per individual DPH. The default value of 0 indicates that any number of seconds is allowed – but the fractional overlap test (mindphfracoverlap) must also pass. (max dph time nonoverlap = 0.5) [real ] The maximum non-overlap time, in seconds, allowed per individual DPH in the input file. After intersecting the combined set of all good times and the individual DPH time interval, the remaining non-overlapping time must be no more than maxdphtimenonoverlap seconds, or else the DPH row is rejected. A larger number is a more liberal acceptance criterium. The default value of 0.5 seconds, allows for a small amount of non-overlap between the good time intervals and the survey DPH.

100 APPENDIX D. BAT SOFTWARE TOOL REFERENCE (buffersize = 32768) [integer ] Size of internal event buffer for processing. (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 of the task actions; 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.1.5 EXAMPLES MAKING LIGHT CURVES from EVENT DATA 1. Uniform binning of 0.1 seconds in the 15-195 keV energy range (light curve is weighted i.e. background subtracted) batbinevt infile.evt outfile.lc LC 0.1 uniform 15-195 (“uniform” binning means uniformly sampled (=0.1s) bins) 2. Two-band light light curve for 15-50 and 50-195 keV (otherwise same as above) batbinevt infile.evt outfile.lc LC 0.1 uniform 15-50,50-195 (the energy bins can be specified as either an ASCII list or a file name with the energy bins) 3. Binning by constant signal to noise (threshold = 6 sigma) batbinevt infile.evt outfile.lc LC 0 snr 15-195 snrthresh=6.0 (When the “snr” time binning method is specified, a zero time binning is ignored.) 4. Binning by constant signal to noise (threshold = 6 sigma, maximum bin size of 10 seconds) batbinevt infile.evt outfile.lc LC 10 snr 15-195 snrthresh=6.0 (When the “snr” time binning method is specified, a non-zero time binning indicates the maximum bin size that is imposed.) 5. Selecting the times by hand (0.1 second uniform bins, 15-195 keV)

D.1. <strong>BAT</strong>BINEVT 99<br />

(countscol = “DPH COUNTS”) [string ]<br />

Name of counts column column in input file (column ‘DPH COUNTS’ containing detector<br />

counts histogram when reading DPH data).<br />

(xcol = “DETX”) [string ]<br />

Name of X column in input file (event data).<br />

(ycol = “DETY”) [string ]<br />

Name of Y column in input file (event data).<br />

(maskwtcol = “MASK WEIGHT”) [string ]<br />

Name of MASK WEIGHT column in input file (event data).<br />

(ebinquant = 0.1) [real ]<br />

Default energy bin quantization, in keV, if none is specified in the input event file. Most<br />

<strong>BAT</strong> input events are quantized with 0.1 keV step sizes using the TSCALn keyword. If no<br />

such keywords are found, then ebinquant is used. This value should represent the minimum<br />

possible energy bin size of the instrument.<br />

(delzeroes = “NO”) [boolean ]<br />

Delete time bins with zero flux? If yes, then any bin which has no counts, or all counts with<br />

zero weights, will be removed from the output. For multi-channel output data types, the time<br />

bin will only be deleted if all spatial/spectral bins contain zero. If delzeroes=“NO”, then the<br />

output may contain bins with zero flux. <strong>The</strong> error bars will be zero too for those cases, which<br />

may cause subsequent processing to fail.<br />

(minfracexp = 0.1) [real ]<br />

<strong>The</strong> minimum fractional exposure. Time bins with smaller fractional exposure are deleted<br />

before creating the output. To preserve all time bins, even bins with zero exposure, set<br />

minfracexp=0. Bins with no exposure will have null COUNTS / RATE.<br />

(min dph frac overlap = 0.999) [real ]<br />

<strong>The</strong> minimum fractional exposure per individual DPH in the input file. <strong>The</strong> combined set of<br />

all good time intervals must fractionally overlap with a DPH by at least mindphfracoverlap,<br />

or else the DPH row is rejected. <strong>The</strong> default value of 0.999 allows for a small non-overlap as<br />

well as numerical round-off issues.<br />

(min dph time overlap = 0) [real ]<br />

<strong>The</strong> minimum time overlap, in seconds, per individual DPH in the input file. <strong>The</strong> combined<br />

set of all good time intervals must overlap with the DPH by at least mindphtimeoverlap<br />

duration, or else the DPH row is rejected. This is also equivalent to a filter on the minimum<br />

exposure time per individual DPH. <strong>The</strong> default value of 0 indicates that any number of<br />

seconds is allowed – but the fractional overlap test (mindphfracoverlap) must also pass.<br />

(max dph time nonoverlap = 0.5) [real ]<br />

<strong>The</strong> maximum non-overlap time, in seconds, allowed per individual DPH in the input file.<br />

After intersecting the combined set of all good times and the individual DPH time interval,<br />

the remaining non-overlapping time must be no more than maxdphtimenonoverlap seconds,<br />

or else the DPH row is rejected. A larger number is a more liberal acceptance criterium. <strong>The</strong><br />

default value of 0.5 seconds, allows for a small amount of non-overlap between the good time<br />

intervals and the survey DPH.

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

Saved successfully!

Ooh no, something went wrong!