LALSimIMRNRWaveforms.c File Reference

Prototypes
static UNUSED REAL8	XLALSimInspiralNRWaveformCheckFRef (UNUSED LALH5File *file, UNUSED REAL8 fRef)
static UNUSED REAL8	XLALSimInspiralNRWaveformGetRefTimeFromRefFreq (UNUSED LALH5File *file, UNUSED REAL8 fRef)
static UNUSED REAL8	XLALSimInspiralNRWaveformGetInterpValueFromGroupAtPoint (UNUSED LALH5File *file, UNUSED const char *groupName, UNUSED REAL8 ref_point)
static UNUSED UINT4	XLALSimInspiralNRWaveformGetSpinsFromHDF5FilePointer (UNUSED REAL8 *S1x, UNUSED REAL8 *S1y, UNUSED REAL8 *S1z, UNUSED REAL8 *S2x, UNUSED REAL8 *S2y, UNUSED REAL8 *S2z, UNUSED REAL8 fRef, UNUSED REAL8 mTot, UNUSED LALH5File *file)
static UNUSED UINT4	XLALSimInspiralNRWaveformGetDataFromHDF5File (UNUSED REAL8Vector **output, UNUSED LALH5File *pointer, UNUSED REAL8 totalMass, UNUSED REAL8 startTime, UNUSED size_t length, UNUSED REAL8 deltaT, UNUSED const char *keyName)
static UNUSED UINT4	XLALSimInspiralNRWaveformGetRotationAnglesFromH5File (UNUSED REAL8 *theta, UNUSED REAL8 *psi, UNUSED REAL8 *calpha, UNUSED REAL8 *salpha, UNUSED LALH5File *filepointer, UNUSED const REAL8 inclination, UNUSED const REAL8 phi_ref, UNUSED REAL8 fRef)
int	XLALSimInspiralNRWaveformGetSpinsFromHDF5File (UNUSED REAL8 *S1x, UNUSED REAL8 *S1y, UNUSED REAL8 *S1z, UNUSED REAL8 *S2x, UNUSED REAL8 *S2y, UNUSED REAL8 *S2z, UNUSED REAL8 fRef, UNUSED REAL8 mTot, UNUSED const char *NRDataFile)
static UNUSED INT4	XLALSimIMRNRWaveformGetModes (UNUSED SphHarmTimeSeries **Hlms, UNUSED LIGOTimeGPS *epoch, UNUSED UINT4 *length, UNUSED REAL8 deltaT, UNUSED REAL8 m1, UNUSED REAL8 m2, UNUSED REAL8 r, UNUSED REAL8 fStart, UNUSED REAL8 fRef, UNUSED REAL8 s1x, UNUSED REAL8 s1y, UNUSED REAL8 s1z, UNUSED REAL8 s2x, UNUSED REAL8 s2y, UNUSED REAL8 s2z, UNUSED LALH5File *file, UNUSED LALValue *ModeArray)
INT4	XLALSimInspiralNRWaveformGetHplusHcross (UNUSED REAL8TimeSeries **hplus, UNUSED REAL8TimeSeries **hcross, UNUSED REAL8 phiRef, UNUSED REAL8 inclination, UNUSED REAL8 deltaT, UNUSED REAL8 m1_SI, UNUSED REAL8 m2_SI, UNUSED REAL8 r, UNUSED REAL8 fStart, UNUSED REAL8 fRef, UNUSED REAL8 s1x, UNUSED REAL8 s1y, UNUSED REAL8 s1z, UNUSED REAL8 s2x, UNUSED REAL8 s2y, UNUSED REAL8 s2z, UNUSED const char *NRDataFile, UNUSED LALValue *ModeArray)
INT4	XLALSimInspiralNRWaveformGetHlms (UNUSED SphHarmTimeSeries **Hlms, UNUSED REAL8 deltaT, UNUSED REAL8 m1_SI, UNUSED REAL8 m2_SI, UNUSED REAL8 r, UNUSED REAL8 fStart, UNUSED REAL8 fRef, UNUSED REAL8 s1x, UNUSED REAL8 s1y, UNUSED REAL8 s1z, UNUSED REAL8 s2x, UNUSED REAL8 s2y, UNUSED REAL8 s2z, UNUSED const char *NRDataFile, UNUSED LALValue *ModeArray)

Go to the source code of this file.

Function Documentation

XLALSimInspiralNRWaveformCheckFRef()

static UNUSED REAL8 XLALSimInspiralNRWaveformCheckFRef ( UNUSED LALH5File *  file, UNUSED REAL8  fRef  )

static

Definition at line 61 of file LALSimIMRNRWaveforms.c.

