Simulates a gravitational waveform from binary inspiral.

Synopsis

lalsim-inspiral [options]

Description

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).

Options

[default values in brackets]

-h, --help: print a help message and exit
-v, --verbose: verbose output
-C, --radians: use radians rather than decimal degrees
-F, --frequency-domain: output data in frequency domain
-c, --condition-waveform: apply waveform conditioning
-P, --amp-phase: output data as amplitude and phase
-a APPROX, --approximant=APPROX: approximant [TaylorT1]
-w WAVEFORM, --waveform=WAVEFORM: waveform string giving both approximant and order
-D domain, --domain=DOMAIN: domain for waveform generation when both are available {"time", "freq"} [use natural domain for output]
-O PHASEO, --phase-order=PHASEO: twice pN order of phase (-1 == highest) [-1]
-o AMPO, --amp-order=AMPO: twice pN order of amplitude (-1 == highest) [0]
-u PHIREF, --phiRef=PHIREF: reference phase in degrees [0]
-U PERIANOM, --periastron-anomaly=PERIANOM: mean periastron anomaly in degrees [0]
-W LONGASC, --longitude-ascending-node=LONGASC: longitude of ascending node in degrees [0]
-e ECC, --eccentricity=ECC: orbital eccentricity [0]
-R SRATE, --sample-rate=SRATE: sample rate in Hertz [16384]
-M M1, --m1=M1: mass of primary in solar masses [1.4]
-m M2, --m2=M2: mass of secondary in solar masses [1.4]
-d D, --distance=D: distance in Mpc [1]
-i IOTA, --inclination=IOTA: inclination in degrees [0]
-X S1X, --spin1x=S1X: x-component of dimensionless spin of primary [0]
-Y S1Y, --spin1y=S1Y: y-component of dimensionless spin of primary [0]
-Z S1Z, --spin1z=S1Z: z-component of dimensionless spin of primary [0]
-x S2X, --spin2x=S2X: x-component of dimensionless spin of secondary [0]
-y S2Y, --spin2y=S2Y: y-component of dimensionless spin of secondary [0]
-z S2Z, --spin2z=S2Z: z-component of dimensionless spin of secondary [0]
-L LAM1, --tidal-lambda1=LAM1: dimensionless tidal deformability of primary [0]
-l LAM2, --tidal-lambda2=LAM2: dimensionless tidal deformability of secondary [0]
-q DQM1, --delta-quad-mon1=DQM1: difference in quadrupole-monopole term of primary [0]
-Q DQM2, --delta-quad-mon2=DQM2: difference in quadrupole-monopole term of secondary [0]
-s SPINO, --spin-order=SPINO: twice pN order of spin effects (-1 == all) [-1]
-t TIDEO, --tidal-order=TIDEO: twice pN order of tidal effects (-1 == all) [-1]
-f FMIN, --f-min=FMIN: frequency to start waveform in Hertz [40]
-r FREF, --fRef=FREF: reference frequency in Hertz [0]
-A AXIS, --axis=AXIS: axis for PhenSpin {View, TotalJ, OrbitalL} [OrbitalL]
-n MODES, --modes=MODES: allowed l modes {L2, L23, ..., ALL} [L2]
-p KEY1=VAL1,KEY2=VAL2,..., --params=KEY1=VAL1,KEY2=VAL2,...: extra parameters as a key-value pair

Environment

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.

Exit Status

The lalsim-inspiral utility exits 0 on success, and >0 if an error occurs.

Example

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.