Some helper functions useful for "transient CWs", mostly applying transient window functions. More...

Prototypes
static int	XLALCreateExpLUT (void)
	Generate an exponential lookup-table expLUT for e^(-x) over the interval x in [0, xmax], using 'length' points. More...

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...

CHAR *	XLALPulsarDopplerParams2String (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...

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...

transientFstatMap_t *	XLALComputeTransientFstatMap (const MultiFstatAtomVector *multiFstatAtoms, transientWindowRange_t windowRange, BOOLEAN useFReg)
	Function to compute transient-window "F-statistic map" over start-time and timescale {t0, tau}. More...

FstatAtomVector *	XLALmergeMultiFstatAtomsBinned (const MultiFstatAtomVector *multiAtoms, UINT4 deltaT)
	Combine N Fstat-atoms vectors into a single 'canonical' binned and ordered atoms-vector. 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...

int	write_MultiFstatAtoms_to_fp (LALFILE fp, const MultiFstatAtomVector multiAtoms)
	Write multi-IFO F-stat atoms 'multiAtoms' into output stream 'fstat'. 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...

void	XLALDestroyExpLUT (void)
	Destructor function for expLUT_t lookup table. More...

REAL8	XLALFastNegExp (REAL8 mx)
	Fast exponential function e^-x using lookup-table (LUT). More...

Detailed Description

Some helper functions useful for "transient CWs", mostly applying transient window functions.

Author: R. Prix, S. Giampanis

Definition in file TransientCW_utils.c.

Go to the source code of this file.

Macros
#define	EXPLUT_XMAX 20.0
	Lookup-table for negative exponentials e^(-x) Holds an array 'data' of 'length' for values e^(-x) for x in the range [0, xmax]. More...

#define	EXPLUT_LENGTH 2000

#define	EXPLUT_DXINV ((EXPLUT_LENGTH)/(EXPLUT_XMAX))

#define	MAXLEN 1024

Variables
static gsl_vector *	expLUT = NULL
	module-global lookup-table for negative exponentials e^(-x) More...

static const char *	transientWindowNames [TRANSIENT_LAST]

Macro Definition Documentation

◆ EXPLUT_XMAX

#define EXPLUT_XMAX 20.0

Lookup-table for negative exponentials e^(-x) Holds an array 'data' of 'length' for values e^(-x) for x in the range [0, xmax].

Definition at line 54 of file TransientCW_utils.c.

◆ EXPLUT_LENGTH

#define EXPLUT_LENGTH 2000

Definition at line 55 of file TransientCW_utils.c.

◆ EXPLUT_DXINV

#define EXPLUT_DXINV ((EXPLUT_LENGTH)/(EXPLUT_XMAX))

Definition at line 57 of file TransientCW_utils.c.

◆ MAXLEN

#define MAXLEN 1024

Variable Documentation

◆ expLUT

gsl_vector* expLUT = NULL

static

module-global lookup-table for negative exponentials e^(-x)

Definition at line 56 of file TransientCW_utils.c.

◆ transientWindowNames

const char* transientWindowNames[TRANSIENT_LAST]

static

Initial value:

= {
  [TRANSIENT_NONE]            = "none",
  [TRANSIENT_RECTANGULAR]     = "rect",
  [TRANSIENT_EXPONENTIAL]     = "exp"
}

Definition at line 61 of file TransientCW_utils.c.

Prototypes