Detailed Description

Provides routines to generate ringdown waveforms.

Author: Goggin, L., and Brown, D. A.

Synopsis

#include <lal/GenerateRing.h>

Computes the ringdown waveform with specified \(h_{rss}\).

Prototypes
void	LALGenerateRing (LALStatus status, CoherentGW output, REAL4TimeSeries UNUSED series, SimRingdownTable simRingdown, RingParamStruc *params)

void	LALRingInjectSignals (LALStatus status, REAL4TimeSeries series, SimRingdownTable injections, COMPLEX8FrequencySeries resp, INT4 calType)

Data Structures
struct	RingParamStruc
	This structure stores the parameters for constructing a burst gravitational waveform. More...

Enumerations
enum	SimRingType { Ringdown }
	UNDOCUMENTED. More...

Error Codes
#define	GENERATERINGH_ENUL 1
	Unexpected null pointer in arguments. More...

#define	GENERATERINGH_EOUT 2
	Output field a, f, phi, or shift already exists. More...

#define	GENERATERINGH_EMEM 3
	Out of memory. More...

#define	GENERATERINGH_ETYP 4
	Waveform type not implemented. More...

#define	GENERATERINGH_ELEN 5
	Waveform length not correctly specified. More...

Function Documentation

◆ LALGenerateRing()

void LALGenerateRing	(	LALStatus *	status,
		CoherentGW *	output,
		REAL4TimeSeries UNUSED *	series,
		SimRingdownTable *	simRingdown,
		RingParamStruc *	params
	)

See also: See Header GenerateRing.h for documentation

Definition at line 44 of file GenerateRing.c.

◆ LALRingInjectSignals()

void LALRingInjectSignals	(	LALStatus *	status,
		REAL4TimeSeries *	series,
		SimRingdownTable *	injections,
		COMPLEX8FrequencySeries *	resp,
		INT4	calType
	)

See also: See Header GenerateRing.h for documentation

Definition at line 219 of file GenerateRing.c.

Enumeration Type Documentation

◆ SimRingType

enum SimRingType

UNDOCUMENTED.

Enumerator
Ringdown

Definition at line 70 of file GenerateRing.h.

Macro Definition Documentation

◆ GENERATERINGH_ENUL

#define GENERATERINGH_ENUL 1

Unexpected null pointer in arguments.

Definition at line 54 of file GenerateRing.h.

◆ GENERATERINGH_EOUT

#define GENERATERINGH_EOUT 2

Output field a, f, phi, or shift already exists.

Definition at line 55 of file GenerateRing.h.

◆ GENERATERINGH_EMEM

#define GENERATERINGH_EMEM 3

Out of memory.

Definition at line 56 of file GenerateRing.h.

◆ GENERATERINGH_ETYP

#define GENERATERINGH_ETYP 4

Waveform type not implemented.

Definition at line 57 of file GenerateRing.h.

◆ GENERATERINGH_ELEN

#define GENERATERINGH_ELEN 5

Waveform length not correctly specified.

Definition at line 58 of file GenerateRing.h.