LALPulsar  6.1.0.1-08ee4f4
TransientCW_utils.h File Reference

Prototypes

int XLALParseTransientWindowName (const char *windowName)
 Parse a transient window name string into the corresponding transientWindowType. More...
 
int XLALGetTransientWindowTimespan (UINT4 *t0, UINT4 *t1, transientWindow_t transientWindow)
 Helper-function to determine the total timespan of a transient CW window, ie. More...
 
int XLALApplyTransientWindow (REAL4TimeSeries *series, transientWindow_t transientWindow)
 apply a "transient CW window" described by TransientWindowParams to the given timeseries More...
 
int XLALApplyTransientWindow2NoiseWeights (MultiNoiseWeights *multiNoiseWeights, const MultiLIGOTimeGPSVector *multiTS, transientWindow_t transientWindow)
 apply transient window to give multi noise-weights, associated with given multi timestamps More...
 
int write_transientCandidate_to_fp (LALFILE *fp, const transientCandidate_t *thisCand, const char timeUnit)
 Write one line for given transient CW candidate into output file. More...
 
int write_transientFstatMap_to_fp (LALFILE *fp, const transientFstatMap_t *FstatMap, const transientWindowRange_t *windowRange, const PulsarDopplerParams *doppler)
 Write full set of t0 and tau grid points (assumed at fixed Doppler parameters) into output file. More...
 
int write_transientCandidateAll_to_fp (LALFILE *fp, const transientCandidate_t *thisCand)
 Write full set of t0 and tau grid points for given transient CW candidate into output file. More...
 
transientFstatMap_tXLALComputeTransientFstatMap (const MultiFstatAtomVector *multiFstatAtoms, transientWindowRange_t windowRange, BOOLEAN useFReg)
 Function to compute transient-window "F-statistic map" over start-time and timescale {t0, tau}. More...
 
REAL8 XLALComputeTransientBstat (transientWindowRange_t windowRange, const transientFstatMap_t *FstatMap)
 Compute transient-CW Bayes-factor B_SG = P(x|HypS)/P(x|HypG) (where HypG = Gaussian noise hypothesis), marginalized over start-time and timescale of transient CW signal, using given type and parameters of transient window range. More...
 
pdf1D_t * XLALComputeTransientPosterior_t0 (transientWindowRange_t windowRange, const transientFstatMap_t *FstatMap)
 Compute transient-CW posterior (normalized) on start-time t0, using given type and parameters of transient window range. More...
 
pdf1D_t * XLALComputeTransientPosterior_tau (transientWindowRange_t windowRange, const transientFstatMap_t *FstatMap)
 Compute transient-CW posterior (normalized) on timescale tau, using given type and parameters of transient window range. More...
 
void XLALDestroyTransientFstatMap (transientFstatMap_t *FstatMap)
 Standard destructor for transientFstatMap_t Fully NULL-robust as usual. More...
 
void XLALDestroyTransientCandidate (transientCandidate_t *cand)
 Standard destructor for transientCandidate_t Fully NULL-robust as usual. More...
 
REAL8 XLALFastNegExp (REAL8 mx)
 Fast exponential function e^-x using lookup-table (LUT). More...
 
void XLALDestroyExpLUT (void)
 Destructor function for expLUT_t lookup table. More...
 
int write_MultiFstatAtoms_to_fp (LALFILE *fp, const MultiFstatAtomVector *multiAtoms)
 Write multi-IFO F-stat atoms 'multiAtoms' into output stream 'fstat'. More...
 
CHARXLALPulsarDopplerParams2String (const PulsarDopplerParams *par)
 Turn pulsar doppler-params into a single string that can be used for filenames The format is tRefNNNNNN_RAXXXXX_DECXXXXXX_FreqXXXXX[_f1dotXXXXX][_f2dotXXXXx][_f3dotXXXXX]. More...
 
FstatAtomVectorXLALmergeMultiFstatAtomsBinned (const MultiFstatAtomVector *multiAtoms, UINT4 deltaT)
 Combine N Fstat-atoms vectors into a single 'canonical' binned and ordered atoms-vector. More...
 
static REAL8 XLALGetRectangularTransientWindowValue (UINT4 timestamp, UINT4 t0, UINT4 t1)
 Function to compute the value of a rectangular transient-window at a given timestamp. More...
 
static REAL8 XLALGetExponentialTransientWindowValue (UINT4 timestamp, UINT4 t0, UINT4 t1, UINT4 tau)
 Function to compute the value of an exponential transient-window at a given timestamp. More...
 
static REAL8 XLALGetTransientWindowValue (UINT4 timestamp, UINT4 t0, UINT4 t1, UINT4 tau, transientWindowType_t type)
 Function to compute the value of a given transient-window function at a given timestamp. More...
 

Go to the source code of this file.

Data Structures

struct  transientWindowRange_t
 Struct defining a range of transient windows. More...
 
struct  transientFstatMap_t
 Struct holding a transient-window "F-statistic map" over start-time and timescale {t0, tau}. More...
 
struct  transientCandidate_t
 Struct holding a transient CW candidate. More...
 

Macros

#define DAY24   (24 * 3600)
 standard 24h day = 86400 seconds ==> this is what's used in the definition of 'tauDays' More...
 
#define TRANSIENT_EXP_EFOLDING   3.0
 e-folding parameter for exponential window, after which we truncate the window for efficiency. More...