Detailed Description

Module for generating h(t) from Numrel waveforms.

Author: S.Fairhurst, B. Krishnan, L.Santamaria

Prototypes
REAL4TimeVectorSeries *	XLALSumStrain (REAL4TimeVectorSeries tempstrain, REAL4TimeVectorSeries strain)
	Takes a strain of h+ and hx data and stores it in a temporal strain in order to perform the sum over l and m modes. More...

REAL8TimeVectorSeries *	XLALSumStrainREAL8 (REAL8TimeVectorSeries tempstrain, REAL8TimeVectorSeries strain)

INT4	XLALOrientNRWave (REAL4TimeVectorSeries *strain, UINT4 modeL, INT4 modeM, REAL4 inclination, REAL4 coa_phase)
	Takes a (sky averaged) numerical relativity waveform and returns the waveform appropriate for given coalescence phase and inclination angles. More...

REAL8TimeVectorSeries *	XLALOrientNRWaveREAL8 (REAL8TimeVectorSeries *strain, UINT4 modeL, INT4 modeM, REAL4 inclination, REAL4 coa_phase)
	Takes a (sky averaged) numerical relativity waveform and returns the waveform appropriate for given coalescence phase and inclination angles. More...

void	XLALOrientNRWaveTimeSeriesREAL8 (REAL8TimeSeries plus, REAL8TimeSeries cross, UINT4 modeL, INT4 modeM, REAL4 inclination, REAL4 coa_phase)
	Takes a (sky averaged) numerical relativity waveform and returns the waveform appropriate for given coalescence phase and inclination angles. More...

REAL4TimeSeries *	XLALCalculateNRStrain (REAL4TimeVectorSeries strain, SimInspiralTable thisInj, const CHAR *ifo, INT4 sampleRate)

REAL4TimeSeries *	XLALInterpolateNRWave (REAL4TimeSeries *in, INT4 sampleRate)
	Function for interpolating time series to a given sampling rate. More...

REAL8TimeSeries *	XLALInterpolateNRWaveREAL8 (REAL8TimeSeries *in, INT4 sampleRate)
	Function for interpolating time series to a given sampling rate. More...

INT4	XLALFindNRFile (NRWaveMetaData out, NRWaveCatalog nrCatalog, const SimInspiralTable *inj, INT4 modeL, INT4 modeM)
	For given inspiral parameters, find nearest waveform in catalog of numerical relativity waveforms. More...

void	LALInjectStrainGW (LALStatus status, REAL4TimeSeries injData, REAL4TimeVectorSeries strain, SimInspiralTable thisInj, CHAR *ifo, REAL8 dynRange)

void	LALInjectStrainGWREAL8 (LALStatus status, REAL8TimeSeries injData, REAL8TimeVectorSeries strain, SimInspiralTable thisInj, CHAR *ifo, REAL8 dynRange)

INT4	XLALFindNRCoalescenceTime (REAL8 tc, const REAL4TimeVectorSeries in)
	Function for calculating the coalescence time (defined to be the peak) of a NR wave. More...

INT4	XLALFindNRCoalescenceTimeFromhoft (REAL8 tc, const REAL4TimeSeries in)
	Function for calculating the coalescence time (defined to be the peak) of a NR wave This uses the peak of h(t) More...

INT4	XLALFindNRCoalescenceTimeREAL8 (REAL8 tc, const REAL8TimeSeries in)
	Function for calculating the coalescence time (defined to be the peak) of a NR wave. More...

INT4	XLALFindNRCoalescencePlusCrossREAL8 (REAL8 tc, const REAL8TimeSeries plus, const REAL8TimeSeries *cross)

CHAR *	XLALGetNinjaChannelName (const CHAR *polarisation, UINT4 l, INT4 m)
	channel name for nr data in frame file More...

NumRelGroup	XLALParseNumRelGroupName (CHAR *name)
	Function for parsing numrel group name and converting it into a enum element. More...

