Header file for initialisation functions used by LALInference codes. More...

Prototypes
LALInferenceRunState *	LALInferenceInitRunState (ProcessParamsTable *command_line)

void	LALInferenceInitCBCThreads (LALInferenceRunState *run_state, INT4 nthreads)

void	LALInferenceInitBurstThreads (LALInferenceRunState *run_state, INT4 nthreads)

void	LALInferenceDrawThreads (LALInferenceRunState *run_state)

void	LALInferenceRegisterUniformVariableREAL8 (LALInferenceRunState state, LALInferenceVariables var, const char *name, REAL8 startval, REAL8 min, REAL8 max, LALInferenceParamVaryType varytype)
	Register a variable in vars for the model with given name, and a uniform prior. More...

void	LALInferenceRegisterGaussianVariableREAL8 (LALInferenceRunState state, LALInferenceVariables var, const char *name, REAL8 startval, REAL8 mean, REAL8 stdev, LALInferenceParamVaryType varytype)

LALInferenceModel *	LALInferenceInitCBCModel (LALInferenceRunState *state)
	Initialise state variables needed for LALInferenceNest or LALInferenceMCMC to run on a CBC signal. More...

LALInferenceModel *	LALInferenceInitBurstModel (LALInferenceRunState *state)
	Initialise state variables needed for LALInferenceNest or LALInferenceMCMC to run on a CBC signal. More...

LALInferenceTemplateFunction	LALInferenceInitCBCTemplate (LALInferenceRunState *runState)
	Initialise the template for a standard CBC signal. More...

LALInferenceTemplateFunction	LALInferenceInitBurstTemplate (LALInferenceRunState *runState)
	Initialise the template for a standard burst signal. More...

void	LALInferenceInitGlitchVariables (LALInferenceRunState runState, LALInferenceVariables currentParams)
	Initialise the glitch fitting parameters. More...

LALInferenceModel *	LALInferenceInitModelReviewEvidence (LALInferenceRunState *state)
	Review functions. More...

LALInferenceModel *	LALInferenceInitModelReviewEvidence_bimod (LALInferenceRunState *state)

LALInferenceModel *	LALInferenceInitModelReviewEvidence_banana (LALInferenceRunState *state)

void	LALInferenceCheckOptionsConsistency (ProcessParamsTable *commandLine)
	Check options consistency. More...

void	LALInferenceInitCalibrationVariables (LALInferenceRunState runState, LALInferenceVariables currentParams)

Detailed Description

Header file for initialisation functions used by LALInference codes.

Definition in file LALInferenceInit.h.

Go to the source code of this file.

Function Documentation

◆ LALInferenceInitRunState()

LALInferenceRunState * LALInferenceInitRunState ( ProcessParamsTable * command_line )

Definition at line 76 of file LALInferenceInitCBC.c.

◆ LALInferenceInitCBCThreads()

void LALInferenceInitCBCThreads	(	LALInferenceRunState *	run_state,
		INT4	nthreads
	)

Definition at line 203 of file LALInferenceInitCBC.c.

◆ LALInferenceInitBurstThreads()

void LALInferenceInitBurstThreads	(	LALInferenceRunState *	run_state,
		INT4	nthreads
	)

Definition at line 52 of file LALInferenceInitBurst.c.

◆ LALInferenceDrawThreads()

void LALInferenceDrawThreads ( LALInferenceRunState * run_state )

Definition at line 124 of file LALInferenceInitCBC.c.

◆ LALInferenceRegisterUniformVariableREAL8()

void LALInferenceRegisterUniformVariableREAL8	(	LALInferenceRunState *	state,
		LALInferenceVariables *	var,
		const char *	name,
		REAL8	startval,
		REAL8	min,
		REAL8	max,
		LALInferenceParamVaryType	varytype
	)

Register a variable in vars for the model with given name, and a uniform prior.

