Calculate the F-statistic for a given parameter-space of pulsar GW signals. Implements the so-called "F-statistic" as introduced in [9] . More...

Prototypes
int	main (int argc, char *argv[])
	MAIN function of ComputeFstatistic 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	InitFstat (ConfigVariables cfg, const UserInput_t uvar)
	Initialized Fstat-code: handle user-input and set everything up. More...

void	Freemem (ConfigVariables *cfg)
	Free all globally allocated memory. More...

int	checkUserInputConsistency (const UserInput_t *uvar)
	Some general consistency-checks on user-input. More...

int	outputBeamTS (const CHAR fname, const AMCoeffs amcoe, const DetectorStateSeries *detStates)

MultiNoiseWeights *	getUnitWeights (const MultiSFTVector *multiSFTs)

int	write_FstatCandidate_to_fp (FILE fp, const FstatCandidate thisFCand, const BOOLEAN output_stats, const BOOLEAN output_orbit)
	write one 'FstatCandidate' (i.e. More...

int	write_PulsarCandidate_to_fp (FILE fp, const PulsarCandidate pulsarParams, const FstatCandidate *Fcand)
	write full 'PulsarCandidate' (i.e. More...

int	compareFstatCandidates (const void candA, const void candB)
	comparison function for our candidates toplist More...

int	compareFstatCandidates_BSGL (const void candA, const void candB)
	comparison function for our candidates toplist with alternate sorting statistic BSGL=log10BSGL More...

int	WriteFstatLog (const CHAR log_fname, const CHAR log_string)
	Log the all relevant parameters of the present search-run to a log-file. More...

CHAR *	XLALGetLogString (const ConfigVariables *cfg, const BOOLEAN verbose)
	Produce a log-string describing the present run-setup. More...

int	write_TimingInfo (const CHAR fname, const timingInfo_t ti, const ConfigVariables *cfg)
	Function to append one timing-info line to output file. More...

gsl_vector_int *	resize_histogram (gsl_vector_int *old_hist, size_t size)

scanlineWindow_t *	XLALCreateScanlineWindow (UINT4 windowWings)
	Create a scanline window, with given windowWings >= 0. More...

void	XLALDestroyScanlineWindow (scanlineWindow_t *scanlineWindow)

int	XLALAdvanceScanlineWindow (const FstatCandidate nextCand, scanlineWindow_t scanWindow)
	Advance by pushing a new candidate into the scanline-window. More...

BOOLEAN	XLALCenterIsLocalMax (const scanlineWindow_t *scanWindow, const UINT4 rankingStatistic)
	check wether central candidate in Scanline-window is a local maximum More...

Detailed Description

Calculate the F-statistic for a given parameter-space of pulsar GW signals. Implements the so-called "F-statistic" as introduced in [9] .

Author: R. Prix, I. Gholami, Y. Ioth, Papa, X. Siemens, C. Messenger, K. Wette

This code is a descendant of an earlier implementation 'ComputeFStatistic.[ch]' by Bruce Allen, Bernd Machenschalk, David Hammer, Jolien Creighton, Maria Alessandra Papa, Reinhard Prix, Xavier Siemens, Scott Koranda, Yousuke Itoh

Definition in file ComputeFstatistic_v2.c.

Go to the source code of this file.

Data Structures
struct	FstatCandidate
	What info do we want to store in our toplist? More...

struct	scanlineWindow_t
	moving 'Scanline window' of candidates on the scan-line, which is used to find local 1D maxima. More...

struct	timingInfo_t
	Struct holding various timing measurements and relevant search parameters. More...

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	TRUE (1==1)

#define	FALSE (1==0)

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

#define	MYMAX(x, y) ( (x) > (y) ? (x) : (y) )
	convert GPS-time to REAL8 More...

#define	MYMIN(x, y) ( (x) < (y) ? (x) : (y) )

#define	LAL_NAN XLALREAL4FailNaN()

#define	GETTIME XLALGetCPUTime

#define	BUFLEN 1024

Enumerations
enum	RankingStat_t { RANKBY_2F = 0 , RANKBY_NC = 1 , RANKBY_BSGL = 2 }
	Enum for which statistic is used to "rank" significance of candidates. More...

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

Macro Definition Documentation

◆ TRUE

#define TRUE (1==1)

Definition at line 77 of file ComputeFstatistic_v2.c.

◆ FALSE

#define FALSE (1==0)

Definition at line 78 of file ComputeFstatistic_v2.c.

◆ SQ

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

Definition at line 79 of file ComputeFstatistic_v2.c.

◆ MYMAX

#define MYMAX	(	x,
		y
	)	( (x) > (y) ? (x) : (y) )

convert GPS-time to REAL8

Definition at line 85 of file ComputeFstatistic_v2.c.

◆ MYMIN

#define MYMIN	(	x,
		y
	)	( (x) < (y) ? (x) : (y) )

Definition at line 86 of file ComputeFstatistic_v2.c.

◆ LAL_NAN

#define LAL_NAN XLALREAL4FailNaN()

Definition at line 89 of file ComputeFstatistic_v2.c.

◆ GETTIME

#define GETTIME XLALGetCPUTime

Definition at line 349 of file ComputeFstatistic_v2.c.

◆ BUFLEN

#define BUFLEN 1024

Enumeration Type Documentation

◆ RankingStat_t

enum RankingStat_t

Enum for which statistic is used to "rank" significance of candidates.

