Detailed Description

Routines for mode decompositions of post-Newtonian waveforms.

Prototypes
COMPLEX16TimeSeries *	XLALCreateSimInspiralPNModeCOMPLEX16TimeSeries (REAL8TimeSeries v, REAL8TimeSeries phi, REAL8 v0, REAL8 m1, REAL8 m2, REAL8 r, int O, int l, int m)
	Computes h(l,m) mode timeseries of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALCreateSimInspiralPNModeCOMPLEX16TimeSeriesLALConvention (REAL8TimeSeries v, REAL8TimeSeries phi, REAL8 m1, REAL8 m2, REAL8 r, int O, int l, int m)
	Computes h(l,m) mode timeseries of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode22 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 v0, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(2,2) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode21 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 v0, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(2,1) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode20 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 UNUSED v0, REAL8 m1, REAL8 m2, REAL8 r, int UNUSED O)
	Computes h(2,0) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode33 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 v0, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(3,3) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode32 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 v0, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(3,2) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode31 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 v0, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(3,1) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode30 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 UNUSED v0, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(3,0) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode44 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 v0, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(4,4) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode43 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 UNUSED v0, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(4,3) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode42 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 v0, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(4,2) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode41 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 UNUSED v0, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(4,1) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode40 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 UNUSED v0, REAL8 m1, REAL8 m2, REAL8 r, int UNUSED O)
	Computes h(4,0) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode55 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 UNUSED v0, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(5,5) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode54 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 UNUSED v0, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(5,4) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode53 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 UNUSED v0, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(5,3) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode52 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 UNUSED v0, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(5,2) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode51 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 UNUSED v0, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(5,1) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode50 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 UNUSED v0, REAL8 UNUSED m1, REAL8 UNUSED m2, REAL8 UNUSED r, int UNUSED O)
	Computes h(5,0) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode66 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 UNUSED v0, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(6,6) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode65 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 UNUSED v0, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(6,5) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode64 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 UNUSED v0, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(6,4) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode63 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 UNUSED v0, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(6,3) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode62 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 UNUSED v0, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(6,2) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode61 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 UNUSED v0, REAL8 m1, REAL8 m2, REAL8 r, int O)
	Computes h(6,1) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

COMPLEX16TimeSeries *	XLALSimInspiralPNMode60 (REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8 UNUSED v0, REAL8 UNUSED m1, REAL8 UNUSED m2, REAL8 UNUSED r, int UNUSED O)
	Computes h(6,0) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform. More...

static LALSimInspiralInclAngle *	XLALSimInspiralComputeInclAngle (REAL8 ciota)

INT4	XLALSimInspiralSpinPNMode2m (SphHarmTimeSeries *h2ms, REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8TimeSeries LNhx, REAL8TimeSeries LNhy, REAL8TimeSeries LNhz, REAL8TimeSeries e1x, REAL8TimeSeries e1y, REAL8TimeSeries e1z, REAL8TimeSeries S1x, REAL8TimeSeries S1y, REAL8TimeSeries S1z, REAL8TimeSeries S2x, REAL8TimeSeries S2y, REAL8TimeSeries *S2z, REAL8 m1, REAL8 m2, REAL8 distance, int ampO)
	Computes the 5 l=2 modes of spherical harmonic decomposition of the post-Newtonian inspiral waveform for spinning-precessing waveforms. More...

INT4	XLALSimInspiralSpinPNMode3m (SphHarmTimeSeries *h3ms, REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8TimeSeries LNhx, REAL8TimeSeries LNhy, REAL8TimeSeries LNhz, REAL8TimeSeries e1x, REAL8TimeSeries e1y, REAL8TimeSeries e1z, REAL8TimeSeries S1x, REAL8TimeSeries S1y, REAL8TimeSeries S1z, REAL8TimeSeries S2x, REAL8TimeSeries S2y, REAL8TimeSeries *S2z, REAL8 m1, REAL8 m2, REAL8 distance, int ampO)
	Computes all l=3 modes of spherical harmonic decomposition of the post-Newtonian inspiral waveform for spinning-precessing waveforms. More...

INT4	XLALSimInspiralSpinPNMode4m (SphHarmTimeSeries *h4ms, REAL8TimeSeries V, REAL8TimeSeries Phi, REAL8TimeSeries LNhx, REAL8TimeSeries LNhy, REAL8TimeSeries LNhz, REAL8TimeSeries e1x, REAL8TimeSeries e1y, REAL8TimeSeries e1z, UNUSED REAL8TimeSeries S1x, UNUSED REAL8TimeSeries S1y, UNUSED REAL8TimeSeries S1z, UNUSED REAL8TimeSeries S2x, UNUSED REAL8TimeSeries S2y, UNUSED REAL8TimeSeries *S2z, REAL8 m1, REAL8 m2, REAL8 distance, int ampO)
	Computes all l=3 modes of spherical harmonic decomposition of the post-Newtonian inspiral waveform for spinning-precessing waveforms. More...

