Header LALInferenceReadData.h

Detailed Description

Utility functions for handling IFO data.

Prototypes
void	LALInferenceInjectBurstSignal (LALInferenceIFOData *IFOdata, ProcessParamsTable *commandLine)
	Read IFO data according to command line arguments. More...
void	LALInferenceBurstInjectionToVariables (SimBurst *theEventTable, LALInferenceVariables *vars)
	Fill the variables passed in vars with the parameters of the injection passed in event will over-write and destroy any existing parameters. More...
struct tagLALInferenceIFOData *	LALInferenceReadData (ProcessParamsTable *commandLine)
	Read IFO data according to command line arguments. More...
void	LALInferenceInjectInspiralSignal (struct tagLALInferenceIFOData *IFOdata, ProcessParamsTable *commandLine)
	Convenience function to inject a signal into the data, using a SimInspiralTable Injects a signal from a SimInspiralTable into a pre-existing IFOdata structure, based on command line arguments (see –help for details). More...
void	LALInferenceSetupROQdata (LALInferenceIFOData *IFOdata, ProcessParamsTable *commandLine)
void	LALInferenceSetupROQmodel (LALInferenceModel *model, ProcessParamsTable *commandLine)
void	LALInferenceInjectionToVariables (SimInspiralTable *theEventTable, LALInferenceVariables *vars)
	Fills the variable in vars with the injection values from theEventTable. More...
LALInferenceVariables *	LALInferencePrintInjectionSample (LALInferenceRunState *runState)
	Function to output a sample with logL values etc for the injection, if one is made. More...
void	LALInferenceInjectFromMDC (ProcessParamsTable *commandLine, LALInferenceIFOData *IFOdata)

Function Documentation

LALInferenceInjectBurstSignal()

void LALInferenceInjectBurstSignal	(	LALInferenceIFOData *	IFOdata,
		ProcessParamsTable *	commandLine
	)

Read IFO data according to command line arguments.

This function reads command line arguments and returns a LALInferenceIFOData linked list.

Parameters

IFOdata	[out] A new LALInferenceIFOData linked list containing the data, or NULL upon error
commandLine	[in] Pointer to a ProcessParamsTable containing command line arguments

Author

John Veitch

Definition at line 77 of file LALInferenceReadBurstData.c.

LALInferenceBurstInjectionToVariables()

void LALInferenceBurstInjectionToVariables	(	SimBurst *	theEventTable,
		LALInferenceVariables *	vars
	)

Fill the variables passed in vars with the parameters of the injection passed in event will over-write and destroy any existing parameters.

Param vary type will be fixed

Definition at line 249 of file LALInferenceReadBurstData.c.

LALInferenceReadData()

struct tagLALInferenceIFOData* LALInferenceReadData

(

ProcessParamsTable *

commandLine

)

Read IFO data according to command line arguments.

This function reads command line arguments and returns a LALInferenceIFOData linked list.

Parameters

commandLine

[in] Pointer to a ProcessParamsTable containing command line arguments

Returns

Pointer to a new LALInferenceIFOData linked list containing the data, or NULL upon error.

Author

John Veitch

Definition at line 568 of file LALInferenceReadData.c.

LALInferenceInjectInspiralSignal()

void LALInferenceInjectInspiralSignal	(	struct tagLALInferenceIFOData *	IFOdata,
		ProcessParamsTable *	commandLine
	)

Convenience function to inject a signal into the data, using a SimInspiralTable Injects a signal from a SimInspiralTable into a pre-existing IFOdata structure, based on command line arguments (see –help for details).

Parameters

commandLine	[in] Pointer to a ProcessParamsTable containing command line arguments
IFOdata	[in] Pointer to an already existing IFOdata structure.

LALInferenceSetupROQdata()

void LALInferenceSetupROQdata	(	LALInferenceIFOData *	IFOdata,
		ProcessParamsTable *	commandLine
	)

Definition at line 2731 of file LALInferenceReadData.c.

LALInferenceSetupROQmodel()

void LALInferenceSetupROQmodel	(	LALInferenceModel *	model,
		ProcessParamsTable *	commandLine
	)

Definition at line 2604 of file LALInferenceReadData.c.

LALInferenceInjectionToVariables()

void LALInferenceInjectionToVariables	(	SimInspiralTable *	theEventTable,
		LALInferenceVariables *	vars
	)

Fills the variable in vars with the injection values from theEventTable.

Destroys contents of vars. vars cannot be NULL. Resulting variables are LALINFERENCE_PARAM_FIXED.

Fills the variable in vars with the injection values from theEventTable.

Param vary type will be fixed

Definition at line 2385 of file LALInferenceReadData.c.

LALInferencePrintInjectionSample()

LALInferenceVariables* LALInferencePrintInjectionSample

(

LALInferenceRunState *

runState

)

Function to output a sample with logL values etc for the injection, if one is made.

Requires –inj, –outfile and optionally –event (if not 0).

Definition at line 2466 of file LALInferenceReadData.c.

LALInferenceInjectFromMDC()

void LALInferenceInjectFromMDC	(	ProcessParamsTable *	commandLine,
		LALInferenceIFOData *	IFOdata
	)

Definition at line 2973 of file LALInferenceReadData.c.