LALSimInspiralWaveformCache.h File Reference

Prototypes
LALSimInspiralWaveformCache *	XLALCreateSimInspiralWaveformCache (void)
	Construct and initialize a waveform cache. More...
void	XLALDestroySimInspiralWaveformCache (LALSimInspiralWaveformCache *cache)
	Destroy a waveform cache. More...
int	XLALSimInspiralChooseTDWaveformFromCache (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 phiRef, REAL8 deltaT, REAL8 m1, REAL8 m2, REAL8 s1x, REAL8 s1y, REAL8 s1z, REAL8 s2x, REAL8 s2y, REAL8 s2z, REAL8 f_min, REAL8 f_ref, REAL8 r, REAL8 i, LALDict *LALpars, Approximant approximant, LALSimInspiralWaveformCache *cache)
	Chooses between different approximants when requesting a waveform to be generated Returns the waveform in the time domain. More...
int	XLALSimInspiralChooseFDWaveformFromCache (COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 deltaF, REAL8 m1, REAL8 m2, REAL8 S1x, REAL8 S1y, REAL8 S1z, REAL8 S2x, REAL8 S2y, REAL8 S2z, REAL8 f_min, REAL8 f_max, REAL8 f_ref, REAL8 r, REAL8 i, LALDict *LALpars, Approximant approximant, LALSimInspiralWaveformCache *cache, REAL8Sequence *frequencies)
	Chooses between different approximants when requesting a waveform to be generated Returns the waveform in the frequency domain. More...
int	XLALSimInspiralChooseFDWaveformSequence (COMPLEX16FrequencySeries **hptilde, COMPLEX16FrequencySeries **hctilde, REAL8 phiRef, REAL8 m1, REAL8 m2, REAL8 S1x, REAL8 S1y, REAL8 S1z, REAL8 S2x, REAL8 S2y, REAL8 S2z, REAL8 f_ref, REAL8 r, REAL8 i, LALDict *LALpars, Approximant approximant, REAL8Sequence *frequencies)
	Wrapper similar to XLALSimInspiralChooseFDWaveform() for waveforms to be generated a specific freqencies. More...

Go to the source code of this file.

Data Structures
struct	LALSimInspiralWaveformCacheOld
	Stores previously-computed waveforms and parameters to take advantage of approximant- and parameter-specific opportunities for accelerating waveform computation. More...
struct	LALSimInspiralWaveformCache

Function Documentation

XLALSimInspiralChooseFDWaveformSequence()

int XLALSimInspiralChooseFDWaveformSequence	(	COMPLEX16FrequencySeries **	hptilde,
		COMPLEX16FrequencySeries **	hctilde,
		REAL8	phiRef,
		REAL8	m1,
		REAL8	m2,
		REAL8	S1x,
		REAL8	S1y,
		REAL8	S1z,
		REAL8	S2x,
		REAL8	S2y,
		REAL8	S2z,
		REAL8	f_ref,
		REAL8	distance,
		REAL8	inclination,
		LALDict *	LALpars,
		Approximant	approximant,
		REAL8Sequence *	frequencies
	)

Wrapper similar to XLALSimInspiralChooseFDWaveform() for waveforms to be generated a specific freqencies.

Returns the waveform in the frequency domain at the frequencies of the REAL8Sequence frequencies.

Parameters

hptilde	FD plus polarization
hctilde	FD cross polarization
phiRef	reference orbital phase (rad)
m1	mass of companion 1 (kg)
m2	mass of companion 2 (kg)
S1x	x-component of the dimensionless spin of object 1
S1y	y-component of the dimensionless spin of object 1
S1z	z-component of the dimensionless spin of object 1
S2x	x-component of the dimensionless spin of object 2
S2y	y-component of the dimensionless spin of object 2
S2z	z-component of the dimensionless spin of object 2
f_ref	Reference frequency (Hz)
distance	distance of source (m)
inclination	inclination of source (rad)
LALpars	LALDictionary containing non-mandatory variables/flags
approximant	post-Newtonian approximant to use for waveform production
frequencies	sequence of frequencies for which the waveform will be computed. Pass in NULL (or None in python) for standard f_min to f_max sequence.

Definition at line 882 of file LALSimInspiralWaveformCache.c.