LAL  7.5.0.1-b72065a
Prototypes | Data Structures
Header DetResponse.h
General Packages » General Purpose Tools

Detailed Description

Provides routines to compute gravitational wave detector response to polarized planar gravitational wave originating from a given source, detected at a given time.

Author
David Chin dwchi.nosp@m.n@um.nosp@m.ich.e.nosp@m.du, Kipp Cannon kipp@.nosp@m.grav.nosp@m.ity.p.nosp@m.hys..nosp@m.uwm.e.nosp@m.du

Synopsis

#include <lal/DetResponse.h>

Description

These routines compute the antenna beam pattern for all supported detector types. XLALComputeDetAMResponse() computes the response at one instance in time, and XLALComputeDetAMResponseSeries() computes a vector of response for some length of time.

Algorithm

This code is a translation of the algorithm in the Maple worksheet by Anderson, et al. [5] . We compute the \(h\)-tensors for \(+\)- and \(\times\)-polarized in the Earth-fixed frame, and then contract them (take the scalar product) with the detector response tensors as described in the Header LALDetectors.h section of the tools package.

Header LALDetectors.h provides predefined LALDetector structures representing most current detectors, including LIGO (Hanford and Livingston), and GEO.

Notes

For examples of usage, please see the test programs in the test directory.

Prototypes

void LALComputeDetAMResponse (LALStatus *status, LALDetAMResponse *pResponse, const LALDetAndSource *pDetAndSrc, const LIGOTimeGPS *gps)
 
void XLALComputeDetAMResponse (double *fplus, double *fcross, const REAL4 D[3][3], const double ra, const double dec, const double psi, const double gmst)
 An implementation of the detector response formulae in Anderson et al PRD 63 042003 (2001) [4] . More...
 
void XLALComputeDetAMResponseExtraModes (double *fplus, double *fcross, double *fb, double *fl, double *fx, double *fy, const REAL4 D[3][3], const double ra, const double dec, const double psi, const double gmst)
 An implementation of the detector response for all six tensor, vector and scalar polarisation modes of general metric theories of gravity. More...
 
COMPLEX16 XLALComputeDetArmTransferFunction (double beta, double mu)
 
void XLALComputeDetAMResponseParts (double *armlen, double *xcos, double *ycos, double *fxplus, double *fyplus, double *fxcross, double *fycross, const LALDetector *detector, double ra, double dec, double psi, double gmst)
 
void LALComputeDetAMResponseSeries (LALStatus *status, LALDetAMResponseSeries *pResponseSeries, const LALDetAndSource *pDetAndSource, const LALTimeIntervalAndNSample *pTimeInfo)
 Computes REAL4TimeSeries containing time series of response amplitudes. More...
 
int XLALComputeDetAMResponseSeries (REAL4TimeSeries **fplus, REAL4TimeSeries **fcross, const REAL4 D[3][3], const double ra, const double dec, const double psi, const LIGOTimeGPS *start, const double deltaT, const int n)
 Computes REAL4TimeSeries containing time series of response amplitudes. More...
 
int XLALComputeDetAMResponseExtraModesSeries (REAL4TimeSeries **fplus, REAL4TimeSeries **fcross, REAL4TimeSeries **fb, REAL4TimeSeries **fl, REAL4TimeSeries **fx, REAL4TimeSeries **fy, const REAL4 D[3][3], const double ra, const double dec, const double psi, const LIGOTimeGPS *start, const double deltaT, const int n)
 Computes REAL4TimeSeries containing time series of the full general metric theory of gravity response amplitudes. More...
 

Data Structures

struct  LALSource
 This structure contains gravitational wave source position (in Equatorial coördinates), and orientation angle. More...
 
struct  LALDetAndSource
 This structure aggregates a pointer to a LALDetector and a LALSource. More...
 
struct  LALDetAMResponse
 This structure encapsulates the detector AM (beam pattern) coefficients for one source at one instance in time. More...
 
struct  LALDetAMResponseSeries
 This structure aggregates together three REAL4TimeSeries objects containing time series of detector AM response. More...
 
struct  LALTimeIntervalAndNSample
 This structure encapsulates time and sampling information for computing a LALDetAMResponseSeries. More...
 

Error Codes

#define DETRESPONSEH_ENULLINPUT   1
 Input is NULL. More...
 
#define DETRESPONSEH_ENULLOUTPUT   2
 Output is NULL. More...
 
#define DETRESPONSEH_ESRCNOTEQUATORIAL   3
 Source coordinates not in Equatorial system. More...
 

Function Documentation

◆ LALComputeDetAMResponse()

void LALComputeDetAMResponse ( LALStatus *  status,
LALDetAMResponse *  pResponse,
const LALDetAndSource *  pDetAndSrc,
const LIGOTimeGPS *  gps 
)
Deprecated:
Use XLALComputeDetAMResponse() instead.

Definition at line 401 of file DetResponse.c.

◆ XLALComputeDetAMResponse()

void XLALComputeDetAMResponse ( double *  fplus,
double *  fcross,
const REAL4  D[3][3],
const double  ra,
const double  dec,
const double  psi,
const double  gmst 
)

An implementation of the detector response formulae in Anderson et al PRD 63 042003 (2001) [4] .

