Prototypes
static BBHPhenomParams *	ComputeIMRPhenomAParams (const REAL8 m1, const REAL8 m2)

static BBHPhenomParams *	ComputeIMRPhenomBParams (const REAL8 m1, const REAL8 m2, const REAL8 chi)

static REAL8	EstimateSafeFMinForTD (const REAL8 m1, const REAL8 m2, const REAL8 f_min, const REAL8 deltaT)

static REAL8	EstimateSafeFMaxForTD (const REAL8 f_max, const REAL8 dt)

static REAL8	ComputeTau0 (const REAL8 m1, const REAL8 m2, const REAL8 f_min)

static size_t	EstimateIMRLength (const REAL8 m1, const REAL8 m2, const REAL8 f_min, const REAL8 deltaT)

static size_t	NextPow2 (const size_t n)

static REAL8	LorentzianFn (const REAL8 freq, const REAL8 fRing, const REAL8 sigma)

static int	IMRPhenomAGenerateFD (COMPLEX16FrequencySeries *htilde, const REAL8 phi0, const REAL8 deltaF, const REAL8 m1, const REAL8 m2, const REAL8 f_min, const REAL8 f_max, const REAL8 distance, const BBHPhenomParams params)

static int	IMRPhenomBGenerateFD (COMPLEX16FrequencySeries *htilde, const REAL8 phi0, const REAL8 deltaF, const REAL8 m1, const REAL8 m2, const REAL8 chi, const REAL8 f_min, const REAL8 f_max, const REAL8 distance, const BBHPhenomParams params)

static int	IMRPhenomAGenerateTD (REAL8TimeSeries *h, const REAL8 phiPeak, const REAL8 deltaT, const REAL8 m1, const REAL8 m2, const REAL8 f_min, const REAL8 f_max, const REAL8 distance, const BBHPhenomParams params)

static int	IMRPhenomBGenerateTD (REAL8TimeSeries *h, const REAL8 phiPeak, const REAL8 deltaT, const REAL8 m1, const REAL8 m2, const REAL8 chi, const REAL8 f_min, const REAL8 f_max, const REAL8 distance, const BBHPhenomParams params)

static int	FDToTD (REAL8TimeSeries *signalTD, const COMPLEX16FrequencySeries signalFD, const REAL8 totalMass, const REAL8 deltaT, const REAL8 f_min, const REAL8 f_max, const REAL8 f_min_wide, const REAL8 f_max_wide)

static size_t	find_instant_freq (const REAL8TimeSeries hp, const REAL8TimeSeries hc, const REAL8 target, const size_t start)

static size_t	find_peak_amp (const REAL8TimeSeries hp, const REAL8TimeSeries hc)

static int	apply_phase_shift (const REAL8TimeSeries hp, const REAL8TimeSeries hc, const REAL8 shift)

static int	apply_inclination (const REAL8TimeSeries hp, const REAL8TimeSeries hc, const REAL8 inclination)

static gsl_matrix *	XLALSimIMRPhenomBFisherMatrix (const REAL8 m1, const REAL8 m2, const REAL8 chi, const REAL8 fLow, const REAL8FrequencySeries *Sh)

static IMRDerivCoeffs *	XLALComputeIMRPhenomBDerivativeCoeffs (const REAL8 m1, const REAL8 m2, const REAL8 chi, BBHPhenomParams *params)

static gsl_matrix *	XLALSimIMRPhenomBProjectExtrinsicParam (gsl_matrix *g)

Routines for IMR Phenomenological Model "A"
int	XLALSimIMRPhenomAGenerateFD (COMPLEX16FrequencySeries **htilde, const REAL8 phi0, const REAL8 deltaF, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 f_min, const REAL8 f_max, const REAL8 distance)
	Driver routine to compute the non-spinning, inspiral-merger-ringdown phenomenological waveform IMRPhenomA in the frequency domain. More...

int	XLALSimIMRPhenomAGenerateTD (REAL8TimeSeries hplus, REAL8TimeSeries hcross, const REAL8 phiPeak, const REAL8 deltaT, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 f_min, const REAL8 f_max, const REAL8 distance, const REAL8 inclination)
	Driver routine to compute the non-spinning, inspiral-merger-ringdown phenomenological waveform IMRPhenomA in the time domain. More...

double	XLALSimIMRPhenomAGetFinalFreq (const REAL8 m1, const REAL8 m2)
	Compute the default final frequency. More...

Routines for IMR Phenomenological Model "B"
double	XLALSimIMRPhenomBComputeChi (const REAL8 m1, const REAL8 m2, const REAL8 s1z, const REAL8 s2z)
	Compute the dimensionless, spin-aligned parameter chi as used in the IMRPhenomB waveform. More...

double	XLALSimIMRPhenomBGetFinalFreq (const REAL8 m1, const REAL8 m2, const REAL8 chi)
	Compute the default final frequency. More...

