Header NRWaveIO.h

Detailed Description

Module for reading/writing Numrel waveforms.

Author

S.Fairhurst, B. Krishnan, L.Santamaria

Prototypes
void	LALReadNRWave_raw (LALStatus *status, REAL4TimeVectorSeries **out, const CHAR *filename)
	Functionfor reading the numrel waveform – just returns the numrel data as it is without any rescaling of time or amplitude. More...
void	LALReadNRWave_raw_real8 (LALStatus *status, REAL8TimeVectorSeries **out, const CHAR *filename)
void	LALReadNRWave (LALStatus *status, REAL4TimeVectorSeries **out, const REAL4 mass, const CHAR *filename)
	Reads a numerical relativity waveform given a filename and a value of the total mass for setting the timescale. More...
void	LALNRDataFind (LALStatus *status, NRWaveCatalog *out, const CHAR *dir, const CHAR *filename)
	Function for reading a numerical relativity metadata file. More...
void	LALGetSingleNRMetaData (LALStatus *status, NRWaveMetaData *data, const CHAR *dir, const CHAR *cfgstr)
	Parse a single string to fill the NRWaveMetaData structure. More...
void	LALAddStrainModes (LALStatus *status, REAL4TimeVectorSeries **outStrain, NRWaveCatalog *nrCatalog, INT4 modeLlo, INT4 modeLhi, const SimInspiralTable *thisInj)
	Put the main functionalities of nr_wave.c together. More...
void	LALDriveNRInject (LALStatus *status, REAL4TimeSeries *injData, SimInspiralTable *injections, NumRelInjectParams *params)
	Main driver funtion for doing Numerical Relativity Injections. More...

Data Structures
struct	NRWaveMetaData
	Struct containing metadata information about a single numerical relativity waveform. More...
struct	NRWaveCatalog
	List of numrel waveform metadata. More...
struct	NumRelInjectParams

Files
file	NRWaveIO.c
	Functions for reading/writing numerical relativity waveforms.

Error codes
#define	NRWAVEIO_ENULL   1
	Null pointer. More...
#define	NRWAVEIO_EFILE   2
	Error in file-IO. More...
#define	NRWAVEIO_ENONULL   3
	Not a Null pointer. More...
#define	NRWAVEIO_ENOMEM   4
	Memory ellocation error. More...
#define	NRWAVEIO_EVAL   5
	Invalid value. More...
#define	NRWAVEIO_EFORMAT   6
	Meta data file format incorrect. More...

Function Documentation

LALReadNRWave_raw()

void LALReadNRWave_raw	(	LALStatus *	status,
		REAL4TimeVectorSeries **	out,
		const CHAR *	filename
	)

Functionfor reading the numrel waveform – just returns the numrel data as it is without any rescaling of time or amplitude.

Parameters

	status	pointer to LALStatus structure
[out]	out	output time series for h+ and hx
[in]	filename	File containing numrel waveform

Definition at line 39 of file NRWaveIO.c.

LALReadNRWave_raw_real8()

void LALReadNRWave_raw_real8	(	LALStatus *	status,
		REAL8TimeVectorSeries **	out,
		const CHAR *	filename
	)

Parameters

	status	pointer to LALStatus structure
[out]	out	output time series for h+ and hx
[in]	filename	File containing numrel waveform

Definition at line 118 of file NRWaveIO.c.

LALReadNRWave()

void LALReadNRWave	(	LALStatus *	status,
		REAL4TimeVectorSeries **	out,
		const REAL4	mass,
		const CHAR *	filename
	)

Reads a numerical relativity waveform given a filename and a value of the total mass for setting the timescale.

The output waveform is scaled corresponding to a distance of 1Mpc.

Parameters

	status	pointer to LALStatus structure
[out]	out	output time series for h+ and hx
[in]	mass	Value of total mass for setting time scale
[in]	filename	File containing numrel waveform

Definition at line 201 of file NRWaveIO.c.

LALNRDataFind()

void LALNRDataFind	(	LALStatus *	status,
		NRWaveCatalog *	out,
		const CHAR *	dir,
		const CHAR *	filename
	)

Function for reading a numerical relativity metadata file.

It returns a list of numrel wave parameters. It uses XLALParseDataFile() for reading the data file. This automatically takes care of removing comment lines starting with # and other details.

Parameters

	status	pointer to LALStatus structure
[out]	out	list of numrel metadata
[in]	dir	directory with data files
[in]	filename	File with metadata information

Definition at line 293 of file NRWaveIO.c.

LALGetSingleNRMetaData()

void LALGetSingleNRMetaData	(	LALStatus *	status,
		NRWaveMetaData *	data,
		const CHAR *	dir,
		const CHAR *	cfgstr
	)

Parse a single string to fill the NRWaveMetaData structure.

Parameters

	status	pointer to LALStatus structure
[out]	data	Meta data struct to be filled
[in]	dir	data directory
[in]	cfgstr	config string containing the data for a single NR wave

Definition at line 335 of file NRWaveIO.c.

LALAddStrainModes()

void LALAddStrainModes	(	LALStatus *	status,
		REAL4TimeVectorSeries **	outStrain,
		NRWaveCatalog *	nrCatalog,
		INT4	modeLlo,
		INT4	modeLhi,
		const SimInspiralTable *	thisInj
	)

Put the main functionalities of nr_wave.c together.

Parameters

status	pointer to LALStatus structure
outStrain	h+, hx data
nrCatalog	NR wave metadata struct
modeLlo	contains modeLlo and modeLhi
modeLhi	modeLhi
thisInj	injection

Definition at line 389 of file NRWaveIO.c.

LALDriveNRInject()

void LALDriveNRInject	(	LALStatus *	status,
		REAL4TimeSeries *	injData,
		SimInspiralTable *	injections,
		NumRelInjectParams *	params
	)

Main driver funtion for doing Numerical Relativity Injections.

Parameters

status	pointer to LALStatus structure
injData	The time series to inject into
injections	The list of injections to perform
params	Parameters

Definition at line 464 of file NRWaveIO.c.

Macro Definition Documentation

NRWAVEIO_ENULL

#define NRWAVEIO_ENULL   1

Null pointer.

Definition at line 58 of file NRWaveIO.h.

NRWAVEIO_EFILE

#define NRWAVEIO_EFILE   2

Error in file-IO.

Definition at line 59 of file NRWaveIO.h.

NRWAVEIO_ENONULL

#define NRWAVEIO_ENONULL   3

Not a Null pointer.

Definition at line 60 of file NRWaveIO.h.

NRWAVEIO_ENOMEM

#define NRWAVEIO_ENOMEM   4

Memory ellocation error.

Definition at line 61 of file NRWaveIO.h.

NRWAVEIO_EVAL

#define NRWAVEIO_EVAL   5

Invalid value.

Definition at line 62 of file NRWaveIO.h.

NRWAVEIO_EFORMAT

#define NRWAVEIO_EFORMAT   6

Meta data file format incorrect.

Definition at line 63 of file NRWaveIO.h.