LALSimBurst.h File Reference

#include <gsl/gsl_rng.h>
#include <lal/LALDatatypes.h>
#include <lal/LALRCSID.h>

Include dependency graph for LALSimBurst.h:

Go to the source code of this file.

Functions
	NRCSID (LALSIMBURSTH,"$Id:")
int	XLALGenerateBandAndTimeLimitedWhiteNoiseBurst (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 duration, REAL8 frequency, REAL8 bandwidth, REAL8 int_hdot_squared, REAL8 delta_t, gsl_rng *rng)
int	XLALGenerateStringCusp (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 amplitude, REAL8 f_high, REAL8 delta_t)
int	XLALSimBurstSineGaussian (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 Q, REAL8 centre_frequency, REAL8 hrss, REAL8 eccentricity, REAL8 polarization, REAL8 delta_t)
REAL8	XLALMeasureHPeak (const REAL8TimeSeries *)
	Returns the strain of the sample with the largest magnitude.
REAL8	XLALMeasureIntS1S2DT (const REAL8TimeSeries *, const REAL8TimeSeries *)
	From two time series, s1 and s2, computes and returns.
REAL8	XLALMeasureHrss (const REAL8TimeSeries *, const REAL8TimeSeries *)
	Returns what people call the "root-sum-square strain".
REAL8	XLALMeasureIntHDotSquaredDT (const COMPLEX16FrequencySeries *)
REAL8	XLALMeasureEoverRsquared (REAL8TimeSeries *, REAL8TimeSeries *)

---

Function Documentation

NRCSID	(	LALSIMBURSTH	,
		"$Id:"
	)

int XLALGenerateBandAndTimeLimitedWhiteNoiseBurst	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	duration,
		REAL8	frequency,
		REAL8	bandwidth,
		REAL8	int_hdot_squared,
		REAL8	delta_t,
		gsl_rng *	rng
	)

int XLALGenerateStringCusp	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	amplitude,
		REAL8	f_high,
		REAL8	delta_t
	)

int XLALSimBurstSineGaussian	(	REAL8TimeSeries **	hplus,
		REAL8TimeSeries **	hcross,
		REAL8	Q,
		REAL8	centre_frequency,
		REAL8	hrss,
		REAL8	eccentricity,
		REAL8	polarization,
		REAL8	delta_t
	)

REAL8 XLALMeasureHPeak

(

const REAL8TimeSeries *

)

Returns the strain of the sample with the largest magnitude.

Definition at line 81 of file LALSimBurst.c.

REAL8 XLALMeasureIntS1S2DT	(	const REAL8TimeSeries *	s1,
		const REAL8TimeSeries *	s2
	)

From two time series, s1 and s2, computes and returns.

s1(t) s2(t) t.

Definition at line 106 of file LALSimBurst.c.

REAL8 XLALMeasureHrss	(	const REAL8TimeSeries *	hplus,
		const REAL8TimeSeries *	hcross
	)

Returns what people call the "root-sum-square strain".

Infact, this is

{ (h_{+}^{2} + h_{x}^{2}) t},

which is an approximation of

{ (h_{+}^{2} + h_{x}^{2}) t}.

Definition at line 147 of file LALSimBurst.c.

REAL8 XLALMeasureIntHDotSquaredDT

(

const COMPLEX16FrequencySeries *

)

REAL8 XLALMeasureEoverRsquared	(	REAL8TimeSeries *	,
		REAL8TimeSeries *
	)

---