LALNoiseModels.h File Reference

#include <math.h>
#include <stdio.h>
#include <stdlib.h>
#include <lal/LALStdlib.h>
#include <lal/LALConstants.h>
#include <lal/LALInspiral.h>
#include <lal/RealFFT.h>

Include dependency graph for LALNoiseModels.h:

Go to the source code of this file.

Data Structures

struct  tagInspiralWaveCorrelateIn
struct  tagAddVectorsIn
struct  tagDiscoverInspiralEventsIn
struct  tagDiscoverInspiralEventsList
struct  tagInspiralChisqInput
struct  tagInspiralChisqOutput
struct  tagInvSpecTruncationParams
struct  tagRandomInspiralSignalIn
struct  tagInspiralWaveOverlapIn
struct  tagInspiralWaveOverlapOut
struct  tagInspiralFindEventsIn
struct  tagInspiralEventsList
struct  tagInspiralWaveNormaliseIn
struct  tagStatsREAL4VectorOut
struct  tagInspiralChisqDataVec
struct  tagInspiralChisqParams
struct  tagInspiralSNRIntegrandParams

Defines

#define LALNOISEMODELSH_ENULL   1
#define LALNOISEMODELSH_EMEM   2
#define LALNOISEMODELSH_ECHOICE   4
#define LALNOISEMODELSH_EDIV0   8
#define LALNOISEMODELSH_ESIZE   16
#define LALNOISEMODELSH_MSGENULL   "Arguments contained an unexpected null pointer"
#define LALNOISEMODELSH_MSGEMEM   "Memory allocation error"
#define LALNOISEMODELSH_MSGECHOICE   "Invalid choice for an input parameter"
#define LALNOISEMODELSH_MSGEDIV0   "Division by zero"
#define LALNOISEMODELSH_MSGESIZE   "Invalid input size"

Typedefs

typedef tagInspiralWaveCorrelateIn InspiralWaveCorrelateIn
typedef tagAddVectorsIn AddVectorsIn
typedef tagDiscoverInspiralEventsIn DiscoverInspiralEventsIn
typedef tagDiscoverInspiralEventsList DiscoverInspiralEventsList
typedef tagInspiralChisqInput InspiralChisqInput
typedef tagInspiralChisqOutput InspiralChisqOutput
typedef tagInvSpecTruncationParams InvSpecTruncationParams
typedef tagRandomInspiralSignalIn RandomInspiralSignalIn
typedef tagInspiralWaveOverlapIn InspiralWaveOverlapIn
typedef tagInspiralWaveOverlapOut InspiralWaveOverlapOut
typedef tagInspiralFindEventsIn InspiralFindEventsIn
typedef tagInspiralEventsList InspiralEventsList
typedef tagInspiralWaveNormaliseIn InspiralWaveNormaliseIn
typedef tagStatsREAL4VectorOut StatsREAL4VectorOut
typedef tagInspiralChisqDataVec InspiralChisqDataVec
typedef tagInspiralChisqParams InspiralChisqParams
typedef tagInspiralSNRIntegrandParams InspiralSNRIntegrandParams

Enumerations

enum  Detector { geo, ligo, tama, virgo }

Functions

 NRCSID (LALNOISEMODELSH,"$Id: LALNoiseModels.h,v 1.31 2008/09/09 18:50:00 kipp Exp $")
void LALNoiseSpectralDensity (LALStatus *status, REAL8Vector *psd, void(*NoisePsd)(LALStatus *status, REAL8 *shf, REAL8 f), REAL8 f)
void LALInspiralWaveCorrelate (LALStatus *status, REAL4Vector *output, InspiralWaveCorrelateIn in)
void LALInspiralWaveNormalise (LALStatus *status, REAL4Vector *dh, REAL8 *norm, REAL8Vector psd)
void LALInspiralWaveNormaliseLSO (LALStatus *status, REAL4Vector *filter, REAL8 *norm, InspiralWaveNormaliseIn *in)
void LALEGOPsd (LALStatus *status, REAL8 *shf, REAL8 x)
void LALGEOPsd (LALStatus *status, REAL8 *shf, REAL8 x)
void LALAdvLIGOPsd (LALStatus *status, REAL8 *shf, REAL8 x)
REAL8 XLALLIGOIPsd (REAL8 f)
 Calculate the Initial LIGO SRD noise spectral density at given a frequency.
