NAME

batsumdph - (OBSOLETE) Add specified rows in a BAT_DPH table and generate a new, single-row BAT_DPH extension.

USAGE

batsumdph infile outfile rows="<row_ranges>" clobber = "yes" chatter=5

DESCRIPTION

NOTE: This task is not supported for scientific analysis. Please use the 'batbinevt' task to sum survey DPHs.

This tool sums up detector by detector and energy bin by energy bin, the user specified rows in an input BAT Detector Plane Histogram (DPH) to produce a single summed DPH. The user can specify any set of rows in the input DPH to be summed. The GTI extension of the output DPH contains the times of the rows that were actually summed.

The number of rows in the corresponding GTI extension of the new FITS file depends on the number of rows specified. The GTI START value of each GTI extension row is the start time of the corresponding selected row. The stop time of that row is the start time + the EXPOSURE value of the corresponding row in the original BAT_DPH extension. The EBOUNDS extension is copied "as is" to the new file.

Any specified rows not in the infile BAT_DPH extension are ignored.

The generation of the output file will fail if the file is too large to fit the available memory.

PARAMETERS

input [filename]
Input file name. The file must contain a BAT_DPH extension.

outfile [filename]
Output file name. Precede it 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).

rows
The ranges of rows, from the binary table of the BAT_DPH extension of the original file, to be summed. e.g "1-3, 6-10"

(clobber = "No") [char, "Yes" or "No"]
Overwrites an existing file if "Yes". clobber is normally set to "No" and does not overwrite an existing file.

(chatter = 1) [integer, 0 - 5]
Controls the amount of informative text written to standard output. Setting chatter = 5 will produce detailed diagnostic output, otherwise this task normally does not write any output.

(history = NO) [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.

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 how the program can be executed to generate a new FITS file as described above.

1. Add DPH_COUNTS in rows 1 and 3 and generate a new BAT_DPH extension with a single row and a corresponding GTI extension with two rows and new START and STOP values. The new FITS file also contains the entire EBOUNDS extension from the infile. 

batsumdph infile.dph sumfile.dph rows="1,3" clobber="Yes" chatter=1
2. Add DPH_COUNTS in row ranges 1-3, 5-7 and generate a new BAT_DPH extension with a single row and a corresponding GTI extension with the total number of rows within the specified ranges. Any rows not in the original infile are ignored in the summing of the DPH_COUNTS and in the GTI extension. The START and STOP values are computed from the specified rows existing in the original infile. As in example one the new FITS file also contains the entire EBOUNDS extension from the infile. 

batsumdph infile.dph sumfile.dph rows="1-3,5-7" clobber="Yes" chatter=1

LAST MODIFIED

Nov 2006