NAME
hxdbstjudge - Judge HXD WAM light curves for bursts
SYNOPSIS
hxdbstjudge input_name=<WAM TH light curve> outfile=<output text
file> bgd_integ_time=<background integration time> delta_t=<burst
integration time> sigma=<detection threshold>
DESCRIPTION
This task uses a simple algorithm to detect bursts in an HXD WAM light
curve. The algorithm is as follows:
- Integrate background rate for
bgd_integ_time seconds, if no
previous burst is overlapping.
- Integrate light curve after background interval for
delta_t
seconds.
- Determine if light curve is
sigma above background.
- If so, goto step 2.
- If not, and in a burst already, end of burst, goto step 1.
- If not, and NOT in a burst already, goto step 1.
The output file is a pure text file with several columns, and a comment
header (comments are indicated as lines starting with '#'). The columns in the
output file are as follows:
- 1 - Burst Start Date (UTC)
- YYYY-MM-DD
- 2 - Burst Start Time (UTC)
- HH:MM:SS
- 3 - Burst Start Time (MET s)
- float
- 4 - Burst Stop Time (MET s)
- float
- 5 - Burst Duration (s)
- Time that light curve spent <sigma> above background
- 6 - Total Burst Counts
- Sum of all counts betwee Burst Start Time and Burst Stop Time
- 7 - Total sigma of burst
- Sigma above background for entire burst
PARAMETERS
- input_name [filename]
- Input HXD WAM light curve (see also fhelp hxdmkwamlc)
- outfile [string]
- Output text file name.
- bgd_integ_time [int]
- Background light curve integration time (in seconds)
- delta_t [float]
- Source integration time. Bursts that last less than this time may not be
well characterized. Bursts much longer than this time may not be detected.
- sigma [float]
- Detection threshold in sigma.
- (leapfile) [filename]
- Leap second FITS table.
- (chatter) [int, [0,5], default=2]
- Chattiness level. 0 means essentially nothing will be printed. 5 is
debugging mode. Default is 2.
- (clobber) [bool, default=no]
- Clobber existing output file? This parameter is ignored if
inplace=yes.
NOTES
LAST MODIFIED
October 2009