Detailed Description

Functions for producing SEOBNRv1 and v2 waveforms using reduced order models.

C code for SEOBNRv4 reduced order model See CQG 31 195010, 2014, arXiv:1402.4146 for the basic approach. Further details in PRD 93, 064041, 2016, arXiv:1512.02248.

C code for SEOBNRv2 reduced order model (double spin high resolution low mass version). See M. Pürrer ,CQG 31 195010, 2014, arXiv:1402.4146 for the basic approach. Further details in PRD 93, 064041, 2016, arXiv:1512.02248.

Review status:: SEOBNRv1/2_ROM_(Effective/Double)Spin reviewed by Frank Ohme, Sarah Caudill, Michael Puerrer, Ian Harry, John Veitch, Gareth Thomas. Review concluded with git hash 9dc5e84583bfe2707ac20638e7b89bf988d4d482 (July 2015).

Author: Michael Puerrer

This is a frequency domain model that approximates the time domain SEOBNRv2 model.

The binary data HDF5 file (SEOBNRv2ROM_DS_HI_v1.0.hdf5) is available at on LIGO clusters in /home/cbc/. Make sure the files are in your LAL_DATA_PATH.

Note

Note that due to its construction the iFFT of the ROM has a small (~ 20 M) offset in the peak time that scales with total mass as compared to the time-domain SEOBNRv2 model.

Parameter ranges:

0.01 <= eta <= 0.25
-1 <= chi_i <= 0.99
Mtot >= 2 Msun < 500Msun

Aligned component spins chi1, chi2. Symmetric mass-ratio eta = m1*m2/(m1+m2)^2. Total mass Mtot.

Author: Michael Puerrer

This is a frequency domain model that approximates the time domain SEOBNRv4 model.

The binary data HDF5 file (SEOBNRv4ROM_DS_HI_v1.0.hdf5) will be available at on LIGO clusters in /home/cbc/. Make sure the files are in your LAL_DATA_PATH.

Note

Note that due to its construction the iFFT of the ROM has a small (~ 20 M) offset in the peak time that scales with total mass as compared to the time-domain SEOBNRv4 model.

Parameter ranges:

0.01 <= eta <= 0.25
-1 <= chi_i <= 1.0
2Msun (@ flow=20Hz) <= Mtot < 500Msun

Aligned component spins chi1, chi2. Symmetric mass-ratio eta = m1*m2/(m1+m2)^2. Total mass Mtot.

This ROM consists of three submodels and glues together one low-mass and 2 high-mass models These submodels and their boundaries are not explicit in the source, just in the HDF5 data file.

Prototypes
int	XLALSimIMRSEOBNRv2ROMDoubleSpinHIFrequencySequence (struct tagCOMPLEX16FrequencySeries hptilde, struct tagCOMPLEX16FrequencySeries hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max)
	Compute waveform in LAL format at specified frequencies for the SEOBNRv2_ROM_DoubleSpin_HI model. More...

int	XLALSimIMRSEOBNRv2ROMDoubleSpinHI (struct tagCOMPLEX16FrequencySeries hptilde, struct tagCOMPLEX16FrequencySeries hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max)
	Compute waveform in LAL format for the SEOBNRv2_ROM_DoubleSpin_HI model. More...

int	XLALSimIMRSEOBNRv4ROMFrequencySequence (struct tagCOMPLEX16FrequencySeries hptilde, struct tagCOMPLEX16FrequencySeries hctilde, const REAL8Sequence freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max, LALDict LALparams, NRTidal_version_type NRTidal_version)
	Compute waveform in LAL format at specified frequencies for the SEOBNRv4_ROM model. More...

int	XLALSimIMRSEOBNRv4ROM (struct tagCOMPLEX16FrequencySeries hptilde, struct tagCOMPLEX16FrequencySeries hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2, INT4 nk_max, LALDict *LALparams, NRTidal_version_type NRTidal_version)
	Compute waveform in LAL format for the SEOBNRv4_ROM model. More...

SEOBNRv1 Reduced Order Model (Double Spin)
C code for SEOBNRv1 reduced order model (double spin version). See CQG 31 195010, 2014, arXiv:1402.4146 for details. Author Michael Puerrer, John Veitch This is a frequency domain model that approximates the time domain SEOBNRv1 model. Note that SEOBNRv2 supersedes SEOBNRv1. The binary data files are available at https://dcc.ligo.org/T1400701-v1. Put the untared data into a location in your LAL_DATA_PATH. Note Note that due to its construction the iFFT of the ROM has a small (~ 20 M) offset in the peak time that scales with total mass as compared to the time-domain SEOBNRv1 model. Parameter ranges: q <= 10 -1 <= chi_i <= 0.6 Mtot >= 12Msun Aligned component spins chi1, chi2. Asymmetric mass-ratio q = max(m1/m2, m2/m1). Total mass Mtot.
int	XLALSimIMRSEOBNRv1ROMDoubleSpinFrequencySequence (struct tagCOMPLEX16FrequencySeries hptilde, struct tagCOMPLEX16FrequencySeries hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2)
	Compute waveform in LAL format at specified frequencies for the SEOBNRv1_ROM_DoubleSpin model. More...

int	XLALSimIMRSEOBNRv1ROMDoubleSpin (struct tagCOMPLEX16FrequencySeries hptilde, struct tagCOMPLEX16FrequencySeries hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2)
	Compute waveform in LAL format for the SEOBNRv1_ROM_DoubleSpin model. More...

