LALPulsar  6.1.0.1-fe68b98
LISAspecifics.h File Reference

Header-file defining the API for the LISA-specific functions. More...

Prototypes

BOOLEAN XLALisLISAdetector (const LALDetector *det)
 Return true if 'det' is a LISA LALDetector struct. More...
 
int XLALregisterLISAdetectors (const CHAR prefixLetter)
 Set up the LALDetector structs representing LISA X, Y, Z TDI observables. More...
 
int XLALprecomputeLISAarms (DetectorState *detState)
 Precompute the arm-geometry for LISA, which is later used for assembling the RAA detector-tensor (which depends on frequency and skyposition. More...
 
int XLALgetLISADetectorTensorLWL (SymmTensor3 *detT, const Detector3Arms detArms, CHAR channelNum)
 
int XLALgetLISADetectorTensorRAA (CmplxDetectorTensor *detT, const Detector3Arms detArms, CHAR channelNum, const FreqSkypos_t *freq_skypos)
 

Detailed Description

Header-file defining the API for the LISA-specific functions.

Author
Reinhard Prix
Date
2006

Definition in file LISAspecifics.h.

Go to the source code of this file.

Data Structures

struct  CmplxDetectorTensor
 The 'detector tensor' for a GW-detector: symmetric 3x3 matrix, storing only the upper triangle. More...
 
struct  FreqSkypos_t
 Convenience container for precomputed pi f L/c and skyposition vector. More...
 

Macros

#define LISA_TIME_ORIGIN   700000000; /* ad-hoc setting for MLDC 't=0' to GPS for Tue Mar 12 20:26:27 GMT 2002 */
 

Enumerations

enum  LISAarmT { LISA_ARM1 = 0 , LISA_ARM2 , LISA_ARM3 }
 Translate TDI arm indices to C-indexing. More...
 

Macro Definition Documentation

◆ LISA_TIME_ORIGIN

#define LISA_TIME_ORIGIN   700000000; /* ad-hoc setting for MLDC 't=0' to GPS for Tue Mar 12 20:26:27 GMT 2002 */

Definition at line 45 of file LISAspecifics.h.

Enumeration Type Documentation

◆ LISAarmT

enum LISAarmT

Translate TDI arm indices to C-indexing.

Enumerator
LISA_ARM1 
LISA_ARM2 
LISA_ARM3 

Definition at line 49 of file LISAspecifics.h.

Function Documentation

◆ XLALisLISAdetector()

BOOLEAN XLALisLISAdetector ( const LALDetector det)

Return true if 'det' is a LISA LALDetector struct.

Definition at line 65 of file LISAspecifics.c.

◆ XLALregisterLISAdetectors()

int XLALregisterLISAdetectors ( const CHAR  prefixLetter)

Set up the LALDetector structs representing LISA X, Y, Z TDI observables.

Detectors will be registered with prefixes beginning with 'prefixLetter'.

Definition at line 75 of file LISAspecifics.c.

◆ XLALprecomputeLISAarms()

int XLALprecomputeLISAarms ( DetectorState detState)

Precompute the arm-geometry for LISA, which is later used for assembling the RAA detector-tensor (which depends on frequency and skyposition.

Definition at line 150 of file LISAspecifics.c.

◆ XLALgetLISADetectorTensorLWL()

int XLALgetLISADetectorTensorLWL ( SymmTensor3 detT,
const Detector3Arms  detArms,
CHAR  channelNum 
)
Parameters
[out]detT: LISA LWL detector-tensor
[in]detArmsprecomputed detector-arms
channelNumchannel-number (as a char) '1', '2', '3' ..

Definition at line 235 of file LISAspecifics.c.

◆ XLALgetLISADetectorTensorRAA()

int XLALgetLISADetectorTensorRAA ( CmplxDetectorTensor detT,
const Detector3Arms  detArms,
CHAR  channelNum,
const FreqSkypos_t freq_skypos 
)
Parameters
[out]detT: LISA LWL detector-tensor
[in]detArmsprecomputed detector-arms
[in]channelNumchannel-number (as a char) '1', '2', '3' ..
[in]freq_skyposprecompute frequency and skypos info

Definition at line 392 of file LISAspecifics.c.