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

Recommendations

Info

D.6. BATECONVERT 131 LIN GAIN and LIN OFFSET columns, contain the cubic fit itself rather than the residuals of the cubic from the linear fit, and the GAINMETH keyword is FULLCUBIC. If zeroit==YES or CALMODE==LINEAR then the residfile need not exist and residfile can be set to NONE (or left off the command line). (pulserfile=“CALDB”) [string ] Name of the file that contains the pulser DAC to energy calibration coefficients, or “CALDB” to search CALDB. These are the best known coefficients derived from ground calibration efforts. Only used for QUADRATIC correction; pulsercal=NONE is allowed for the LINEAR correction case. (fltpulserfile=“CALDB”) [string ] Name of the file that contains the pulser DAC to energy calibration coefficients, or CALDB; this should be the as-flown coefficients at the time of the observation. Only used for QUADRATIC correction; pulsercal=NONE is allowed for the LINEAR correction case. (outfile) [filename ] Output file name. If an output file name is given,bateconvert will create a new file which is a copy of the input file with the PI and ENERGY columns filled in. The input file will remain unchanged. Precede the output file name with an exclamation point, “!”, (or “\ !” on the Unix command line), to overwrite a preexisting file with the same name (or set the clobber parameter to YES). (calmode=INDEF) [string ] The calibration mode. The currently supported options are LINEAR, QUADRATIC, CUBIC, DIRECTCUBIC, and FIXEDDAC. If LINEAR is chosen, no residfile is needed, otherwise, the keyword GAINMETH in residfile must correspond to the calmode. If calmode == INDEF, the mode will be chosen based on the keyword in the residfile. FIXEDDAC is the preferred mode for accurate energy correction. LINEAR is provided to do the same correction as is done by the flight software before the events are binned in a DPH. A linear fit applies two parameters, gain and offset using the formula: ENERGY=GAIN*(OFFSET-PHA). The other fits perform the linear fit and then adds in a residual to correct for the deviation of the true fit from linearity, except for DIRECTCUBIC. DIRECTCUBIC computes the energy from the cubic pre-flight DAC to ADU fit and the values in pulserfile alone, ignoring the changes indicated by changes in the peaks of the pulser as a function of DAC value in flight. (zeroit=NO) [boolean ] An optional parameter requesting bateconvert to set all values in the PI and ENERGY columns to zero instead of calculating the energy conversion. If zeroit==YES, then calfile can equal NONE. (scaled energy=YES) [boolean ] If YES (default), then the ENERGY column is written as 16-bit integers with a TSCAL scale factor which converts to keV. If NO, 32-bit floating point values are written directly. The default is YES to conserve disk space. (clobber = NO) [boolean ] If the output file already exists, then setting “clobber = yes” will cause it to be overwritten.
132 APPENDIX D. BAT SOFTWARE TOOL REFERENCE (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 = 1 prints out a basic diagnostic message. The default is to produce a brief summary on output. (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 bateconvert task parameters that were used to produce the output file. D.6.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 bateconvert can be used. 1. Apply a linear conversion to convert from PHA (ADUs) to ENERGY (keV). The input file is updated with the PI and ENERGY columns filled in. bateconvert infile=’events.fits’ calfile=’cal.fits’ residfile=NONE pulserfile=NONE calmode=LINEAR -or- bateconvert events.fits cal.fits NONE NONE calmode=LINEAR 2. Apply the same linear conversion from PHA(ADUs) to ENERGY (keV). Copy the input file to a new file with the PI and ENERGY columns filled in. The input file is untouched. bateconvert infile=’events.fits’ calfile=’cal.fits’ outfile=’out.fits’ residfile=NONE pulserfile=NONE calmode=LINEAR -or- bateconvert events.fits cal.fits NONE NONE out.fits calmode=LINEAR Overwrite an existing version of ‘out.fits’ bateconvert events.fits cal.fits NONE NONE \!out.fits calmode=LINEAR -or- bateconvert events.fits cal.fits out.fits NONE NONE calmode=LINEAR clobber=YES 3. Apply a quadratic conversion instead of a linear conversion. This requires valid residfile and pulserfile. bateconvert events.fits cal.fits resid.fits pulser.fits 4. Set all values in the PI and ENERGY columns of the existing file to zeros. bateconvert events.fits calfile=’none’ residfile=NONE pulserfile=NONE zeroit=YES
Page 1 and 2:
The SWIFT BAT Software Guide Versio
Page 3 and 4:
ii CONTENTS 4.4 How Sky Fluxes are
Page 5 and 6:
iv CONTENTS 6 BAT Analysis Issues 5
Page 7 and 8:
vi CONTENTS D.1.6 SEE ALSO . . . .
Page 9 and 10:
viii CONTENTS D.10.2 USAGE . . . .
Page 11 and 12:
x CONTENTS D.18.5 EXAMPLES . . . .
Page 13 and 14:
xii CONTENTS
Page 15 and 16:
2 CHAPTER 1. INTRODUCTION • Appen
Page 17 and 18:
4 CHAPTER 2. BAT INSTRUMENT Figure
Page 19 and 20:
6 CHAPTER 2. BAT INSTRUMENT Figure
Page 21 and 22:
8 CHAPTER 2. BAT INSTRUMENT The The
Page 23 and 24:
10 CHAPTER 2. BAT INSTRUMENT
Page 25 and 26:
12 CHAPTER 3. BAT OPERATING MODES A
Page 27 and 28:
Page 29 and 30:
Page 31 and 32:
Page 33 and 34:
20 CHAPTER 4. INTRODUCTION TO BAT A
Page 35 and 36:
Page 37 and 38:
Page 39 and 40:
Page 41 and 42:
28 CHAPTER 5. BAT ANALYSIS PROCEDUR
Page 43 and 44:
Page 45 and 46:
Page 47 and 48:
Page 49 and 50:
Page 51 and 52:
Page 53 and 54:
Page 55 and 56:
Page 57 and 58:
Page 59 and 60:
Page 61 and 62:
Page 63 and 64:
Page 65 and 66:
Page 67 and 68:
Page 69 and 70:
56 CHAPTER 6. BAT ANALYSIS ISSUES T
Page 71 and 72:
58 CHAPTER 6. BAT ANALYSIS ISSUES w
Page 73 and 74:
60 CHAPTER 6. BAT ANALYSIS ISSUES T
Page 75 and 76:
62 CHAPTER 6. BAT ANALYSIS ISSUES 2
Page 77 and 78:
Page 79 and 80:
Page 81 and 82:
Page 83 and 84:
70 APPENDIX A. BAT DATA FORMATS Nam
Page 85 and 86:
72 APPENDIX A. BAT DATA FORMATS A.5
Page 87 and 88:
74 APPENDIX A. BAT DATA FORMATS A.5
Page 89 and 90:
76 APPENDIX A. BAT DATA FORMATS Nam
Page 91 and 92:
78 APPENDIX A. BAT DATA FORMATS wil
Page 93 and 94: 80 APPENDIX A. BAT DATA FORMATS BBi
Page 95 and 96: 82 APPENDIX A. BAT DATA FORMATS Arr
Page 97 and 98: 84 APPENDIX A. BAT DATA FORMATS 535
Page 99 and 100: 86 APPENDIX B. BAT FITS KEYWORDS
Page 101 and 102: 88 APPENDIX B. BAT FITS KEYWORDS
Page 103 and 104: 90 APPENDIX C. BAT ACRONYM AND TERM
Page 105 and 106: 92 APPENDIX C. BAT ACRONYM AND TERM
Page 107 and 108: 94 APPENDIX D. BAT SOFTWARE TOOL RE
Page 113 and 114: 100 APPENDIX D. BAT SOFTWARE TOOL R
Page 143: 130 APPENDIX D. BAT SOFTWARE TOOL R
Page 195 and 196:
182 APPENDIX D. BAT SOFTWARE TOOL R
Page 197 and 198:
Page 199 and 200:
Page 201 and 202:
Page 203 and 204:
190 APPENDIX E. BAT SOFTWARE REVISI
Page 205 and 206:
Page 207 and 208:
Page 209 and 210:
Page 211 and 212:
Page 213 and 214:
Page 215 and 216:
Page 217 and 218:
Page 219 and 220:
Page 221 and 222:
Page 223 and 224:
Page 225 and 226:
Page 227 and 228:
Page 229 and 230:
Page 231 and 232:
Page 233 and 234:
Page 235 and 236:
Page 237:
show all

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

Create successful ePaper yourself

Delete template?

Save as template?