XLALSimInspiralNRWaveformGetRefTimeFromRefFreq()

static UNUSED REAL8 XLALSimInspiralNRWaveformGetRefTimeFromRefFreq ( UNUSED LALH5File *  file, UNUSED REAL8  fRef  )

static

Definition at line 100 of file LALSimIMRNRWaveforms.c.

XLALSimInspiralNRWaveformGetInterpValueFromGroupAtPoint()

static UNUSED REAL8 XLALSimInspiralNRWaveformGetInterpValueFromGroupAtPoint ( UNUSED LALH5File *  file, UNUSED const char *  groupName, UNUSED REAL8  ref_point  )

static

Parameters

file	Pointer to HDF5 file
groupName	Name of group in HDF file
ref_point	Point at which to evaluate

Definition at line 137 of file LALSimIMRNRWaveforms.c.

XLALSimInspiralNRWaveformGetSpinsFromHDF5FilePointer()

static UNUSED UINT4 XLALSimInspiralNRWaveformGetSpinsFromHDF5FilePointer ( UNUSED REAL8 *  S1x, UNUSED REAL8 *  S1y, UNUSED REAL8 *  S1z, UNUSED REAL8 *  S2x, UNUSED REAL8 *  S2y, UNUSED REAL8 *  S2z, UNUSED REAL8  fRef, UNUSED REAL8  mTot, UNUSED LALH5File *  file  )

static

Parameters

[out]	S1x	Dimensionless spin1x in LAL frame
[out]	S1y	Dimensionless spin1y in LAL frame
[out]	S1z	Dimensionless spin1z in LAL frame
[out]	S2x	Dimensionless spin2x in LAL frame
[out]	S2y	Dimensionless spin2y in LAL frame
[out]	S2z	Dimensionless spin2z in LAL frame
	fRef	Reference frequency
	mTot	Total mass
	file	Pointer to HDF5 file

Definition at line 174 of file LALSimIMRNRWaveforms.c.

XLALSimInspiralNRWaveformGetDataFromHDF5File()

static UNUSED UINT4 XLALSimInspiralNRWaveformGetDataFromHDF5File ( UNUSED REAL8Vector **  output, UNUSED LALH5File *  pointer, UNUSED REAL8  totalMass, UNUSED REAL8  startTime, UNUSED size_t  length, UNUSED REAL8  deltaT, UNUSED const char *  keyName  )

static

Parameters

output	Returned vector uncompressed
pointer	Pointer to HDF5 file
totalMass	Total mass of system for scaling
startTime	Start time of veturn vector
length	Length of returned vector
deltaT	Sample rate of returned vector
keyName	Name of vector to uncompress

Definition at line 295 of file LALSimIMRNRWaveforms.c.

XLALSimInspiralNRWaveformGetRotationAnglesFromH5File()

static UNUSED UINT4 XLALSimInspiralNRWaveformGetRotationAnglesFromH5File ( UNUSED REAL8 *  theta, UNUSED REAL8 *  psi, UNUSED REAL8 *  calpha, UNUSED REAL8 *  salpha, UNUSED LALH5File *  filepointer, UNUSED const REAL8  inclination, UNUSED const REAL8  phi_ref, UNUSED REAL8  fRef  )

static

Parameters

theta	Returned inclination angle of source
psi	Returned azimuth angle of source
calpha	Returned cosine of the polarisation angle
salpha	Returned sine of the polarisation angle
filepointer	Pointer to NR HDF5 file
inclination	Inclination of source
phi_ref	Orbital reference phase
fRef	Reference frequency

Definition at line 356 of file LALSimIMRNRWaveforms.c.

XLALSimInspiralNRWaveformGetSpinsFromHDF5File()

int XLALSimInspiralNRWaveformGetSpinsFromHDF5File	(	UNUSED REAL8 *	S1x,
		UNUSED REAL8 *	S1y,
		UNUSED REAL8 *	S1z,
		UNUSED REAL8 *	S2x,
		UNUSED REAL8 *	S2y,
		UNUSED REAL8 *	S2z,
		UNUSED REAL8	fRef,
		UNUSED REAL8	mTot,
		UNUSED const char *	NRDataFile
	)

Parameters

[out]	S1x	Dimensionless spin1x in LAL frame
[out]	S1y	Dimensionless spin1y in LAL frame
[out]	S1z	Dimensionless spin1z in LAL frame
[out]	S2x	Dimensionless spin2x in LAL frame
[out]	S2y	Dimensionless spin2y in LAL frame
[out]	S2z	Dimensionless spin2z in LAL frame
	fRef	Reference frequency
	mTot	Total mass
	NRDataFile	Location of NR HDF file

