lal » packages » inspiral » include

LALInspiral.h File Reference

#include <math.h>
#include <stdio.h>
#include <stdlib.h>
#include <gsl/gsl_errno.h>
#include <gsl/gsl_odeiv.h>
#include <lal/LALGSL.h>
#include <lal/LALStdlib.h>
#include <lal/LALConstants.h>
#include <lal/SimulateCoherentGW.h>
#include <lal/GeneratePPNInspiral.h>
#include <lal/LIGOMetadataTables.h>

Include dependency graph for LALInspiral.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct tagEtaTau02In

--------------------------------------------------------------------- </lalErrTable> More...

struct tagEtaTau04In

struct tagInspiralTemplate

struct tagInspiralToffInput

struct tagInspiralACSTParams

struct tagexpnCoeffs

struct tagexpnFunc

struct tagTofVIn

struct tagTofVIntegrandIn

struct tagInspiralDerivativesIn

struct tagrk4In

struct tagrk4GSLIntegrator

struct tagInspiralPhaseIn

struct tagPhiofVIntegrandIn

struct tagInspiralInit

Defines

#define oneby3   0.333333333333333333333333333

#define twoby3   0.666666666666666666666666667

#define fourby3   1.333333333333333333333333333

#define fiveby3   1.666666666666666666666666667

#define sevenby3   2.333333333333333333333333333

#define eightby3   2.666666666666666666666666667

#define tenby3   3.333333333333333333333333333

#define elevenby3   3.666666666666666666666666666

#define threeby8   0.375

#define fiveby8   0.625

#define threeby4   0.75

#define sevenby8   0.875

#define ninty4by3etc   18.687902694437592603

#define LALINSPIRALH_ENULL   1

#define LALINSPIRALH_EMEM   2

#define LALINSPIRALH_EDIV0   3

#define LALINSPIRALH_ESIZE   4

#define LALINSPIRALH_ECHOICE   5

#define LALINSPIRALH_EORDER   6

#define LALINSPIRALH_EAPPROXIMANT   7

#define LALINSPIRALH_EPSI0   8

#define LALINSPIRALH_EPSI3   9

#define LALINSPIRALH_EALPHA   10

#define LALINSPIRALH_EFCUTOFF   11

#define LALINSPIRALH_ENOWAVEFORM   12

#define LALINSPIRALH_ESTOPPED   13

#define LALINSPIRALH_EROOTINIT   14

#define LALINSPIRALH_EFLOWER   15

#define LALINSPIRALH_EVECTOR   16

#define LALINSPIRALH_EFLOWERINJ   17

#define LALINSPIRALH_EORDERMISSING   18

#define LALINSPIRALH_MSGENULL   "Arguments contained an unexpected null pointer"

#define LALINSPIRALH_MSGEMEM   "Memory allocation error"

#define LALINSPIRALH_MSGEDIV0   "Division by zero"

#define LALINSPIRALH_MSGESIZE   "Invalid input range"

#define LALINSPIRALH_MSGECHOICE   "Invalid choice for an input parameter"

#define LALINSPIRALH_MSGEORDER   "unknown order specified"

#define LALINSPIRALH_MSGEAPPROXIMANT   "Invalid model"

#define LALINSPIRALH_MSGEPSI0   "psi0 must be > 0"

#define LALINSPIRALH_MSGEPSI3   "psi3 must be < 0"

#define LALINSPIRALH_MSGEALPHA   "alpha must be defined positive"

#define LALINSPIRALH_MSGEFCUTOFF   "fcutoff must be defined and > 0"

#define LALINSPIRALH_MSGENOWAVEFORM   "No Waveform generated"

#define LALINSPIRALH_MSGESTOPPED   "Waveform generation stopped"

#define LALINSPIRALH_MSGEROOTINIT   "Can't find good bracket for BisectionFindRoot"

#define LALINSPIRALH_MSGEFLOWER   "fLower too low in comparison to flso"

#define LALINSPIRALH_MSGEVECTOR   "Attempting to write beyond the end of vector"

#define LALINSPIRALH_MSGEFLOWERINJ   "flower for the injection must be greater than zero"

#define LALINSPIRALH_MSGEORDERMISSING   "The PN order requested is not implemented for this approximant"

Typedefs

typedef tagEtaTau02In EtaTau02In

--------------------------------------------------------------------- </lalErrTable>

typedef tagEtaTau04In EtaTau04In

typedef tagInspiralTemplate InspiralTemplate

typedef tagInspiralToffInput InspiralToffInput

typedef tagInspiralACSTParams InspiralACSTParams

typedef tagexpnCoeffs expnCoeffs

typedef REAL8 EnergyFunction (REAL8 v, expnCoeffs *ak)

typedef REAL8 FluxFunction (REAL8 v, expnCoeffs *ak)

typedef void( TestFunction )(REAL8Vector *vector1, REAL8Vector *vector2, void *params)

typedef void( InspiralPhasing2 )(LALStatus *status, REAL8 *phase, REAL8 v, expnCoeffs *ak)

typedef void( InspiralPhasing3 )(LALStatus *status, REAL8 *f, REAL8 td, expnCoeffs *ak)

typedef void( InspiralFrequency3 )(LALStatus *status, REAL8 *f, REAL8 td, expnCoeffs *ak)

typedef void( InspiralTiming2 )(LALStatus *status, REAL8 *toff, REAL8 f, void *params)

typedef tagexpnFunc expnFunc

typedef tagTofVIn TofVIn

typedef tagTofVIntegrandIn TofVIntegrandIn

