Loading [MathJax]/extensions/TeX/AMSsymbols.js
LALPulsar 7.1.1.1-ea7c608
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages

Generate N samples of various statistics (F-stat, BSGL,...) drawn from their respective distributions, assuming Gaussian noise, and drawing signal params from their (given) priors. More...

Prototypes

int main (int argc, char *argv[])
 MAIN function Generates samples of B-stat and F-stat according to their pdfs for given signal-params. More...
 
int XLALInitUserVars (UserInput_t *uvar)
 Register all our "user-variables" that can be specified from cmd-line and/or config-file. More...
 
int XLALInitCode (ConfigVariables *cfg, const UserInput_t *uvar)
 Initialize Fstat-code: handle user-input and set everything up. More...
 
int XLALInitAmplitudePrior (AmplitudePrior_t *AmpPrior, const UserInput_t *uvar)
 Initialize amplitude-prior pdfs from the user-input. More...
 
int write_BSGL_candidate_to_fp (FILE *fp, const BSGLComponents *stats, const LALStringVector *IFOs, const InjParams_t *injParams, const BOOLEAN haveBSGL)
 Write one line for given BSGL candidate into output file. More...
 
MultiNoiseWeightsXLALComputeConstantMultiNoiseWeightsFromNoiseFloor (const MultiNoiseFloor *multiNoiseFloor, const MultiLIGOTimeGPSVector *multiTS, const UINT4 Tsft)
 

Detailed Description

Generate N samples of various statistics (F-stat, BSGL,...) drawn from their respective distributions, assuming Gaussian noise, and drawing signal params from their (given) priors.

Author
R. Prix, D. Keitel

This is based on synthesizeBstat and synthesizeTransientStats, and is mostly meant to be used for Monte-Carlos studies of ROC curves

Definition in file synthesizeLVStats.c.

Go to the source code of this file.

Data Structures

struct  BSGLComponents
 Type containing multi- and single-detector \( \mathcal{F} \) -statistics and line-robust statistic. More...
 
struct  UserInput_t
 User-variables: can be set from config-file or command-line.
 
struct  ConfigVariables
 Configuration settings required for and defining a coherent pulsar search. More...
 

Macros

#define SQ(x)   ((x)*(x))
 
#define SQUARE(x)   ( (x) * (x) )
 
#define CUBE(x)   ((x)*(x)*(x))
 
#define QUAD(x)   ((x)*(x)*(x)*(x))
 
#define TRUE   (1==1)
 
#define FALSE   (1==0)
 
#define DEFAULT_TRANSIENT   "rect"
 

Variables

int vrbflg
 defined in lal/lib/std/LALError.c More...
 

Macro Definition Documentation

◆ SQ

#define SQ (   x)    ((x)*(x))

Definition at line 67 of file synthesizeLVStats.c.

◆ SQUARE

#define SQUARE (   x)    ( (x) * (x) )

Definition at line 68 of file synthesizeLVStats.c.

◆ CUBE

#define CUBE (   x)    ((x)*(x)*(x))

Definition at line 69 of file synthesizeLVStats.c.

◆ QUAD

#define QUAD (   x)    ((x)*(x)*(x)*(x))

Definition at line 70 of file synthesizeLVStats.c.

◆ TRUE

#define TRUE   (1==1)

Definition at line 71 of file synthesizeLVStats.c.

◆ FALSE

#define FALSE   (1==0)

Definition at line 72 of file synthesizeLVStats.c.

◆ DEFAULT_TRANSIENT

#define DEFAULT_TRANSIENT   "rect"

Function Documentation

◆ main()

int main ( int  argc,
char argv[] 
)

MAIN function Generates samples of B-stat and F-stat according to their pdfs for given signal-params.

Definition at line 177 of file synthesizeLVStats.c.

◆ XLALInitUserVars()

int XLALInitUserVars ( UserInput_t uvar)

Register all our "user-variables" that can be specified from cmd-line and/or config-file.

Here we set defaults for some user-variables and register them with the UserInput module.

Definition at line 387 of file synthesizeLVStats.c.

◆ XLALInitCode()

int XLALInitCode ( ConfigVariables cfg,
const UserInput_t uvar 
)

Initialize Fstat-code: handle user-input and set everything up.

Definition at line 486 of file synthesizeLVStats.c.

◆ XLALInitAmplitudePrior()

int XLALInitAmplitudePrior ( AmplitudePrior_t AmpPrior,
const UserInput_t uvar 
)

Initialize amplitude-prior pdfs from the user-input.

Definition at line 605 of file synthesizeLVStats.c.

◆ write_BSGL_candidate_to_fp()

int write_BSGL_candidate_to_fp ( FILE *  fp,
const BSGLComponents stats,
const LALStringVector IFOs,
const InjParams_t injParams,
const BOOLEAN  haveBSGL 
)

Write one line for given BSGL candidate into output file.

NOTE: input stats and injParams can be NULL pointers, then writes header comment instead

Definition at line 768 of file synthesizeLVStats.c.

◆ XLALComputeConstantMultiNoiseWeightsFromNoiseFloor()

MultiNoiseWeights * XLALComputeConstantMultiNoiseWeightsFromNoiseFloor ( const MultiNoiseFloor multiNoiseFloor,
const MultiLIGOTimeGPSVector multiTS,
const UINT4  Tsft 
)
Parameters
[in]multiNoiseFloornoise floor values sqrt(S) for all detectors
[in]multiTStimestamps vectors for all detectors, only needed for their lengths
[in]Tsftlength of SFTs in secons, needed for normalization factor Sinv_Tsft

Definition at line 830 of file synthesizeLVStats.c.

Variable Documentation

◆ vrbflg

int vrbflg
extern

defined in lal/lib/std/LALError.c