Prototypes
int	XLALGetBurstApproximantFromString (const CHAR *inString)
	XLAL function to determine burst approximant from a string. More...

int	XLALCheckBurstApproximantFromString (const CHAR *inString)

char *	XLALGetStringFromBurstApproximant (BurstApproximant approximant)
	XLAL function to determine string from approximant enum. More...

int	XLALSimBurstImplementedTDApproximants (BurstApproximant approximant)

int	XLALSimBurstImplementedFDApproximants (BurstApproximant approximant)
	Checks whether the given approximant is implemented in lalsimulation's XLALSimInspiralChooseFDWaveform(). More...

int	XLALInferenceBurstSineGaussian (REAL8TimeSeries hplus, REAL8TimeSeries hcross, REAL8 Q, REAL8 centre_frequency, REAL8 hrss, REAL8 eccentricity, REAL8 phase, REAL8 delta_t)
	Enumeration to specify time or frequency domain. More...

int	XLALInferenceBurstSineGaussianF (COMPLEX16FrequencySeries hplus, COMPLEX16FrequencySeries hcross, REAL8 Q, REAL8 centre_frequency, REAL8 hrss, REAL8 eccentricity, REAL8 phase, REAL8 deltaF, REAL8 deltaT)

int	XLALInferenceBurstSineGaussianFFast (COMPLEX16FrequencySeries hplus, COMPLEX16FrequencySeries hcross, REAL8 Q, REAL8 centre_frequency, REAL8 hrss, REAL8 eccentricity, REAL8 phase, REAL8 deltaF, REAL8 deltaT)

int	XLALInferenceBurstGaussianF (COMPLEX16FrequencySeries hplus, COMPLEX16FrequencySeries hcross, REAL8 duration, REAL8 hrss, REAL8 alpha, REAL8 deltaF, REAL8 deltaT)

int	XLALInferenceBurstDampedSinusoid (REAL8TimeSeries hplus, REAL8TimeSeries hcross, REAL8 Q, REAL8 centre_frequency, REAL8 hrss, REAL8 eccentricity, REAL8 phase, REAL8 delta_t)

int	XLALInferenceBurstDampedSinusoidF (COMPLEX16FrequencySeries hplus, COMPLEX16FrequencySeries hcross, REAL8 Q, REAL8 centre_frequency, REAL8 hrss, REAL8 eccentricity, REAL8 phase, REAL8 deltaF, REAL8 deltaT)

int	XLALInferenceBurstGaussian (REAL8TimeSeries hplus, REAL8TimeSeries hcross, REAL8 duration, REAL8 hrss, REAL8 eccentricity, REAL8 polarization, REAL8 delta_t)

LALSimBurstExtraParam *	XLALSimBurstCreateExtraParam (const char *name, double value)
	Function that creates the head node of the extra burst parameters linked list. More...

int	XLALSimBurstAddExtraParam (LALSimBurstExtraParam *parameter, const char name, const double value)
	Function that adds a parameter to the extra burst parameters linked list. More...

int	XLALSimBurstSetExtraParam (LALSimBurstExtraParam parameter, const char name, const double value)
	Function that sets the value of the desired parameter in the burst extra parameters linked list to 'value'. More...

double	XLALSimBurstGetExtraParam (const LALSimBurstExtraParam parameter, const char name)
	Function that returns the value of the desired parameters in the burst extra parameters linked list. More...

int	XLALSimBurstExtraParamExists (const LALSimBurstExtraParam parameter, const char name)
	Function that checks whether the requested parameter exists within the burst extra parameters linked list. More...

int	XLALSimBurstPrintExtraParam (FILE fp, LALSimBurstExtraParam parameter)
	Function that prints the whole burst extra parameters linked list. More...

void	XLALSimBurstDestroyExtraParam (LALSimBurstExtraParam *parameter)
	Function that destroys the whole extra burst parameters linked list. More...

LALSimBurstWaveformCache *	XLALCreateSimBurstWaveformCache (void)
	Construct and initialize a waveform cache. More...