void LALLIGOIPsd (LALStatus *status, REAL8 *shf, REAL8 x)
 Legacy LAL wrapper of XLALLIGOIPsd().
void LALTAMAPsd (LALStatus *status, REAL8 *shf, REAL8 x)
void LALVIRGOPsd (LALStatus *status, REAL8 *shf, REAL8 x)
void LALRandomInspiralSignal (LALStatus *status, REAL4Vector *signalvec, RandomInspiralSignalIn *randIn)
void LALColoredNoise (LALStatus *status, REAL4Vector *noisy, REAL8Vector psd)
void LALAddVectors (LALStatus *status, REAL4Vector *vector, AddVectorsIn in)
void LALInspiralWaveOverlap (LALStatus *status, REAL4Vector *output, InspiralWaveOverlapOut *overlapout, InspiralWaveOverlapIn *overlapin)
void LALInspiralGetOrthoNormalFilter (REAL4Vector *filter2, REAL4Vector *filter1)
void LALInspiralFindEvents (LALStatus *status, INT4 *nEvents, InspiralEventsList **findeventsout, InspiralFindEventsIn *findeventsin)
void LALInspiralFindLoudestEvent (LALStatus *status, INT4 *nEvents, InspiralEventsList *eventlist, InspiralFindEventsIn *findeventsin)
void LALInspiralFindEventsCluster (LALStatus *status, INT4 *nEvents, InspiralEventsList **findeventsout, InspiralFindEventsIn *findeventsin)
void LALStatsREAL4Vector (LALStatus *status, StatsREAL4VectorOut *out, REAL4Vector *vector)
void LALInspiralComputeChisq (LALStatus *status, REAL4 *chisq, InspiralChisqDataVec *input, InspiralChisqParams *params)
void LALInspiralComputeSNRIntegrand (LALStatus *status, REAL4Vector *output, InspiralWaveCorrelateIn corrin, InspiralSNRIntegrandParams *params)
void LALDiscoverInspiralEvents (LALStatus *status, INT4 *nEvents, DiscoverInspiralEventsList **eventlist, DiscoverInspiralEventsIn *findeventsin)
void LALEstimateEffectiveDistance (LALStatus *status, InspiralTemplate param, REAL8 df, REAL8Vector *psd, REAL8 snr, REAL8 *effDistance)
void LALEvaluateInspiralChisqTest (LALStatus *status, InspiralChisqOutput *chisqOut, InspiralChisqInput *chisqIn)
void LALTruncateInvSpectrum (LALStatus *status, REAL8Vector *inputVec, InvSpecTruncationParams *params)
void GenerateTimeDomainWaveformForInjection (LALStatus *status, REAL4Vector *buff, InspiralTemplate *params)


Define Documentation

#define LALNOISEMODELSH_ENULL   1

Definition at line 71 of file LALNoiseModels.h.

#define LALNOISEMODELSH_EMEM   2

Definition at line 72 of file LALNoiseModels.h.

#define LALNOISEMODELSH_ECHOICE   4

Definition at line 73 of file LALNoiseModels.h.

#define LALNOISEMODELSH_EDIV0   8

Definition at line 74 of file LALNoiseModels.h.

#define LALNOISEMODELSH_ESIZE   16

Definition at line 75 of file LALNoiseModels.h.

#define LALNOISEMODELSH_MSGENULL   "Arguments contained an unexpected null pointer"

Definition at line 76 of file LALNoiseModels.h.

#define LALNOISEMODELSH_MSGEMEM   "Memory allocation error"

Definition at line 77 of file LALNoiseModels.h.

#define LALNOISEMODELSH_MSGECHOICE   "Invalid choice for an input parameter"

Definition at line 78 of file LALNoiseModels.h.

#define LALNOISEMODELSH_MSGEDIV0   "Division by zero"

Definition at line 79 of file LALNoiseModels.h.

#define LALNOISEMODELSH_MSGESIZE   "Invalid input size"