int	XLALSimIMRPhenomBGenerateTD (REAL8TimeSeries hplus, REAL8TimeSeries hcross, const REAL8 phiPeak, const REAL8 deltaT, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi, const REAL8 f_min, const REAL8 f_max, const REAL8 distance, const REAL8 inclination)
	Driver routine to compute the spin-aligned, inspiral-merger-ringdown phenomenological waveform IMRPhenomB in the time domain. More...

int	XLALSimIMRPhenomBGenerateFD (COMPLEX16FrequencySeries **htilde, const REAL8 phi0, const REAL8 deltaF, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi, const REAL8 f_min, const REAL8 f_max, const REAL8 distance)
	Driver routine to compute the spin-aligned, inspiral-merger-ringdown phenomenological waveform IMRPhenomB in the frequency domain. More...

int	XLALSimIMRPhenomBMetricInMEtaChi (REAL8 gamma00, REAL8 gamma01, REAL8 gamma02, REAL8 gamma11, REAL8 gamma12, REAL8 gamma22, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi, const REAL8 fLow, const REAL8FrequencySeries *Sh)
	Compute the template-space metric of the IMRPhenomB waveform in the M, eta, chi coordinates. More...

int	XLALSimIMRPhenomBMetricInTheta0Theta3Theta3S (REAL8 gamma00, REAL8 gamma01, REAL8 gamma02, REAL8 gamma11, REAL8 gamma12, REAL8 gamma22, const REAL8 m1_SI, const REAL8 m2_SI, const REAL8 chi, const REAL8 fLow, const REAL8FrequencySeries *Sh)
	Compute the template-space metric of the IMRPhenomB waveform in the theta0, theta3, theta3S coordinates. More...

Data Structures
struct	BBHPhenomParams

struct	IMRDerivCoeffs

Function Documentation

◆ ComputeIMRPhenomAParams()

static BBHPhenomParams * ComputeIMRPhenomAParams	(	const REAL8	m1,
		const REAL8	m2
	)

static

Definition at line 90 of file LALSimIMRPhenom.c.

◆ ComputeIMRPhenomBParams()

static BBHPhenomParams * ComputeIMRPhenomBParams	(	const REAL8	m1,
		const REAL8	m2,
		const REAL8	chi
	)

static

Definition at line 167 of file LALSimIMRPhenom.c.

◆ EstimateSafeFMinForTD()

static REAL8 EstimateSafeFMinForTD	(	const REAL8	m1,
		const REAL8	m2,
		const REAL8	f_min,
		const REAL8	deltaT
	)

static

Definition at line 271 of file LALSimIMRPhenom.c.

◆ EstimateSafeFMaxForTD()

static REAL8 EstimateSafeFMaxForTD	(	const REAL8	f_max,
		const REAL8	dt
	)

static

Definition at line 285 of file LALSimIMRPhenom.c.

◆ ComputeTau0()

static REAL8 ComputeTau0	(	const REAL8	m1,
		const REAL8	m2,
		const REAL8	f_min
	)

static

Definition at line 248 of file LALSimIMRPhenom.c.

◆ EstimateIMRLength()

static size_t EstimateIMRLength	(	const REAL8	m1,
		const REAL8	m2,
		const REAL8	f_min,
		const REAL8	deltaT
	)

static

Definition at line 258 of file LALSimIMRPhenom.c.

◆ NextPow2()

static size_t NextPow2 ( const size_t n )

static

Definition at line 262 of file LALSimIMRPhenom.c.

◆ LorentzianFn()

static REAL8 LorentzianFn	(	const REAL8	freq,
		const REAL8	fRing,
		const REAL8	sigma
	)

static

Definition at line 293 of file LALSimIMRPhenom.c.

◆ IMRPhenomAGenerateFD()

static int IMRPhenomAGenerateFD	(	COMPLEX16FrequencySeries **	htilde,
		const REAL8	phi0,
		const REAL8	deltaF,
		const REAL8	m1,
		const REAL8	m2,
		const REAL8	f_min,
		const REAL8	f_max,
		const REAL8	distance,
		const BBHPhenomParams *	params
	)

static

Parameters

htilde	FD waveform
phi0	orbital phase at peak (rad)
deltaF	frequency resolution
m1	mass of companion 1 [solar masses]
m2	mass of companion 2 [solar masses]
f_min	start frequency
f_max	end frequency
distance	distance of source
params	from ComputeIMRPhenomAParams

Definition at line 302 of file LALSimIMRPhenom.c.

◆ IMRPhenomBGenerateFD()

static int IMRPhenomBGenerateFD	(	COMPLEX16FrequencySeries **	htilde,
		const REAL8	phi0,
		const REAL8	deltaF,
		const REAL8	m1,
		const REAL8	m2,
		const REAL8	chi,
		const REAL8	f_min,
		const REAL8	f_max,
		const REAL8	distance,
		const BBHPhenomParams *	params
	)

static

Parameters

htilde	FD waveform
phi0	orbital phase at peak (rad)
deltaF	frequency resolution
m1	mass of companion 1 [solar masses]
m2	mass of companion 2 [solar masses]
chi	mass-weighted aligned-spin parameter
f_min	start frequency
f_max	end frequency
distance	distance of source
params	from ComputeIMRPhenomBParams