Enumerations
enum	NumRelGroup { NINJA_GROUP_AEI = 0 , NINJA_GROUP_CIT , NINJA_GROUP_LSU , NINJA_GROUP_JENA , NINJA_GROUP_RIT , NINJA_GROUP_CORNELL , NINJA_GROUP_PSU , NINJA_GROUP_FAU , NINJA_GROUP_UTB , NINJA_GROUP_UIUC , NINJA_GROUP_PRINCETON , NINJA_GROUP_LAST }
	enum for list of numrel groups More...

Macros
#define	NINJA_MIN_MODE 2

#define	NINJA_MAX_MODE 5

Error codes
#define	NRWAVEINJECT_ENULL 1
	Null pointer. More...

#define	NRWAVEINJECT_EFILE 2
	Error in file-IO. More...

#define	NRWAVEINJECT_ENONULL 3
	Not a Null pointer. More...

#define	NRWAVEINJECT_ENOMEM 4
	Memory ellocation error. More...

#define	NRWAVEINJECT_EVAL 5
	Invalid value. More...

#define	NRWAVEINJECT_EFORMAT 6
	Meta data file format incorrect. More...

Function Documentation

◆ XLALSumStrain()

REAL4TimeVectorSeries * XLALSumStrain	(	REAL4TimeVectorSeries *	tempstrain,
		REAL4TimeVectorSeries *	strain
	)

Takes a strain of h+ and hx data and stores it in a temporal strain in order to perform the sum over l and m modes.

Parameters

tempstrain	storing variable
strain	variable to add

Definition at line 58 of file NRWaveInject.c.

◆ XLALSumStrainREAL8()

REAL8TimeVectorSeries * XLALSumStrainREAL8	(	REAL8TimeVectorSeries *	tempstrain,
		REAL8TimeVectorSeries *	strain
	)

Parameters

tempstrain	storing variable
strain	variable to add

Definition at line 76 of file NRWaveInject.c.

◆ XLALOrientNRWave()

INT4 XLALOrientNRWave	(	REAL4TimeVectorSeries *	strain,
		UINT4	modeL,
		INT4	modeM,
		REAL4	inclination,
		REAL4	coa_phase
	)

Takes a (sky averaged) numerical relativity waveform and returns the waveform appropriate for given coalescence phase and inclination angles.

Parameters

strain	sky average h+, hx data
modeL	L
modeM	M
inclination	binary inclination
coa_phase	binary coalescence phase

Definition at line 99 of file NRWaveInject.c.

◆ XLALOrientNRWaveREAL8()

REAL8TimeVectorSeries * XLALOrientNRWaveREAL8	(	REAL8TimeVectorSeries *	strain,
		UINT4	modeL,
		INT4	modeM,
		REAL4	inclination,
		REAL4	coa_phase
	)

Takes a (sky averaged) numerical relativity waveform and returns the waveform appropriate for given coalescence phase and inclination angles.

Parameters

strain	sky average h+, hx data
modeL	L
modeM	M
inclination	binary inclination
coa_phase	binary coalescence phase

Definition at line 182 of file NRWaveInject.c.

◆ XLALOrientNRWaveTimeSeriesREAL8()

void XLALOrientNRWaveTimeSeriesREAL8	(	REAL8TimeSeries *	plus,
		REAL8TimeSeries *	cross,
		UINT4	modeL,
		INT4	modeM,
		REAL4	inclination,
		REAL4	coa_phase
	)

Takes a (sky averaged) numerical relativity waveform and returns the waveform appropriate for given coalescence phase and inclination angles.

Parameters

plus	NEEDS DOCUMENTATION
cross	NEEDS DOCUMENTATION
modeL	L
modeM	M
inclination	binary inclination
coa_phase	binary coalescence phase

Definition at line 140 of file NRWaveInject.c.

◆ XLALCalculateNRStrain()

REAL4TimeSeries * XLALCalculateNRStrain	(	REAL4TimeVectorSeries *	strain,
		SimInspiralTable *	thisInj,
		const CHAR *	ifo,
		INT4	sampleRate
	)

Parameters