void	XLALDestroySimBurstWaveformCache (LALSimBurstWaveformCache *cache)
	Destroy a waveform cache. More...

int	XLALSimBurstChooseTDWaveformFromCache (REAL8TimeSeries hplus, REAL8TimeSeries hcross, REAL8 deltaT, REAL8 f0, REAL8 q, REAL8 tau, REAL8 f_min, REAL8 f_max, REAL8 hrss, REAL8 polar_angle, REAL8 polar_ecc, LALSimBurstExtraParam extraParams, BurstApproximant approximant, LALSimBurstWaveformCache cache)
	Chooses between different approximants when requesting a waveform to be generated Returns the waveform in the time domain. More...

int	XLALSimBurstChooseFDWaveformFromCache (COMPLEX16FrequencySeries hptilde, COMPLEX16FrequencySeries hctilde, REAL8 deltaF, REAL8 deltaT, REAL8 f0, REAL8 q, REAL8 tau, REAL8 f_min, REAL8 f_max, REAL8 hrss, REAL8 polar_angle, REAL8 polar_ecc, LALSimBurstExtraParam extraParams, BurstApproximant approximant, LALSimBurstWaveformCache cache)
	Chooses between different approximants when requesting a waveform to be generated Returns the waveform in the frequency domain. More...

int	XLALSimBurstChooseFDWaveform (COMPLEX16FrequencySeries hptilde, COMPLEX16FrequencySeries hctilde, REAL8 deltaF, REAL8 deltaT, REAL8 f0, REAL8 q, REAL8 tau, REAL8 f_min, REAL8 f_max, REAL8 hrss, REAL8 polar_angle, REAL8 polar_ecc, LALSimBurstExtraParam *extraParams, BurstApproximant approximant)

int	XLALSimBurstChooseTDWaveform (REAL8TimeSeries hplus, REAL8TimeSeries hcross, REAL8 deltaT, REAL8 f0, REAL8 q, REAL8 tau, REAL8 f_min, REAL8 f_max, REAL8 hrss, REAL8 polar_angle, REAL8 polar_ecc, LALSimBurstExtraParam *extraParams, BurstApproximant approximant)

Data Structures
struct	LALSimBurstExtraParamData
	Linked list node for the testing GR parameters. More...

struct	LALSimBurstExtraParam
	Linked list of any number of parameters for testing GR. More...

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

Enumerations
enum	BurstApproximant { SineGaussianFFast , SineGaussianF , SineGaussian , GaussianF , Gaussian , RingdownF , DampedSinusoidF , DampedSinusoid , NumBurstApproximants }
	Enum that specifies the PN approximant to be used in computing the waveform. More...

Enumeration Type Documentation

◆ BurstApproximant

enum BurstApproximant

Enum that specifies the PN approximant to be used in computing the waveform.

Enumerator
SineGaussianFFast
SineGaussianF
SineGaussian
GaussianF
Gaussian
RingdownF
DampedSinusoidF
DampedSinusoid
NumBurstApproximants	Number of elements in enum, useful for checking bounds.

Definition at line 53 of file LALInferenceBurstRoutines.h.

Function Documentation

◆ XLALGetBurstApproximantFromString()

int XLALGetBurstApproximantFromString ( const CHAR * inString )

XLAL function to determine burst approximant from a string.

The string need not match exactly, only contain a member of the BurstApproximant enum.

Definition at line 65 of file LALInferenceBurstRoutines.c.

◆ XLALCheckBurstApproximantFromString()

int XLALCheckBurstApproximantFromString ( const CHAR * inString )

Definition at line 101 of file LALInferenceBurstRoutines.c.

◆ XLALGetStringFromBurstApproximant()

char * XLALGetStringFromBurstApproximant ( BurstApproximant bapproximant )

XLAL function to determine string from approximant enum.

This function needs to be updated when new approximants are added.

Definition at line 315 of file LALInferenceBurstRoutines.c.

◆ XLALSimBurstImplementedTDApproximants()

int XLALSimBurstImplementedTDApproximants ( BurstApproximant approximant )

Parameters

