30.01.2013 Views

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

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

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

(rows=“-”) [string ]<br />

<strong>The</strong> row numbers in the input DPH which are to be included in the output. Row numbers<br />

in a DPH correspond to different time intervals. <strong>The</strong> rows are expressed as a series of ranges<br />

separated by commas, e.g. “1, 3-5, 9-10”.<br />

(outdatatype=“FLOAT”) [string ]<br />

Data type of the output histograms. One of “SHORT”, “INT”, “FLOAT”, or “DOUBLE”.<br />

Choosing an integer type will result in the wholecount parameter to be set to YES.<br />

(clobber=“no”) [boolean ]<br />

If the output file already exists, then setting “clobber = yes” will cause it to be overwritten.<br />

(chatter = 1) [integer, 0 - 5 ]<br />

Controls the amount of informative text written to standard output. Setting chatter = 4<br />

or higher will produce detailed diagnostic output; chatter = 1 prints out a basic diagnostic<br />

message. <strong>The</strong> default is to produce a brief summary on output.<br />

(history = YES) [boolean ]<br />

If history = YES, then a set of HISTORY keywords will be written to the header of the<br />

specified HDU in the output file to record the value of all the bateconvert task parameters<br />

that were used to produce the output file.<br />

D.7.5 EXAMPLES<br />

Note that when commands are issued on the Unix command line, strings containing special characters<br />

such as ‘[’ or ‘]’ must be enclosed in single or double quotes.<strong>The</strong> following examples illustrate<br />

ways in which baterebin can be used.<br />

1. Rebin all rows in a DPH file choosing boundaries to the energy bins different from the<br />

nominal boundaries in the input file.<br />

baterebin {infile} {outfile} {calfile} {residfile} {pulserfile} outefile={outefile} rows=-<br />

2. Rebin the 2nd to 10th rows in a DPH file assigning fractional counts to bins as appropriate.<br />

baterebin {infile} {outfile} {calfile} {residfile} {pulserfile} rows=2-10<br />

3. Rebin the third row in a DPH file moving only whole numbers of events from a bin.<br />

baterebin {infile} {outfile} {calfile} {residfile} {pulserfile} wholecount=yes rows=3<br />

D.7.6 SEE ALSO<br />

bateconvert – energy calculation for event files<br />

D.7.7 LAST MODIFIED<br />

Apr 2007

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

Saved successfully!

Ooh no, something went wrong!