Prototypes
static CacheVariableDiffersBitmask	CacheArgsDifferenceBitmask (LALSimInspiralWaveformCache cache, REAL8 phiRef, REAL8 deltaTF, REAL8 m1, REAL8 m2, REAL8 S1x, REAL8 S1y, REAL8 S1z, REAL8 S2x, REAL8 S2y, REAL8 S2z, REAL8 f_min, REAL8 f_ref, REAL8 f_max, REAL8 r, REAL8 i, LALDict LALpars, Approximant approximant, REAL8Sequence *frequencies)
	Function to compare the requested arguments to those stored in the cache, returns a bitmask which determines if a cached waveform can be recycled. More...

static int	FrequenciesAreDifferent (REAL8Sequence newFrequencies, REAL8Sequence cachedFrequencies)
	Function to compare two frequencies sequences. More...

static int	StoreTDHCache (LALSimInspiralWaveformCache cache, 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)
	Store the output TD hplus and hcross in the cache. More...

static int	StoreFDHCache (LALSimInspiralWaveformCache cache, COMPLEX16FrequencySeries hptilde, COMPLEX16FrequencySeries hctilde, 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 f_max, REAL8 r, REAL8 i, LALDict LALpars, Approximant approximant, REAL8Sequence *frequencies)
	Store the output FD hptilde and hctilde in 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...

LALSimInspiralWaveformCache *	XLALCreateSimInspiralWaveformCache (void)
	Construct and initialize a waveform cache. More...

void	XLALDestroySimInspiralWaveformCache (LALSimInspiralWaveformCache *cache)
	Destroy a waveform cache. 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 distance, REAL8 inclination, LALDict LALpars, Approximant approximant, REAL8Sequence frequencies)
	Wrapper similar to XLALSimInspiralChooseFDWaveform() for waveforms to be generated a specific freqencies. More...

Enumerations
enum	CacheVariableDiffersBitmask { NO_DIFFERENCE = 0 , INTRINSIC = 1 , DISTANCE = 2 , PHI_REF = 4 , INCLINATION = 8 }
	Bitmask enumerating which parameters have changed, to determine if the requested waveform can be transformed from a cached waveform or if it must be generated from scratch. More...

Enumeration Type Documentation

◆ CacheVariableDiffersBitmask

enum CacheVariableDiffersBitmask

Bitmask enumerating which parameters have changed, to determine if the requested waveform can be transformed from a cached waveform or if it must be generated from scratch.

Enumerator
NO_DIFFERENCE
INTRINSIC
DISTANCE
PHI_REF
INCLINATION

Definition at line 37 of file LALSimInspiralWaveformCache.c.

Function Documentation

◆ CacheArgsDifferenceBitmask()

static CacheVariableDiffersBitmask CacheArgsDifferenceBitmask	(	LALSimInspiralWaveformCache *	cache,
		REAL8	phiRef,
		REAL8	deltaTF,
		REAL8	m1,
		REAL8	m2,
		REAL8	S1x,
		REAL8	S1y,
		REAL8	S1z,
		REAL8	S2x,
		REAL8	S2y,
		REAL8	S2z,
		REAL8	f_min,
		REAL8	f_ref,
		REAL8	f_max,
		REAL8	r,
		REAL8	i,
		LALDict *	LALpars,
		Approximant	approximant,
		REAL8Sequence *	frequencies
	)

static

Function to compare the requested arguments to those stored in the cache, returns a bitmask which determines if a cached waveform can be recycled.

Definition at line 660 of file LALSimInspiralWaveformCache.c.

◆ FrequenciesAreDifferent()

static int FrequenciesAreDifferent	(	REAL8Sequence *	newFrequencies,
		REAL8Sequence *	cachedFrequencies
	)

static

Function to compare two frequencies sequences.

Returns 1 if different, 0 if the same sequences (including if NULL pointers)

Definition at line 721 of file LALSimInspiralWaveformCache.c.

◆ StoreTDHCache()

static int StoreTDHCache	(	LALSimInspiralWaveformCache *	cache,
		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
	)

static

Store the output TD hplus and hcross in the cache.

Definition at line 738 of file LALSimInspiralWaveformCache.c.

◆ StoreFDHCache()

static int StoreFDHCache	(	LALSimInspiralWaveformCache *	cache,
		COMPLEX16FrequencySeries *	hptilde,
		COMPLEX16FrequencySeries *	hctilde,
		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	f_max,
		REAL8	r,
		REAL8	i,
		LALDict *	LALpars,
		Approximant	approximant,
		REAL8Sequence *	frequencies
	)

static

Store the output FD hptilde and hctilde in cache.

Definition at line 807 of file LALSimInspiralWaveformCache.c.

◆ 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.

Prototypes

Enumerations

Enumeration Type Documentation

◆ CacheVariableDiffersBitmask

Function Documentation

◆ CacheArgsDifferenceBitmask()

◆ FrequenciesAreDifferent()

◆ StoreTDHCache()

◆ StoreFDHCache()

◆ XLALSimInspiralChooseFDWaveformSequence()