approximant Burst approximant (see enum in LALInferenceBurst.h)

Definition at line 123 of file LALInferenceBurstRoutines.c.

◆ XLALSimBurstImplementedFDApproximants()

int XLALSimBurstImplementedFDApproximants ( BurstApproximant approximant )

Checks whether the given approximant is implemented in lalsimulation's XLALSimInspiralChooseFDWaveform().

returns 1 if the approximant is implemented, 0 otherwise.

Parameters

approximant Burst approximant (see enum in LALSimBurst.h)

Definition at line 144 of file LALInferenceBurstRoutines.c.

◆ XLALInferenceBurstSineGaussian()

int XLALInferenceBurstSineGaussian	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	Q,
		REAL8	centre_frequency,
		REAL8	hrss,
		REAL8	eccentricity,
		REAL8	phase,
		REAL8	delta_t
	)

Enumeration to specify time or frequency domain.

Q: the "Q" of the waveform. The Gaussian envelope is \(exp(-1/2 t^{2} / \sigma_{t}^{2})\) where \(\sigma_{t} = Q / (2 \pi f)\). High Q --> long duration.

centre_frequency: the frequency of the sinusoidal oscillations that get multiplied by the Gaussian envelope.

hrss: the root-sum-squares strain of the waveform (summed over both polarizations). See K. Riles, LIGO-T040055-00.pdf.

eccentricity: 0 --> circularly polarized, 1 --> linearly polarized.

polarization: the angle from the + axis to the major axis of the waveform ellipsoid. with the eccentricity set to 1 (output is linearly polarized): 0 --> output contains + polarization only; pi/2 --> output contains x polarization only. with the eccentricity set to 0 (output is circularly polarized), the polarization parameter is irrelevant.

Output:

h+ and hx time series containing a cosine-Gaussian in the + polarization and a sine-Gaussian in the x polarization. The Gaussian envelope peaks in both at t = 0 as defined by epoch and deltaT. Note that a Tukey window with tapers covering 50% of the time series is applied to make the waveform go to 0 smoothly at the start and end.

Definition at line 381 of file LALInferenceBurstRoutines.c.

◆ XLALInferenceBurstSineGaussianF()

int XLALInferenceBurstSineGaussianF	(	COMPLEX16FrequencySeries **	hplus,
		COMPLEX16FrequencySeries **	hcross,
		REAL8	Q,
		REAL8	centre_frequency,
		REAL8	hrss,
		REAL8	eccentricity,
		REAL8	phase,
		REAL8	deltaF,
		REAL8	deltaT
	)

Definition at line 454 of file LALInferenceBurstRoutines.c.

◆ XLALInferenceBurstSineGaussianFFast()

int XLALInferenceBurstSineGaussianFFast	(	COMPLEX16FrequencySeries **	hplus,
		COMPLEX16FrequencySeries **	hcross,
		REAL8	Q,
		REAL8	centre_frequency,
		REAL8	hrss,
		REAL8	eccentricity,
		REAL8	phase,
		REAL8	deltaF,
		REAL8	deltaT
	)

Definition at line 558 of file LALInferenceBurstRoutines.c.

◆ XLALInferenceBurstGaussianF()

int XLALInferenceBurstGaussianF	(	COMPLEX16FrequencySeries **	hplus,
		COMPLEX16FrequencySeries **	hcross,
		REAL8	duration,
		REAL8	hrss,
		REAL8	alpha,
		REAL8	deltaF,
		REAL8	deltaT
	)

Definition at line 726 of file LALInferenceBurstRoutines.c.

◆ XLALInferenceBurstDampedSinusoid()

int XLALInferenceBurstDampedSinusoid	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	Q,
		REAL8	centre_frequency,
		REAL8	hrss,
		REAL8	eccentricity,
		REAL8	phase,
		REAL8	delta_t
	)

Definition at line 803 of file LALInferenceBurstRoutines.c.

◆ XLALInferenceBurstDampedSinusoidF()