Enumerator
RANKBY_2F	rank candidates by F-statistic
RANKBY_NC	HierarchSearchGCT also has RANKBY_NC = 1, not applicable here.
RANKBY_BSGL	rank candidates by BSGListic

Definition at line 139 of file ComputeFstatistic_v2.c.

Function Documentation

◆ main()

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

MAIN function of ComputeFstatistic code.

Calculate the F-statistic over a given portion of the parameter-space and write a list of 'candidates' into a file(default: 'Fstats').

Definition at line 360 of file ComputeFstatistic_v2.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 931 of file ComputeFstatistic_v2.c.

◆ InitFstat()

int InitFstat	(	ConfigVariables *	cfg,
		const UserInput_t *	uvar
	)

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

NOTE: the logical order of things in here is very important, so be careful

Definition at line 1170 of file ComputeFstatistic_v2.c.

◆ Freemem()

void Freemem ( ConfigVariables * cfg )

Free all globally allocated memory.

Definition at line 1692 of file ComputeFstatistic_v2.c.

◆ checkUserInputConsistency()

int checkUserInputConsistency ( const UserInput_t * uvar )

Some general consistency-checks on user-input.

Throws an error plus prints error-message if problems are found.

Definition at line 1750 of file ComputeFstatistic_v2.c.

◆ outputBeamTS()

int outputBeamTS	(	const CHAR *	fname,
		const AMCoeffs *	amcoe,
		const DetectorStateSeries *	detStates
	)

Definition at line 1922 of file ComputeFstatistic_v2.c.

◆ getUnitWeights()

MultiNoiseWeights * getUnitWeights ( const MultiSFTVector * multiSFTs )

◆ write_FstatCandidate_to_fp()

int write_FstatCandidate_to_fp	(	FILE *	fp,
		const FstatCandidate *	thisFCand,
		const BOOLEAN	output_stats,
		const BOOLEAN	output_orbit
	)

write one 'FstatCandidate' (i.e.

only Doppler-params + Fstat) into file 'fp'. Return: 0 = OK, -1 = ERROR

Definition at line 2095 of file ComputeFstatistic_v2.c.

◆ write_PulsarCandidate_to_fp()

int write_PulsarCandidate_to_fp	(	FILE *	fp,
		const PulsarCandidate *	pulsarParams,
		const FstatCandidate *	Fcand
	)

write full 'PulsarCandidate' (i.e.

Doppler params + Amplitude params + error-bars + Fa,Fb, F, + A,B,C,D RETURN 0 = OK, -1 = ERROR

Definition at line 1960 of file ComputeFstatistic_v2.c.

◆ compareFstatCandidates()

int compareFstatCandidates	(	const void *	candA,
		const void *	candB
	)

comparison function for our candidates toplist

Definition at line 2060 of file ComputeFstatistic_v2.c.

◆ compareFstatCandidates_BSGL()

int compareFstatCandidates_BSGL	(	const void *	candA,
		const void *	candB
	)

comparison function for our candidates toplist with alternate sorting statistic BSGL=log10BSGL

Definition at line 2076 of file ComputeFstatistic_v2.c.

◆ WriteFstatLog()

int WriteFstatLog	(	const CHAR *	log_fname,
		const CHAR *	log_string
	)

Log the all relevant parameters of the present search-run to a log-file.

The name of the log-file is log_fname NOTE: Currently this function only logs the user-input and code-versions.

Definition at line 1673 of file ComputeFstatistic_v2.c.

◆ XLALGetLogString()

CHAR * XLALGetLogString	(	const ConfigVariables *	cfg,
		const BOOLEAN	verbose
	)

Produce a log-string describing the present run-setup.

Definition at line 1605 of file ComputeFstatistic_v2.c.

◆ write_TimingInfo()

int write_TimingInfo	(	const CHAR *	timingFile,
		const timingInfo_t *	ti,
		const ConfigVariables *	cfg
	)

Function to append one timing-info line to output file.

Definition at line 2253 of file ComputeFstatistic_v2.c.

◆ resize_histogram()

gsl_vector_int * resize_histogram	(	gsl_vector_int *	old_hist,
		size_t	size
	)

Definition at line 2286 of file ComputeFstatistic_v2.c.

◆ XLALCreateScanlineWindow()

scanlineWindow_t * XLALCreateScanlineWindow ( UINT4 windowWings )

Create a scanline window, with given windowWings >= 0.

Note: the actual window-size is 1 + 2 * windowWings

Parameters

windowWings number of neighbors on each side in scanlineWindow

Definition at line 2153 of file ComputeFstatistic_v2.c.

◆ XLALDestroyScanlineWindow()

void XLALDestroyScanlineWindow ( scanlineWindow_t * scanlineWindow )

Definition at line 2170 of file ComputeFstatistic_v2.c.

◆ XLALAdvanceScanlineWindow()

int XLALAdvanceScanlineWindow	(	const FstatCandidate *	nextCand,
		scanlineWindow_t *	scanWindow
	)

Advance by pushing a new candidate into the scanline-window.

Definition at line 2190 of file ComputeFstatistic_v2.c.

◆ XLALCenterIsLocalMax()

BOOLEAN XLALCenterIsLocalMax	(	const scanlineWindow_t *	scanWindow,
		const UINT4	sortingStatistic
	)

check wether central candidate in Scanline-window is a local maximum

Definition at line 2212 of file ComputeFstatistic_v2.c.

Variable Documentation

◆ vrbflg

int vrbflg

extern

defined in lal/lib/std/LALError.c

Prototypes