LALPulsar  6.1.0.1-89842e6
UniversalDopplerMetric.h File Reference

Prototypes

DopplerFstatMetricXLALComputeDopplerFstatMetric (const DopplerMetricParams *metricParams, const EphemerisData *edat)
 Calculate the general (single-segment coherent, or multi-segment semi-coherent) full (multi-IFO) Fstat-metrix and the Fisher-matrix derived in [20] . More...
 
void XLALDestroyDopplerFstatMetric (DopplerFstatMetric *metric)
 Free a DopplerFstatMetric structure. More...
 
DopplerPhaseMetricXLALComputeDopplerPhaseMetric (const DopplerMetricParams *metricParams, const EphemerisData *edat)
 Calculate an approximate "phase-metric" with the specified parameters. More...
 
void XLALDestroyDopplerPhaseMetric (DopplerPhaseMetric *metric)
 Free a DopplerPhaseMetric structure. More...
 
FmetricAtoms_tXLALComputeAtomsForFmetric (const DopplerMetricParams *metricParams, const EphemerisData *edat)
 Function to the compute the FmetricAtoms_t, from which the F-metric and Fisher-matrix can be computed. More...
 
int XLALDetectorPosVel (PosVel3D_t *spin_posvel, PosVel3D_t *orbit_posvel, const LIGOTimeGPS *tGPS, const LALDetector *site, const EphemerisData *edat, DetectorMotionType detMotionType)
 Given a GPS time and detector, return the current position (and velocity) of the detector. More...
 