int XLALInferenceBurstDampedSinusoidF	(	COMPLEX16FrequencySeries **	hplus,
		COMPLEX16FrequencySeries **	hcross,
		REAL8	Q,
		REAL8	centre_frequency,
		REAL8	hrss,
		REAL8	eccentricity,
		REAL8	phase,
		REAL8	deltaF,
		REAL8	deltaT
	)

Definition at line 871 of file LALInferenceBurstRoutines.c.

◆ XLALInferenceBurstGaussian()

int XLALInferenceBurstGaussian	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	duration,
		REAL8	hrss,
		REAL8	eccentricity,
		REAL8	polarization,
		REAL8	delta_t
	)

Definition at line 663 of file LALInferenceBurstRoutines.c.

◆ XLALSimBurstCreateExtraParam()

LALSimBurstExtraParam * XLALSimBurstCreateExtraParam	(	const char *	name,
		double	value
	)

Function that creates the head node of the extra burst parameters linked list.

It is initialized with a single parameter with given name and value

Function that creates the head node of the extra burst parameters linked list.

It is initialized with a single parameter with given name and value

Parameters

name	Name of first parameter in new linked list
value	Value of first parameter in new linked list

Definition at line 1489 of file LALInferenceBurstRoutines.c.

◆ XLALSimBurstAddExtraParam()

int XLALSimBurstAddExtraParam	(	LALSimBurstExtraParam **	parameter,
		const char *	name,
		double	value
	)

Function that adds a parameter to the extra burst parameters linked list.

If the parameter already exists, it throws an error.

Function that adds a parameter to the extra burst parameters linked list.

If the parameter already exists, it throws an error.

Parameters

parameter	Pointer to the head node of the linked list of parameters
name	Parameter name
value	Parameter value

Definition at line 1509 of file LALInferenceBurstRoutines.c.

◆ XLALSimBurstSetExtraParam()

int XLALSimBurstSetExtraParam	(	LALSimBurstExtraParam *	parameter,
		const char *	name,
		const double	value
	)

Function that sets the value of the desired parameter in the burst extra parameters linked list to 'value'.

Throws an error if the parameter is not found

Function that sets the value of the desired parameter in the burst extra parameters linked list to 'value'.

Throws an error if the parameter is not found

Parameters

parameter	Linked list to be modified
name	Name of parameter to be modified
value	New value for parameter

Definition at line 1548 of file LALInferenceBurstRoutines.c.

◆ XLALSimBurstGetExtraParam()

double XLALSimBurstGetExtraParam	(	const LALSimBurstExtraParam *	parameter,
		const char *	name
	)

Function that returns the value of the desired parameters in the burst extra parameters linked list.

Aborts if the parameter is not found

Function that returns the value of the desired parameters in the burst extra parameters linked list.

Aborts if the parameter is not found

Parameters

parameter	Linked list to retrieve from
name	Name of parameter to be retrieved

Definition at line 1575 of file LALInferenceBurstRoutines.c.

◆ XLALSimBurstExtraParamExists()

int XLALSimBurstExtraParamExists	(	const LALSimBurstExtraParam *	parameter,
		const char *	name
	)

Function that checks whether the requested parameter exists within the burst extra parameters linked list.

Returns true (1) or false (0) accordingly

Parameters

parameter	Linked list to check
name	Parameter name to check for

Definition at line 1601 of file LALInferenceBurstRoutines.c.

◆ XLALSimBurstPrintExtraParam()

int XLALSimBurstPrintExtraParam	(	FILE *	fp,
		LALSimBurstExtraParam *	parameter
	)

Function that prints the whole burst extra parameters linked list.

Parameters

fp	FILE pointer to write to
parameter	Linked list to print

Definition at line 1612 of file LALInferenceBurstRoutines.c.

◆ XLALSimBurstDestroyExtraParam()

void XLALSimBurstDestroyExtraParam ( LALSimBurstExtraParam * parameter )

Function that destroys the whole extra burst parameters linked list.

Parameters

parameter Linked list to destroy

Definition at line 1634 of file LALInferenceBurstRoutines.c.

◆ XLALCreateSimBurstWaveformCache()