SEOBNRv1 Reduced Order Model (Effective Spin)
C code for SEOBNRv1 reduced order model (equal spin version). See CQG 31 195010, 2014, arXiv:1402.4146 for details. Author Michael Puerrer, John Veitch This is a frequency domain model that approximates the time domain SEOBNRv1 model with equal spins. Note that SEOBNRv2 supersedes SEOBNRv1. The binary data files are available at https://dcc.ligo.org/T1400701-v1. Put the untared data into a location in your LAL_DATA_PATH. Note Note that due to its construction the iFFT of the ROM has a small (~ 20 M) offset in the peak time that scales with total mass as compared to the time-domain SEOBNRv1 model. Due to non-smoothness in SEOBNRv1 at chi1=chi2 ~ -0.8 and 20 <= q <= 40 the ROM deviates from the SEOBNRv1 behavior there. See arXiv:1402.4146, Fig 7, Fig 11, and Fig 13 for details. Parameter ranges: 1 <= q <= 100 -1 <= chi <= 0.6 Mtot >= 1.4Msun Equal spin chi = chi1 = chi2. Asymmetric mass-ratio q = max(m1/m2, m2/m1). Total mass Mtot.
int	XLALSimIMRSEOBNRv1ROMEffectiveSpinFrequencySequence (struct tagCOMPLEX16FrequencySeries hptilde, struct tagCOMPLEX16FrequencySeries hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi)
	Compute waveform in LAL format at specified frequencies for the SEOBNRv1_ROM_EffectiveSpin model. More...

int	XLALSimIMRSEOBNRv1ROMEffectiveSpin (struct tagCOMPLEX16FrequencySeries hptilde, struct tagCOMPLEX16FrequencySeries hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi)
	Compute waveform in LAL format for the SEOBNRv1_ROM_EffectiveSpin model. More...

SEOBNRv2 Reduced Order Model (Double Spin)
C code for SEOBNRv2 reduced order model (double spin version). See CQG 31 195010, 2014, arXiv:1402.4146 for the basic approach. Further details in PRD 93, 064041, 2016, arXiv:1512.02248. Author Michael Puerrer, John Veitch This is a frequency domain model that approximates the time domain SEOBNRv2 model. The binary data files are available at https://dcc.ligo.org/T1400701-v1. Put the untared data into a location in your LAL_DATA_PATH. Note Note that due to its construction the iFFT of the ROM has a small (~ 20 M) offset in the peak time that scales with total mass as compared to the time-domain SEOBNRv2 model. Parameter ranges: 0.01 <= eta <= 0.25 -1 <= chi_i <= 0.99 Mtot >= 12Msun Aligned component spins chi1, chi2. Symmetric mass-ratio eta = m1*m2/(m1+m2)^2. Total mass Mtot.
int	XLALSimIMRSEOBNRv2ROMDoubleSpinFrequencySequence (struct tagCOMPLEX16FrequencySeries hptilde, struct tagCOMPLEX16FrequencySeries hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2)
	Compute waveform in LAL format at specified frequencies for the SEOBNRv2_ROM_DoubleSpin model. More...

int	XLALSimIMRSEOBNRv2ROMDoubleSpin (struct tagCOMPLEX16FrequencySeries hptilde, struct tagCOMPLEX16FrequencySeries hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2)
	Compute waveform in LAL format for the SEOBNRv2_ROM_DoubleSpin model. More...

int	XLALSimIMRSEOBNRv2ROMDoubleSpinAmpPhaseInterpolants (struct tagREAL8Vector amplitude_interp, struct tagREAL8Vector amplitude_freq_points, struct tagREAL8Vector phase_interp, struct tagREAL8Vector phase_freq_points, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2)
	Compute the Amplitude and Phase interpolants for the SEOBNRv2DoubleSpin model. More...

int	XLALSimIMRSEOBNRv2ROMDoubleSpinTimeOfFrequency (REAL8 *t, REAL8 frequency, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2)
	Compute the 'time' elapsed in the ROM waveform from a given starting frequency until the ringdown. More...

int	XLALSimIMRSEOBNRv2ROMDoubleSpinFrequencyOfTime (REAL8 *frequency, REAL8 t, REAL8 m1SI, REAL8 m2SI, REAL8 chi1, REAL8 chi2)
	Compute the starting frequency so that the given amount of 'time' elapses in the ROM waveform from the starting frequency until the ringdown. More...

SEOBNRv2 Reduced Order Model (Effective Spin)
C code for SEOBNRv2 reduced order model (equal spin version). See CQG 31 195010, 2014, arXiv:1402.4146 for details. Author Michael Puerrer, John Veitch This is a frequency domain model that approximates the time domain SEOBNRv2 model with equal spins. The binary data files are available at https://dcc.ligo.org/T1400701-v1. Put the untared data into a location in your LAL_DATA_PATH. Note Note that due to its construction the iFFT of the ROM has a small (~ 20 M) offset in the peak time that scales with total mass as compared to the time-domain SEOBNRv2 model. Parameter ranges: 0.01 <= eta <= 0.25 -1 <= chi <= 0.99 Mtot >= 1.4Msun Equal spin chi = chi1 = chi2 in terms of aligned component spins chi1, chi2. Symmetric mass-ratio eta = m1*m2/(m1+m2)^2. Total mass Mtot.
int	XLALSimIMRSEOBNRv2ROMEffectiveSpinFrequencySequence (struct tagCOMPLEX16FrequencySeries hptilde, struct tagCOMPLEX16FrequencySeries hctilde, const REAL8Sequence *freqs, REAL8 phiRef, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi)
	Compute waveform in LAL format at specified frequencies for the SEOBNRv2_ROM_EffectiveSpin model. More...

