LISAspecifics.h File Reference

Author:

Reinhard Prix Header-file defining the API for the LISA-specific functions

More...

#include <lal/LALRCSID.h>
#include <lal/LALDetectors.h>
#include <lal/LALDatatypes.h>
#include <lal/DetectorStates.h>
#include <lal/ComplexAM.h>

Include dependency graph for LISAspecifics.h:

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

Go to the source code of this file.

Defines
#define	LISA_TIME_ORIGIN   700000000;
Enumerations
enum	LISAarmT { LISA_ARM1 = 0, LISA_ARM2, LISA_ARM3 }
	Translate TDI arm indices to C-indexing. More...
Functions
	NRCSID (LISASPECIFICSH,"$Id: LISAspecifics.h,v 1.9 2007/12/19 19:44:34 reinhard Exp $")
int	XLALcreateLISA (LALDetector *Detector, CHAR channelNum)
	Set up the LALDetector struct representing LISA X, Y, Z TDI observables.
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.
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

Author:

Reinhard Prix Header-file defining the API for the LISA-specific functions

Date:

2006

Id

LISAspecifics.h,v 1.9 2007/12/19 19:44:34 reinhard Exp

Definition in file LISAspecifics.h.

---

Define Documentation

#define LISA_TIME_ORIGIN   700000000;

Definition at line 50 of file LISAspecifics.h.

---

Enumeration Type Documentation

enum LISAarmT

Translate TDI arm indices to C-indexing.

Enumerator:

LISA_ARM1
LISA_ARM2
LISA_ARM3

Definition at line 54 of file LISAspecifics.h.

---

Function Documentation

NRCSID	(	LISASPECIFICSH	,
		"$Id: LISAspecifics.	h,
		v 1.9 2007/12/19 19:44:34 reinhard Exp $"
	)

int XLALcreateLISA	(	LALDetector *	Detector,
		CHAR	channelNum
	)

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

INPUT: channelNum = '1', '2', '3', '4', '5', '6', '7', '8', '9': detector-tensor corresponding to TDIs X, Y, Z, Y-Z, Z-X, X-Y, A, E, T respectively. return -1 on ERROR, 0 if OK

Parameters:

Detector	[out] LALDetector
channelNum	[in] which TDI observable: '1' = X, '2'= Y, '3' = Z, '4' = Y-Z, '5' = Z-X, '6' = X-Y, '7' = A, '8' = E, '9' = T

Definition at line 72 of file LISAspecifics.c.

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 155 of file LISAspecifics.c.

int XLALgetLISADetectorTensorLWL	(	SymmTensor3 *	detT,
		const Detector3Arms	detArms,
		CHAR	channelNum
	)

Parameters:

detT	[out]: LISA LWL detector-tensor
detArms	[in] precomputed detector-arms
channelNum	channel-number (as a char) '1', '2', '3' ..

Definition at line 241 of file LISAspecifics.c.

int XLALgetLISADetectorTensorRAA	(	CmplxDetectorTensor *	detT,
		const Detector3Arms	detArms,
		CHAR	channelNum,
		const FreqSkypos_t *	freq_skypos
	)

Parameters:

detT	[out]: LISA LWL detector-tensor
detArms	[in] precomputed detector-arms
channelNum	[in] channel-number (as a char) '1', '2', '3' ..
freq_skypos	[in] precompute frequency and skypos info

Definition at line 399 of file LISAspecifics.c.

---