LALSimBurstWaveformCache * XLALCreateSimBurstWaveformCache ( void )

Construct and initialize a waveform cache.

Caches are used to avoid re-computation of waveforms that differ only by simple scaling relations in extrinsic parameters.

Definition at line 1264 of file LALInferenceBurstRoutines.c.

◆ XLALDestroySimBurstWaveformCache()

void XLALDestroySimBurstWaveformCache ( LALSimBurstWaveformCache * cache )

Destroy a waveform cache.

Definition at line 1275 of file LALInferenceBurstRoutines.c.

◆ XLALSimBurstChooseTDWaveformFromCache()

int XLALSimBurstChooseTDWaveformFromCache	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	deltaT,
		REAL8	f0,
		REAL8	q,
		REAL8	tau,
		REAL8	f_min,
		REAL8	f_max,
		REAL8	hrss,
		REAL8	polar_angle,
		REAL8	polar_ecc,
		LALSimBurstExtraParam *	extraParams,
		BurstApproximant	approximant,
		LALSimBurstWaveformCache *	cache
	)

Chooses between different approximants when requesting a waveform to be generated Returns the waveform in the time domain.

The parameters passed must be in SI units.

This version allows caching of waveforms. The most recently generated waveform and its parameters are stored. If the next call requests a waveform that can be obtained by a simple transformation, then it is done. This bypasses the waveform generation and speeds up the code.

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
deltaT	sampling interval (s)
f0	central frequency [Hz]
q	quality
tau	duration
f_min	starting GW frequency (Hz)
f_max	max GW frequency (Hz)
hrss	hrss
polar_angle	Together with polar_ecc, controls ratio plus/cross polarization (rad)
polar_ecc	(tidal deformability of mass 1) / m1^5 (dimensionless)
extraParams	Linked list of extra Parameters. Pass in NULL (or None in python) to neglect
approximant	Burst approximant to use for waveform production
cache	waveform cache structure; use NULL for no caching

Definition at line 1056 of file LALInferenceBurstRoutines.c.

◆ XLALSimBurstChooseFDWaveformFromCache()

int XLALSimBurstChooseFDWaveformFromCache	(	COMPLEX16FrequencySeries **	hptilde,
		COMPLEX16FrequencySeries **	hctilde,
		REAL8	deltaF,
		REAL8	deltaT,
		REAL8	f0,
		REAL8	q,
		REAL8	tau,
		REAL8	f_min,
		REAL8	f_max,
		REAL8	hrss,
		REAL8	polar_angle,
		REAL8	polar_ecc,
		LALSimBurstExtraParam *	extraParams,
		BurstApproximant	approximant,
		LALSimBurstWaveformCache *	cache
	)

Chooses between different approximants when requesting a waveform to be generated Returns the waveform in the frequency domain.

The parameters passed must be in SI units.

This version allows caching of waveforms. The most recently generated waveform and its parameters are stored. If the next call requests a waveform that can be obtained by a simple transformation, then it is done. This bypasses the waveform generation and speeds up the code.

Parameters

hptilde	+-polarization waveform
hctilde	x-polarization waveform
deltaF	sampling interval (Hz)
deltaT	time step corresponding to consec
f0	central frequency (Hz)
q	Q (==sqrt(2) \(\pi\) f0 tau ) [dless]
tau	Duration [s]
f_min	starting GW frequency (Hz)
f_max	ending GW frequency (Hz) (0 for Nyquist)
hrss	hrss [strain]
polar_angle	Polar_ellipse_angle as defined in the burst table. Together with polar_ellipse_eccentricity below will fix the ratio of + vs x amplitude.
polar_ecc	See above
extraParams	Linked list of extra burst parameters. Pass in NULL (or None in python) to neglect these
approximant	Burst approximant
cache	waveform cache structure; use NULL for no caching

Definition at line 1161 of file LALInferenceBurstRoutines.c.

◆ XLALSimBurstChooseFDWaveform()

