General Packages

Detailed Description

UNDOCUMENTED.

Modules
	Header LALBurstVCSInfo.h
	VCS and build information for LALBurst.

Prototypes
int	XLALGenerateSimBurst (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const SimBurst *sim_burst, double delta_t)
	Generate the + and x time series for a single sim_burst table row. More...
int	XLALBurstInjectSignals (REAL8TimeSeries *h, const SimBurst *sim_burst, const TimeSlide *time_slide_table_head, const COMPLEX16FrequencySeries *response)
	Wrapper to iterate over the entries in a sim_burst linked list and inject them into a time series. More...

Function Documentation

XLALGenerateSimBurst()

int XLALGenerateSimBurst	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		const SimBurst *	sim_burst,
		double	delta_t
	)

Generate the + and x time series for a single sim_burst table row.

Note: only the row pointed to by sim_burst is processed, the linked list is not iterated over. The hplus and hcross time series objects will be allocated by this function. The time-at-geocentre is applied, but the time shift offset must be applied separately. delta_t is the sample interval for the time series. The return value is 0 on success, non-0 on failure.

Definition at line 67 of file GenerateBurst.c.

XLALBurstInjectSignals()

int XLALBurstInjectSignals	(	REAL8TimeSeries *	series,
		const SimBurst *	sim_burst,
		const TimeSlide *	time_slide_table_head,
		const COMPLEX16FrequencySeries *	response
	)

Wrapper to iterate over the entries in a sim_burst linked list and inject them into a time series.

Passing NULL for the response disables it (input time series is strain).

Definition at line 158 of file GenerateBurst.c.