gstlal_inspiral_metric_overlap
==============================

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



.. code-block:: none

   usage: gstlal_inspiral_metric_overlap [-h] [--psd-xml-file PSD_XML_FILE]
                                         [--bank-file BANK_FILE] --out-h5-file
                                         OUT_H5_FILE [--approximant APPROXIMANT]
                                         [--f-low F_LOW] [--f-high F_HIGH]
                                         [--split-bank-cache SPLIT_BANK_CACHE]
                                         [--split-bank-index SPLIT_BANK_INDEX]
                                         [--overlap-threshold OVERLAP_THRESHOLD]
                                         [--number-of-templates NUMBER_OF_TEMPLATES]
   
   optional arguments:
     -h, --help            show this help message and exit
     --psd-xml-file PSD_XML_FILE
                           provide a psd xml file
     --bank-file BANK_FILE
                           provide the bank file for which overlaps will be
                           calculated
     --out-h5-file OUT_H5_FILE
                           provide the output hdf5 file name
     --approximant APPROXIMANT
                           Waveform model. Default IMRPhenomD.
     --f-low F_LOW         Lowest frequency component of template. Default 15 Hz.
     --f-high F_HIGH       Highest frequency component of template Default 4096
                           Hz.
     --split-bank-cache SPLIT_BANK_CACHE
                           Cache file containing paths to split banks. Required.
     --split-bank-index SPLIT_BANK_INDEX
                           Split bank index that will be looped over.
     --overlap-threshold OVERLAP_THRESHOLD
                           Overlap threshold. Default 0.25.
     --number-of-templates NUMBER_OF_TEMPLATES
                           Total number of templates in bank. Required.