int XLALSimBurstChooseFDWaveform	(	COMPLEX16FrequencySeries **	hptilde,
		COMPLEX16FrequencySeries **	hctilde,
		REAL8	deltaF,
		REAL8	deltaT,
		REAL8	f0,
		REAL8	q,
		REAL8	tau,
		REAL8	f_min,
		REAL8	f_max,
		REAL8	hrss,
		REAL8	polar_angle,
		REAL8	polar_ecc,
		LALSimBurstExtraParam *	extraParams,
		BurstApproximant	approximant
	)

Parameters

hptilde	FD plus polarization
hctilde	FD cross polarization
deltaF	sampling interval (Hz)
deltaT	time step corresponding to consec
f0	central frequency (Hz)
q	Q (==sqrt(2) \(\pi\) f0 tau ) [dless]
tau	Duration [s]
f_min	starting GW frequency (Hz)
f_max	ending GW frequency (Hz) (0 for Nyquist)
hrss	hrss [strain]
polar_angle	Polar_ellipse_angle as defined in the burst table. Together with polar_ellipse_eccentricity below will fix the ratio of + vs x aplitude. Some WFs uses a single parameter alpha for this. Alpha is passed through extraParams
polar_ecc	See above
extraParams	Linked list of non-GR parameters. Pass in NULL (or None in python) to neglect these
approximant	Burst approximant

Definition at line 168 of file LALInferenceBurstRoutines.c.

◆ XLALSimBurstChooseTDWaveform()

int XLALSimBurstChooseTDWaveform	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	deltaT,
		REAL8	f0,
		REAL8	q,
		REAL8	tau,
		REAL8	f_min,
		REAL8	f_max,
		REAL8	hrss,
		REAL8	polar_angle,
		REAL8	polar_ecc,
		LALSimBurstExtraParam *	extraParams,
		BurstApproximant	approximant
	)

Parameters

hplus	+-polarization waveform
hcross	x-polarization waveform
deltaT	time step corresponding to consec
f0	central frequency (Hz)
q	Q (==sqrt(2) \(\pi\) f0 tau ) [dless]
tau	Duration [s]
f_min	starting GW frequency (Hz)
f_max	ending GW frequency (Hz) (0 for Nyquist)
hrss	hrss [strain]
polar_angle	Polar_ellipse_angle as defined in the burst table. Together with polar_ellipse_eccentricity below will fix the ratio of + vs x aplitude. Some WFs uses a single parameter alpha for this. Alpha is passed through extraParams
polar_ecc	See above
extraParams	Linked list of non-GR parameters. Pass in NULL (or None in python) to neglect these
approximant	Burst approximant

Definition at line 245 of file LALInferenceBurstRoutines.c.

Prototypes

Data Structures

Enumerations

Enumeration Type Documentation

◆ BurstApproximant

Function Documentation

◆ XLALGetBurstApproximantFromString()

◆ XLALCheckBurstApproximantFromString()

◆ XLALGetStringFromBurstApproximant()

◆ XLALSimBurstImplementedTDApproximants()

◆ XLALSimBurstImplementedFDApproximants()

◆ XLALInferenceBurstSineGaussian()

◆ XLALInferenceBurstSineGaussianF()

◆ XLALInferenceBurstSineGaussianFFast()

◆ XLALInferenceBurstGaussianF()

◆ XLALInferenceBurstDampedSinusoid()

◆ XLALInferenceBurstDampedSinusoidF()

◆ XLALInferenceBurstGaussian()

◆ XLALSimBurstCreateExtraParam()

◆ XLALSimBurstAddExtraParam()

◆ XLALSimBurstSetExtraParam()

◆ XLALSimBurstGetExtraParam()

◆ XLALSimBurstExtraParamExists()

◆ XLALSimBurstPrintExtraParam()

◆ XLALSimBurstDestroyExtraParam()

◆ XLALCreateSimBurstWaveformCache()

◆ XLALDestroySimBurstWaveformCache()

◆ XLALSimBurstChooseTDWaveformFromCache()

◆ XLALSimBurstChooseFDWaveformFromCache()

◆ XLALSimBurstChooseFDWaveform()

◆ XLALSimBurstChooseTDWaveform()