Data Structures
struct	LALSimInspiralInclAngle
	Utility type and function to compute trigonometric functions from the cosine of an angle. More...

Function Documentation

◆ XLALCreateSimInspiralPNModeCOMPLEX16TimeSeries()

COMPLEX16TimeSeries* XLALCreateSimInspiralPNModeCOMPLEX16TimeSeries	(	REAL8TimeSeries *	v,
		REAL8TimeSeries *	phi,
		REAL8	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O,
		int	l,
		int	m
	)

Computes h(l,m) mode timeseries of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

See Eqns. (79)-(116) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

v	post-Newtonian parameter
phi	orbital phase
v0	tail gauge parameter (default = 1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonain order
l	mode number l
m	mode number m

Definition at line 51 of file LALSimInspiralPNMode.c.

◆ XLALCreateSimInspiralPNModeCOMPLEX16TimeSeriesLALConvention()

COMPLEX16TimeSeries* XLALCreateSimInspiralPNModeCOMPLEX16TimeSeriesLALConvention	(	REAL8TimeSeries *	v,
		REAL8TimeSeries *	phi,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O,
		int	l,
		int	m
	)

Computes h(l,m) mode timeseries of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

See Eqns. (79)-(116) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

v	post-Newtonian parameter
phi	orbital phase
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonain order
l	mode number l
m	mode number m

Definition at line 141 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode22()

COMPLEX16TimeSeries* XLALSimInspiralPNMode22	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(2,2) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (79) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 235 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode21()

COMPLEX16TimeSeries* XLALSimInspiralPNMode21	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(2,1) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (80) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 340 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode20()

COMPLEX16TimeSeries* XLALSimInspiralPNMode20	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8 UNUSED	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int UNUSED	O
	)

Computes h(2,0) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (81) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 425 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode33()

COMPLEX16TimeSeries* XLALSimInspiralPNMode33	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(3,3) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (82) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 468 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode32()

COMPLEX16TimeSeries* XLALSimInspiralPNMode32	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(3,2) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (83) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 555 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode31()

COMPLEX16TimeSeries* XLALSimInspiralPNMode31	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(3,1) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (84) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 637 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode30()

COMPLEX16TimeSeries* XLALSimInspiralPNMode30	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8 UNUSED	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(3,0) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (85) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 723 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode44()

COMPLEX16TimeSeries* XLALSimInspiralPNMode44	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(4,4) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (86) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 786 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode43()

COMPLEX16TimeSeries* XLALSimInspiralPNMode43	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8 UNUSED	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(4,3) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (87) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 872 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode42()

COMPLEX16TimeSeries* XLALSimInspiralPNMode42	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(4,2) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (88) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 946 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode41()

COMPLEX16TimeSeries* XLALSimInspiralPNMode41	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8 UNUSED	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(4,1) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (89) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 1032 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode40()

COMPLEX16TimeSeries* XLALSimInspiralPNMode40	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8 UNUSED	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int UNUSED	O
	)

Computes h(4,0) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (90) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 1106 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode55()

COMPLEX16TimeSeries* XLALSimInspiralPNMode55	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8 UNUSED	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(5,5) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (91) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 1149 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode54()

COMPLEX16TimeSeries* XLALSimInspiralPNMode54	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8 UNUSED	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(5,4) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (92) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 1223 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode53()

COMPLEX16TimeSeries* XLALSimInspiralPNMode53	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8 UNUSED	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(5,3) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (93) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 1297 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode52()

COMPLEX16TimeSeries* XLALSimInspiralPNMode52	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8 UNUSED	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(5,2) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (94) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 1371 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode51()

COMPLEX16TimeSeries* XLALSimInspiralPNMode51	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8 UNUSED	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(5,1) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (95) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 1445 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode50()

COMPLEX16TimeSeries* XLALSimInspiralPNMode50	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8 UNUSED	v0,
		REAL8 UNUSED	m1,
		REAL8 UNUSED	m2,
		REAL8 UNUSED	r,
		int UNUSED	O
	)

Computes h(5,0) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

THIS MODE IS ZERO TO THE ORDER CONSIDERED IN: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 1519 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode66()

COMPLEX16TimeSeries* XLALSimInspiralPNMode66	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8 UNUSED	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(6,6) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (96) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 1554 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode65()

COMPLEX16TimeSeries* XLALSimInspiralPNMode65	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8 UNUSED	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(6,5) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (97) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 1628 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode64()

COMPLEX16TimeSeries* XLALSimInspiralPNMode64	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8 UNUSED	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(6,4) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (98) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 1695 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode63()

