Module to initialize some parameters for waveform generation. More...

Prototypes
void	LALInspiralInit (LALStatus status, InspiralTemplate params, InspiralInit *paramsInit)

int	XLALInspiralInit (InspiralTemplate params, InspiralInit paramsInit)

Detailed Description

Module to initialize some parameters for waveform generation.

Author: Cokelaer T.

Description

The input parameters is an InspiralTemplate structure which provides the waveform parameters such as masses, lower frequency ... . The function LALInspiralInit calls the LALInspiralParameterCalc function in order to compute all the mass parameters. Then, XLALInspiralRestrictedAmplitude function is called to get the restricted newtonian amplitude. LALInspiralWavelength, LALInspiralSetup and LALInspiralChooseModel are also called in order to estimate the waveform length which is stored in an output structure called InspiralInit. We also stored Energy, flux and evolution function of flux and energy in that structure.

The LALInspiralChooseModel function might failed or send a non zero status code. That function force it to be zero therefore the codes which use LALInspiralInit (mainly injection code right now) won't stopped. Of course, if status code is non zero, we have to keep trace of it. Thus, the length of the waveform is fixed to zero in case of problems such as negative length, cutoff frequency lower than the lower cutoff frequency ... .

Uses

LALInspiralParameterCalc
XLALInspiralRestrictedAmplitude
LALInspiralWaveLength
LALInspiralChooseModel
LALInspiralSetup

Notes

There is only one assert on the InspiralTemplate variable since all relevant asserts are already included in the different functions which are called throughout the LALInspiralInit function.

Definition in file LALInspiralInit.c.

Go to the source code of this file.

Macros
#define	LALINSPIRALINIT_LENGTHOVERESTIMATION 0.1 /* 10 % */

Macro Definition Documentation

◆ LALINSPIRALINIT_LENGTHOVERESTIMATION

#define LALINSPIRALINIT_LENGTHOVERESTIMATION 0.1 /* 10 % */

Definition at line 65 of file LALInspiralInit.c.

Function Documentation

◆ LALInspiralInit()

void LALInspiralInit	(	LALStatus *	status,
		InspiralTemplate *	params,
		InspiralInit *	paramsInit
	)

Definition at line 68 of file LALInspiralInit.c.

◆ XLALInspiralInit()

int XLALInspiralInit	(	InspiralTemplate *	params,
		InspiralInit *	paramsInit
	)

Definition at line 87 of file LALInspiralInit.c.

Prototypes