typedef tagInspiralDerivativesIn InspiralDerivativesIn

typedef tagrk4In rk4In

typedef tagrk4GSLIntegrator rk4GSLIntegrator

typedef tagInspiralPhaseIn InspiralPhaseIn

typedef tagPhiofVIntegrandIn PhiofVIntegrandIn

typedef tagInspiralInit InspiralInit

Enumerations

enum Order {
  newtonian, oneHalfPN, onePN, onePointFivePN,
  twoPN, twoPointFivePN, threePN, threePointFivePN,
  pseudoFourPN
}

enum Approximant {
  TaylorT1, TaylorT2, TaylorT3, TaylorF1,
  TaylorF2, PadeT1, PadeF1, EOB,
  BCV, BCVSpin, SpinTaylorT3, SpinTaylor,
  FindChirpSP, FindChirpPTF, GeneratePPN, BCVC,
  FrameFile, AmpCorPPN, NumRel, Eccentricity,
  EOBNR, NumApproximants
}

enum InputMasses {
  m1Andm2, totalMassAndEta, totalMassUAndEta, totalMassAndMu,
  t01, t02, t03, t04,
  psi0Andpsi3, bhns, fixedMasses, fixedPsi,
  fixedTau, massesAndSpin, minmaxTotalMass, spinOnly
}

enum InspiralApplyTaper {
  INSPIRAL_TAPER_NONE, INSPIRAL_TAPER_START, INSPIRAL_TAPER_END, INSPIRAL_TAPER_BOTH,
  INSPIRAL_TAPER_NUM_OPTS
}

Functions

NRCSID (LALINSPIRALH,"$Id: LALInspiral.h,v 1.106 2008/09/04 16:42:19 spxcar Exp $")

void LALInspiralParameterCalc (LALStatus *status, InspiralTemplate *params)

void LALInspiralRestrictedAmplitude (LALStatus *status, InspiralTemplate *params)

void LALInspiralWaveLength (LALStatus *status, UINT4 *n, InspiralTemplate params)

void LALInspiralChooseModel (LALStatus *status, expnFunc *func, expnCoeffs *ak, InspiralTemplate *params)

void LALInspiralSetup (LALStatus *status, expnCoeffs *ak, InspiralTemplate *params)

void LALInspiralInit (LALStatus *status, InspiralTemplate *params, InspiralInit *paramsInit)

void LALInspiralWaveTaper (LALStatus *status, REAL4Vector *signal, UINT4 bookends)

int XLALInspiralWaveTaper (REAL4Vector *signal, InspiralApplyTaper bookends)

void LALInspiralAmplitudeCorrectedWave (LALStatus *status, REAL4Vector *signalvec, InspiralTemplate *params)

void LALInspiralAmplitudeCorrectedWaveTemplates (LALStatus *status, REAL4Vector *filter1, REAL4Vector *filter2, InspiralTemplate *params)

void LALInspiralAmplitudeCorrectedWaveForInjection (LALStatus *status, CoherentGW *waveform, InspiralTemplate *params, PPNParamStruc *ppnParams)

void LALInspiralWave (LALStatus *status, REAL4Vector *signalvec, InspiralTemplate *params)

void LALInspiralWaveTemplates (LALStatus *status, REAL4Vector *filter1, REAL4Vector *filter2, InspiralTemplate *params)

void LALInspiralWaveForInjection (LALStatus *status, CoherentGW *waveform, InspiralTemplate *params, PPNParamStruc *ppnParams)

void LALInspiralWave1 (LALStatus *status, REAL4Vector *signalvec, InspiralTemplate *params)

void LALInspiralWave1Templates (LALStatus *status, REAL4Vector *signalvec1, REAL4Vector *signalvec2, InspiralTemplate *params)

void LALInspiralWave1ForInjection (LALStatus *status, CoherentGW *waveform, InspiralTemplate *params, PPNParamStruc *ppnParams)

void LALInspiralEccentricity (LALStatus *status, REAL4Vector *signalvec, InspiralTemplate *params)

void LALInspiralEccentricityTemplates (LALStatus *status, REAL4Vector *signalvec1, REAL4Vector *signalvec2, InspiralTemplate *params)

void LALInspiralEccentricityForInjection (LALStatus *status, CoherentGW *waveform, InspiralTemplate *params, PPNParamStruc *ppnParams)

void LALInspiralWave2 (LALStatus *status, REAL4Vector *signalvec, InspiralTemplate *params)

void LALInspiralWave2Templates (LALStatus *status, REAL4Vector *signalvec1, REAL4Vector *signalvec2, InspiralTemplate *params)

void LALInspiralWave2ForInjection (LALStatus *status, CoherentGW *waveform, InspiralTemplate *params, PPNParamStruc *ppnParams)

void LALInspiralWave3 (LALStatus *status, REAL4Vector *signalvec, InspiralTemplate *params)

void LALInspiralWave3Templates (LALStatus *status, REAL4Vector *signalvec1, REAL4Vector *signalvec2, InspiralTemplate *params)

void LALInspiralWave3ForInjection (LALStatus *status, CoherentGW *waveform, InspiralTemplate *params, PPNParamStruc *ppnParams)

void LALInspiralStationaryPhaseApprox1 (LALStatus *status, REAL4Vector *signalvec, InspiralTemplate *params)

void LALInspiralStationaryPhaseApprox2 (LALStatus *status, REAL4Vector *signalvec, InspiralTemplate *params)

void LALEOBWaveform (LALStatus *status, REAL4Vector *signalvec, InspiralTemplate *params)