COMPLEX16TimeSeries* XLALSimInspiralPNMode63	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8 UNUSED	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(6,3) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (99) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 1769 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode62()

COMPLEX16TimeSeries* XLALSimInspiralPNMode62	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8 UNUSED	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(6,2) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (100) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 1836 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode61()

COMPLEX16TimeSeries* XLALSimInspiralPNMode61	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8 UNUSED	v0,
		REAL8	m1,
		REAL8	m2,
		REAL8	r,
		int	O
	)

Computes h(6,1) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

Implements Equation (101) of: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 1910 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralPNMode60()

COMPLEX16TimeSeries* XLALSimInspiralPNMode60	(	REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8 UNUSED	v0,
		REAL8 UNUSED	m1,
		REAL8 UNUSED	m2,
		REAL8 UNUSED	r,
		int UNUSED	O
	)

Computes h(6,0) mode of spherical harmonic decomposition of the post-Newtonian inspiral waveform.

THIS MODE IS ZERO TO THE ORDER CONSIDERED IN: Lawrence E. Kidder, "Using Full Information When Computing Modes of Post-Newtonian Waveforms From Inspiralling Compact Binaries in Circular Orbit", Physical Review D 77, 044016 (2008), arXiv:0710.0614v1 [gr-qc].

Parameters

V	post-Newtonian parameter
Phi	orbital phase
v0	tail gauge parameter (default=1)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
r	distance of source (m)
O	twice post-Newtonian order

Definition at line 1977 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralComputeInclAngle()

static LALSimInspiralInclAngle* XLALSimInspiralComputeInclAngle ( REAL8 ciota )

static

Parameters

ciota INPUT

Definition at line 2029 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralSpinPNMode2m()

INT4 XLALSimInspiralSpinPNMode2m	(	SphHarmTimeSeries **	h2ms,
		REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8TimeSeries *	LNhx,
		REAL8TimeSeries *	LNhy,
		REAL8TimeSeries *	LNhz,
		REAL8TimeSeries *	e1x,
		REAL8TimeSeries *	e1y,
		REAL8TimeSeries *	e1z,
		REAL8TimeSeries *	S1x,
		REAL8TimeSeries *	S1y,
		REAL8TimeSeries *	S1z,
		REAL8TimeSeries *	S2x,
		REAL8TimeSeries *	S2y,
		REAL8TimeSeries *	S2z,
		REAL8	m1,
		REAL8	m2,
		REAL8	distance,
		int	ampO
	)

Computes the 5 l=2 modes of spherical harmonic decomposition of the post-Newtonian inspiral waveform for spinning-precessing waveforms.

For reference see eq. B1,2 of Arun et al., "Higher-order spin effects in the amplitude and phase of gravitational waveforms emitted by inspiraling compact binaries: Ready-to-use gravitational waveforms", Physical Review D 79, 104023 (2009), Erratum PRD 84, 049901 (2011), arXiv:0810.5336v3 [gr-qc]. All variable are inputs.

!!BEWARE!! Spin components are given wrt LNh. LNh components define angles incl and alpha (polarization angle) entering the mode analytic form.

Parameters

h2ms	OUTPUT
V	post-Newtonian parameter
Phi	orbital phase
LNhx	angular momentum unit vector x component
LNhy	angular momentum unit vector y component
LNhz	angular momentum unit vector z components
e1x	x-axis tetrad x component
e1y	x-axis tetrad y component
e1z	x-axis tetrad z component
S1x	spin1-x component
S1y	spin1-y component
S1z	spin1-z component
S2x	spin2-x component
S2y	spin2-y component
S2z	spin2-z component
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
distance	distance of source (m)
ampO	twice post-Newtonian amp-order

Definition at line 2072 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralSpinPNMode3m()

INT4 XLALSimInspiralSpinPNMode3m	(	SphHarmTimeSeries **	h3ms,
		REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8TimeSeries *	LNhx,
		REAL8TimeSeries *	LNhy,
		REAL8TimeSeries *	LNhz,
		REAL8TimeSeries *	e1x,
		REAL8TimeSeries *	e1y,
		REAL8TimeSeries *	e1z,
		REAL8TimeSeries *	S1x,
		REAL8TimeSeries *	S1y,
		REAL8TimeSeries *	S1z,
		REAL8TimeSeries *	S2x,
		REAL8TimeSeries *	S2y,
		REAL8TimeSeries *	S2z,
		REAL8	m1,
		REAL8	m2,
		REAL8	distance,
		int	ampO
	)

Computes all l=3 modes of spherical harmonic decomposition of the post-Newtonian inspiral waveform for spinning-precessing waveforms.

For reference see eq. B3 of Arun et al., "Higher-order spin effects in the amplitude and phase of gravitational waveforms emitted by inspiraling compact binaries: Ready-to-use gravitational waveforms", Physical Review D 79, 104023 (2009), Erratum PRD 84, 049901 (2011), arXiv:0810.5336v3 [gr-qc]. All variable are inputs.

