gstlal_inspiral_svd_bank
========================

This program will create svd bank files; see gstlal_svd_bank for more information

Usage examples
--------------

1. Typical use::

	gstlal_svd_bank --reference-psd reference_psd.xml --samples-min 1024 \
	--bank-id 0 --ortho-gate-fap 0.5 --flow 40.0 \
	--template-bank /mnt/qfs3/gstlalcbc/engineering/5/bns_bank_40Hz/0000-H1_split_bank-H1-TMPLTBANK-871147516-2048.xml \
	--svd-tolerance 0.9995
	--write-svd-bank /mnt/qfs3/gstlalcbc/engineering/5/bns_bank_40Hz/svd_0000-H1_split_bank-H1-TMPLTBANK-871147516-2048.xml \
	--samples-max-64 4096 --clipleft 0 --autocorrelation-length 351 --samples-max-256 1024 --clipright 20 --samples-max 4096

2. Please add more!

Review Status
-------------

+-------------------------------------------------+------------------------------------------+------------+
| Names                                           | Hash                                     | Date       |
+=================================================+==========================================+============+
| Florent, Sathya, Duncan Me., Jolien, Kipp, Chad | 7536db9d496be9a014559f4e273e1e856047bf71 | 2014-04-30 |
+-------------------------------------------------+------------------------------------------+------------+

Command line options
--------------------



.. code-block:: none

   Usage: gstlal_inspiral_svd_bank [options]
   
   Build time-sliced, SVD'd filter banks for use with gstlal_inspiral
   
   Options:
     -h, --help            show this help message and exit
     --flow=Hz             Set the template low-frequency cut-off (default =
                           40.0).
     --sample-rate=Hz      Set the sample rate.  If not set, the sample rate will
                           be based on the template frequency.  The sample rate
                           must be at least twice the highest frequency in the
                           templates. If provided it must be a power of two
     --append-time-reversed-template
                           A shortcut for appending time reversed template bank
                           to the output file without manually adding --bank-
                           type. (optional; cannot combined with --bank-type.)
     --bank-type=N         Define the type of the template bank: is it used to
                           produce signal candidates or it is used to produce
                           noise candidate? Use 'noise_model' to indicate that
                           it's for noise candidates or 'signal_model' to
                           indicate for signal candidates (default). (optional;
                           if provided, it must be as many as --template-bank).
     --padding=pad         Fractional amount to pad time slices.
     --svd-tolerance=match
                           Set the SVD reconstruction tolerance (default =
                           0.9999).
     --reference-psd=filename
                           Load the spectrum from this LIGO light-weight XML file
                           (required).
     --instrument-override=ifo
                           Override the ifo column of the single inspiral tables
     --template-bank-cache=filename
                           Provide a cache file with the names of the LIGO light-
                           weight XML file from which to load the template bank.
     --ortho-gate-fap=probability
                           Set the orthogonal SNR projection gate false-alarm
                           probability (default = 0.5).
     --write-svd-bank=filename
                           Set the filename in which to save the template bank
                           (required).
     -v, --verbose         Be verbose (optional).
     --autocorrelation-length=AUTOCORRELATION_LENGTH
                           The minimum number of samples to use for auto-
                           chisquared, default 201 should be odd
     --samples-min=SAMPLES_MIN
                           The minimum number of samples to use for time slices
                           default 1024
     --samples-max-256=SAMPLES_MAX_256
                           The maximum number of samples to use for time slices
                           with frequencies above 256Hz, default 1024
     --samples-max-64=SAMPLES_MAX_64
                           The maximum number of samples to use for time slices
                           with frequencies between 64Hz and 256 Hz, default 2048
     --samples-max=SAMPLES_MAX
                           The maximum number of samples to use for time slices
                           with frequencies below 64Hz, default 4096
     --max-duration=s      The maximum time duration for the waveform to be
                           searched instead of the minimum frequency