void LALEOBWaveformTemplates (LALStatus *status, REAL4Vector *signalvec1, REAL4Vector *signalvec2, InspiralTemplate *params)

void LALEOBWaveformForInjection (LALStatus *status, CoherentGW *waveform, InspiralTemplate *params, PPNParamStruc *ppnParams)

void LALBCVWaveform (LALStatus *status, REAL4Vector *signalvec, InspiralTemplate *params)

void LALBCVSpinWaveform (LALStatus *status, REAL4Vector *signalvec, InspiralTemplate *params)

void LALInspiralSpinModulatedWave (LALStatus *status, REAL4Vector *signalvec, InspiralTemplate *in)

void LALInspiralSpinModulatedWaveForInjection (LALStatus *status, CoherentGW *waveform, InspiralTemplate *params, PPNParamStruc *ppnParams)

void LALSTPNWaveformForInjection (LALStatus *status, CoherentGW *waveform, InspiralTemplate *params, PPNParamStruc *ppnParams)

void LALSTPNWaveformEngine (LALStatus *status, REAL4Vector *signal1, REAL4Vector *signal2, REAL4Vector *a, REAL4Vector *ff, REAL8Vector *phi, REAL4Vector *shift, UINT4 *countback, InspiralTemplate *params, InspiralInit *paramsInit)

void LALSTPNWaveformTemplates (LALStatus *status, REAL4Vector *signal1, REAL4Vector *signal2, InspiralTemplate *params)

void LALSTPNWaveform (LALStatus *status, REAL4Vector *signalvec, InspiralTemplate *params)

void LALEtaTau02 (LALStatus *status, REAL8 *x, REAL8 eta, void *in)

void LALEtaTau04 (LALStatus *status, REAL8 *x, REAL8 eta, void *in)

void LALInspiralDerivatives (REAL8Vector *vec1, REAL8Vector *vec2, void *params)

void LALInspiralVelocity (LALStatus *status, REAL8 *v, TofVIn *params)

void LALInspiralPhasing1 (LALStatus *status, REAL8 *phase, REAL8 v, void *params)

void LALInspiralPhiofVIntegrand (LALStatus *status, REAL8 *, REAL8, void *)

void LALInspiralPhasing2_0PN (LALStatus *status, REAL8 *phase, REAL8 v, expnCoeffs *ak)

void LALInspiralPhasing2_1PN (LALStatus *status, REAL8 *phase, REAL8 v, expnCoeffs *ak)

void LALInspiralPhasing2_2PN (LALStatus *status, REAL8 *phase, REAL8 v, expnCoeffs *ak)

void LALInspiralPhasing2_3PN (LALStatus *status, REAL8 *phase, REAL8 v, expnCoeffs *ak)

void LALInspiralPhasing2_4PN (LALStatus *status, REAL8 *phase, REAL8 v, expnCoeffs *ak)

void LALInspiralPhasing2_5PN (LALStatus *status, REAL8 *phase, REAL8 v, expnCoeffs *ak)

void LALInspiralPhasing2_6PN (LALStatus *status, REAL8 *phase, REAL8 v, expnCoeffs *ak)

void LALInspiralPhasing2_7PN (LALStatus *status, REAL8 *phase, REAL8 v, expnCoeffs *ak)

void LALInspiralPhasing3_0PN (LALStatus *status, REAL8 *phase, REAL8 td, expnCoeffs *ak)

void LALInspiralPhasing3_1PN (LALStatus *status, REAL8 *phase, REAL8 td, expnCoeffs *ak)

void LALInspiralPhasing3_2PN (LALStatus *status, REAL8 *phase, REAL8 td, expnCoeffs *ak)

void LALInspiralPhasing3_3PN (LALStatus *status, REAL8 *phase, REAL8 td, expnCoeffs *ak)

void LALInspiralPhasing3_4PN (LALStatus *status, REAL8 *phase, REAL8 td, expnCoeffs *ak)

void LALInspiralPhasing3_5PN (LALStatus *status, REAL8 *phase, REAL8 td, expnCoeffs *ak)

void LALInspiralPhasing3_6PN (LALStatus *, REAL8 *phase, REAL8 td, expnCoeffs *ak)

void LALInspiralPhasing3_7PN (LALStatus *status, REAL8 *phase, REAL8 td, expnCoeffs *ak)

void LALInspiralTofV (LALStatus *, REAL8 *, REAL8, void *)

void LALInspiralTofVIntegrand (LALStatus *status, REAL8 *, REAL8, void *)

void LALInspiralTiming2_0PN (LALStatus *, REAL8 *toff, REAL8 f, void *params)

void LALInspiralTiming2_1PN (LALStatus *, REAL8 *toff, REAL8 f, void *params)

void LALInspiralTiming2_2PN (LALStatus *, REAL8 *toff, REAL8 f, void *params)

void LALInspiralTiming2_3PN (LALStatus *, REAL8 *toff, REAL8 f, void *params)

void LALInspiralTiming2_4PN (LALStatus *, REAL8 *toff, REAL8 f, void *params)

void LALInspiralTiming2_5PN (LALStatus *, REAL8 *toff, REAL8 f, void *params)

void LALInspiralTiming2_6PN (LALStatus *, REAL8 *toff, REAL8 f, void *params)

void LALInspiralTiming2_7PN (LALStatus *, REAL8 *toff, REAL8 f, void *params)

void LALInspiralFrequency3_0PN (LALStatus *status, REAL8 *frequency, REAL8 td, expnCoeffs *ak)