Definition at line 613 of file LALSimIMRNRWaveforms.c.

XLALSimIMRNRWaveformGetModes()

static UNUSED INT4 XLALSimIMRNRWaveformGetModes ( UNUSED SphHarmTimeSeries **  Hlms, UNUSED LIGOTimeGPS *  epoch, UNUSED UINT4 *  length, UNUSED REAL8  deltaT, UNUSED REAL8  m1, UNUSED REAL8  m2, UNUSED REAL8  r, UNUSED REAL8  fStart, UNUSED REAL8  fRef, UNUSED REAL8  s1x, UNUSED REAL8  s1y, UNUSED REAL8  s1z, UNUSED REAL8  s2x, UNUSED REAL8  s2y, UNUSED REAL8  s2z, UNUSED LALH5File *  file, UNUSED LALValue *  ModeArray  )

static

Parameters

Hlms	OUTPUT
epoch	OUTPUT
length	OUTPUT
deltaT	sampling interval (s)
m1	mass of companion 1 (solar units)
m2	mass of companion 2 (solar units)
r	distance of source (m)
fStart	start GW frequency (Hz)
fRef	reference GW frequency (Hz)
s1x	initial value of S1x
s1y	initial value of S1y
s1z	initial value of S1z
s2x	initial value of S2x
s2y	initial value of S2y
s2z	initial value of S2z
file	pointer to location of NR HDF file
ModeArray	Container for the ell and m modes to generate. To generate all available modes pass NULL

Definition at line 646 of file LALSimIMRNRWaveforms.c.

XLALSimInspiralNRWaveformGetHplusHcross()

INT4 XLALSimInspiralNRWaveformGetHplusHcross	(	UNUSED REAL8TimeSeries **	hplus,
		UNUSED REAL8TimeSeries **	hcross,
		UNUSED REAL8	phiRef,
		UNUSED REAL8	inclination,
		UNUSED REAL8	deltaT,
		UNUSED REAL8	m1_SI,
		UNUSED REAL8	m2_SI,
		UNUSED REAL8	r,
		UNUSED REAL8	fStart,
		UNUSED REAL8	fRef,
		UNUSED REAL8	s1x,
		UNUSED REAL8	s1y,
		UNUSED REAL8	s1z,
		UNUSED REAL8	s2x,
		UNUSED REAL8	s2y,
		UNUSED REAL8	s2z,
		UNUSED const char *	NRDataFile,
		UNUSED LALValue *	ModeArray
	)

Parameters

hplus	Output h_+ vector
hcross	Output h_x vector
phiRef	orbital phase at reference pt.
inclination	inclination angle
deltaT	sampling interval (s)
m1_SI	mass of companion 1 (kg)
m2_SI	mass of companion 2 (kg)
r	distance of source (m)
fStart	start GW frequency (Hz)
fRef	reference GW frequency (Hz)
s1x	initial value of S1x
s1y	initial value of S1y
s1z	initial value of S1z
s2x	initial value of S2x
s2y	initial value of S2y
s2z	initial value of S2z
NRDataFile	Location of NR HDF file
ModeArray	Container for the ell and m modes to generate. To generate all available modes pass NULL

Definition at line 895 of file LALSimIMRNRWaveforms.c.

XLALSimInspiralNRWaveformGetHlms()

INT4 XLALSimInspiralNRWaveformGetHlms	(	UNUSED SphHarmTimeSeries **	Hlms,
		UNUSED REAL8	deltaT,
		UNUSED REAL8	m1_SI,
		UNUSED REAL8	m2_SI,
		UNUSED REAL8	r,
		UNUSED REAL8	fStart,
		UNUSED REAL8	fRef,
		UNUSED REAL8	s1x,
		UNUSED REAL8	s1y,
		UNUSED REAL8	s1z,
		UNUSED REAL8	s2x,
		UNUSED REAL8	s2y,
		UNUSED REAL8	s2z,
		UNUSED const char *	NRDataFile,
		UNUSED LALValue *	ModeArray
	)

Parameters

Hlms	OUTPUT
deltaT	sampling interval (s)
m1_SI	mass of companion 1 (kg)
m2_SI	mass of companion 2 (kg)
r	distance of source (m)
fStart	start GW frequency (Hz)
fRef	reference GW frequency (Hz)
s1x	initial value of S1x
s1y	initial value of S1y
s1z	initial value of S1z
s2x	initial value of S2x
s2y	initial value of S2y
s2z	initial value of S2z
NRDataFile	Location of NR HDF file
ModeArray	Container for the ell and m modes to generate. To generate all available modes pass NULL

Definition at line 1028 of file LALSimIMRNRWaveforms.c.