Detailed Description

Routines to construct waveforms from spherical harmonic mode decompositions.

The gravitational wave polarizations depend on the location of the observer relative to the source frame, defined by the spherical-polar coordinates theta and phi (equivalently, inclination and azimuthal phase). Waveforms are sometimes decomposed into spin -2 weighted spherical harmonics, indexed with mode quantum numbers l and m, with the resulting waveform modes stored as COMPLEX16TimeSeries. These routines reconstruct a waveform from these mode decompositions for a given inclination and azimuthal phase.

Prototypes
int	XLALSimAddMode (REAL8TimeSeries hplus, REAL8TimeSeries hcross, COMPLEX16TimeSeries *hmode, REAL8 theta, REAL8 phi, int l, int m, int sym)
	Multiplies a mode h(l,m) by a spin-2 weighted spherical harmonic to obtain hplus - i hcross, which is added to the time series. More...

int	XLALSimAddModeAngleTimeSeries (REAL8TimeSeries hplus, REAL8TimeSeries hcross, COMPLEX16TimeSeries hmode, REAL8TimeSeries theta, REAL8TimeSeries *phi, int l, int m, int sym)
	Multiplies a mode h(l,m) by a spin-2 weighted spherical harmonic to obtain hplus - i hcross, which is added to the time series for TimeSeries of angles. More...

int	XLALSimAddModeFD (COMPLEX16FrequencySeries hptilde, COMPLEX16FrequencySeries hctilde, COMPLEX16FrequencySeries *hlmtilde, REAL8 theta, REAL8 phi, INT4 l, INT4 m, INT4 sym)
	Helper function to add a mode to hplus, hcross in Fourier domain copies the function XLALSimAddMode, which was done only for TD structures. More...

int	XLALSimAddModeFromModes (REAL8TimeSeries hplus, REAL8TimeSeries hcross, SphHarmTimeSeries *hmode, REAL8 theta, REAL8 phi)
	For all valid TimeSeries contained within hmode structure, multiplies a mode h(l,m) by a spin-2 weighted spherical harmonic to obtain hplus - i hcross, which is added to the time series. More...

int	XLALSimAddModeFromModesAngleTimeSeries (REAL8TimeSeries hplus, REAL8TimeSeries hcross, SphHarmTimeSeries hmode, REAL8TimeSeries theta, REAL8TimeSeries *phi)
	For all valid TimeSeries contained within hmode structure, multiplies a mode h(l,m) by a spin-2 weighted spherical harmonic to obtain hplus - i hcross, which is added to the time series. More...

int	XLALSimNewTimeSeriesFromModes (REAL8TimeSeries hplus, REAL8TimeSeries hcross, SphHarmTimeSeries *hmode, REAL8 theta, REAL8 phi)
	Returns the h+, hx waveforms constructed from all valid TimeSeries contained within hmode structure. More...

int	XLALSimNewTimeSeriesFromModesAngleTimeSeries (REAL8TimeSeries hplus, REAL8TimeSeries hcross, SphHarmTimeSeries hmode, REAL8TimeSeries theta, REAL8TimeSeries *phi)
	Returns the h+, hx waveforms constructed from all valid TimeSeries contained within hmode structure. More...

Function Documentation

◆ XLALSimAddMode()

int XLALSimAddMode	(	REAL8TimeSeries *	hplus,
		REAL8TimeSeries *	hcross,
		COMPLEX16TimeSeries *	hmode,
		REAL8	theta,
		REAL8	phi,
		int	l,
		int	m,
		int	sym
	)

Multiplies a mode h(l,m) by a spin-2 weighted spherical harmonic to obtain hplus - i hcross, which is added to the time series.

Implements the sum of a single term of Eq. (11) 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].

If sym is non-zero, symmetrically add the m and -m terms assuming that \(h(l,-m) = (-1)^l h(l,m)*\); see Eq. (78) ibid.

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
hmode	complex mode h(l,m)
theta	polar angle (rad)
phi	azimuthal angle (rad)
l	mode number l
m	mode number m
sym	flag to add -m mode too

Definition at line 44 of file LALSimSphHarmMode.c.

◆ XLALSimAddModeAngleTimeSeries()

int XLALSimAddModeAngleTimeSeries	(	REAL8TimeSeries *	hplus,
		REAL8TimeSeries *	hcross,
		COMPLEX16TimeSeries *	hmode,
		REAL8TimeSeries *	theta,
		REAL8TimeSeries *	phi,
		int	l,
		int	m,
		int	sym
	)