void LALInspiralFrequency3_1PN (LALStatus *status, REAL8 *frequency, REAL8 td, expnCoeffs *ak)

void LALInspiralFrequency3_2PN (LALStatus *status, REAL8 *frequency, REAL8 td, expnCoeffs *ak)

void LALInspiralFrequency3_3PN (LALStatus *status, REAL8 *frequency, REAL8 td, expnCoeffs *ak)

void LALInspiralFrequency3_4PN (LALStatus *status, REAL8 *frequency, REAL8 td, expnCoeffs *ak)

void LALInspiralFrequency3_5PN (LALStatus *status, REAL8 *frequency, REAL8 td, expnCoeffs *ak)

void LALInspiralFrequency3_6PN (LALStatus *status, REAL8 *frequency, REAL8 td, expnCoeffs *ak)

void LALInspiralFrequency3_7PN (LALStatus *status, REAL8 *frequency, REAL8 td, expnCoeffs *ak)

REAL4 LALInspiralHPlusPolarization (REAL8 phase, REAL8 v, InspiralTemplate *params)

REAL4 LALInspiralHCrossPolarization (REAL8 phase, REAL8 v, InspiralTemplate *params)

rk4GSLIntegrator * XLALRungeKutta4Init (INT4 n, rk4In *input)

void LALRungeKutta4 (LALStatus *, REAL8Vector *, rk4GSLIntegrator *, void *)

void XLALRungeKutta4Free (rk4GSLIntegrator *integrator)

void LALInspiralITStructureParseParameters (LALStatus *status, UINT4 argc, CHAR **argv, InspiralTemplate *params)

void LALInspiralITStructureSetDefault (LALStatus *status, InspiralTemplate *params)

void LALInspiralITStructurePrint (LALStatus *status, InspiralTemplate params)

void LALInspiralITStructureHelp (void)

INT4 XLALInspiralRingdownWave (REAL4Vector *rdwave1, REAL4Vector *rdwave2, InspiralTemplate *params, REAL4VectorSequence *inspwave1, REAL4VectorSequence *inspwave2, COMPLEX8Vector *modefreqs, UINT4 nmodes)

INT4 XLALGenerateWaveDerivatives (REAL4Vector *dwave, REAL4Vector *ddwave, REAL4Vector *wave, InspiralTemplate *params)

INT4 XLALGenerateQNMFreq (COMPLEX8Vector *modefreqs, InspiralTemplate *params, UINT4 l, UINT4 m, UINT4 nmodes)

INT4 XLALFinalMassSpin (REAL8 *finalMass, REAL8 *finalSpin, InspiralTemplate *params)

INT4 XLALInspiralAttachRingdownWave (REAL4Vector *Omega, REAL4Vector *signal1, REAL4Vector *signal2, InspiralTemplate *params)

int XLALInspiralGetApproximantString (CHAR *output, UINT4 length, Approximant approx, Order order)

int XLALBandPassInspiralTemplate (REAL4Sequence *sequence, REAL4 fLow, REAL4 fHigh, REAL4 fSampling)

Define Documentation

#define oneby3 0.333333333333333333333333333

Definition at line 67 of file LALInspiral.h.

#define twoby3 0.666666666666666666666666667

Definition at line 68 of file LALInspiral.h.

#define fourby3 1.333333333333333333333333333

Definition at line 69 of file LALInspiral.h.

#define fiveby3 1.666666666666666666666666667

Definition at line 70 of file LALInspiral.h.

#define sevenby3 2.333333333333333333333333333

Definition at line 71 of file LALInspiral.h.

#define eightby3 2.666666666666666666666666667

Definition at line 72 of file LALInspiral.h.

#define tenby3 3.333333333333333333333333333

Definition at line 73 of file LALInspiral.h.

#define elevenby3 3.666666666666666666666666666

Definition at line 74 of file LALInspiral.h.

#define threeby8 0.375

Definition at line 75 of file LALInspiral.h.

#define fiveby8 0.625

Definition at line 76 of file LALInspiral.h.

#define threeby4 0.75

Definition at line 77 of file LALInspiral.h.

#define sevenby8 0.875

Definition at line 78 of file LALInspiral.h.

#define ninty4by3etc 18.687902694437592603

Definition at line 79 of file LALInspiral.h.

#define LALINSPIRALH_ENULL 1

Definition at line 86 of file LALInspiral.h.

#define LALINSPIRALH_EMEM 2

Definition at line 87 of file LALInspiral.h.

#define LALINSPIRALH_EDIV0 3

Definition at line 88 of file LALInspiral.h.

#define LALINSPIRALH_ESIZE 4

Definition at line 89 of file LALInspiral.h.

#define LALINSPIRALH_ECHOICE 5

Definition at line 90 of file LALInspiral.h.

#define LALINSPIRALH_EORDER 6

Definition at line 91 of file LALInspiral.h.

#define LALINSPIRALH_EAPPROXIMANT 7

Definition at line 92 of file LALInspiral.h.

#define LALINSPIRALH_EPSI0 8

Definition at line 93 of file LALInspiral.h.

#define LALINSPIRALH_EPSI3 9

Definition at line 94 of file LALInspiral.h.

#define LALINSPIRALH_EALPHA 10

Definition at line 95 of file LALInspiral.h.

#define LALINSPIRALH_EFCUTOFF 11

Definition at line 96 of file LALInspiral.h.

#define LALINSPIRALH_ENOWAVEFORM 12

Definition at line 97 of file LALInspiral.h.

#define LALINSPIRALH_ESTOPPED 13