Definition at line 80 of file LALNoiseModels.h.


Typedef Documentation

typedef struct tagInspiralWaveCorrelateIn InspiralWaveCorrelateIn

typedef struct tagAddVectorsIn AddVectorsIn

typedef struct tagDiscoverInspiralEventsIn DiscoverInspiralEventsIn

typedef struct tagDiscoverInspiralEventsList DiscoverInspiralEventsList

typedef struct tagInspiralChisqInput InspiralChisqInput

typedef struct tagInspiralChisqOutput InspiralChisqOutput

typedef struct tagInvSpecTruncationParams InvSpecTruncationParams

typedef struct tagRandomInspiralSignalIn RandomInspiralSignalIn

typedef struct tagInspiralWaveOverlapIn InspiralWaveOverlapIn

typedef struct tagInspiralWaveOverlapOut InspiralWaveOverlapOut

typedef struct tagInspiralFindEventsIn InspiralFindEventsIn

typedef struct tagInspiralEventsList InspiralEventsList

typedef struct tagInspiralWaveNormaliseIn InspiralWaveNormaliseIn

typedef struct tagStatsREAL4VectorOut StatsREAL4VectorOut

typedef struct tagInspiralChisqDataVec InspiralChisqDataVec

typedef struct tagInspiralChisqParams InspiralChisqParams

typedef struct tagInspiralSNRIntegrandParams InspiralSNRIntegrandParams


Enumeration Type Documentation

enum Detector

Enumerator:
geo 
ligo 
tama 
virgo 

Definition at line 92 of file LALNoiseModels.h.


Function Documentation

NRCSID ( LALNOISEMODELSH  ,
"$Id: LALNoiseModels.  h,
v 1.31 2008/09/09 18:50:00 kipp Exp $"   
)

void LALNoiseSpectralDensity ( LALStatus status,
REAL8Vector psd,
void(*)(LALStatus *status, REAL8 *shf, REAL8 f)  NoisePsd,
REAL8  f 
)

Definition at line 75 of file LALNoiseSpectralDensity.c.

void LALInspiralWaveCorrelate ( LALStatus status,
REAL4Vector output,
InspiralWaveCorrelateIn  in 
)

Definition at line 73 of file LALInspiralWaveCorrelate.c.

void LALInspiralWaveNormalise ( LALStatus status,
REAL4Vector dh,
REAL8 norm,
REAL8Vector  psd 
)

Definition at line 72 of file LALInspiralWaveNormalise.c.

void LALInspiralWaveNormaliseLSO ( LALStatus status,
REAL4Vector filter,
REAL8 norm,
InspiralWaveNormaliseIn in 
)

Definition at line 78 of file LALInspiralWaveNormaliseLSO.c.

void LALEGOPsd ( LALStatus status,
REAL8 shf,
REAL8  x 
)

Definition at line 63 of file LALEGOPsd.c.

void LALGEOPsd ( LALStatus status,
REAL8 shf,
REAL8  x 
)

Definition at line 71 of file LALGEOPsd.c.

void LALAdvLIGOPsd ( LALStatus status,
REAL8 shf,
REAL8  x 
)

Definition at line 69 of file LALAdvLIGOPsd.c.

REAL8 XLALLIGOIPsd ( REAL8  f  ) 

Calculate the Initial LIGO SRD noise spectral density at given a frequency.

The input is frequency in Hz, and the return value is the noise spectral density, $S_{h}(f)$, for that frequency.

The noise PSD is based on data provided by K. Blackburn (see T. Damour, B.R. Iyer and B.S. Sathyaprakash, Phys. Rev. D 63, 044023 (2001)) and is approximated by the following:

{equation} S_h(f) = 9 10^{-46} [ ( 4.49 {f}{f_0} )^{-56} + 0.16 ( {f}{f_0} )^{-4.52} + 0.52 + 0.32 ( {f}{f_0} )^2 ] {equation}

Definition at line 46 of file LALLIGOIPsd.c.

void LALLIGOIPsd ( LALStatus status,
REAL8 psd,
REAL8  f 
)

Legacy LAL wrapper of XLALLIGOIPsd().