int	XLALSimIMRSEOBNRv2ROMEffectiveSpin (struct tagCOMPLEX16FrequencySeries hptilde, struct tagCOMPLEX16FrequencySeries hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 fLow, REAL8 fHigh, REAL8 fRef, REAL8 distance, REAL8 inclination, REAL8 m1SI, REAL8 m2SI, REAL8 chi)
	Compute waveform in LAL format for the SEOBNRv2_ROM_EffectiveSpin model. More...

int	XLALSimIMRSEOBNRv2ROMEffectiveSpinTimeOfFrequency (REAL8 *t, REAL8 frequency, REAL8 m1SI, REAL8 m2SI, REAL8 chi)
	Compute the 'time' elapsed in the ROM waveform from a given starting frequency until the ringdown. More...

int	XLALSimIMRSEOBNRv2ROMEffectiveSpinFrequencyOfTime (REAL8 *frequency, REAL8 t, REAL8 m1SI, REAL8 m2SI, REAL8 chi)
	Compute the starting frequency so that the given amount of 'time' elapses in the ROM waveform from the starting frequency until the ringdown. More...

Function Documentation

◆ XLALSimIMRSEOBNRv1ROMDoubleSpinFrequencySequence()

int XLALSimIMRSEOBNRv1ROMDoubleSpinFrequencySequence	(	struct tagCOMPLEX16FrequencySeries **	hptilde,
		struct tagCOMPLEX16FrequencySeries **	hctilde,
		const REAL8Sequence *	freqs,
		REAL8	phiRef,
		REAL8	fRef,
		REAL8	distance,
		REAL8	inclination,
		REAL8	m1SI,
		REAL8	m2SI,
		REAL8	chi1,
		REAL8	chi2
	)

Compute waveform in LAL format at specified frequencies for the SEOBNRv1_ROM_DoubleSpin model.

XLALSimIMRSEOBNRv1ROMDoubleSpin() returns the plus and cross polarizations as a complex frequency series with equal spacing deltaF and contains zeros from zero frequency to the starting frequency and zeros beyond the cutoff frequency in the ringdown.

In contrast, XLALSimIMRSEOBNRv1ROMDoubleSpinFrequencySequence() returns a complex frequency series with entries exactly at the frequencies specified in the sequence freqs (which can be unequally spaced). No zeros are added.

If XLALSimIMRSEOBNRv1ROMDoubleSpinFrequencySequence() is called with frequencies that are beyond the maxium allowed geometric frequency for the ROM, zero strain is returned. It is not assumed that the frequency sequence is ordered.

This function is designed as an entry point for reduced order quadratures.

Parameters

hptilde	Output: Frequency-domain waveform h+
hctilde	Output: Frequency-domain waveform hx
freqs	Frequency points at which to evaluate the waveform (Hz), need to be strictly monotonically increasing
phiRef	Orbital phase at reference time
fRef	Reference frequency (Hz); 0 defaults to fLow
distance	Distance of source (m)
inclination	Inclination of source (rad)
m1SI	Mass of companion 1 (kg)
m2SI	Mass of companion 2 (kg)
chi1	Dimensionless aligned component spin 1
chi2	Dimensionless aligned component spin 2

Definition at line 739 of file LALSimIMRSEOBNRv1ROMDoubleSpin.c.

◆ XLALSimIMRSEOBNRv1ROMDoubleSpin()

int XLALSimIMRSEOBNRv1ROMDoubleSpin	(	struct tagCOMPLEX16FrequencySeries **	hptilde,
		struct tagCOMPLEX16FrequencySeries **	hctilde,
		REAL8	phiRef,
		REAL8	deltaF,
		REAL8	fLow,
		REAL8	fHigh,
		REAL8	fRef,
		REAL8	distance,
		REAL8	inclination,
		REAL8	m1SI,
		REAL8	m2SI,
		REAL8	chi1,
		REAL8	chi2
	)

Compute waveform in LAL format for the SEOBNRv1_ROM_DoubleSpin model.

Returns the plus and cross polarizations as a complex frequency series with equal spacing deltaF and contains zeros from zero frequency to the starting frequency fLow and zeros beyond the cutoff frequency fHigh to the next power of 2 in the size of the frequency series.

Parameters

hptilde	Output: Frequency-domain waveform h+
hctilde	Output: Frequency-domain waveform hx
phiRef	Orbital phase at reference frequency
deltaF	Sampling frequency (Hz)
fLow	Starting GW frequency (Hz)
fHigh	End frequency; 0 defaults to Mf=0.14
fRef	Reference frequency (Hz); 0 defaults to fLow
distance	Distance of source (m)
inclination	Inclination of source (rad)
m1SI	Mass of companion 1 (kg)
m2SI	Mass of companion 2 (kg)
chi1	Dimensionless aligned component spin 1
chi2	Dimensionless aligned component spin 2

Definition at line 797 of file LALSimIMRSEOBNRv1ROMDoubleSpin.c.

◆ XLALSimIMRSEOBNRv1ROMEffectiveSpinFrequencySequence()

int XLALSimIMRSEOBNRv1ROMEffectiveSpinFrequencySequence	(	struct tagCOMPLEX16FrequencySeries **	hptilde,
		struct tagCOMPLEX16FrequencySeries **	hctilde,
		const REAL8Sequence *	freqs,
		REAL8	phiRef,
		REAL8	fRef,
		REAL8	distance,
		REAL8	inclination,
		REAL8	m1SI,
		REAL8	m2SI,
		REAL8	chi
	)

Compute waveform in LAL format at specified frequencies for the SEOBNRv1_ROM_EffectiveSpin model.

