Calculate the expected (multi-IFO) F-statistic for pulsar GW signals, without actually performing a search. The "F-statistic" was introduced in [9] and Cutler-Schutz 2005. Contrary to SemiAnalyticF this code can use (multi-IFO) SFTs to specify the startTime, duration, detectors and noise-floors to use in the estimation. More...

Prototypes
int	main (int argc, char *argv[])
	MAIN function of PredictFstat code. More...

int	initUserVars (UserInput_t *uvar)
	Register all our "user-variables" that can be specified from cmd-line and/or config-file. More...

int	InitPFS (ConfigVariables cfg, UserInput_t uvar)
	Initialized Fstat-code: handle user-input and set everything up. More...

Detailed Description

Calculate the expected (multi-IFO) F-statistic for pulsar GW signals, without actually performing a search. The "F-statistic" was introduced in [9] and Cutler-Schutz 2005. Contrary to SemiAnalyticF this code can use (multi-IFO) SFTs to specify the startTime, duration, detectors and noise-floors to use in the estimation.

Author: I. Gholami, R. Prix

Definition in file PredictFstat.c.

Go to the source code of this file.

Data Structures
struct	ConfigVariables
	Configuration settings required for and defining a coherent pulsar search. More...

struct	UserInput_t
	User-variables: can be set from config-file or command-line.

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

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

ConfigVariables	GV
	global container for various derived configuration settings More...

Macro Definition Documentation

◆ SQ

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

Definition at line 54 of file PredictFstat.c.

Function Documentation

◆ main()

int main	(	int	argc,
		char *	argv[]
	)

MAIN function of PredictFstat code.

Calculates the F-statistic for a given position in the sky and detector semi-analytically and outputs the final 2F value.

Definition at line 128 of file PredictFstat.c.

◆ initUserVars()

int initUserVars ( 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 220 of file PredictFstat.c.

◆ InitPFS()

int InitPFS	(	ConfigVariables *	cfg,
		UserInput_t *	uvar
	)

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

< properties of transient-signal window

Definition at line 304 of file PredictFstat.c.

Variable Documentation

◆ vrbflg

int vrbflg

extern

defined in lal/lib/std/LALError.c

◆ GV

ConfigVariables GV

global container for various derived configuration settings

Definition at line 70 of file PredictFstat.c.

Prototypes