This module deals with calculating various F-statistic metric approximations, Fisher matrices and mismatches. Contrary to previous implementations this consistently uses gsl-integration, and allows for very generic handling of different coordinate systems in the Doppler parameter space. More...

Prototypes
int	initUserVars (UserVariables_t *uvar)
	register all "user-variables" More...

int	XLALInitCode (ConfigVariables cfg, const UserVariables_t uvar, const char *app_name)
	basic initializations: set-up 'ConfigVariables' More...

int	XLALOutputDopplerMetric (FILE fp, const DopplerPhaseMetric Pmetric, const DopplerFstatMetric Fmetric, const ResultHistory_t history)

int	XLALDestroyConfig (ConfigVariables *cfg)
	Destructor for internal configuration struct. More...

void	XLALDestroyResultHistory (ResultHistory_t *history)
	Destructor for ResultHistory type. More...

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

Detailed Description

This module deals with calculating various F-statistic metric approximations, Fisher matrices and mismatches. Contrary to previous implementations this consistently uses gsl-integration, and allows for very generic handling of different coordinate systems in the Doppler parameter space.

Author: Reinhard Prix

In particular, it allows for easy extensions to new coordinates and Doppler parameters.

Definition in file FstatMetric_v2.c.

Go to the source code of this file.

Data Structures
struct	ResultHistory_t
	Rudimentary first sketch of a history type, to encode all the history-trail leading to a certain result from primal inputs. More...

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

struct	UserVariables_t
	user input variables More...

Macros
#define	FSTATMETRIC_EMEM 1

#define	FSTATMETRIC_EINPUT 2

#define	FSTATMETRIC_ENULL 3

#define	FSTATMETRIC_ENONULL 4

#define	FSTATMETRIC_EFILE 5

#define	FSTATMETRIC_EXLAL 6

#define	FSTATMETRIC_MSGEMEM "Out of memory."

#define	FSTATMETRIC_MSGEINPUT "Invalid input."

#define	FSTATMETRIC_MSGENULL "Illegal NULL input"

#define	FSTATMETRIC_MSGENONULL "Output field not initialized to NULL"

#define	FSTATMETRIC_MSGEFILE "File IO error"

#define	FSTATMETRIC_MSGEXLAL "XLAL function call failed"

#define	METRIC_FORMAT "% .16e" /* fprintf-format used for printing metric components */

#define	TRUE (1==1)

#define	FALSE (1==0)

#define	OneBillion 1.0e9

#define	ORB_V0 1e-4

#define	GPS2REAL8(gps) (1.0 * (gps).gpsSeconds + 1.e-9 * (gps).gpsNanoSeconds )
	convert GPS-time to REAL8 More...

#define	SCALAR(u, v) ((u)[0](v)[0] + (u)[1](v)[1] + (u)[2]*(v)[2])
	Simple Euklidean scalar product for two 3-dim vectors in cartesian coords. More...

#define	COPY_VECT(dst, src) do { (dst)[0] = (src)[0]; (dst)[1] = (src)[1]; (dst)[2] = (src)[2]; } while(0)
	copy 3 components of Euklidean vector More...

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

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

Macro Definition Documentation

◆ FSTATMETRIC_EMEM

#define FSTATMETRIC_EMEM 1

Definition at line 60 of file FstatMetric_v2.c.

◆ FSTATMETRIC_EINPUT

#define FSTATMETRIC_EINPUT 2

Definition at line 61 of file FstatMetric_v2.c.

◆ FSTATMETRIC_ENULL

#define FSTATMETRIC_ENULL 3

Definition at line 62 of file FstatMetric_v2.c.

◆ FSTATMETRIC_ENONULL

#define FSTATMETRIC_ENONULL 4

Definition at line 63 of file FstatMetric_v2.c.

◆ FSTATMETRIC_EFILE

#define FSTATMETRIC_EFILE 5

Definition at line 64 of file FstatMetric_v2.c.

◆ FSTATMETRIC_EXLAL

#define FSTATMETRIC_EXLAL 6

Definition at line 65 of file FstatMetric_v2.c.