XLALSimIMRSEOBNRv1ROMEffectiveSpin() returns the plus and cross polarizations as a complex frequency series with equal spacing deltaF and contains zeros from zero frequency to the starting frequency and zeros beyond the cutoff frequency in the ringdown.

In contrast, XLALSimIMRSEOBNRv1ROMEffectiveSpinFrequencySequence() returns a complex frequency series with entries exactly at the frequencies specified in the sequence freqs (which can be unequally spaced). No zeros are added.

If XLALSimIMRSEOBNRv1ROMEffectiveSpinFrequencySequence() is called with frequencies that are beyond the maxium allowed geometric frequency for the ROM, zero strain is returned. It is not assumed that the frequency sequence is ordered.

This function is designed as an entry point for reduced order quadratures.

Parameters

hptilde	Output: Frequency-domain waveform h+
hctilde	Output: Frequency-domain waveform hx
freqs	Frequency points at which to evaluate the waveform (Hz), need to be strictly monotonically increasing
phiRef	Orbital phase at reference time
fRef	Reference frequency (Hz); 0 defaults to fLow
distance	Distance of source (m)
inclination	Inclination of source (rad)
m1SI	Mass of companion 1 (kg)
m2SI	Mass of companion 2 (kg)
chi	Effective aligned spin

Definition at line 750 of file LALSimIMRSEOBNRv1ROMEffectiveSpin.c.

◆ XLALSimIMRSEOBNRv1ROMEffectiveSpin()

int XLALSimIMRSEOBNRv1ROMEffectiveSpin	(	struct tagCOMPLEX16FrequencySeries **	hptilde,
		struct tagCOMPLEX16FrequencySeries **	hctilde,
		REAL8	phiRef,
		REAL8	deltaF,
		REAL8	fLow,
		REAL8	fHigh,
		REAL8	fRef,
		REAL8	distance,
		REAL8	inclination,
		REAL8	m1SI,
		REAL8	m2SI,
		REAL8	chi
	)

Compute waveform in LAL format for the SEOBNRv1_ROM_EffectiveSpin model.

Returns the plus and cross polarizations as a complex frequency series with equal spacing deltaF and contains zeros from zero frequency to the starting frequency fLow and zeros beyond the cutoff frequency fHigh to the next power of 2 in the size of the frequency series.

Parameters

hptilde	Output: Frequency-domain waveform h+
hctilde	Output: Frequency-domain waveform hx
phiRef	Orbital phase at reference time
deltaF	Sampling frequency (Hz)
fLow	Starting GW frequency (Hz)
fHigh	End frequency; 0 defaults to Mf=0.14
fRef	Reference frequency (Hz); 0 defaults to fLow
distance	Distance of source (m)
inclination	Inclination of source (rad)
m1SI	Mass of companion 1 (kg)
m2SI	Mass of companion 2 (kg)
chi	Effective aligned spin

Definition at line 797 of file LALSimIMRSEOBNRv1ROMEffectiveSpin.c.

◆ XLALSimIMRSEOBNRv2ROMDoubleSpinFrequencySequence()

int XLALSimIMRSEOBNRv2ROMDoubleSpinFrequencySequence	(	struct tagCOMPLEX16FrequencySeries **	hptilde,
		struct tagCOMPLEX16FrequencySeries **	hctilde,
		const REAL8Sequence *	freqs,
		REAL8	phiRef,
		REAL8	fRef,
		REAL8	distance,
		REAL8	inclination,
		REAL8	m1SI,
		REAL8	m2SI,
		REAL8	chi1,
		REAL8	chi2
	)

Compute waveform in LAL format at specified frequencies for the SEOBNRv2_ROM_DoubleSpin model.

XLALSimIMRSEOBNRv2ROMDoubleSpin() returns the plus and cross polarizations as a complex frequency series with equal spacing deltaF and contains zeros from zero frequency to the starting frequency and zeros beyond the cutoff frequency in the ringdown.

In contrast, XLALSimIMRSEOBNRv2ROMDoubleSpinFrequencySequence() returns a complex frequency series with entries exactly at the frequencies specified in the sequence freqs (which can be unequally spaced). No zeros are added.

If XLALSimIMRSEOBNRv2ROMDoubleSpinFrequencySequence() is called with frequencies that are beyond the maxium allowed geometric frequency for the ROM, zero strain is returned. It is not assumed that the frequency sequence is ordered.

This function is designed as an entry point for reduced order quadratures.

Parameters

hptilde	Output: Frequency-domain waveform h+
hctilde	Output: Frequency-domain waveform hx
freqs	Frequency points at which to evaluate the waveform (Hz), need to be strictly monotonically increasing
phiRef	Orbital phase at reference time
fRef	Reference frequency (Hz); 0 defaults to fLow
distance	Distance of source (m)
inclination	Inclination of source (rad)
m1SI	Mass of companion 1 (kg)
m2SI	Mass of companion 2 (kg)
chi1	Dimensionless aligned component spin 1
chi2	Dimensionless aligned component spin 2

Definition at line 1109 of file LALSimIMRSEOBNRv2ROMDoubleSpin.c.

◆ XLALSimIMRSEOBNRv2ROMDoubleSpin()

int XLALSimIMRSEOBNRv2ROMDoubleSpin	(	struct tagCOMPLEX16FrequencySeries **	hptilde,
		struct tagCOMPLEX16FrequencySeries **	hctilde,
		REAL8	phiRef,
		REAL8	deltaF,
		REAL8	fLow,
		REAL8	fHigh,
		REAL8	fRef,
		REAL8	distance,
		REAL8	inclination,
		REAL8	m1SI,
		REAL8	m2SI,
		REAL8	chi1,
		REAL8	chi2
	)

