LALPulsar  6.1.0.1-89842e6
synthesizeTransientStats.c File Reference

Generate N samples of various statistics (F-stat, B-stat,...) 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...
 

Detailed Description

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

Author
R. Prix

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

Definition in file synthesizeTransientStats.c.

Go to the source code of this file.

Data Structures

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 CUBE(x)   ((x)*(x)*(x))
 
#define QUAD(x)   ((x)*(x)*(x)*(x))
 
#define min(a, b)   ((a)<(b)?(a):(b))
 
#define max(a, b)   ((a)>(b)?(a):(b))
 
#define DEFAULT_IFO   "H1"
 
#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 64 of file synthesizeTransientStats.c.

◆ CUBE

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

Definition at line 65 of file synthesizeTransientStats.c.

◆ QUAD

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

Definition at line 66 of file synthesizeTransientStats.c.

◆ min

#define min (   a,
 
)    ((a)<(b)?(a):(b))

Definition at line 70 of file synthesizeTransientStats.c.

◆ max

#define max (   a,
 
)    ((a)>(b)?(a):(b))

Definition at line 73 of file synthesizeTransientStats.c.

◆ DEFAULT_IFO

#define DEFAULT_IFO   "H1"

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

< various derived configuration settings

Definition at line 175 of file synthesizeTransientStats.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 476 of file synthesizeTransientStats.c.

◆ XLALInitCode()

int XLALInitCode ( ConfigVariables cfg,
const UserInput_t uvar 
)

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

Definition at line 610 of file synthesizeTransientStats.c.

◆ XLALInitAmplitudePrior()

int XLALInitAmplitudePrior ( AmplitudePrior_t AmpPrior,
const UserInput_t uvar 
)

Initialize amplitude-prior pdfs from the user-input.

Definition at line 839 of file synthesizeTransientStats.c.

Variable Documentation

◆ vrbflg

int vrbflg
extern

defined in lal/lib/std/LALError.c