Use the min and max arguments to specify a default range Use startval to give a starting value. This is ignored unless the varytype==LALINFERENCE_PARAM_FIXED, in which case it will be used as the initial value of the variable, unless the user over-rides it on the command line (see below). varytype is a LALInferenceParamVaryType e.g. LALINFERENCE_PARAM_LINEAR, LALINFERENCE_PARAM_CIRCULAR

The function will query the state->commandLine to read command line arguments of the form –name-min MINVAL –name-max MAXVAL to allow the user to over-ride the prior limits. The initial value can be given with –name FIXEDVAL If the –fix-name flag is given the variable will be pinned to that value by setting it as LALINFERENCE_PARAM_FIXED Note: The prior is setup in state->priorArgs, but it does not set state->currentParams

Definition at line 662 of file LALInferenceInitCBC.c.

◆ LALInferenceRegisterGaussianVariableREAL8()

void LALInferenceRegisterGaussianVariableREAL8	(	LALInferenceRunState *	state,
		LALInferenceVariables *	var,
		const char *	name,
		REAL8	startval,
		REAL8	mean,
		REAL8	stdev,
		LALInferenceParamVaryType	varytype
	)

Definition at line 634 of file LALInferenceInitCBC.c.

◆ LALInferenceInitCBCModel()

LALInferenceModel * LALInferenceInitCBCModel ( LALInferenceRunState * state )

Initialise state variables needed for LALInferenceNest or LALInferenceMCMC to run on a CBC signal.

Reads the command line to get user-specified options

Definition at line 725 of file LALInferenceInitCBC.c.

◆ LALInferenceInitBurstModel()

LALInferenceModel * LALInferenceInitBurstModel ( LALInferenceRunState * state )

Initialise state variables needed for LALInferenceNest or LALInferenceMCMC to run on a CBC signal.

Reads the command line to get user-specified options

Definition at line 141 of file LALInferenceInitBurst.c.

◆ LALInferenceInitCBCTemplate()

LALInferenceTemplateFunction LALInferenceInitCBCTemplate ( LALInferenceRunState * runState )

Initialise the template for a standard CBC signal.

Definition at line 265 of file LALInferenceInitCBC.c.

◆ LALInferenceInitBurstTemplate()

LALInferenceTemplateFunction LALInferenceInitBurstTemplate ( LALInferenceRunState * runState )

Initialise the template for a standard burst signal.

Definition at line 100 of file LALInferenceInitBurst.c.

◆ LALInferenceInitGlitchVariables()

void LALInferenceInitGlitchVariables	(	LALInferenceRunState *	runState,
		LALInferenceVariables *	currentParams
	)

Initialise the glitch fitting parameters.

Definition at line 312 of file LALInferenceInitCBC.c.

◆ LALInferenceInitModelReviewEvidence()

LALInferenceModel * LALInferenceInitModelReviewEvidence ( LALInferenceRunState * state )

Review functions.

Definition at line 1691 of file LALInferenceInitCBC.c.

◆ LALInferenceInitModelReviewEvidence_bimod()

LALInferenceModel * LALInferenceInitModelReviewEvidence_bimod ( LALInferenceRunState * state )

Definition at line 1737 of file LALInferenceInitCBC.c.

◆ LALInferenceInitModelReviewEvidence_banana()

LALInferenceModel * LALInferenceInitModelReviewEvidence_banana ( LALInferenceRunState * state )

Definition at line 1782 of file LALInferenceInitCBC.c.

◆ LALInferenceCheckOptionsConsistency()

void LALInferenceCheckOptionsConsistency ( ProcessParamsTable * commandLine )

Check options consistency.

Definition at line 1930 of file LALInferenceInitCBC.c.

◆ LALInferenceInitCalibrationVariables()

void LALInferenceInitCalibrationVariables	(	LALInferenceRunState *	runState,
		LALInferenceVariables *	currentParams
	)

Definition at line 480 of file LALInferenceInitCBC.c.

Prototypes