gstlal_inspiral_plot_background
===============================

A program to plot the likelihood distributions in noise of a gstlal inspiral analysis
Command line options
--------------------



.. code-block:: none

   Usage: gstlal_inspiral_plot_background [options]
   
   Options:
     -h, --help            show this help message and exit
     -d filename, --database=filename
                           Retrieve search results from this database (optional).
                           Can be given multiple times.
     -c filename, --database-cache=filename
                           Retrieve search results from all databases in this LAL
                           cache (optional).  See lalapps_path2cache.
     --max-snr=SNR         Plot SNR PDFs up to this value of SNR (default = 200).
     --max-log-lambda=value
                           Plot ranking statistic CCDFs, etc., up to this value
                           of the natural logarithm of the likelihood ratio
                           (default = 40).
     --min-log-lambda=value
                           Plot ranking statistic CCDFs, etc., down to this value
                           of the natural logarithm of the likelihood ratio
                           (default = -5).
     --scatter-log-lambdas=[low]:[high][,[low]:[high]...]
                           Overlay scatter plots of candidate parameter co-
                           ordinates on various PDF plots, limiting the
                           candidates to those whose log likelihood ratios are in
                           the given range (default = don't overlay scatter
                           plot).  Use a range of ":" to plot all candidates.
     --output-dir=output-dir
                           Write output to this directory (default = ".").
     --output-format=extension
                           Select output format by setting the filename extension
                           (default = ".png").
     -t path, --tmp-space=path
                           Path to a directory suitable for use as a work area
                           while manipulating the database file.  The database
                           file will be worked on in this directory, and then
                           moved to the final location when complete.  This
                           option is intended to improve performance when running
                           in a networked environment, where there might be a
                           local disk with higher bandwidth than is available to
                           the filesystem on which the final output will reside.
     --add-zerolag-to-background
                           Add zerolag events to background before populating
                           coincident parameter PDF histograms.
     --user-tag=user-tag   Set the adjustable component of the description fields
                           in the output filenames (default = "ALL").
     --plot-snr-snr-pdfs   Plot the full cache of snr-snr-pdfs.
     --event-snr=ifo:snr   SNR to plot on snr chisq plots. Pass as ifo:snr, e.g.
                           H1:3.2. Can be passed multiple times, though only once
                           for each ifo. Must also pass --event-chisq for ifo.
     --event-chisq=ifo:chisq
                           chisq to plot on snr chisq plots. Pass as ifo:chisq,
                           e.g. H1:1.1. Can be passed multiple times, though only
                           once for each ifo. Must also pass --event-snr for ifo.
     --event-bankchisq=ifo:chisq
                           chisq to plot on snr chisq plots. Pass as ifo:chisq,
                           e.g. H1:1.1. Can be passed multiple times, though only
                           once for each ifo. Must also pass --event-snr for ifo.
     -v, --verbose         Be verbose.