gstlal_cs_triggergen
====================

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



.. code-block:: none

   Usage: gstlal_cs_triggergen [options]
   
   GstLAL-based cosmic string search pipeline.
   
   Options:
     -h, --help            show this help message and exit
     --sample-rate=rate    Desired sample rate (Hz).
     --frame-cache=filename
                           Frame cache file to load as input data.
     --reference-psd=filename
                           Reference psd files as input to obtain the template
                           and SNR. Can be given for multiple detectors, but must
                           be in one file. If not given, the PSD will be measured
                           on the fly, which can prevent loss of sensitivity for
                           not using the most recent PSD. However, there will be
                           some burn-in time where the data will not be analyzed
                           until the PSD converges.
     --output=filename     Name of output xml file to record candidate events.
     --rankingstat-output=filename
                           Name of output xml file to record rankingstat objects.
     --segments-file=filename
                           Set the name of the LIGO Light-Weight XML file with
                           segment lists that are science mode, for the trigger
                           generator to enable gating.  See also --segments-name.
     --segments-name=name  Set the name of the segment lists to retrieve from the
                           segments file.  See also --segments-file.
     --vetoes-file=filename
                           Set the name of the LIGO Light-Weight XML file with
                           segment lists that are vetoed, for the trigger
                           generator to enable gating.  See also --vetoes-name.
     --vetoes-name=name    Set the name of the veto segment lists to retrieve
                           from the veto segments file.  See also --vetoes-file.
     --injection-file=filename
                           Name of xml file with injections.
     --time-slide-file=filename
                           Name of xml file with time slides for each detector.
     --channel=channel     Name of channel. Can be given multiple inputs, but
                           must be one for each detector.
     --template-bank=filename
                           Name of template file. Template bank for all the
                           detectors involved should be given.
     --gps-start-time=start_time
                           GPS start time.
     --gps-end-time=end_time
                           GPS end time.
     --threshold=snr_threshold
                           SNR threshold.
     --cluster-events=cluster_events
                           Cluster events with input timescale (in seconds).
     --user-tag=user_tag   User tag set in the search summary and process tables
     --delta-t=delta_t     Maximum time difference in seconds for coincidence,
                           excluding the light-travel time between the detectors.
                           Default: 0.008
     --verbose             Be verbose.