SimulateCoherentGW.h File Reference

#include <lal/LALStdlib.h>
#include <lal/DetectorSite.h>
#include <lal/SkyCoordinates.h>
#include <lal/LALBarycenter.h>

Include dependency graph for SimulateCoherentGW.h:

Go to the source code of this file.

Data Structures

struct  tagCoherentGW
 This structure stores a representation of a plane gravitational wave propagating from a particular point on the sky. More...
struct  tagDetectorResponse
 This structure contains information required to determine the response of a detector to a gravitational waveform. More...

Defines

#define SIMULATECOHERENTGWH_ENUL   1
#define SIMULATECOHERENTGWH_EBAD   2
#define SIMULATECOHERENTGWH_ESIG   3
#define SIMULATECOHERENTGWH_EDIM   4
#define SIMULATECOHERENTGWH_EMEM   5
#define SIMULATECOHERENTGWH_EUNIT   6
#define SIMULATECOHERENTGWH_MSGENUL   "Unexpected null pointer in arguments"
#define SIMULATECOHERENTGWH_MSGEBAD   "A sampling interval is (effectively) zero"
#define SIMULATECOHERENTGWH_MSGESIG   "Input signal must specify amplitude and phase functions"
#define SIMULATECOHERENTGWH_MSGEDIM   "Amplitude must be a 2-dimensional vector"
#define SIMULATECOHERENTGWH_MSGEMEM   "Memory allocation error"
#define SIMULATECOHERENTGWH_MSGEUNIT   "Bad input units"

Typedefs

typedef tagCoherentGW CoherentGW
 This structure stores a representation of a plane gravitational wave propagating from a particular point on the sky.
typedef tagDetectorResponse DetectorResponse
 This structure contains information required to determine the response of a detector to a gravitational waveform.

Functions

 NRCSID (SIMULATECOHERENTGWH,"$Id: SimulateCoherentGW.h,v 1.18 2007/06/08 14:41:47 bema Exp $")
void LALSimulateCoherentGW (LALStatus *status, REAL4TimeSeries *output, CoherentGW *input, DetectorResponse *detector)
void LALSimulateCoherentGW_exp (LALStatus *status, REAL4TimeSeries *output, CoherentGW *input, DetectorResponse *detector)


Define Documentation

#define SIMULATECOHERENTGWH_ENUL   1

Definition at line 271 of file SimulateCoherentGW.h.

#define SIMULATECOHERENTGWH_EBAD   2

Definition at line 272 of file SimulateCoherentGW.h.

#define SIMULATECOHERENTGWH_ESIG   3

Definition at line 273 of file SimulateCoherentGW.h.

#define SIMULATECOHERENTGWH_EDIM   4

Definition at line 274 of file SimulateCoherentGW.h.

#define SIMULATECOHERENTGWH_EMEM   5

Definition at line 275 of file SimulateCoherentGW.h.

#define SIMULATECOHERENTGWH_EUNIT   6

Definition at line 276 of file SimulateCoherentGW.h.

#define SIMULATECOHERENTGWH_MSGENUL   "Unexpected null pointer in arguments"

Definition at line 278 of file SimulateCoherentGW.h.

#define SIMULATECOHERENTGWH_MSGEBAD   "A sampling interval is (effectively) zero"

Definition at line 279 of file SimulateCoherentGW.h.

#define SIMULATECOHERENTGWH_MSGESIG   "Input signal must specify amplitude and phase functions"

Definition at line 280 of file SimulateCoherentGW.h.

#define SIMULATECOHERENTGWH_MSGEDIM   "Amplitude must be a 2-dimensional vector"

Definition at line 281 of file SimulateCoherentGW.h.

#define SIMULATECOHERENTGWH_MSGEMEM   "Memory allocation error"

Definition at line 282 of file SimulateCoherentGW.h.

#define SIMULATECOHERENTGWH_MSGEUNIT   "Bad input units"

Definition at line 283 of file SimulateCoherentGW.h.


Typedef Documentation

typedef struct tagCoherentGW CoherentGW

This structure stores a representation of a plane gravitational wave propagating from a particular point on the sky.

Several alternate representations are permitted to allow a more natural characterization of quasiperiodic waveforms.

typedef struct tagDetectorResponse DetectorResponse

This structure contains information required to determine the response of a detector to a gravitational waveform.


Function Documentation

NRCSID ( SIMULATECOHERENTGWH  ,
"$Id: SimulateCoherentGW.  h,
v 1.18 2007/06/08 14:41:47 bema Exp $"   
)

void LALSimulateCoherentGW ( LALStatus status,
REAL4TimeSeries output,
CoherentGW input,
DetectorResponse detector 
)

Definition at line 223 of file SimulateCoherentGW.c.

void LALSimulateCoherentGW_exp ( LALStatus status,
REAL4TimeSeries output,
CoherentGW input,
DetectorResponse detector 
)

Definition at line 998 of file SimulateCoherentGW.c.


Generated on Fri Sep 5 03:08:26 2008 for LAL by  doxygen 1.5.2