gstlal_lvc_rates_injections
===========================
Command line options
--------------------
.. code-block:: none
Usage: gstlal_lvc_rates_injections [options]
Options:
-h, --help show this help message and exit
--gps-start-time=GPS_START_TIME
Start time of the injection data to be created.
--gps-end-time=GPS_END_TIME
End time of the injection data to be created.
--use-segments Not currently implemented. Cut on segments.
--output-tag=tag Set the string to write the injection xml.
--random-seed=RANDOM_SEED
Set the seed of the random number generator to get
reproducible results, default = 7.
--max-redshift=MAX_REDSHIFT
Set the maximum redshift at which injections will be
placed.
--redshift-power=REDSHIFT_POWER
Power of (1+z) to multiply the constant-comoving-rate
distribution by.
--time-step=TIME_STEP
Set the time step interval between injections.
--time-interval=TIME_INTERVAL
Set the size of the interval used to randomly place
injections around the --time-step. For example, 10
will result in +-10s interval on either side of time-
step.
--randomize-start-time
Add a small random jitter to the gps-start-time. In
the case of many injection sets, this results in
jittering the time-intervals a bit.
--mass-distribution=MASS_DISTRIBUTION
Set the desired component mass distribution. Select
one of the following: 1. IMF_PAIR - First component
from Salpeter IMF distribution and second drawn
uniformly between min_mass and mass of first
component. 2. UNIFORM_PAIR - Both components drawn
from uniform distribution so that min_mass <= m1,m2 <
max_mass. 3. UNIFORMLNM_PAIR - Both components drawn
from uniform-in-log distribution. 4. NORMAL_PAIR -
Both components drawn from normal distribution of mean
mean_mass and standard deviation sigma_mass.5.
UNIFORM_DISTINCT - Components will be drawn from two
distinct uniform mass distributions. Must specify
min_mass1, max_mass1, min_mass2, max_mass2.6.
UNIFORMLNM_DISTINCT - Components will be drawn from
two distinct uniform-in-log mass distributions. Must
specify min_mass1, max_mass1, min_mass2, max_mass2.7.
UNIFORM_UNIFORMLNM_DISTINCT - Component 1 will be
drawn from a uniform mass distribution and component 2
will be drawn from a uniform-in-log mass distribution.
Must specify min_mass1, max_mass1, min_mass2,
max_mass2.8. NORMAL_IMF_DISTINCT - Component 1 will be
drawn from a normal mass distribution and component 2
will be drawn from a Salpeter IMF distribution.9.
UNIFORM_IMF_DISTINCT - Primary drawn from a uniform
mass distribution, secondary drawn from a Salpeter IMF
distribution. 10. POWER_PAIR - Primary from power law,
secondary from another power law conditional on m2 <
m1. Default power laws m1**2.35, m2**2 reproduce the
IMF_M2SQ distribution.
--min-mass=MIN_MASS Set the minimum component mass of the two compact
objects.
--max-mass=MAX_MASS Set the maximum component mass of the two compact
objects.
--max-mtotal=MAX_MTOTAL
Set a cutoff on the allowed total mass. Currently only
implemented for IMF_PAIR, UNIFORMLNM_PAIR,
UNIFORM_DISTINCT, UNIFORMLNM_DISTINCT,
UNIFORM_UNIFORMLNM_DISTINCT.
--mean-mass=MEAN_MASS
Mean of normal mass distribution. Required if using
NORMAL_PAIR.
--sigma-mass=SIGMA_MASS
Stdev of normal mass distribution. Required if using
NORMAL_PAIR.
--min-mass1=MIN_MASS1
Set the minimum component mass of the lighter of two
compact objects.
--max-mass1=MAX_MASS1
Set the maximum component mass of the lighter of two
compact objects.
--min-mass2=MIN_MASS2
Set the minimum component mass of the heavier of two
compact objects.
--max-mass2=MAX_MASS2
Set the maximum component mass of the heavier of two
compact objects.
--mass1-power=MASS1_POWER
Power law index for primary mass. Default 2.35
--mass2-power=MASS2_POWER
Power law index for secondary mass. Default 2
--spin-distribution=SPIN_DISTRIBUTION
Set the desired component spin distribution. Select
one of the following: 1. ALIGNED - Spinz uniformly
random in (-max_spin, +max_spin) for each component.
2. ISOTROPIC - (s_x, s_y, s_z) isotropically
distributed with uniform magnitude distribution for
each component.3. ALIGNED_ALIGNED - Components
uniformly random in (-max_spin1, +max_spin1) and
(-max_spin2, +max_spin2)4. ISOTROPIC_ALIGNED -
Component 2 spinz uniformly random in (-max_spin1,
+max_spin1), component 1 isotropically distributed.5.
ISOTROPIC_ISOTROPIC - Both components isotropically
distributed with uniform magnitude distribution.6.
ALIGNED_EQUAL - Spinz uniform in (-max_spin,
+max_spin) for component 1, spin2z = spin1z.7.
SALPETER_PRIMARY_SPIN - Both components (1/2 chi_max)
ln(chi_max/s1z), needs --max-chi
--max-spin=MAX_SPIN Set the maximum component spin magnitude. Required if
using ALIGNED, ALIGNED_EQUAL or ISOTROPIC.
--max-chi=MAX_CHI Maximum chi spin magnitude. Takes 0.99. Required if
using SALPETER_PRIMARY_SPIN.
--max-spin1=MAX_SPIN1
Set the maximum component spin magnitude of mass_1.
Required if using ALIGNED_ISOTROPIC.
--max-spin2=MAX_SPIN2
Set the maximum component spin magnitude of mass_2.
Required if using ALIGNED_ISOTROPIC.
--waveform=WAVEFORM Set the waveform family to populate the sim_inspiral
table.
--snr-calculation=SNR_CALCULATION
Set the desired method for computing the approximate
injection snr. Select one of the following: 1.
OPTIMALLY_ORIENTED_1MPC - Assumes inclination = 0,
distance = 1Mpc. Computes only hp.2. INJ_PARAMS -
Computes hp and hc using injections' parameters.3.
GENERIC - Computes hp and hc using injections'
parameters and can take FD and TD waveforms.
--snr-threshold=SNR_THRESHOLD
Set the network snr threshold to determine whether an
injection is expected to be found or not, default =
5.0
--min-frequency=MIN_FREQUENCY
Lower frequency cutoff for SNR calculation, default =
15 Hz.
--max-frequency=MAX_FREQUENCY
Upper frequency cutoff for SNR calculation, default =
1500 Hz.
--delta-frequency=DELTA_FREQUENCY
Step in frequency for SNR calculation, default = 1 Hz.
--approximant=APPROXIMANT
Set the approximant waveform to use in the
SNRcalculation, default = SEOBNRv2_ROM_DoubleSpin
--h1-reference-spectrum-file=filename
Full path to the H1 PSD as txt
--l1-reference-spectrum-file=filename
Full path to the L1 PSD as txt
--v1-reference-spectrum-file=filename
Full path to the V1 PSD as txt
-v, --verbose Be verbose.