Compute waveform in LAL format for the SEOBNRv2_ROM_DoubleSpin model.

Returns the plus and cross polarizations as a complex frequency series with equal spacing deltaF and contains zeros from zero frequency to the starting frequency fLow and zeros beyond the cutoff frequency fHigh to the next power of 2 in the size of the frequency series.

Parameters

hptilde	Output: Frequency-domain waveform h+
hctilde	Output: Frequency-domain waveform hx
phiRef	Orbital phase at reference frequency
deltaF	Sampling frequency (Hz)
fLow	Starting GW frequency (Hz)
fHigh	End frequency; 0 defaults to Mf=0.14
fRef	Reference frequency (Hz); 0 defaults to fLow
distance	Distance of source (m)
inclination	Inclination of source (rad)
m1SI	Mass of companion 1 (kg)
m2SI	Mass of companion 2 (kg)
chi1	Dimensionless aligned component spin 1
chi2	Dimensionless aligned component spin 2

Definition at line 1170 of file LALSimIMRSEOBNRv2ROMDoubleSpin.c.

◆ XLALSimIMRSEOBNRv2ROMDoubleSpinAmpPhaseInterpolants()

int XLALSimIMRSEOBNRv2ROMDoubleSpinAmpPhaseInterpolants	(	struct tagREAL8Vector **	amplitude_interp,
		struct tagREAL8Vector **	amplitude_freq_points,
		struct tagREAL8Vector **	phase_interp,
		struct tagREAL8Vector **	phase_freq_points,
		REAL8	phiRef,
		REAL8	deltaF,
		REAL8	fLow,
		REAL8	fHigh,
		REAL8	fRef,
		REAL8	distance,
		REAL8	inclination,
		REAL8	m1SI,
		REAL8	m2SI,
		REAL8	chi1,
		REAL8	chi2
	)

Compute the Amplitude and Phase interpolants for the SEOBNRv2DoubleSpin model.

Return A, psi, f_A, and f_Psi, given the parameters of a waveform

Parameters

amplitude_interp	Output: amplitude interpolants
amplitude_freq_points	Output: frequencies of amp interpolants
phase_interp	Output: phase interpolants
phase_freq_points	Output: frequencies of phase interpolants
phiRef	Orbital phase at reference frequency
deltaF	Sampling frequency (Hz)
fLow	Starting GW frequency (Hz)
fHigh	End frequency; 0 defaults to Mf=0.14
fRef	Reference frequency (Hz); 0 defaults to fLow
distance	Distance of source (m)
inclination	Inclination of source (rad)
m1SI	Mass of companion 1 (kg)
m2SI	Mass of companion 2 (kg)
chi1	Dimensionless aligned component spin 1
chi2	Dimensionless aligned component spin 2

Definition at line 1236 of file LALSimIMRSEOBNRv2ROMDoubleSpin.c.

◆ XLALSimIMRSEOBNRv2ROMDoubleSpinTimeOfFrequency()

int XLALSimIMRSEOBNRv2ROMDoubleSpinTimeOfFrequency	(	REAL8 *	t,
		REAL8	frequency,
		REAL8	m1SI,
		REAL8	m2SI,
		REAL8	chi1,
		REAL8	chi2
	)

Compute the 'time' elapsed in the ROM waveform from a given starting frequency until the ringdown.

UNREVIEWED!

The notion of elapsed 'time' (in seconds) is defined here as the difference of the frequency derivative of the frequency domain phase between the ringdown frequency and the starting frequency ('frequency' argument). This notion of time is similar to the chirp time, but it includes both the inspiral and the merger ringdown part of SEOBNRv2.

The allowed frequency range for the starting frequency in geometric frequency is [0.00053, 0.135]. The SEOBNRv2 ringdown frequency can be obtained by calling XLALSimInspiralGetFinalFreq().

See XLALSimIMRSEOBNRv2ROMDoubleSpinFrequencyOfTime() for the inverse function.

Parameters

t	Output: time (s) elapsed from starting frequency to ringdown
frequency	Starting frequency (Hz)
m1SI	Mass of companion 1 (kg)
m2SI	Mass of companion 2 (kg)
chi1	Dimensionless aligned component spin 1
chi2	Dimensionless aligned component spin 2

Definition at line 1321 of file LALSimIMRSEOBNRv2ROMDoubleSpin.c.

◆ XLALSimIMRSEOBNRv2ROMDoubleSpinFrequencyOfTime()

int XLALSimIMRSEOBNRv2ROMDoubleSpinFrequencyOfTime	(	REAL8 *	frequency,
		REAL8	t,
		REAL8	m1SI,
		REAL8	m2SI,
		REAL8	chi1,
		REAL8	chi2
	)

Compute the starting frequency so that the given amount of 'time' elapses in the ROM waveform from the starting frequency until the ringdown.

UNREVIEWED!

The notion of elapsed 'time' (in seconds) is defined here as the difference of the frequency derivative of the frequency domain phase between the ringdown frequency and the starting frequency ('frequency' argument). This notion of time is similar to the chirp time, but it includes both the inspiral and the merger ringdown part of SEOBNRv2.

If the frequency that corresponds to the specified elapsed time is lower than the geometric frequency Mf=0.00053 (ROM starting frequency) or above half of the SEOBNRv2 ringdown frequency an error is thrown. The SEOBNRv2 ringdown frequency can be obtained by calling XLALSimInspiralGetFinalFreq().

See XLALSimIMRSEOBNRv2ROMDoubleSpinTimeOfFrequency() for the inverse function.

Parameters

