LALSimulation.h File Reference

#include <lal/LALDatatypes.h>
#include <lal/LALDetectors.h>
#include <lal/LALRCSID.h>

Include dependency graph for LALSimulation.h:

Go to the source code of this file.

Functions
	NRCSID (LALSIMULATIONH,"$Id:")
const LALDetector *	XLALInstrumentNameToLALDetector (const char *string)
	Turn an instrument name into a LALDetector structure.
REAL8TimeSeries *	XLALSimDetectorStrainREAL8TimeSeries (const REAL8TimeSeries *hplus, const REAL8TimeSeries *hcross, REAL8 right_ascension, REAL8 declination, REAL8 psi, LALDetector *detector)
	Input.
int	XLALSimAddInjectionREAL8TimeSeries (REAL8TimeSeries *target, REAL8TimeSeries *h, const COMPLEX16FrequencySeries *response)
	Essentially a wrapper for XLALAddREAL8TimeSeries(), but performs sub-sample re-interpolation to adjust the source time series epoch to lie on an integer sample boundary in the target time series.

---

Function Documentation

NRCSID	(	LALSIMULATIONH	,
		"$Id:"
	)

const LALDetector* XLALInstrumentNameToLALDetector

(

const char *

string

)

Turn an instrument name into a LALDetector structure.

The first two characters of the input string are used as the instrument name, which allows channel names in the form "H1:LSC-STRAIN" to be used. The return value is a pointer into the lalCachedDetectors array, so modifications to the contents are global. Make a copy of the structure if you want to modify it safely.

Definition at line 87 of file LALSimulation.c.

REAL8TimeSeries* XLALSimDetectorStrainREAL8TimeSeries	(	const REAL8TimeSeries *	hplus,
		const REAL8TimeSeries *	hcross,
		REAL8	right_ascension,
		REAL8	declination,
		REAL8	psi,
		LALDetector *	detector
	)

Input.

• h+ and hx time series for the injection with their epochs set to the start of those time series at the geocentre (for simplicity the epochs must be the same),

• the right ascension and declination of the source in radians.

• the orientation of the wave co-ordinate system, psi, in radians.

• the detector into which the injection is destined to be injected,

Output

The strain time series as seen in the detector, with the epoch set to the start of the time series at that detector.

Notes

Antenna response factors are computed sample-by-sample, but waveform is not Doppler corrected or otherwise re-interpolated to account for detector motion.

The output time series units are the same as the two input time series (which must both have the same sample units).

Definition at line 197 of file LALSimulation.c.

int XLALSimAddInjectionREAL8TimeSeries	(	REAL8TimeSeries *	target,
		REAL8TimeSeries *	h,
		const COMPLEX16FrequencySeries *	response
	)

Essentially a wrapper for XLALAddREAL8TimeSeries(), but performs sub-sample re-interpolation to adjust the source time series epoch to lie on an integer sample boundary in the target time series.

This transformation is done in the frequency domain, so it is convenient to allow a response function to be applied at the same time. Passing NULL for the response function turns this feature off (i.e., uses a unit response).

NOTE: the source time series is modified in place by this function!

This function accepts source and target time series whose units are not the same, and allows the two time series to be herterodyned (although it currently requires them to have the same heterodyne frequency).

Definition at line 266 of file LALSimulation.c.

---