LALPulsar  6.1.0.1-fe68b98
DetectorStates.h File Reference

Prototypes

DetectorStateSeriesXLALCreateDetectorStateSeries (UINT4 length)
 Create a DetectorStateSeries with length entries. More...
 
DetectorStateSeriesXLALGetDetectorStates (const LIGOTimeGPSVector *timestamps, const LALDetector *detector, const EphemerisData *edat, REAL8 tOffset)
 Get the 'detector state' (ie detector-tensor, position, velocity, etc) for the given vector of timestamps, shifted by a common time-shift tOffset. More...
 
MultiDetectorStateSeriesXLALGetMultiDetectorStates (const MultiLIGOTimeGPSVector *multiTS, const MultiLALDetector *multiIFO, const EphemerisData *edat, REAL8 tOffset)
 Get the detector-time series for the given MultiLIGOTimeGPSVector. More...
 
MultiDetectorStateSeriesXLALGetMultiDetectorStatesFromMultiSFTs (const MultiSFTVector *multiSFTs, const EphemerisData *edat, REAL8 tOffset)
 Get the 'detector state' (ie detector-tensor, position, velocity, etc) for the given multi-vector of SFTs, shifted by a common time-shift tOffset. More...
 
int XLALParseMultiLALDetector (MultiLALDetector *detInfo, const LALStringVector *detNames)
 Parse string-vectors (typically input by user) of N detector-names for detectors \( X=1\ldots N \) , returns a MultiLALDetector struct. More...
 
int XLALParseMultiNoiseFloor (MultiNoiseFloor *multiNoiseFloor, const LALStringVector *sqrtSX, UINT4 numDetectors)
 Parse string-vectors (typically input by user) of N detector noise-floors \( \sqrt{S_X} \) for detectors \( X=1\ldots N \) , where here we assume equal number of SFTs per detector such that \( S^{-1} = \frac{1}{N}\sum_{X=0}^{N-1} S_X^{-1} \) . More...
 
int XLALParseMultiNoiseFloorMapped (MultiNoiseFloor *multiNoiseFloor, const LALStringVector *multiNoiseFloorDetNames, const LALStringVector *sqrtSX, const LALStringVector *sqrtSXDetNames)
 Parse string-vectors (typically input by user) of N detector noise-floors \( \sqrt{S_X} \) for detectors \( X=1\ldots N \) , where here we assume equal number of SFTs per detector such that \( S^{-1} = \frac{1}{N}\sum_{X=0}^{N-1} S_X^{-1} \) . More...
 
int XLALMultiLALDetectorFromMultiSFTCatalogView (MultiLALDetector *multiIFO, const MultiSFTCatalogView *multiView)
 Extract multi detector-info from a given multi SFTCatalog view. More...
 
int XLALMultiLALDetectorFromMultiSFTs (MultiLALDetector *multiIFO, const MultiSFTVector *multiSFTs)
 Extract multi detector-info from a given multi SFTCatalog view. More...
 
int XLALAddSymmTensor3s (SymmTensor3 *sum, const SymmTensor3 *aT, const SymmTensor3 *bT)
 Convenience function for adding two SymmTensor3s: aT + bT NOTE: it is safe to have sum point to the same tensor-struct as either aT or bT. More...
 
int XLALSubtractSymmTensor3s (SymmTensor3 *diff, const SymmTensor3 *aT, const SymmTensor3 *bT)
 Convenience function for subtracting two SymmTensor3s: aT - bT NOTE: it is safe to have diff point to the same tensor-struct as either aT or bT. More...
 
int XLALScaleSymmTensor3 (SymmTensor3 *mult, const SymmTensor3 *aT, REAL4 factor)
 Convenience function for multiplying a SymmTensor3 by a scalar factor. More...
 
int XLALTensorSquareVector3 (SymmTensor3 *vxv, REAL4 v[3])
 Compute the "squared-tensor" v x v for given vector v, the result is returned in a "detectorTensor" struct. More...
 
int XLALSymmetricTensorProduct3 (SymmTensor3 *vxw, REAL4 v[3], REAL4 w[3])
 Compute the symmetrized tensor product T = v x w + w x v. More...
 
REAL4 XLALContractSymmTensor3s (const SymmTensor3 *T1, const SymmTensor3 *T2)
 Contract two symmetric tensors over both indices T1 : T2. More...
 
void XLALDestroyDetectorStateSeries (DetectorStateSeries *detStates)
 Get rid of a DetectorStateSeries. More...
 
void XLALDestroyMultiDetectorStateSeries (MultiDetectorStateSeries *mdetStates)
 Helper function to get rid of a multi-IFO DetectorStateSeries Note, this is "NULL-robust" in the sense that it will not crash on NULL-entries anywhere in this struct, so it can be used for failure-cleanup even on incomplete structs. More...
 

Go to the source code of this file.

Data Structures

struct  SymmTensor3
 A symmetric 3x3 tensor (such as detector-tensors), storing only the upper triangle. More...
 
struct  SymmTensor3d
 A symmetric 3x3 tensor (such as detector-tensors), storing only the upper triangle, using REAL8 precision. More...
 
struct  DetectorArm
 Struct containing pre-computed quantites describing a single detector arm: unit-vector along detector-arm, arm-length, and arm "basis-tensor" n x n. More...
 
struct  MultiLALDetector
 array of detectors definitions 'LALDetector' More...
 
struct  MultiNoiseFloor
 array of detector-specific 'noise floors' (ie PSD values), assumed constant over the frequency-band of interest More...
 
struct  DetectorState
 State-info about position, velocity and LMST of a detector together with corresponding EarthState. More...
 
struct  DetectorStateSeries
 Timeseries of DetectorState's, representing the detector-info at different timestamps. More...
 
struct  MultiDetectorStateSeries
 Multi-IFO time-series of DetectorStates. More...
 

Macros

Error-codes
#define DETECTORSTATES_ENULL   1
 
#define DETECTORSTATES_ENONULL   2
 
#define DETECTORSTATES_EINPUT   3
 
#define DETECTORSTATES_EMEM   4
 
#define DETECTORSTATES_EXLAL   5
 
#define DETECTORSTATES_EIEEE   6
 
#define DETECTORSTATES_MSGENULL   "Arguments contained an unexpected null pointer"
 
#define DETECTORSTATES_MSGENONULL   "Output pointer is non-NULL"
 
#define DETECTORSTATES_MSGEINPUT   "Invalid input"
 
#define DETECTORSTATES_MSGEMEM   "Out of memory. Bad."
 
#define DETECTORSTATES_MSGEXLAL   "XLAL function call failed"
 
#define DETECTORSTATES_MSGEIEEE   "Floating point failure"
 

Typedefs

typedef DetectorArm Detector3Arms[3]
 used to allow functions some type/size checking More...