int XLALPtolemaicPosVel (PosVel3D_t *posvel, const LIGOTimeGPS *tGPS)
 Compute position and velocity assuming a purely "Ptolemaic" orbital motion (i.e. More...
 
void XLALequatorialVect2ecliptic (vect3D_t out, const vect3D_t in)
 Convert 3-D vector from equatorial into ecliptic coordinates. More...
 
void XLALeclipticVect2equatorial (vect3D_t out, const vect3D_t in)
 Convert 3-D vector from ecliptic into equatorial coordinates. More...
 
void XLALmatrix33_in_vect3 (vect3D_t out, mat33_t mat, const vect3D_t in)
 compute matrix product mat . More...
 
vect3Dlist_tXLALComputeOrbitalDerivatives (UINT4 maxorder, const LIGOTimeGPS *tGPS, const EphemerisData *edat)
 Compute time-derivatives up to 'maxorder' of the Earths' orbital position vector \( r_{\mathrm{orb}}(t) \) . More...
 
void XLALDestroyFmetricAtoms (FmetricAtoms_t *atoms)
 Free a FmetricAtoms_t structure, allowing any pointers to be NULL. More...
 
int XLALParseDetectorMotionString (const CHAR *detMotionString)
 Parse a detector-motion type string into the corresponding enum-number,. More...
 
int XLALParseDopplerCoordinateString (const CHAR *coordName)
 Parse a DopplerCoordinate-name into the corresponding DopplerCoordinateID. More...
 
int XLALDopplerCoordinateNames2System (DopplerCoordinateSystem *coordSys, const LALStringVector *coordNames)
 Given a LALStringVector of coordinate-names, parse them into a 'DopplerCoordinateSystem', namely a list of coordinate-IDs. More...
 
int XLALFindDopplerCoordinateInSystem (const DopplerCoordinateSystem *coordSys, const DopplerCoordinateID coordID)
 Given a coordinate ID 'coordID', return its dimension within the given coordinate system 'coordSys', or return -1 if 'coordID' is not found. More...
 
const CHARXLALDetectorMotionName (DetectorMotionType detMotionType)
 Provide a pointer to a static string containing the DopplerCoordinate-name cooresponding to the enum DopplerCoordinateID. More...
 
const CHARXLALDopplerCoordinateName (DopplerCoordinateID coordID)
 Provide a pointer to a static string containing the DopplerCoordinate-name cooresponding to the enum DopplerCoordinateID. More...
 
const CHARXLALDopplerCoordinateHelp (DopplerCoordinateID coordID)
 Provide a pointer to a static string containing the a descriptive 'help-string' describing the coordinate DopplerCoordinateID. More...
 
CHARXLALDopplerCoordinateHelpAll (void)
 Return a string (allocated here) containing a full name - helpstring listing for all doppler-coordinates DopplerCoordinateID allowed by UniversalDopplerMetric.c. More...
 
REAL8 XLALComputePhaseDerivative (REAL8 t, const PulsarDopplerParams *dopplerPoint, DopplerCoordinateID coordID, const EphemerisData *edat, const LALDetector *site, BOOLEAN includeRoemer)
 
void XLALDestroyVect3Dlist (vect3Dlist_t *list)
 

Go to the source code of this file.

Data Structures

struct  vect2Dlist_t
 variable-length list of 2D-vectors More...
 
struct  vect3Dlist_t
 variable-length list of 3D vectors More...
 
struct  PosVel3D_t
 Small Container to hold two 3D vectors: position and velocity. More...
 
struct  DopplerCoordinateSystem
 type describing a Doppler coordinate system: lists the number of dimensions and the symbolic names of the coordinates. More...
 
struct  DopplerMetricParams
 meta-info specifying a Doppler-metric More...
 
struct  FmetricAtoms_t
 Struct to hold the 'atoms', ie weighted phase-derivative averages like \( \langle a^2 \partial_i \phi \partial_j \phi\rangle> \) from which the F-metric is computed, but also the full Fisher-matrix. More...
 
struct  DopplerFstatMetric
 Struct to hold the output of XLALComputeDopplerFstatMetric(), including meta-info on the number of dimensions, the coordinate-system and type of metric. More...
 
struct  DopplerPhaseMetric
 Struct to hold the output of XLALComputeDopplerPhaseMetric(), including meta-info on the number of dimensions, the coordinate-system and type of metric. More...
 

Macros

#define DOPPLERMETRIC_MAX_DIM   60
 should be large enough for a long time ... More...
 

Typedefs

typedef REAL8 vect2D_t[2]
 2D vector More...
 
typedef REAL8 vect3D_t[3]
 3D vector More...
 
typedef REAL8 mat33_t[3][3]
 3x3 matrix, useful for spatial 3D vector operations More...
 

Enumerations

enum  DetectorMotionType {
  DETMOTION_SPIN = 0x01 , DETMOTION_SPINZ = 0x02 , DETMOTION_SPINXY = 0x03 , DETMOTION_MASKSPIN = 0x0F ,
  DETMOTION_ORBIT = 0x10 , DETMOTION_PTOLEORBIT = 0x20 , DETMOTION_MASKORBIT = 0xF0
}
 Bitfield of different types of detector-motion to use in order to compute the Doppler-metric. More...
 
enum  DopplerCoordinateID {
  DOPPLERCOORD_NONE = -1 , DOPPLERCOORD_FREQ , DOPPLERCOORD_F1DOT , DOPPLERCOORD_F2DOT ,
  DOPPLERCOORD_F3DOT , DOPPLERCOORD_F4DOT , DOPPLERCOORD_LASTFDOT = DOPPLERCOORD_F4DOT , DOPPLERCOORD_GC_NU0 ,
  DOPPLERCOORD_GC_NU1 , DOPPLERCOORD_GC_NU2 , DOPPLERCOORD_GC_NU3 , DOPPLERCOORD_GC_NU4 ,
  DOPPLERCOORD_ALPHA , DOPPLERCOORD_DELTA , DOPPLERCOORD_N2X_EQU , DOPPLERCOORD_N2Y_EQU ,
  DOPPLERCOORD_N2X_ECL , DOPPLERCOORD_N2Y_ECL , DOPPLERCOORD_N3X_EQU , DOPPLERCOORD_N3Y_EQU ,
  DOPPLERCOORD_N3Z_EQU , DOPPLERCOORD_N3X_ECL , DOPPLERCOORD_N3Y_ECL , DOPPLERCOORD_N3Z_ECL ,
  DOPPLERCOORD_N3SX_EQU , DOPPLERCOORD_N3SY_EQU , DOPPLERCOORD_N3OX_ECL , DOPPLERCOORD_N3OY_ECL ,
  DOPPLERCOORD_N3OZ_ECL , DOPPLERCOORD_ASINI , DOPPLERCOORD_TASC , DOPPLERCOORD_PORB ,
  DOPPLERCOORD_KAPPA , DOPPLERCOORD_ETA , DOPPLERCOORD_VP , DOPPLERCOORD_DASC ,
  DOPPLERCOORD_KAPPAP , DOPPLERCOORD_ETAP , DOPPLERCOORD_LAST
}
 enum listing symbolic 'names' for all Doppler Coordinates supported by the metric codes in FstatMetric More...