frequency	Output: Frequency (Hz)
t	Time (s) at frequency
m1SI	Mass of companion 1 (kg)
m2SI	Mass of companion 2 (kg)
chi1	Dimensionless aligned component spin 1
chi2	Dimensionless aligned component spin 2

Definition at line 1391 of file LALSimIMRSEOBNRv2ROMDoubleSpin.c.

◆ XLALSimIMRSEOBNRv2ROMDoubleSpinHIFrequencySequence()

int XLALSimIMRSEOBNRv2ROMDoubleSpinHIFrequencySequence	(	struct tagCOMPLEX16FrequencySeries **	hptilde,
		struct tagCOMPLEX16FrequencySeries **	hctilde,
		const REAL8Sequence *	freqs,
		REAL8	phiRef,
		REAL8	fRef,
		REAL8	distance,
		REAL8	inclination,
		REAL8	m1SI,
		REAL8	m2SI,
		REAL8	chi1,
		REAL8	chi2,
		INT4	nk_max
	)

Compute waveform in LAL format at specified frequencies for the SEOBNRv2_ROM_DoubleSpin_HI model.

XLALSimIMRSEOBNRv2ROMDoubleSpinHI() returns the plus and cross polarizations as a complex frequency series with equal spacing deltaF and contains zeros from zero frequency to the starting frequency and zeros beyond the cutoff frequency in the ringdown.

In contrast, XLALSimIMRSEOBNRv2ROMDoubleSpinHIFrequencySequence() returns a complex frequency series with entries exactly at the frequencies specified in the sequence freqs (which can be unequally spaced). No zeros are added.

If XLALSimIMRSEOBNRv2ROMDoubleSpinHIFrequencySequence() is called with frequencies that are beyond the maxium allowed geometric frequency for the ROM, zero strain is returned. It is not assumed that the frequency sequence is ordered.

This function is designed as an entry point for reduced order quadratures.

Parameters

hptilde	Output: Frequency-domain waveform h+
hctilde	Output: Frequency-domain waveform hx
freqs	Frequency points at which to evaluate the waveform (Hz)
phiRef	Orbital phase at reference time
fRef	Reference frequency (Hz); 0 defaults to fLow
distance	Distance of source (m)
inclination	Inclination of source (rad)
m1SI	Mass of companion 1 (kg)
m2SI	Mass of companion 2 (kg)
chi1	Dimensionless aligned component spin 1
chi2	Dimensionless aligned component spin 2
nk_max	Truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1

Definition at line 1486 of file LALSimIMRSEOBNRv2ROMDoubleSpinHI.c.

◆ XLALSimIMRSEOBNRv2ROMDoubleSpinHI()

int XLALSimIMRSEOBNRv2ROMDoubleSpinHI	(	struct tagCOMPLEX16FrequencySeries **	hptilde,
		struct tagCOMPLEX16FrequencySeries **	hctilde,
		REAL8	phiRef,
		REAL8	deltaF,
		REAL8	fLow,
		REAL8	fHigh,
		REAL8	fRef,
		REAL8	distance,
		REAL8	inclination,
		REAL8	m1SI,
		REAL8	m2SI,
		REAL8	chi1,
		REAL8	chi2,
		INT4	nk_max
	)

Compute waveform in LAL format for the SEOBNRv2_ROM_DoubleSpin_HI model.

Returns the plus and cross polarizations as a complex frequency series with equal spacing deltaF and contains zeros from zero frequency to the starting frequency fLow and zeros beyond the cutoff frequency in the ringdown.

Parameters

hptilde	Output: Frequency-domain waveform h+
hctilde	Output: Frequency-domain waveform hx
phiRef	Phase at reference time
deltaF	Sampling frequency (Hz)
fLow	Starting GW frequency (Hz)
fHigh	End frequency; 0 defaults to Mf=0.14
fRef	Reference frequency (Hz); 0 defaults to fLow
distance	Distance of source (m)
inclination	Inclination of source (rad)
m1SI	Mass of companion 1 (kg)
m2SI	Mass of companion 2 (kg)
chi1	Dimensionless aligned component spin 1
chi2	Dimensionless aligned component spin 2
nk_max	Truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1

Definition at line 1547 of file LALSimIMRSEOBNRv2ROMDoubleSpinHI.c.

◆ XLALSimIMRSEOBNRv2ROMEffectiveSpinFrequencySequence()

int XLALSimIMRSEOBNRv2ROMEffectiveSpinFrequencySequence	(	struct tagCOMPLEX16FrequencySeries **	hptilde,
		struct tagCOMPLEX16FrequencySeries **	hctilde,
		const REAL8Sequence *	freqs,
		REAL8	phiRef,
		REAL8	fRef,
		REAL8	distance,
		REAL8	inclination,
		REAL8	m1SI,
		REAL8	m2SI,
		REAL8	chi
	)

Compute waveform in LAL format at specified frequencies for the SEOBNRv2_ROM_EffectiveSpin model.

XLALSimIMRSEOBNRv2ROMEffectiveSpin() returns the plus and cross polarizations as a complex frequency series with equal spacing deltaF and contains zeros from zero frequency to the starting frequency and zeros beyond the cutoff frequency in the ringdown.

In contrast, XLALSimIMRSEOBNRv2ROMEffectiveSpinFrequencySequence() returns a complex frequency series with entries exactly at the frequencies specified in the sequence freqs (which can be unequally spaced). No zeros are added.

If XLALSimIMRSEOBNRv2ROMEffectiveSpinFrequencySequence() is called with frequencies that are beyond the maxium allowed geometric frequency for the ROM, zero strain is returned. It is not assumed that the frequency sequence is ordered.