Definition at line 378 of file LALSimIMRPhenom.c.

◆ IMRPhenomAGenerateTD()

static int IMRPhenomAGenerateTD	(	REAL8TimeSeries **	h,
		const REAL8	phiPeak,
		const REAL8	deltaT,
		const REAL8	m1,
		const REAL8	m2,
		const REAL8	f_min,
		const REAL8	f_max,
		const REAL8	distance,
		const BBHPhenomParams *	params
	)

static

Definition at line 474 of file LALSimIMRPhenom.c.

◆ IMRPhenomBGenerateTD()

static int IMRPhenomBGenerateTD	(	REAL8TimeSeries **	h,
		const REAL8	phiPeak,
		const REAL8	deltaT,
		const REAL8	m1,
		const REAL8	m2,
		const REAL8	chi,
		const REAL8	f_min,
		const REAL8	f_max,
		const REAL8	distance,
		const BBHPhenomParams *	params
	)

static

Definition at line 502 of file LALSimIMRPhenom.c.

◆ FDToTD()

static int FDToTD	(	REAL8TimeSeries **	signalTD,
		const COMPLEX16FrequencySeries *	signalFD,
		const REAL8	totalMass,
		const REAL8	deltaT,
		const REAL8	f_min,
		const REAL8	f_max,
		const REAL8	f_min_wide,
		const REAL8	f_max_wide
	)

static

Definition at line 531 of file LALSimIMRPhenom.c.

◆ find_instant_freq()

static size_t find_instant_freq	(	const REAL8TimeSeries *	hp,
		const REAL8TimeSeries *	hc,
		const REAL8	target,
		const size_t	start
	)

static

Definition at line 580 of file LALSimIMRPhenom.c.

◆ find_peak_amp()

static size_t find_peak_amp	(	const REAL8TimeSeries *	hp,
		const REAL8TimeSeries *	hc
	)

static

Definition at line 599 of file LALSimIMRPhenom.c.

◆ apply_phase_shift()

static int apply_phase_shift	(	const REAL8TimeSeries *	hp,
		const REAL8TimeSeries *	hc,
		const REAL8	shift
	)

static

Definition at line 616 of file LALSimIMRPhenom.c.

◆ apply_inclination()

static int apply_inclination	(	const REAL8TimeSeries *	hp,
		const REAL8TimeSeries *	hc,
		const REAL8	inclination
	)

static

Definition at line 637 of file LALSimIMRPhenom.c.

◆ XLALSimIMRPhenomBFisherMatrix()

static gsl_matrix * XLALSimIMRPhenomBFisherMatrix	(	const REAL8	m1,
		const REAL8	m2,
		const REAL8	chi,
		const REAL8	fLow,
		const REAL8FrequencySeries *	Sh
	)

static

Parameters

m1	component mass 1 (M_sun)
m2	component mass 2 (M_sun)
chi	effective spin parameter of IMRPhenomB: chi = (m1 chi1 + m2 chi2)/(m1+m2)
fLow	low-frequency cutoff (Hz)
Sh	PSD in strain per root Hertz

Definition at line 954 of file LALSimIMRPhenom.c.

◆ XLALComputeIMRPhenomBDerivativeCoeffs()

static IMRDerivCoeffs * XLALComputeIMRPhenomBDerivativeCoeffs	(	const REAL8	m1,
		const REAL8	m2,
		const REAL8	chi,
		BBHPhenomParams *	params
	)

static

Parameters

m1	component mass 1 (M_sun)
m2	component mass 2 (M_sun)
chi	effective spin parameter of IMRPhenomB: chi = (m1 chi1 + m2 chi2)/(m1+m2)
params	phenomenological parameters of IMRPhenomB

Definition at line 757 of file LALSimIMRPhenom.c.

◆ XLALSimIMRPhenomBProjectExtrinsicParam()

static gsl_matrix * XLALSimIMRPhenomBProjectExtrinsicParam ( gsl_matrix * g )

static

Parameters

g	Fisher matrix of IMRPhenomB

Definition at line 1140 of file LALSimIMRPhenom.c.

Prototypes

Data Structures

Function Documentation

◆ ComputeIMRPhenomAParams()

◆ ComputeIMRPhenomBParams()

◆ EstimateSafeFMinForTD()

◆ EstimateSafeFMaxForTD()

◆ ComputeTau0()

◆ EstimateIMRLength()

◆ NextPow2()

◆ LorentzianFn()

◆ IMRPhenomAGenerateFD()

◆ IMRPhenomBGenerateFD()

◆ IMRPhenomAGenerateTD()

◆ IMRPhenomBGenerateTD()

◆ FDToTD()

◆ find_instant_freq()

◆ find_peak_amp()

◆ apply_phase_shift()

◆ apply_inclination()

◆ XLALSimIMRPhenomBFisherMatrix()

◆ XLALComputeIMRPhenomBDerivativeCoeffs()

◆ XLALSimIMRPhenomBProjectExtrinsicParam()