Multiplies a mode h(l,m) by a spin-2 weighted spherical harmonic to obtain hplus - i hcross, which is added to the time series for TimeSeries of angles.

Implements the sum of Eq. (11) 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

hplus	+-polarization waveform
hcross	x-polarization waveform
hmode	complex mode h(l,m)
theta	polar angle (rad)
phi	azimuthal angle (rad)
l	mode number l
m	mode number m
sym	flag to add -m mode too

Definition at line 95 of file LALSimSphHarmMode.c.

◆ XLALSimAddModeFD()

int XLALSimAddModeFD	(	COMPLEX16FrequencySeries *	hptilde,
		COMPLEX16FrequencySeries *	hctilde,
		COMPLEX16FrequencySeries *	hlmtilde,
		REAL8	theta,
		REAL8	phi,
		INT4	l,
		INT4	m,
		INT4	sym
	)

Helper function to add a mode to hplus, hcross in Fourier domain copies the function XLALSimAddMode, which was done only for TD structures.

If sym is non-zero, symmetrically add the m and -m terms assuming that \(h(l,-m)(f) = (-1)^l h(l,m)*(-f) with f > 0 *\). Since the output is an array with positive frequencies, in the case of sym = 1 the modes that are passed should be the modes with negative m that have support for positive frequencies

Definition at line 152 of file LALSimSphHarmMode.c.

◆ XLALSimAddModeFromModes()

int XLALSimAddModeFromModes	(	REAL8TimeSeries *	hplus,
		REAL8TimeSeries *	hcross,
		SphHarmTimeSeries *	hmode,
		REAL8	theta,
		REAL8	phi
	)

For all valid TimeSeries contained within hmode structure, multiplies a mode h(l,m) by a spin-2 weighted spherical harmonic to obtain hplus - i hcross, which is added to the time series.

Implements the sum of Eq. (11) 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

hplus	+-polarization waveform
hcross	x-polarization waveform
hmode	complex modes h(l,m)
theta	polar angle (rad)
phi	azimuthal angle (rad)

Definition at line 213 of file LALSimSphHarmMode.c.

◆ XLALSimAddModeFromModesAngleTimeSeries()

int XLALSimAddModeFromModesAngleTimeSeries	(	REAL8TimeSeries *	hplus,
		REAL8TimeSeries *	hcross,
		SphHarmTimeSeries *	hmode,
		REAL8TimeSeries *	theta,
		REAL8TimeSeries *	phi
	)

For all valid TimeSeries contained within hmode structure, multiplies a mode h(l,m) by a spin-2 weighted spherical harmonic to obtain hplus - i hcross, which is added to the time series.

Angles are TimeSeries too.

Implements the sum of Eq. (11) 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].

See also: XLALSimAddModeAngleTimeSeries()

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
hmode	complex modes h(l,m)
theta	polar angle (rad)
phi	azimuthal angle (rad)

Definition at line 249 of file LALSimSphHarmMode.c.

◆ XLALSimNewTimeSeriesFromModes()

int XLALSimNewTimeSeriesFromModes	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		SphHarmTimeSeries *	hmode,
		REAL8	theta,
		REAL8	phi
	)

Returns the h+, hx waveforms constructed from all valid TimeSeries contained within hmode structure.

See also: XLALSimAddModeFromModes() and XLALSimAddMode()

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
hmode	complex modes h(l,m)
theta	polar angle (rad)
phi	azimuthal angle (rad)

Definition at line 277 of file LALSimSphHarmMode.c.

◆ XLALSimNewTimeSeriesFromModesAngleTimeSeries()

int XLALSimNewTimeSeriesFromModesAngleTimeSeries	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		SphHarmTimeSeries *	hmode,
		REAL8TimeSeries *	theta,
		REAL8TimeSeries *	phi
	)

Returns the h+, hx waveforms constructed from all valid TimeSeries contained within hmode structure.

Angles are TimeSeries too.

See also: XLALSimAddModeFromModesAngleTimeSeries() and XLALSimAddModeAngleTimeSeries()

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
hmode	complex modes h(l,m)
theta	polar angle (rad)
phi	azimuthal angle (rad)

Definition at line 315 of file LALSimSphHarmMode.c.

Detailed Description

Prototypes

Function Documentation

◆ XLALSimAddMode()

◆ XLALSimAddModeAngleTimeSeries()

◆ XLALSimAddModeFD()

◆ XLALSimAddModeFromModes()

◆ XLALSimAddModeFromModesAngleTimeSeries()

◆ XLALSimNewTimeSeriesFromModes()

◆ XLALSimNewTimeSeriesFromModesAngleTimeSeries()