This function is designed as an entry point for reduced order quadratures.

Parameters

hptilde	Output: Frequency-domain waveform h+
hctilde	Output: Frequency-domain waveform hx
freqs	Frequency points at which to evaluate the waveform (Hz), need to be strictly monotonically increasing
phiRef	Orbital phase at reference time
fRef	Reference frequency (Hz); 0 defaults to fLow
distance	Distance of source (m)
inclination	Inclination of source (rad)
m1SI	Mass of companion 1 (kg)
m2SI	Mass of companion 2 (kg)
chi	Effective aligned spin

Definition at line 774 of file LALSimIMRSEOBNRv2ROMEffectiveSpin.c.

◆ XLALSimIMRSEOBNRv2ROMEffectiveSpin()

int XLALSimIMRSEOBNRv2ROMEffectiveSpin	(	struct tagCOMPLEX16FrequencySeries **	hptilde,
		struct tagCOMPLEX16FrequencySeries **	hctilde,
		REAL8	phiRef,
		REAL8	deltaF,
		REAL8	fLow,
		REAL8	fHigh,
		REAL8	fRef,
		REAL8	distance,
		REAL8	inclination,
		REAL8	m1SI,
		REAL8	m2SI,
		REAL8	chi
	)

Compute waveform in LAL format for the SEOBNRv2_ROM_EffectiveSpin model.

Returns the plus and cross polarizations as a complex frequency series with equal spacing deltaF and contains zeros from zero frequency to the starting frequency fLow and zeros beyond the cutoff frequency fHigh to the next power of 2 in the size of the frequency series.

Parameters

hptilde	Output: Frequency-domain waveform h+
hctilde	Output: Frequency-domain waveform hx
phiRef	Orbital phase at reference time
deltaF	Sampling frequency (Hz)
fLow	Starting GW frequency (Hz)
fHigh	End frequency; 0 defaults to Mf=0.14
fRef	Reference frequency (Hz); 0 defaults to fLow
distance	Distance of source (m)
inclination	Inclination of source (rad)
m1SI	Mass of companion 1 (kg)
m2SI	Mass of companion 2 (kg)
chi	Effective aligned spin

Definition at line 821 of file LALSimIMRSEOBNRv2ROMEffectiveSpin.c.

◆ XLALSimIMRSEOBNRv2ROMEffectiveSpinTimeOfFrequency()

int XLALSimIMRSEOBNRv2ROMEffectiveSpinTimeOfFrequency	(	REAL8 *	t,
		REAL8	frequency,
		REAL8	m1SI,
		REAL8	m2SI,
		REAL8	chi
	)

Compute the 'time' elapsed in the ROM waveform from a given starting frequency until the ringdown.

UNREVIEWED!

The notion of elapsed 'time' (in seconds) is defined here as the difference of the frequency derivative of the frequency domain phase between the ringdown frequency and the starting frequency ('frequency' argument). This notion of time is similar to the chirp time, but it includes both the inspiral and the merger ringdown part of SEOBNRv2.

The allowed frequency range for the starting frequency in geometric frequency is [0.0001, 0.3]. The SEOBNRv2 ringdown frequency can be obtained by calling XLALSimInspiralGetFinalFreq().

See XLALSimIMRSEOBNRv2ROMEffectiveSpinFrequencyOfTime() for the inverse function.

Parameters

t	Output: time (s) at frequency
frequency	Frequency (Hz)
m1SI	Mass of companion 1 (kg)
m2SI	Mass of companion 2 (kg)
chi	Equal aligned spin (chi = chi1 = chi2)

Definition at line 884 of file LALSimIMRSEOBNRv2ROMEffectiveSpin.c.

◆ XLALSimIMRSEOBNRv2ROMEffectiveSpinFrequencyOfTime()

int XLALSimIMRSEOBNRv2ROMEffectiveSpinFrequencyOfTime	(	REAL8 *	frequency,
		REAL8	t,
		REAL8	m1SI,
		REAL8	m2SI,
		REAL8	chi
	)

Compute the starting frequency so that the given amount of 'time' elapses in the ROM waveform from the starting frequency until the ringdown.

UNREVIEWED!

The notion of elapsed 'time' (in seconds) is defined here as the difference of the frequency derivative of the frequency domain phase between the ringdown frequency and the starting frequency ('frequency' argument). This notion of time is similar to the chirp time, but it includes both the inspiral and the merger ringdown part of SEOBNRv2.

If the frequency that corresponds to the specified elapsed time is lower than the geometric frequency Mf=0.0001 (ROM starting frequency) or above half of the SEOBNRv2 ringdown frequency an error is thrown. The SEOBNRv2 ringdown frequency can be obtained by calling XLALSimInspiralGetFinalFreq().

See XLALSimIMRSEOBNRv2ROMEffectiveSpinTimeOfFrequency() for the inverse function.

Parameters

frequency	Output: Frequency (Hz)
t	Time (s) at frequency
m1SI	Mass of companion 1 (kg)
m2SI	Mass of companion 2 (kg)
chi	Effective aligned spin

Definition at line 942 of file LALSimIMRSEOBNRv2ROMEffectiveSpin.c.

◆ XLALSimIMRSEOBNRv4ROMFrequencySequence()

int XLALSimIMRSEOBNRv4ROMFrequencySequence	(	struct tagCOMPLEX16FrequencySeries **	hptilde,
		struct tagCOMPLEX16FrequencySeries **	hctilde,
		const REAL8Sequence *	freqs,
		REAL8	phiRef,
		REAL8	fRef,
		REAL8	distance,
		REAL8	inclination,
		REAL8	m1SI,
		REAL8	m2SI,
		REAL8	chi1,
		REAL8	chi2,
		INT4	nk_max,
		LALDict *	LALparams,
		NRTidal_version_type	NRTidal_version
	)