!!BEWARE!! Spin components are given wrt LNh. LNh components define angles incl and alpha (polarization angle) entering the mode analytic form.

Parameters

h3ms	OUTPUT
V	post-Newtonian parameter
Phi	orbital phase
LNhx	angular momentum unit vector x components
LNhy	angular momentum unit vector y components
LNhz	angular momentum unit vector z components
e1x	x-axis tetrad x component
e1y	x-axis tetrad y component
e1z	x-axis tetrad z component
S1x	spin1-x component
S1y	spin1-y component
S1z	spin1-z component
S2x	spin2-x component
S2y	spin2-y component
S2z	spin2-z component
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
distance	distance of source (m)
ampO	twice post-Newtonian amplitude order

Definition at line 2402 of file LALSimInspiralPNMode.c.

◆ XLALSimInspiralSpinPNMode4m()

INT4 XLALSimInspiralSpinPNMode4m	(	SphHarmTimeSeries **	h4ms,
		REAL8TimeSeries *	V,
		REAL8TimeSeries *	Phi,
		REAL8TimeSeries *	LNhx,
		REAL8TimeSeries *	LNhy,
		REAL8TimeSeries *	LNhz,
		REAL8TimeSeries *	e1x,
		REAL8TimeSeries *	e1y,
		REAL8TimeSeries *	e1z,
		UNUSED REAL8TimeSeries *	S1x,
		UNUSED REAL8TimeSeries *	S1y,
		UNUSED REAL8TimeSeries *	S1z,
		UNUSED REAL8TimeSeries *	S2x,
		UNUSED REAL8TimeSeries *	S2y,
		UNUSED REAL8TimeSeries *	S2z,
		REAL8	m1,
		REAL8	m2,
		REAL8	distance,
		int	ampO
	)

Computes all l=3 modes of spherical harmonic decomposition of the post-Newtonian inspiral waveform for spinning-precessing waveforms.

For reference see eq. B3 of Arun et al., "Higher-order spin effects in the amplitude and phase of gravitational waveforms emitted by inspiraling compact binaries: Ready-to-use gravitational waveforms", Physical Review D 79, 104023 (2009), Erratum PRD 84, 049901 (2011), arXiv:0810.5336v3 [gr-qc]. All variable are inputs.

!!BEWARE!! Spin components are given wrt LNh. LNh components define angles incl and alpha (polarization angle) entering the mode analytic form.

Parameters

h4ms	OUTPUT
V	post-Newtonian parameter
Phi	orbital phase
LNhx	angular momentum unit vector x components
LNhy	angular momentum unit vector y components
LNhz	angular momentum unit vector z components
e1x	x-axis tetrad x component
e1y	x-axis tetrad y component
e1z	x-axis tetrad z component
S1x	spin1-x component
S1y	spin1-y component
S1z	spin1-z component
S2x	spin2-x component
S2y	spin2-y component
S2z	spin2-z component
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
distance	distance of source (m)
ampO	twice post-Newtonian amplitude order

Definition at line 2723 of file LALSimInspiralPNMode.c.

Detailed Description

Prototypes

Data Structures

Function Documentation

◆ XLALCreateSimInspiralPNModeCOMPLEX16TimeSeries()

◆ XLALCreateSimInspiralPNModeCOMPLEX16TimeSeriesLALConvention()

◆ XLALSimInspiralPNMode22()

◆ XLALSimInspiralPNMode21()

◆ XLALSimInspiralPNMode20()

◆ XLALSimInspiralPNMode33()

◆ XLALSimInspiralPNMode32()

◆ XLALSimInspiralPNMode31()

◆ XLALSimInspiralPNMode30()

◆ XLALSimInspiralPNMode44()

◆ XLALSimInspiralPNMode43()

◆ XLALSimInspiralPNMode42()

◆ XLALSimInspiralPNMode41()

◆ XLALSimInspiralPNMode40()

◆ XLALSimInspiralPNMode55()

◆ XLALSimInspiralPNMode54()

◆ XLALSimInspiralPNMode53()

◆ XLALSimInspiralPNMode52()

◆ XLALSimInspiralPNMode51()

◆ XLALSimInspiralPNMode50()

◆ XLALSimInspiralPNMode66()

◆ XLALSimInspiralPNMode65()

◆ XLALSimInspiralPNMode64()

◆ XLALSimInspiralPNMode63()

◆ XLALSimInspiralPNMode62()

◆ XLALSimInspiralPNMode61()

◆ XLALSimInspiralPNMode60()

◆ XLALSimInspiralComputeInclAngle()

◆ XLALSimInspiralSpinPNMode2m()

◆ XLALSimInspiralSpinPNMode3m()

◆ XLALSimInspiralSpinPNMode4m()