Computes F+ and Fx for a source at a specified sky position, polarization angle, and sidereal time. Also requires the detector's response matrix which is defined by Eq. (B6) of [ABCF] using either Table 1 of [4] or Eqs. (B11)–(B17) to compute the arm direction unit vectors.

Parameters
fplusReturned value of F+
fcrossReturned value of Fx
DDetector response 3x3 matrix
raRight ascention of source (radians)
decDeclination of source (radians)
psiPolarization angle of source (radians)
gmstGreenwich mean sidereal time (radians)

Definition at line 44 of file DetResponse.c.

◆ XLALComputeDetAMResponseExtraModes()

void XLALComputeDetAMResponseExtraModes ( double *  fplus,
double *  fcross,
double *  fb,
double *  fl,
double *  fx,
double *  fy,
const REAL4  D[3][3],
const double  ra,
const double  dec,
const double  psi,
const double  gmst 
)

An implementation of the detector response for all six tensor, vector and scalar polarisation modes of general metric theories of gravity.

We follow the convention of [7] (this is also equivalent to the Equations in [4] and [20] in albeit with a rotated set of coordinates), but with [7]'s \(\theta = \pi/2 - dec\) and \(\phi = ra-GMST\) rather than the gha = gmst - ra used here.

The values computed are the tensor mode response, F+ and Fx ("cross"), the scalar breathing and longitudinal modes, Fb and Fl, and the vector "x" and "y" modes, Fx ("x") and Fy, for a source at a specified sky position, polarization angle, and sidereal time. Also requires the detector's response matrix which is defined by Eq. (B6) of [4] using either Table 1 of [4] or Eqs. (B11)–(B17) to compute the arm direction unit vectors.

Parameters
fplusReturned value of F+
fcrossReturned value of Fx (cross)
fbReturned value of Fb (breathing mode)
flReturned value of Fl (scalar longitudinal)
fxReturned value of Fx ("x" vector mode)
fyReturned value of Fy (y vector mode)
DDetector response 3x3 matrix
raRight ascention of source (radians)
decDeclination of source (radians)
psiPolarization angle of source (radians)
gmstGreenwich mean sidereal time (radians)

Definition at line 112 of file DetResponse.c.

◆ XLALComputeDetArmTransferFunction()

COMPLEX16 XLALComputeDetArmTransferFunction ( double  beta,
double  mu 
)

Definition at line 202 of file DetResponse.c.

◆ XLALComputeDetAMResponseParts()

void XLALComputeDetAMResponseParts ( double *  armlen,
double *  xcos,
double *  ycos,
double *  fxplus,
double *  fyplus,
double *  fxcross,
double *  fycross,
const LALDetector *  detector,
double  ra,
double  dec,
double  psi,
double  gmst 
)

Definition at line 234 of file DetResponse.c.

◆ LALComputeDetAMResponseSeries()

void LALComputeDetAMResponseSeries ( LALStatus *  status,
LALDetAMResponseSeries *  pResponseSeries,
const LALDetAndSource *  pDetAndSource,
const LALTimeIntervalAndNSample *  pTimeInfo 
)

Computes REAL4TimeSeries containing time series of response amplitudes.

Deprecated:
Use XLALComputeDetAMResponseSeries() instead.

Definition at line 526 of file DetResponse.c.

◆ XLALComputeDetAMResponseSeries()

int XLALComputeDetAMResponseSeries ( REAL4TimeSeries **  fplus,
REAL4TimeSeries **  fcross,
const REAL4  D[3][3],
const double  ra,
const double  dec,
const double  psi,
const LIGOTimeGPS *  start,
const double  deltaT,
const int  n 
)

Computes REAL4TimeSeries containing time series of response amplitudes.

See also
XLALComputeDetAMResponse() for more details.

Definition at line 432 of file DetResponse.c.

◆ XLALComputeDetAMResponseExtraModesSeries()

int XLALComputeDetAMResponseExtraModesSeries ( REAL4TimeSeries **  fplus,
REAL4TimeSeries **  fcross,
REAL4TimeSeries **  fb,
REAL4TimeSeries **  fl,
REAL4TimeSeries **  fx,
REAL4TimeSeries **  fy,
const REAL4  D[3][3],
const double  ra,
const double  dec,
const double  psi,
const LIGOTimeGPS *  start,
const double  deltaT,
const int  n 
)

Computes REAL4TimeSeries containing time series of the full general metric theory of gravity response amplitudes.

See also
XLALComputeDetAMResponseExtraModes() for more details.

Definition at line 470 of file DetResponse.c.

Macro Definition Documentation

◆ DETRESPONSEH_ENULLINPUT

#define DETRESPONSEH_ENULLINPUT   1

Input is NULL.

Definition at line 79 of file DetResponse.h.

◆ DETRESPONSEH_ENULLOUTPUT

#define DETRESPONSEH_ENULLOUTPUT   2

Output is NULL.

Definition at line 80 of file DetResponse.h.

◆ DETRESPONSEH_ESRCNOTEQUATORIAL

#define DETRESPONSEH_ESRCNOTEQUATORIAL   3

Source coordinates not in Equatorial system.

Definition at line 81 of file DetResponse.h.