Note that the return value is scaled up by $s_0 = 10^{46}/9.$ In otherwords, the expected noise PSD is $9 10^{-46}$ times the return value.

Definition at line 61 of file LALLIGOIPsd.c.

void LALTAMAPsd ( LALStatus status,
REAL8 shf,
REAL8  x 
)

Definition at line 69 of file LALTAMAPsd.c.

void LALVIRGOPsd ( LALStatus status,
REAL8 shf,
REAL8  x 
)

Definition at line 61 of file LALVIRGOPsd.c.

void LALRandomInspiralSignal ( LALStatus status,
REAL4Vector signalvec,
RandomInspiralSignalIn randIn 
)

Definition at line 195 of file LALRandomInspiralSignal.c.

void LALColoredNoise ( LALStatus status,
REAL4Vector noisy,
REAL8Vector  psd 
)

Definition at line 61 of file LALColoredNoise.c.

void LALAddVectors ( LALStatus status,
REAL4Vector vector,
AddVectorsIn  in 
)

Definition at line 57 of file LALAddVectors.c.

void LALInspiralWaveOverlap ( LALStatus status,
REAL4Vector output,
InspiralWaveOverlapOut overlapout,
InspiralWaveOverlapIn overlapin 
)

Definition at line 59 of file LALInspiralWaveOverlap.c.

void LALInspiralGetOrthoNormalFilter ( REAL4Vector filter2,
REAL4Vector filter1 
)

Definition at line 335 of file LALInspiralWaveOverlap.c.

void LALInspiralFindEvents ( LALStatus status,
INT4 nEvents,
InspiralEventsList **  findeventsout,
InspiralFindEventsIn findeventsin 
)

Definition at line 60 of file LALInspiralFindEvents.c.

void LALInspiralFindLoudestEvent ( LALStatus status,
INT4 nEvents,
InspiralEventsList eventlist,
InspiralFindEventsIn findeventsin 
)

Definition at line 59 of file LALInspiralFindLoudestEvent.c.

void LALInspiralFindEventsCluster ( LALStatus status,
INT4 nEvents,
InspiralEventsList **  findeventsout,
InspiralFindEventsIn findeventsin 
)

Definition at line 66 of file LALInspiralFindEventsCluster.c.

void LALStatsREAL4Vector ( LALStatus status,
StatsREAL4VectorOut out,
REAL4Vector vector 
)

Definition at line 52 of file LALStatsREAL4Vector.c.

void LALInspiralComputeChisq ( LALStatus status,
REAL4 chisq,
InspiralChisqDataVec input,
InspiralChisqParams params 
)

Definition at line 53 of file LALInspiralComputeChisq.c.

void LALInspiralComputeSNRIntegrand ( LALStatus status,
REAL4Vector output,
InspiralWaveCorrelateIn  corrin,
InspiralSNRIntegrandParams params 
)

Definition at line 51 of file LALInspiralComputeSNRIntegrand.c.

void LALDiscoverInspiralEvents ( LALStatus status,
INT4 nEvents,
DiscoverInspiralEventsList **  eventlist,
DiscoverInspiralEventsIn findeventsin 
)

Definition at line 30 of file LALDiscoverInspiralEvents.c.

void LALEstimateEffectiveDistance ( LALStatus status,
InspiralTemplate  param,
REAL8  df,
REAL8Vector psd,
REAL8  snr,
REAL8 effDistance 
)

Definition at line 27 of file LALEstimateEffectiveDistance.c.

void LALEvaluateInspiralChisqTest ( LALStatus status,
InspiralChisqOutput chisqOut,
InspiralChisqInput chisqIn 
)

Definition at line 30 of file LALEvaluateInspiralChisqTest.c.

void LALTruncateInvSpectrum ( LALStatus status,
REAL8Vector inputVec,
InvSpecTruncationParams params 
)

Definition at line 26 of file LALTruncateInvSpectrum.c.

void GenerateTimeDomainWaveformForInjection ( LALStatus status,
REAL4Vector buff,
InspiralTemplate params 
)

Definition at line 866 of file LALRandomInspiralSignal.c.


Generated on Tue Oct 14 02:33:05 2008 for LAL by  doxygen 1.5.2