◆ FSTATMETRIC_MSGEMEM

#define FSTATMETRIC_MSGEMEM "Out of memory."

Definition at line 68 of file FstatMetric_v2.c.

◆ FSTATMETRIC_MSGEINPUT

#define FSTATMETRIC_MSGEINPUT "Invalid input."

Definition at line 69 of file FstatMetric_v2.c.

◆ FSTATMETRIC_MSGENULL

#define FSTATMETRIC_MSGENULL "Illegal NULL input"

Definition at line 70 of file FstatMetric_v2.c.

◆ FSTATMETRIC_MSGENONULL

#define FSTATMETRIC_MSGENONULL "Output field not initialized to NULL"

Definition at line 71 of file FstatMetric_v2.c.

◆ FSTATMETRIC_MSGEFILE

#define FSTATMETRIC_MSGEFILE "File IO error"

Definition at line 72 of file FstatMetric_v2.c.

◆ FSTATMETRIC_MSGEXLAL

#define FSTATMETRIC_MSGEXLAL "XLAL function call failed"

Definition at line 73 of file FstatMetric_v2.c.

◆ METRIC_FORMAT

#define METRIC_FORMAT "% .16e" /* fprintf-format used for printing metric components */

Definition at line 79 of file FstatMetric_v2.c.

◆ TRUE

#define TRUE (1==1)

Definition at line 82 of file FstatMetric_v2.c.

◆ FALSE

#define FALSE (1==0)

Definition at line 83 of file FstatMetric_v2.c.

◆ OneBillion

#define OneBillion 1.0e9

Definition at line 85 of file FstatMetric_v2.c.

◆ ORB_V0

#define ORB_V0 1e-4

Definition at line 86 of file FstatMetric_v2.c.

◆ GPS2REAL8

#define GPS2REAL8 ( gps ) (1.0 * (gps).gpsSeconds + 1.e-9 * (gps).gpsNanoSeconds )

convert GPS-time to REAL8

Definition at line 90 of file FstatMetric_v2.c.

◆ SCALAR

#define SCALAR	(	u,
		v
	)	((u)[0](v)[0] + (u)[1](v)[1] + (u)[2]*(v)[2])

Simple Euklidean scalar product for two 3-dim vectors in cartesian coords.

Definition at line 93 of file FstatMetric_v2.c.

◆ COPY_VECT

#define COPY_VECT	(	dst,
		src
	)	do { (dst)[0] = (src)[0]; (dst)[1] = (src)[1]; (dst)[2] = (src)[2]; } while(0)

copy 3 components of Euklidean vector

Definition at line 96 of file FstatMetric_v2.c.

◆ SQ

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

Definition at line 98 of file FstatMetric_v2.c.

Function Documentation

◆ initUserVars()

int initUserVars ( UserVariables_t * uvar )

register all "user-variables"

Definition at line 299 of file FstatMetric_v2.c.

◆ XLALInitCode()

int XLALInitCode	(	ConfigVariables *	cfg,
		const UserVariables_t *	uvar,
		const char *	app_name
	)

basic initializations: set-up 'ConfigVariables'

Definition at line 388 of file FstatMetric_v2.c.

◆ XLALOutputDopplerMetric()

int XLALOutputDopplerMetric	(	FILE *	fp,
		const DopplerPhaseMetric *	Pmetric,
		const DopplerFstatMetric *	Fmetric,
		const ResultHistory_t *	history
	)

Definition at line 529 of file FstatMetric_v2.c.

◆ XLALDestroyConfig()

int XLALDestroyConfig ( ConfigVariables * cfg )

Destructor for internal configuration struct.

Definition at line 509 of file FstatMetric_v2.c.

◆ XLALDestroyResultHistory()

void XLALDestroyResultHistory ( ResultHistory_t * history )

Destructor for ResultHistory type.

Definition at line 701 of file FstatMetric_v2.c.

◆ main()

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

Definition at line 189 of file FstatMetric_v2.c.

Variable Documentation

◆ vrbflg

int vrbflg

extern

defined in lal/lib/std/LALError.c

Prototypes