Definition at line 98 of file LALInspiral.h.

#define LALINSPIRALH_EROOTINIT 14

Definition at line 99 of file LALInspiral.h.

#define LALINSPIRALH_EFLOWER 15

Definition at line 100 of file LALInspiral.h.

#define LALINSPIRALH_EVECTOR 16

Definition at line 101 of file LALInspiral.h.

#define LALINSPIRALH_EFLOWERINJ 17

Definition at line 102 of file LALInspiral.h.

#define LALINSPIRALH_EORDERMISSING 18

Definition at line 103 of file LALInspiral.h.

#define LALINSPIRALH_MSGENULL "Arguments contained an unexpected null pointer"

Definition at line 106 of file LALInspiral.h.

#define LALINSPIRALH_MSGEMEM "Memory allocation error"

Definition at line 107 of file LALInspiral.h.

#define LALINSPIRALH_MSGEDIV0 "Division by zero"

Definition at line 108 of file LALInspiral.h.

#define LALINSPIRALH_MSGESIZE "Invalid input range"

Definition at line 109 of file LALInspiral.h.

#define LALINSPIRALH_MSGECHOICE "Invalid choice for an input parameter"

Definition at line 110 of file LALInspiral.h.

#define LALINSPIRALH_MSGEORDER "unknown order specified"

Definition at line 111 of file LALInspiral.h.

#define LALINSPIRALH_MSGEAPPROXIMANT "Invalid model"

Definition at line 112 of file LALInspiral.h.

#define LALINSPIRALH_MSGEPSI0 "psi0 must be > 0"

Definition at line 113 of file LALInspiral.h.

#define LALINSPIRALH_MSGEPSI3 "psi3 must be < 0"

Definition at line 114 of file LALInspiral.h.

#define LALINSPIRALH_MSGEALPHA "alpha must be defined positive"

Definition at line 115 of file LALInspiral.h.

#define LALINSPIRALH_MSGEFCUTOFF "fcutoff must be defined and > 0"

Definition at line 116 of file LALInspiral.h.

#define LALINSPIRALH_MSGENOWAVEFORM "No Waveform generated"

Definition at line 117 of file LALInspiral.h.

#define LALINSPIRALH_MSGESTOPPED "Waveform generation stopped"

Definition at line 118 of file LALInspiral.h.

#define LALINSPIRALH_MSGEROOTINIT "Can't find good bracket for BisectionFindRoot"

Definition at line 119 of file LALInspiral.h.

#define LALINSPIRALH_MSGEFLOWER "fLower too low in comparison to flso"

Definition at line 120 of file LALInspiral.h.

#define LALINSPIRALH_MSGEVECTOR "Attempting to write beyond the end of vector"

Definition at line 121 of file LALInspiral.h.

#define LALINSPIRALH_MSGEFLOWERINJ "flower for the injection must be greater than zero"

Definition at line 122 of file LALInspiral.h.

#define LALINSPIRALH_MSGEORDERMISSING "The PN order requested is not implemented for this approximant"

Definition at line 123 of file LALInspiral.h.

Typedef Documentation

typedef struct tagEtaTau02In EtaTau02In

--------------------------------------------------------------------- </lalErrTable>

typedef struct tagEtaTau04In EtaTau04In

typedef struct tagInspiralTemplate InspiralTemplate


Data Structures
struct	tagEtaTau02In
	--------------------------------------------------------------------- </lalErrTable> More...
struct	tagEtaTau04In
struct	tagInspiralTemplate
struct	tagInspiralToffInput
struct	tagInspiralACSTParams
struct	tagexpnCoeffs
struct	tagexpnFunc
struct	tagTofVIn
struct	tagTofVIntegrandIn
struct	tagInspiralDerivativesIn
struct	tagrk4In
struct	tagrk4GSLIntegrator
struct	tagInspiralPhaseIn
struct	tagPhiofVIntegrandIn
struct	tagInspiralInit
Defines
#define	oneby3 0.333333333333333333333333333
#define	twoby3 0.666666666666666666666666667
#define	fourby3 1.333333333333333333333333333
#define	fiveby3 1.666666666666666666666666667
#define	sevenby3 2.333333333333333333333333333
#define	eightby3 2.666666666666666666666666667
#define	tenby3 3.333333333333333333333333333
#define	elevenby3 3.666666666666666666666666666
#define	threeby8 0.375
#define	fiveby8 0.625
#define	threeby4 0.75
#define	sevenby8 0.875
#define	ninty4by3etc 18.687902694437592603
#define	LALINSPIRALH_ENULL 1
#define	LALINSPIRALH_EMEM 2
#define	LALINSPIRALH_EDIV0 3
#define	LALINSPIRALH_ESIZE 4
#define	LALINSPIRALH_ECHOICE 5
#define	LALINSPIRALH_EORDER 6
#define	LALINSPIRALH_EAPPROXIMANT 7
#define	LALINSPIRALH_EPSI0 8
#define	LALINSPIRALH_EPSI3 9
#define	LALINSPIRALH_EALPHA 10
#define	LALINSPIRALH_EFCUTOFF 11
#define	LALINSPIRALH_ENOWAVEFORM 12
#define	LALINSPIRALH_ESTOPPED 13
#define	LALINSPIRALH_EROOTINIT 14
#define	LALINSPIRALH_EFLOWER 15
#define	LALINSPIRALH_EVECTOR 16
#define	LALINSPIRALH_EFLOWERINJ 17
#define	LALINSPIRALH_EORDERMISSING 18
#define	LALINSPIRALH_MSGENULL "Arguments contained an unexpected null pointer"
#define	LALINSPIRALH_MSGEMEM "Memory allocation error"
#define	LALINSPIRALH_MSGEDIV0 "Division by zero"
#define	LALINSPIRALH_MSGESIZE "Invalid input range"
#define	LALINSPIRALH_MSGECHOICE "Invalid choice for an input parameter"
#define	LALINSPIRALH_MSGEORDER "unknown order specified"
#define	LALINSPIRALH_MSGEAPPROXIMANT "Invalid model"
#define	LALINSPIRALH_MSGEPSI0 "psi0 must be > 0"
#define	LALINSPIRALH_MSGEPSI3 "psi3 must be < 0"
#define	LALINSPIRALH_MSGEALPHA "alpha must be defined positive"
#define	LALINSPIRALH_MSGEFCUTOFF "fcutoff must be defined and > 0"
#define	LALINSPIRALH_MSGENOWAVEFORM "No Waveform generated"
#define	LALINSPIRALH_MSGESTOPPED "Waveform generation stopped"
#define	LALINSPIRALH_MSGEROOTINIT "Can't find good bracket for BisectionFindRoot"
#define	LALINSPIRALH_MSGEFLOWER "fLower too low in comparison to flso"
#define	LALINSPIRALH_MSGEVECTOR "Attempting to write beyond the end of vector"
#define	LALINSPIRALH_MSGEFLOWERINJ "flower for the injection must be greater than zero"
#define	LALINSPIRALH_MSGEORDERMISSING "The PN order requested is not implemented for this approximant"
Typedefs
typedef tagEtaTau02In	EtaTau02In
	--------------------------------------------------------------------- </lalErrTable>
