gstlal_inspiral_make_snr_pdf¶
Generate an SNR PDF database file. Command line options ——————–
Usage: gstlal_inspiral_make_snr_pdf [options]
Options:
-h, --help show this help message and exit
-f, --full Generate SNR PDFs for all possible horizon distance
ratios as defined by the SNR PDF mechanism's internal
quantization system. Use --instruments to select the
detector network to model (required). A PDF will be
constructed for every combination of --min-instruments
or more instruments from the set. When --full is
enabled, any --horizon-distances options and/or PSD
files are ignored. See also --full-fragment for
information on parallelization.
--full-fragment=n/m Enable parallelization of --full by selecting a
fragment of the full SNR PDFs sequence to generate.
When --full is enabled, the iteration over SNR PDFs
employs a reproducible, deterministic, sequence. That
sequence is divided into m (m >= 1) approximately
equal-sized intervals, and only the SNR PDFs from the
n-th interval (1 <= n <= m) of the sequence will be
constructed. Afterwards, the files generated by
several jobs can be combined by re-invoking the
program using the --seed or --seed-cache options to
obtain the complete SNR PDF collection. The format of
this option is "n/m", and the default is "1/1", which
causes all SNR PDFs to be constructed.
--horizon-distance-tolerance=ratio
Set the fractional amount by which two horizon
distances must differ for them to be considered
distinct (optional). The default is 0.05, i.e., when
two horizon distances differ by 5\% or more they are
considered to be distinct, but less than that and they
are considered to be equal.
--horizon-distances=instrument=distance[,instrument=distance,...]
Cache SNR PDFs for these instruments and horizon
distances. Format is, e.g., H1=120,L1=120,V1=48.
Units for distance are irrelevant (PDFs depend only on
their ratios). A PDF will be constructed for every
combination of --min-instruments or more instruments
from the set. All --horizon-distances must list the
same instruments (if an instrument is off set its
horizon distance to 0).
--horizon-distance-flow=Hz
When obtaining horizon distances from a collection PSD
files, start horizon distance integral at this
frequency in Hertz (default = 10 Hz).
--horizon-distance-masses=m1,m2
When obtaining horizon distances from a collection of
PSD files, compute them for these masses in solar mass
units (default = 1.4,1.4). Can be given multiple
times.
--instruments=name[,name,...]
Set the instruments to include in the network. If PSD
files alone are to be used to provide horizon
distances, or --full is selected, then this option is
required, otherwise it is optional. If both
--instruments and --horizon-distances are given, they
must list the same instruments.
--min-instruments=count
Set the minimum number of instruments required to form
a candidate; can be given multiple times (default is
1 and 2). Note that the probability that a recovered
signal is recovered by a given set of instruments
depends on how many instruments are required to
participate. The PDF cache must contain entries for
every value of this parameter one will use to conduct
searches.
-o filename, --output=filename
Write SNR PDF cache to this file (required).
--seed=filename Seed the SNR PDF cache by loading pre-computed SNR
PDFs from this file. Can be given multiple times.
--seed-cache=filename
Seed the SNR PDF cache by loading pre-computed SNR
PDFs from the files named in this LAL cache.
-v, --verbose Be verbose.