Compute waveform in LAL format at specified frequencies for the SEOBNRv4_ROM model.

XLALSimIMRSEOBNRv4ROM() returns the plus and cross polarizations as a complex frequency series with equal spacing deltaF and contains zeros from zero frequency to the starting frequency and zeros beyond the cutoff frequency in the ringdown.

In contrast, XLALSimIMRSEOBNRv4ROMFrequencySequence() returns a complex frequency series with entries exactly at the frequencies specified in the sequence freqs (which can be unequally spaced). No zeros are added.

If XLALSimIMRSEOBNRv4ROMFrequencySequence() is called with frequencies that are beyond the maxium allowed geometric frequency for the ROM, zero strain is returned. It is not assumed that the frequency sequence is ordered.

This function is designed as an entry point for reduced order quadratures.

Parameters

hptilde	Output: Frequency-domain waveform h+
hctilde	Output: Frequency-domain waveform hx
freqs	Frequency points at which to evaluate the waveform (Hz)
phiRef	Orbital phase at reference time
fRef	Reference frequency (Hz); 0 defaults to fLow
distance	Distance of source (m)
inclination	Inclination of source (rad)
m1SI	Mass of companion 1 (kg)
m2SI	Mass of companion 2 (kg)
chi1	Dimensionless aligned component spin 1
chi2	Dimensionless aligned component spin 2
nk_max	Truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1
LALparams	LAL dictionary containing accessory parameters
NRTidal_version	NRTidal version; either NRTidal_V or NRTidalv2_V or NoNRT_V in case of BBH baseline

Definition at line 1156 of file LALSimIMRSEOBNRv4ROM.c.

◆ XLALSimIMRSEOBNRv4ROM()

int XLALSimIMRSEOBNRv4ROM	(	struct tagCOMPLEX16FrequencySeries **	hptilde,
		struct tagCOMPLEX16FrequencySeries **	hctilde,
		REAL8	phiRef,
		REAL8	deltaF,
		REAL8	fLow,
		REAL8	fHigh,
		REAL8	fRef,
		REAL8	distance,
		REAL8	inclination,
		REAL8	m1SI,
		REAL8	m2SI,
		REAL8	chi1,
		REAL8	chi2,
		INT4	nk_max,
		LALDict *	LALparams,
		NRTidal_version_type	NRTidal_version
	)

Compute waveform in LAL format for the SEOBNRv4_ROM model.

Returns the plus and cross polarizations as a complex frequency series with equal spacing deltaF and contains zeros from zero frequency to the starting frequency fLow and zeros beyond the cutoff frequency in the ringdown.

Parameters

hptilde	Output: Frequency-domain waveform h+
hctilde	Output: Frequency-domain waveform hx
phiRef	Phase at reference time
deltaF	Sampling frequency (Hz)
fLow	Starting GW frequency (Hz)
fHigh	End frequency; 0 defaults to Mf=0.14
fRef	Reference frequency (Hz); 0 defaults to fLow
distance	Distance of source (m)
inclination	Inclination of source (rad)
m1SI	Mass of companion 1 (kg)
m2SI	Mass of companion 2 (kg)
chi1	Dimensionless aligned component spin 1
chi2	Dimensionless aligned component spin 2
nk_max	Truncate interpolants at SVD mode nk_max; don't truncate if nk_max == -1
LALparams	LAL dictionary containing accessory parameters
NRTidal_version	NRTidal version; either NRTidal_V or NRTidalv2_V or NoNRT_V in case of BBH baseline

Definition at line 1221 of file LALSimIMRSEOBNRv4ROM.c.

Detailed Description

Prototypes

SEOBNRv1 Reduced Order Model (Double Spin)

SEOBNRv1 Reduced Order Model (Effective Spin)

SEOBNRv2 Reduced Order Model (Double Spin)

SEOBNRv2 Reduced Order Model (Effective Spin)

Function Documentation

◆ XLALSimIMRSEOBNRv1ROMDoubleSpinFrequencySequence()

◆ XLALSimIMRSEOBNRv1ROMDoubleSpin()

◆ XLALSimIMRSEOBNRv1ROMEffectiveSpinFrequencySequence()

◆ XLALSimIMRSEOBNRv1ROMEffectiveSpin()

◆ XLALSimIMRSEOBNRv2ROMDoubleSpinFrequencySequence()

◆ XLALSimIMRSEOBNRv2ROMDoubleSpin()

◆ XLALSimIMRSEOBNRv2ROMDoubleSpinAmpPhaseInterpolants()

◆ XLALSimIMRSEOBNRv2ROMDoubleSpinTimeOfFrequency()

◆ XLALSimIMRSEOBNRv2ROMDoubleSpinFrequencyOfTime()

◆ XLALSimIMRSEOBNRv2ROMDoubleSpinHIFrequencySequence()

◆ XLALSimIMRSEOBNRv2ROMDoubleSpinHI()

◆ XLALSimIMRSEOBNRv2ROMEffectiveSpinFrequencySequence()

◆ XLALSimIMRSEOBNRv2ROMEffectiveSpin()

◆ XLALSimIMRSEOBNRv2ROMEffectiveSpinTimeOfFrequency()

◆ XLALSimIMRSEOBNRv2ROMEffectiveSpinFrequencyOfTime()

◆ XLALSimIMRSEOBNRv4ROMFrequencySequence()

◆ XLALSimIMRSEOBNRv4ROM()