typedef tagEtaTau04In	EtaTau04In
typedef tagInspiralTemplate	InspiralTemplate
typedef tagInspiralToffInput	InspiralToffInput
typedef tagInspiralACSTParams	InspiralACSTParams
typedef tagexpnCoeffs	expnCoeffs
typedef REAL8	EnergyFunction (REAL8 v, expnCoeffs *ak)
typedef REAL8	FluxFunction (REAL8 v, expnCoeffs *ak)
typedef void(	TestFunction )(REAL8Vector vector1, REAL8Vector vector2, void *params)
typedef void(	InspiralPhasing2 )(LALStatus status, REAL8 phase, REAL8 v, expnCoeffs *ak)
typedef void(	InspiralPhasing3 )(LALStatus status, REAL8 f, REAL8 td, expnCoeffs *ak)
typedef void(	InspiralFrequency3 )(LALStatus status, REAL8 f, REAL8 td, expnCoeffs *ak)
typedef void(	InspiralTiming2 )(LALStatus status, REAL8 toff, REAL8 f, void *params)
typedef tagexpnFunc	expnFunc
typedef tagTofVIn	TofVIn
typedef tagTofVIntegrandIn	TofVIntegrandIn
typedef tagInspiralDerivativesIn	InspiralDerivativesIn
typedef tagrk4In	rk4In
typedef tagrk4GSLIntegrator	rk4GSLIntegrator
typedef tagInspiralPhaseIn	InspiralPhaseIn
typedef tagPhiofVIntegrandIn	PhiofVIntegrandIn
typedef tagInspiralInit	InspiralInit
Enumerations
enum	Order { newtonian, oneHalfPN, onePN, onePointFivePN, twoPN, twoPointFivePN, threePN, threePointFivePN, pseudoFourPN }
enum	Approximant { TaylorT1, TaylorT2, TaylorT3, TaylorF1, TaylorF2, PadeT1, PadeF1, EOB, BCV, BCVSpin, SpinTaylorT3, SpinTaylor, FindChirpSP, FindChirpPTF, GeneratePPN, BCVC, FrameFile, AmpCorPPN, NumRel, Eccentricity, EOBNR, NumApproximants }
enum	InputMasses { m1Andm2, totalMassAndEta, totalMassUAndEta, totalMassAndMu, t01, t02, t03, t04, psi0Andpsi3, bhns, fixedMasses, fixedPsi, fixedTau, massesAndSpin, minmaxTotalMass, spinOnly }
enum	InspiralApplyTaper { INSPIRAL_TAPER_NONE, INSPIRAL_TAPER_START, INSPIRAL_TAPER_END, INSPIRAL_TAPER_BOTH, INSPIRAL_TAPER_NUM_OPTS }
Functions
	NRCSID (LALINSPIRALH,"$Id: LALInspiral.h,v 1.106 2008/09/04 16:42:19 spxcar Exp $")