strain	h+, hx time series data
thisInj	injection details
ifo	interferometer
sampleRate	sample rate of time series

Definition at line 218 of file NRWaveInject.c.

◆ XLALInterpolateNRWave()

REAL4TimeSeries * XLALInterpolateNRWave	(	REAL4TimeSeries *	in,
		INT4	sampleRate
	)

Function for interpolating time series to a given sampling rate.

Input vector is destroyed and a new vector is allocated.

Parameters

in	input strain time series
sampleRate	sample rate of time series

Definition at line 289 of file NRWaveInject.c.

◆ XLALInterpolateNRWaveREAL8()

REAL8TimeSeries * XLALInterpolateNRWaveREAL8	(	REAL8TimeSeries *	in,
		INT4	sampleRate
	)

Function for interpolating time series to a given sampling rate.

Input vector is destroyed and a new vector is allocated.

Parameters

in	input strain time series
sampleRate	sample rate of time series

Definition at line 367 of file NRWaveInject.c.

◆ XLALFindNRFile()

INT4 XLALFindNRFile	(	NRWaveMetaData *	out,
		NRWaveCatalog *	nrCatalog,
		const SimInspiralTable *	inj,
		INT4	modeL,
		INT4	modeM
	)

For given inspiral parameters, find nearest waveform in catalog of numerical relativity waveforms.

At the moment, only the mass ratio is considered.

Parameters

out	output wave data
nrCatalog	input NR wave catalog
inj	injection details
modeL	mode index l
modeM	mode index m

Definition at line 586 of file NRWaveInject.c.

◆ LALInjectStrainGW()

void LALInjectStrainGW	(	LALStatus *	status,
		REAL4TimeSeries *	injData,
		REAL4TimeVectorSeries *	strain,
		SimInspiralTable *	thisInj,
		CHAR *	ifo,
		REAL8	dynRange
	)

Definition at line 655 of file NRWaveInject.c.

◆ LALInjectStrainGWREAL8()

void LALInjectStrainGWREAL8	(	LALStatus *	status,
		REAL8TimeSeries *	injData,
		REAL8TimeVectorSeries *	strain,
		SimInspiralTable *	thisInj,
		CHAR *	ifo,
		REAL8	dynRange
	)

◆ XLALFindNRCoalescenceTime()

INT4 XLALFindNRCoalescenceTime	(	REAL8 *	tc,
		const REAL4TimeVectorSeries *	in
	)

Function for calculating the coalescence time (defined to be the peak) of a NR wave.

Parameters

tc	FIXME: !TO BE DOCUMENTED!
in	input strain time series

Definition at line 469 of file NRWaveInject.c.

◆ XLALFindNRCoalescenceTimeFromhoft()

INT4 XLALFindNRCoalescenceTimeFromhoft	(	REAL8 *	tc,
		const REAL4TimeSeries *	in
	)

Function for calculating the coalescence time (defined to be the peak) of a NR wave This uses the peak of h(t)

Parameters

tc	FIXME: !TO BE DOCUMENTED!
in	input strain time series

Definition at line 537 of file NRWaveInject.c.

◆ XLALFindNRCoalescenceTimeREAL8()

INT4 XLALFindNRCoalescenceTimeREAL8	(	REAL8 *	tc,
		const REAL8TimeSeries *	in
	)

Function for calculating the coalescence time (defined to be the peak) of a NR wave.

Parameters

tc	FIXME: !TO BE DOCUMENTED!
in	input strain time series

Definition at line 559 of file NRWaveInject.c.

◆ XLALFindNRCoalescencePlusCrossREAL8()

INT4 XLALFindNRCoalescencePlusCrossREAL8	(	REAL8 *	tc,
		const REAL8TimeSeries *	plus,
		const REAL8TimeSeries *	cross
	)

Parameters

tc	FIXME: !TO BE DOCUMENTED!
plus	input strain plus time series
cross	input strain cross time series

Definition at line 500 of file NRWaveInject.c.

◆ XLALGetNinjaChannelName()

