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.17. BATOCCULTMAP 177 (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.17.5 EXAMPLES 1. Computes the fractional exposure map for the primary HDU of sky.img. Good time intervals are subdivided so that the spacecraft attitude/earth/moon/sun do not move more than 3 arcmin (the default). batoccultmap sky.img occult.img sw00111622000sao.fits.gz \ method=position occultation=fraction D.17.6 SEE ALSO batoccultgti D.17.7 LAST MODIFIED Apr 2007

178 APPENDIX D. BAT SOFTWARE TOOL REFERENCE D.18 BATPHASYSERR D.18.1 NAME batphasyserr - apply BAT spectral systematic error vector D.18.2 USAGE batphasyserr infile syserrfile D.18.3 DESCRIPTION batphasyserr adds the BAT systematic error vector to a BAT spectral file. The systematic error vector contains an estimate of the fractional systematic error in each BAT spectral channel. Normally this information comes from the BAT calibration database (CALDB). The task handles the differences between type I and type II spectral files transparently. It also resamples the systematic error template to the energy bin edges of the input spectrum (this is done by pure averaging). D.18.4 PARAMETERS infile [filename ] Input/output spectral file. The file should be an OGIP-standard type I or type II spectral file. The DATE-OBS keyword is used to query the CALDB. The file is modified in place. If necessary, the SYS ERR column is created, and the SYS ERR keyword is deleted. syserrfile [filename ] Name of the systematic error vector file to use. Normally this should be set to “CALDB” so that the current best estimate of the BAT spectral systematic error is used for the date of the given infile. (chatter = 2) [integer, 0 - 5 ] Controls the amount of informative text written to standard output. D.18.5 EXAMPLES 1. Create the SYS ERR column in a spectral file named myspectrum.pha. batphasyserr myspectrum.pha CALDB The systematic error vector is retrieved from the calibration database.

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

D.18 <strong>BAT</strong>PHASYSERR<br />

D.18.1 NAME<br />

batphasyserr - apply <strong>BAT</strong> spectral systematic error vector<br />

D.18.2 USAGE<br />

batphasyserr infile syserrfile<br />

D.18.3 DESCRIPTION<br />

batphasyserr adds the <strong>BAT</strong> systematic error vector to a <strong>BAT</strong> spectral file. <strong>The</strong> systematic error<br />

vector contains an estimate of the fractional systematic error in each <strong>BAT</strong> spectral channel.<br />

Normally this information comes from the <strong>BAT</strong> calibration database (CALDB).<br />

<strong>The</strong> task handles the differences between type I and type II spectral files transparently. It also<br />

resamples the systematic error template to the energy bin edges of the input spectrum (this is done<br />

by pure averaging).<br />

D.18.4 PARAMETERS<br />

infile [filename ]<br />

Input/output spectral file. <strong>The</strong> file should be an OGIP-standard type I or type II spectral<br />

file. <strong>The</strong> DATE-OBS keyword is used to query the CALDB. <strong>The</strong> file is modified in place. If<br />

necessary, the SYS ERR column is created, and the SYS ERR keyword is deleted.<br />

syserrfile [filename ]<br />

Name of the systematic error vector file to use. Normally this should be set to “CALDB” so<br />

that the current best estimate of the <strong>BAT</strong> spectral systematic error is used for the date of<br />

the given infile.<br />

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

Controls the amount of informative text written to standard output.<br />

D.18.5 EXAMPLES<br />

1. Create the SYS ERR column in a spectral file named myspectrum.pha.<br />

batphasyserr myspectrum.pha CALDB<br />

<strong>The</strong> systematic error vector is retrieved from the calibration database.

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

Saved successfully!

Ooh no, something went wrong!