void	LALInspiralParameterCalc (LALStatus status, InspiralTemplate params)
void	LALInspiralRestrictedAmplitude (LALStatus status, InspiralTemplate params)
void	LALInspiralWaveLength (LALStatus status, UINT4 n, InspiralTemplate params)
void	LALInspiralChooseModel (LALStatus status, expnFunc func, expnCoeffs ak, InspiralTemplate params)
void	LALInspiralSetup (LALStatus status, expnCoeffs ak, InspiralTemplate *params)
void	LALInspiralInit (LALStatus status, InspiralTemplate params, InspiralInit *paramsInit)
void	LALInspiralWaveTaper (LALStatus status, REAL4Vector signal, UINT4 bookends)
int	XLALInspiralWaveTaper (REAL4Vector *signal, InspiralApplyTaper bookends)
void	LALInspiralAmplitudeCorrectedWave (LALStatus status, REAL4Vector signalvec, InspiralTemplate *params)
void	LALInspiralAmplitudeCorrectedWaveTemplates (LALStatus status, REAL4Vector filter1, REAL4Vector filter2, InspiralTemplate params)
void	LALInspiralAmplitudeCorrectedWaveForInjection (LALStatus status, CoherentGW waveform, InspiralTemplate params, PPNParamStruc ppnParams)
void	LALInspiralWave (LALStatus status, REAL4Vector signalvec, InspiralTemplate *params)
void	LALInspiralWaveTemplates (LALStatus status, REAL4Vector filter1, REAL4Vector filter2, InspiralTemplate params)
void	LALInspiralWaveForInjection (LALStatus status, CoherentGW waveform, InspiralTemplate params, PPNParamStruc ppnParams)
void	LALInspiralWave1 (LALStatus status, REAL4Vector signalvec, InspiralTemplate *params)
void	LALInspiralWave1Templates (LALStatus status, REAL4Vector signalvec1, REAL4Vector signalvec2, InspiralTemplate params)
void	LALInspiralWave1ForInjection (LALStatus status, CoherentGW waveform, InspiralTemplate params, PPNParamStruc ppnParams)
void	LALInspiralEccentricity (LALStatus status, REAL4Vector signalvec, InspiralTemplate *params)
void	LALInspiralEccentricityTemplates (LALStatus status, REAL4Vector signalvec1, REAL4Vector signalvec2, InspiralTemplate params)
void	LALInspiralEccentricityForInjection (LALStatus status, CoherentGW waveform, InspiralTemplate params, PPNParamStruc ppnParams)
void	LALInspiralWave2 (LALStatus status, REAL4Vector signalvec, InspiralTemplate *params)
void	LALInspiralWave2Templates (LALStatus status, REAL4Vector signalvec1, REAL4Vector signalvec2, InspiralTemplate params)
void	LALInspiralWave2ForInjection (LALStatus status, CoherentGW waveform, InspiralTemplate params, PPNParamStruc ppnParams)
void	LALInspiralWave3 (LALStatus status, REAL4Vector signalvec, InspiralTemplate *params)
void	LALInspiralWave3Templates (LALStatus status, REAL4Vector signalvec1, REAL4Vector signalvec2, InspiralTemplate params)
void	LALInspiralWave3ForInjection (LALStatus status, CoherentGW waveform, InspiralTemplate params, PPNParamStruc ppnParams)
void	LALInspiralStationaryPhaseApprox1 (LALStatus status, REAL4Vector signalvec, InspiralTemplate *params)
void	LALInspiralStationaryPhaseApprox2 (LALStatus status, REAL4Vector signalvec, InspiralTemplate *params)
void	LALEOBWaveform (LALStatus status, REAL4Vector signalvec, InspiralTemplate *params)
void	LALEOBWaveformTemplates (LALStatus status, REAL4Vector signalvec1, REAL4Vector signalvec2, InspiralTemplate params)
void	LALEOBWaveformForInjection (LALStatus status, CoherentGW waveform, InspiralTemplate params, PPNParamStruc ppnParams)
void	LALBCVWaveform (LALStatus status, REAL4Vector signalvec, InspiralTemplate *params)
void	LALBCVSpinWaveform (LALStatus status, REAL4Vector signalvec, InspiralTemplate *params)
void	LALInspiralSpinModulatedWave (LALStatus status, REAL4Vector signalvec, InspiralTemplate *in)
void	LALInspiralSpinModulatedWaveForInjection (LALStatus status, CoherentGW waveform, InspiralTemplate params, PPNParamStruc ppnParams)
void	LALSTPNWaveformForInjection (LALStatus status, CoherentGW waveform, InspiralTemplate params, PPNParamStruc ppnParams)
void	LALSTPNWaveformEngine (LALStatus status, REAL4Vector signal1, REAL4Vector signal2, REAL4Vector a, REAL4Vector ff, REAL8Vector phi, REAL4Vector shift, UINT4 countback, InspiralTemplate params, InspiralInit paramsInit)
void	LALSTPNWaveformTemplates (LALStatus status, REAL4Vector signal1, REAL4Vector signal2, InspiralTemplate params)
void	LALSTPNWaveform (LALStatus status, REAL4Vector signalvec, InspiralTemplate *params)
void	LALEtaTau02 (LALStatus status, REAL8 x, REAL8 eta, void *in)
void	LALEtaTau04 (LALStatus status, REAL8 x, REAL8 eta, void *in)
void	LALInspiralDerivatives (REAL8Vector vec1, REAL8Vector vec2, void *params)
void	LALInspiralVelocity (LALStatus status, REAL8 v, TofVIn *params)
void	LALInspiralPhasing1 (LALStatus status, REAL8 phase, REAL8 v, void *params)
void	LALInspiralPhiofVIntegrand (LALStatus status, REAL8 , REAL8, void *)
void	LALInspiralPhasing2_0PN (LALStatus status, REAL8 phase, REAL8 v, expnCoeffs *ak)
void	LALInspiralPhasing2_1PN (LALStatus status, REAL8 phase, REAL8 v, expnCoeffs *ak)
void	LALInspiralPhasing2_2PN (LALStatus status, REAL8 phase, REAL8 v, expnCoeffs *ak)
void	LALInspiralPhasing2_3PN (LALStatus status, REAL8 phase, REAL8 v, expnCoeffs *ak)
void	LALInspiralPhasing2_4PN (LALStatus status, REAL8 phase, REAL8 v, expnCoeffs *ak)
void	LALInspiralPhasing2_5PN (LALStatus status, REAL8 phase, REAL8 v, expnCoeffs *ak)
void	LALInspiralPhasing2_6PN (LALStatus status, REAL8 phase, REAL8 v, expnCoeffs *ak)
void	LALInspiralPhasing2_7PN (LALStatus status, REAL8 phase, REAL8 v, expnCoeffs *ak)
void	LALInspiralPhasing3_0PN (LALStatus status, REAL8 phase, REAL8 td, expnCoeffs *ak)
void	LALInspiralPhasing3_1PN (LALStatus status, REAL8 phase, REAL8 td, expnCoeffs *ak)
void	LALInspiralPhasing3_2PN (LALStatus status, REAL8 phase, REAL8 td, expnCoeffs *ak)
void	LALInspiralPhasing3_3PN (LALStatus status, REAL8 phase, REAL8 td, expnCoeffs *ak)
void	LALInspiralPhasing3_4PN (LALStatus status, REAL8 phase, REAL8 td, expnCoeffs *ak)
void	LALInspiralPhasing3_5PN (LALStatus status, REAL8 phase, REAL8 td, expnCoeffs *ak)
void	LALInspiralPhasing3_6PN (LALStatus , REAL8 phase, REAL8 td, expnCoeffs *ak)
void	LALInspiralPhasing3_7PN (LALStatus status, REAL8 phase, REAL8 td, expnCoeffs *ak)
void	LALInspiralTofV (LALStatus , REAL8 , REAL8, void *)
void	LALInspiralTofVIntegrand (LALStatus status, REAL8 , REAL8, void *)
void	LALInspiralTiming2_0PN (LALStatus , REAL8 toff, REAL8 f, void *params)
void	LALInspiralTiming2_1PN (LALStatus , REAL8 toff, REAL8 f, void *params)
void	LALInspiralTiming2_2PN (LALStatus , REAL8 toff, REAL8 f, void *params)
void	LALInspiralTiming2_3PN (LALStatus , REAL8 toff, REAL8 f, void *params)
void	LALInspiralTiming2_4PN (LALStatus , REAL8 toff, REAL8 f, void *params)
void	LALInspiralTiming2_5PN (LALStatus , REAL8 toff, REAL8 f, void *params)
void	LALInspiralTiming2_6PN (LALStatus , REAL8 toff, REAL8 f, void *params)
void	LALInspiralTiming2_7PN (LALStatus , REAL8 toff, REAL8 f, void *params)
void	LALInspiralFrequency3_0PN (LALStatus status, REAL8 frequency, REAL8 td, expnCoeffs *ak)
void	LALInspiralFrequency3_1PN (LALStatus status, REAL8 frequency, REAL8 td, expnCoeffs *ak)
void	LALInspiralFrequency3_2PN (LALStatus status, REAL8 frequency, REAL8 td, expnCoeffs *ak)
void	LALInspiralFrequency3_3PN (LALStatus status, REAL8 frequency, REAL8 td, expnCoeffs *ak)
void	LALInspiralFrequency3_4PN (LALStatus status, REAL8 frequency, REAL8 td, expnCoeffs *ak)
void	LALInspiralFrequency3_5PN (LALStatus status, REAL8 frequency, REAL8 td, expnCoeffs *ak)
void	LALInspiralFrequency3_6PN (LALStatus status, REAL8 frequency, REAL8 td, expnCoeffs *ak)
void	LALInspiralFrequency3_7PN (LALStatus status, REAL8 frequency, REAL8 td, expnCoeffs *ak)
REAL4	LALInspiralHPlusPolarization (REAL8 phase, REAL8 v, InspiralTemplate *params)
REAL4	LALInspiralHCrossPolarization (REAL8 phase, REAL8 v, InspiralTemplate *params)
rk4GSLIntegrator *	XLALRungeKutta4Init (INT4 n, rk4In *input)
void	LALRungeKutta4 (LALStatus , REAL8Vector , rk4GSLIntegrator , void )
void	XLALRungeKutta4Free (rk4GSLIntegrator *integrator)
void	LALInspiralITStructureParseParameters (LALStatus status, UINT4 argc, CHAR argv, InspiralTemplate params)
void	LALInspiralITStructureSetDefault (LALStatus status, InspiralTemplate params)
void	LALInspiralITStructurePrint (LALStatus *status, InspiralTemplate params)
void	LALInspiralITStructureHelp (void)
INT4	XLALInspiralRingdownWave (REAL4Vector rdwave1, REAL4Vector rdwave2, InspiralTemplate params, REAL4VectorSequence inspwave1, REAL4VectorSequence inspwave2, COMPLEX8Vector modefreqs, UINT4 nmodes)
INT4	XLALGenerateWaveDerivatives (REAL4Vector dwave, REAL4Vector ddwave, REAL4Vector wave, InspiralTemplate params)
INT4	XLALGenerateQNMFreq (COMPLEX8Vector modefreqs, InspiralTemplate params, UINT4 l, UINT4 m, UINT4 nmodes)
INT4	XLALFinalMassSpin (REAL8 finalMass, REAL8 finalSpin, InspiralTemplate *params)
INT4	XLALInspiralAttachRingdownWave (REAL4Vector Omega, REAL4Vector signal1, REAL4Vector signal2, InspiralTemplate params)
int	XLALInspiralGetApproximantString (CHAR *output, UINT4 length, Approximant approx, Order order)
int	XLALBandPassInspiralTemplate (REAL4Sequence *sequence, REAL4 fLow, REAL4 fHigh, REAL4 fSampling)