gstlal_inspiral_plot_sensitivity¶
A program to plot the sensitivity of a gstlal inspiral search, e.g., VT #MAIN PROGRAM # # # Command line options ——————–
Usage:
description:
The program gstlal_inspiral_plot_sensitivity computes the sensitive volume of a CBC search from input databases containing triggers from simulation experiments. These triggers need to be ranked by false alarm rate, the detection statistic used in S6 searches. Then injections which register a trigger louder than the loudest event, by false alarm rate, are considered found. All others are considered missed. The efficiency of detecting an event depends on the source parameters, such as its component masses, distance, spin, inclination, sky position, etc. However, lalapps_cbc_svim only considers the dependency of the efficiency on distance and mass, marginalizing over the other parameters. Injections are binned in distance and mass and the estimated efficiency is integrated over distance to convert the efficiency into a physical volume.
Options:
--version show program's version number and exit
-h, --help show this help message and exit
--xaxis-points=XAXIS_POINTS
Specify the number of FARs/SNRs for which to compute
the search volume.
--min-far=MIN_FAR Specify the minimum FAR (Hz)
--max-far=MAX_FAR Specify the maximum FAR (Hz)
--fiducial-far=FIDUCIAL_FAR
Specify a fiducial FAR (Hz) for plotting efficiency
--min-snr=MIN_SNR Specify the minimum SNR for volume calculation.
--max-snr=MAX_SNR Specify the maximum SNR for volume calculation.
--zero-lag-database=ZERO_LAG_DATABASE
Name of database containing the zero lag segments and
triggers.
--injection-database=INJECTION_DATABASE
Name of database containing injection parameters and
triggers.
--live-time-program=name
Set the name of the program whose rings will be
extracted from the search_summary table. Default =
"gstlal_inspiral".
--veto-segments-name=VETO_SEGMENTS_NAME
Set the name of the veto segments to use from the XML
document.
--data-segments-name=DATA_SEGMENTS_NAME
Set the name of the data segments. Default =
"whitehtsegments".
--coinc-table-name=name
Set the name of the table containing coincident
triggers. Default = "coinc_inspiral".
--user-tag=name Add a descriptive tag to the names of output files.
--output-dir=name Select a directory to place output files.
-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.
--output-path=OUTPUT_PATH
Choose directory to save output files.
--output-cache=OUTPUT_CACHE
Name of output cache file. If not specified, then no
cache file will be written.
--verbose Be verbose.
--mass-bins=integer Number of mass bins (per dimension), if mass bin
boundaries are not explicitly set.
--spin-bins=integer Number of spin bins (per dimension), if spin bin
boundaries are not explicitly set.
--dist-bins=integer Space distance bins evenly and specify the number of
distance bins to use.
--min-mtotal=m Specify the minimum total mass to consider among the
injections found in the DB. This filters all
injections outside this total mass range.
--max-mtotal=m Specify the maximum total mass to consider among the
injections found in the DB. This filters all
injections outside this total mass range.
--min-mass=MM Specify the minimum component mass to consider among
the injections found in the DB. This filters all
injectionswith any component lighter than MM.
--max-mass=MM Specify the maximum mass to consider among the
injections found in the DB. This filters all
injections with any component heavier than MM.
--max-mass-ratio=q Specify the maximum allowed mass ratio. Should be >=
1.
--exclude-sim-type=SIM
When computing the search volume, exclude injections
made using the SIM waveform family. Example:
SpinTaylorthreePointFivePN. Use this option multiple
times to exclude more than one injection type.
--remove-precession Exclude precessing injections when plotting
sensitivity.
--bin-by-mass1-mass2 Bin injections by component mass in two dimensions
when estimating the search efficiency.
--bin-by-total-mass Bin injections by total mass when estimating the
search efficiency.
--bin-by-chirp-mass Bin injections by chirp mass when estimating the
search efficiency.
--bin-by-aligned-spin
Bin injections by aligned spin parameter when
estimating the search efficiency.
--bin-by-mass-ratio Bin injections by mass ratio when estimating the
search efficiency.
--bin-by-source-type Bin injections by source type: BNS mchirp between 0.8
and 2, NSBH between 2 and 4.5, BBH between 4.5 and
45.0, IMBH between 45.0 and 450.0
--bin-by-duration Bin injections by template duration when estimating
the search efficiency.