Simulates a gravitational waveform from binary inspiral.
lalsim-inspiral [options]
The lalsim-inspiral
utility produces a stream of a simulated gravitational waveform from a binary inspiral. The output data is the gravitational waveform polarizations in the time domain, or in the frequency domain if the -F
option is specified. If the option -Q
is specified, the output data is in amplitude and phase. This program uses XLALSimInspiralChooseTDWaveform() or XLALSimInspiralChooseFDWaveform() unless the -c
waveform contitioning option is given, in which case it uses XLALSimInspiralTD() or XLALSimInspiralFD(). The output is written to standard output as a multicolumn ascii format. The first column gives the time or frequency corresponding to each sample and the remaining columns give the gravitational waveform values for the two polarizations (real and imaginary parts, or amplitude and phase when complex).
[default values in brackets]
-h
, --help
-v
, --verbose
-C
, --radians
-F
, --frequency-domain
-c
, --condition-waveform
-P
, --amp-phase
-a
APPROX, --approximant=
APPROX -w
WAVEFORM, --waveform=
WAVEFORM -D
domain, --domain=
DOMAIN -O
PHASEO, --phase-order=
PHASEO -o
AMPO, --amp-order=
AMPO -u
PHIREF, --phiRef=
PHIREF -U
PERIANOM, --periastron-anomaly=
PERIANOM -W
LONGASC, --longitude-ascending-node=
LONGASC -e
ECC, --eccentricity=
ECC -R
SRATE, --sample-rate=
SRATE -M
M1, --m1=
M1 -m
M2, --m2=
M2 -d
D, --distance=
D -i
IOTA, --inclination=
IOTA -X
S1X, --spin1x=
S1X -Y
S1Y, --spin1y=
S1Y -Z
S1Z, --spin1z=
S1Z -x
S2X, --spin2x=
S2X -y
S2Y, --spin2y=
S2Y -z
S2Z, --spin2z=
S2Z -L
LAM1, --tidal-lambda1=
LAM1 -l
LAM2, --tidal-lambda2=
LAM2 -q
DQM1, --delta-quad-mon1=
DQM1 -Q
DQM2, --delta-quad-mon2=
DQM2 -s
SPINO, --spin-order=
SPINO -t
TIDEO, --tidal-order=
TIDEO -f
FMIN, --f-min=
FMIN -r
FREF, --fRef=
FREF -A
AXIS, --axis=
AXIS -n
MODES, --modes=
MODES -p
KEY1=
VAL1,
KEY2=
VAL2,..., --params=
KEY1=
VAL1,
KEY2=
VAL2,... The LAL_DEBUG_LEVEL
can used to control the error and warning reporting of lalsim-inspiral
. Common values are: LAL_DEBUG_LEVEL=0
which suppresses error messages, LAL_DEBUG_LEVEL=1
which prints error messages alone, LAL_DEBUG_LEVEL=3
which prints both error messages and warning messages, and LAL_DEBUG_LEVEL=7
which additionally prints informational messages.
The lalsim-inspiral
utility exits 0 on success, and >0 if an error occurs.
The command:
lalsim-inspiral --approx=TaylorT3
produces a three-column ascii output to standard output; the rows are samples (at the default rate of 16384 Hz), and the three columns are 1. the time of each sample, 2. the plus-polarization strain, and 3. the cross-polarization strain. The waveform produced is for the TaylorT3 post-Newtonian approximant for the default parameters of a 1.4 solar mass + 1.4 solar mass binary inspiral at 1 Mpc distance.
The command:
lalsim-inspiral --m1=10 --m2=10 --approx=TaylorF2 --frequency-domain
produces a frequency-domain waveform for a 10 solar mass + 10 solar mass binary inspiral at 1 Mpc distance using the TaylorF2 approximant. The five columns written to standard output are the frequency of each sample, the real part of the plus-polarization, the imaginary part of the plus-polarization, the real part of the cross-polarization, and the imaginary part of the cross-polarization.
The command:
lalsim-inspiral --m1=10 --m2=10 --approx=TaylorF2 --condition
produces the same waveform as in the previous example, but in the time domain and conditioned so that it is suitable for injection into detector data.