CHAR * XLALGetNinjaChannelName	(	const CHAR *	polarisation,
		UINT4	l,
		INT4	m
	)

channel name for nr data in frame file

Parameters

polarisation	either plus or cross
l	azimuthal mode index
m	polar mode index

Definition at line 845 of file NRWaveInject.c.

◆ XLALParseNumRelGroupName()

NumRelGroup XLALParseNumRelGroupName ( CHAR * name )

Function for parsing numrel group name and converting it into a enum element.

This needs to be robust enough to be able to handle the information as submitted by the groups. Is there a cleaner way to do this? add or modify the group names as required

Definition at line 880 of file NRWaveInject.c.

Enumeration Type Documentation

◆ NumRelGroup

enum NumRelGroup

enum for list of numrel groups

Enumerator
NINJA_GROUP_AEI
NINJA_GROUP_CIT
NINJA_GROUP_LSU
NINJA_GROUP_JENA
NINJA_GROUP_RIT
NINJA_GROUP_CORNELL
NINJA_GROUP_PSU
NINJA_GROUP_FAU
NINJA_GROUP_UTB
NINJA_GROUP_UIUC
NINJA_GROUP_PRINCETON
NINJA_GROUP_LAST

Definition at line 76 of file NRWaveInject.h.

Macro Definition Documentation

◆ NRWAVEINJECT_ENULL

#define NRWAVEINJECT_ENULL 1

Null pointer.

Definition at line 55 of file NRWaveInject.h.

◆ NRWAVEINJECT_EFILE

#define NRWAVEINJECT_EFILE 2

Error in file-IO.

Definition at line 56 of file NRWaveInject.h.

◆ NRWAVEINJECT_ENONULL

#define NRWAVEINJECT_ENONULL 3

Not a Null pointer.

Definition at line 57 of file NRWaveInject.h.

◆ NRWAVEINJECT_ENOMEM

#define NRWAVEINJECT_ENOMEM 4

Memory ellocation error.

Definition at line 58 of file NRWaveInject.h.

◆ NRWAVEINJECT_EVAL

#define NRWAVEINJECT_EVAL 5

Invalid value.

Definition at line 59 of file NRWaveInject.h.

◆ NRWAVEINJECT_EFORMAT

#define NRWAVEINJECT_EFORMAT 6

Meta data file format incorrect.

Definition at line 60 of file NRWaveInject.h.

◆ NINJA_MIN_MODE

#define NINJA_MIN_MODE 2

Definition at line 72 of file NRWaveInject.h.

◆ NINJA_MAX_MODE

#define NINJA_MAX_MODE 5

Definition at line 73 of file NRWaveInject.h.

Detailed Description

Prototypes

Enumerations

Macros

Error codes

Function Documentation

◆ XLALSumStrain()

◆ XLALSumStrainREAL8()

◆ XLALOrientNRWave()

◆ XLALOrientNRWaveREAL8()

◆ XLALOrientNRWaveTimeSeriesREAL8()

◆ XLALCalculateNRStrain()

◆ XLALInterpolateNRWave()

◆ XLALInterpolateNRWaveREAL8()

◆ XLALFindNRFile()

◆ LALInjectStrainGW()

◆ LALInjectStrainGWREAL8()

◆ XLALFindNRCoalescenceTime()

◆ XLALFindNRCoalescenceTimeFromhoft()

◆ XLALFindNRCoalescenceTimeREAL8()

◆ XLALFindNRCoalescencePlusCrossREAL8()

◆ XLALGetNinjaChannelName()

◆ XLALParseNumRelGroupName()

Enumeration Type Documentation

◆ NumRelGroup

Macro Definition Documentation

◆ NRWAVEINJECT_ENULL

◆ NRWAVEINJECT_EFILE

◆ NRWAVEINJECT_ENONULL

◆ NRWAVEINJECT_ENOMEM

◆ NRWAVEINJECT_EVAL

◆ NRWAVEINJECT_EFORMAT

◆ NINJA_MIN_MODE

◆ NINJA_MAX_MODE