next up previous contents
Next: Examples Up: Binary Inspiral Search on Previous: Scripts for running binary_search   Contents


Example: binary_reader program

This function reads the output of the binary_search program as implimented to analyse the 40m data taken in November 1994. The data was broken into segments of approximately 20 seconds in length (plus approximately 6 seconds to avoid wrap-around problems in the discrete corellations). This program, with no options implimented, prints out the maximum signal to noise achieved over the bank of filters for each segment. The function requires the environment variable GRASP_MFPATH to point to the directory containing the output files written by binary_reader. You can set this with a command such as
setenv GRASP_MFPATH /usr/local/GRASP/data/mfout/
The binary_reader program does not assume that the data files which it is reading were written on a machine with the same byte-order as the machine that it is running one. This is helpful if one does production runs on a little-endian machine (say a DEC alpha machine) but subsequently analyzes the data on a big-endian machine (for example a SUN sparcstation). The binary_reader program does any byte-swapping that is needed.

The program has several optional flags, some of which require a numerical value to be supplied. The flags are:

-h
: prints a summary of the command options
-m
: prints the list of templates to standard out. The output format is template $m_1$ $m_2$
-f fmt
: specifies that the format fmt should be used in output (see below)
-l
: specifies that field lables should be included in output
-o
: only print segments without outliers
-r rmax
: reject filters with $r^2$ less than rmax in maximization over template bank
-t threshold
: only print segments with maximum SNR greater than threshold
-L lower
: only maximize over templates numbers greater than lower
-T tempno
: consider only template number tempno--do not maximize over template bank
-M
: maximize over the template bank using the median-renormalized signal-to-noise ratio.
-c
: Print the filter peak offsets. These are defined in equation [*]. The peak offsets are only stored in the data files created by binary_search and used by binary_reader if the macro COMPARE = 1 has been set in the file binary_params.h. If peak offsets are requested when the impulse offsets have been recorded, an error message is printed and vice versa.
-s segno
: print the results for all the templates for the segment segno to the file segment.segno.
The format specifier fmt is a string of upto 16 characters which are replaced by the corresponding output field:
t
: segment start time
s
: segment number
o
: segment outlier test result (1: outliers / 0: no outliers)
T
: number of maximum template
M
: masses of maximum template
D
: distance of SNR=1 for maximum template
S
: max SNR of maximum template
X
: max SNR of maximum template with power renormalization
Y
: max SNR of maximum template with median renormalization
O
: offset of maximum template
P
: phase of maximum template
R
: $r^2$ test statistic value of maximum template
N
: number of threshold crossings of maximum template



Subsections
next up previous contents
Next: Examples Up: Binary Inspiral Search on Previous: Scripts for running binary_search   Contents
Bruce Allen 2000-11-19