NRWaveInject.c File Reference

Author:: S.Fairhurst, B.Krishnan, L.SantamariaFunctions for reading/writing numerical relativity waveforms

#include <lal/LALStdio.h>
#include <lal/FileIO.h>
#include <lal/NRWaveIO.h>
#include <lal/LIGOMetadataTables.h>
#include <lal/LIGOMetadataUtils.h>
#include <lal/Date.h>
#include <lal/Units.h>
#include <lal/LALConstants.h>
#include <lal/NRWaveInject.h>
#include <lal/Random.h>
#include <lal/Inject.h>
#include <lal/LALSimulation.h>
#include <lal/LALDetectors.h>
#include <lal/LALComplex.h>
#include <lal/DetResponse.h>
#include <lal/TimeDelay.h>
#include <lal/SkyCoordinates.h>
#include <lal/TimeSeries.h>
#include <lal/FrequencySeries.h>
#include <lal/TimeFreqFFT.h>
#include <lal/Window.h>
#include <gsl/gsl_heapsort.h>

Include dependency graph for NRWaveInject.c:

Go to the source code of this file.

Functions

NRCSID (NRWAVEINJECTC,"$Id: NRWaveInject.c,v 1.56 2008/08/18 01:52:30 badri Exp $")

int compare_abs_float (const void *a, const void *b)

int compare_abs_double (const void *a, const void *b)

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.

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.

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.

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

REAL4TimeSeries * XLALInterpolateNRWave (REAL4TimeSeries *in, INT4 sampleRate)

Function for interpolating time series to a given sampling rate.

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

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

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).

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

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

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.

INT4 XLALSphHarm (COMPLEX16 *out, UINT4 L, INT4 M, REAL4 theta, REAL4 phi)

Spin weighted Spherical Harmonic.

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)

REAL8 version of above but using Jolien's new functions.

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

channel name for nr data in frame file polar mode index

NumRelGroup XLALParseNumRelGroupName (CHAR *name)

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

Detailed Description

Author:: S.Fairhurst, B.Krishnan, L.SantamariaFunctions for reading/writing numerical relativity waveforms

Id: NRWaveInject.c,v 1.56 2008/08/18 01:52:30 badri Exp

Definition in file NRWaveInject.c.

Function Documentation

NRCSID	(	NRWAVEINJECTC	,
		"$Id: NRWaveInject.	c,
		v 1.56 2008/08/18 01:52:30 badri Exp $"
	)

int compare_abs_float	(	const void *	a,
		const void *	b
	)

Definition at line 321 of file NRWaveInject.c.

int compare_abs_double	(	const void *	a,
		const void *	b
	)

Definition at line 337 of file NRWaveInject.c.

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 64 of file NRWaveInject.c.

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

Parameters:

tempstrain	storing variable
strain	variable to add

Definition at line 82 of file NRWaveInject.c.

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 103 of file NRWaveInject.c.

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 143 of file NRWaveInject.c.

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

Parameters:

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

Definition at line 179 of file NRWaveInject.c.

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 251 of file NRWaveInject.c.

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

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

Parameters:

in	input strain time series

Definition at line 355 of file NRWaveInject.c.

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:

in	input strain time series

Definition at line 390 of file NRWaveInject.c.

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

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

Parameters:

in	input strain time series

Definition at line 412 of file NRWaveInject.c.

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 438 of file NRWaveInject.c.

INT4 XLALSphHarm	(	COMPLEX16 *	out,
		UINT4	L,
		INT4	M,
		REAL4	theta,
		REAL4	phi
	)

Spin weighted Spherical Harmonic.

dependency on theta

Parameters:

out	output
L	value of L
M	value of M
theta	angle with respect to the z axis
phi	angle with respect to the x axis

Definition at line 514 of file NRWaveInject.c.

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

Definition at line 779 of file NRWaveInject.c.

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

REAL8 version of above but using Jolien's new functions.

Definition at line 830 of file NRWaveInject.c.

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

channel name for nr data in frame file polar mode index

Parameters:

polarisation	either plus or cross
l	azimuthal mode index

Definition at line 895 of file NRWaveInject.c.

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 933 of file NRWaveInject.c.

Generated on Tue Oct 7 02:41:18 2008 for LAL by

1.5.2


Functions
	NRCSID (NRWAVEINJECTC,"$Id: NRWaveInject.c,v 1.56 2008/08/18 01:52:30 badri Exp $")
int	compare_abs_float (const void a, const void b)
int	compare_abs_double (const void a, const void b)
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.
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.
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.
REAL4TimeSeries *	XLALCalculateNRStrain (REAL4TimeVectorSeries strain, SimInspiralTable inj, CHAR *ifo, INT4 sampleRate)
REAL4TimeSeries *	XLALInterpolateNRWave (REAL4TimeSeries *in, INT4 sampleRate)
	Function for interpolating time series to a given sampling rate.
INT4	XLALFindNRCoalescenceTime (REAL8 tc, const REAL4TimeVectorSeries in)
	Function for calculating the coalescence time (defined to be the peak) of a NR wave.
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).
INT4	XLALFindNRCoalescenceTimeREAL8 (REAL8 tc, const REAL8TimeSeries in)
	Function for calculating the coalescence time (defined to be the peak) of a NR wave.
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.
INT4	XLALSphHarm (COMPLEX16 *out, UINT4 L, INT4 M, REAL4 theta, REAL4 phi)
	Spin weighted Spherical Harmonic.
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)
	REAL8 version of above but using Jolien's new functions.
CHAR *	XLALGetNinjaChannelName (CHAR *polarisation, UINT4 l, INT4 m)
	channel name for nr data in frame file polar mode index
NumRelGroup	XLALParseNumRelGroupName (CHAR *name)
	Function for parsing numrel group name and converting it into a enum element.