Calculates the C-statistic for a given parameter-space of GW signals from binary sources with known sky position. More...

Prototypes
const char *	va (const char *format,...)

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

int	initUserVars (int argc, char argv[], UserInput_t uvar)
	initUserVars function Register "user-variables" specified from cmd-line and/or config-file. More...

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

int	ReadInput (UserInput_t uvar, ParamStruct userParams, VectorStruct Fstat, ExRegion exr)
	ReadInput function reads user input and Fstat file and assigns parameter values and Fstat array. More...

int	createComb (ParamStruct userParams, VectorStruct comb, ExRegion *exr)
	createComb function use userParams to create comb template More...

int	createTopHat (ParamStruct userParams, VectorStruct tophat, ExRegion *exr)
	createTopHat function use userParams to create tophat template if tophat flag is raised More...

int	ComputeCstat (VectorStruct template, VectorStruct Fstat, VectorStruct Cstat, ExRegion exr)
	ComputeCstat function uses comb and Fstat structures to calculate the Cstat. More...

int	OutputCstats (UserInput_t uvar, ParamStruct userParams, VectorStruct Fstat, VectorStruct Cstat, ExRegion *exr)

Detailed Description

Calculates the C-statistic for a given parameter-space of GW signals from binary sources with known sky position.

Author: L.Sammut, C. Messenger

Uses outputFstat file of lalpulsar_ComputeFstatistic_v2.c as input.

Definition in file CombSearch.c.

Go to the source code of this file.

Data Structures
struct	VectorStruct
	A structure for frequency series. More...

struct	ParamStruct
	A structure for template parameters. More...

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

struct	ExRegion
	A structure for information on the exclusion region needed to avoid edge effects in calculation of Cstat. More...

Macros
#define	MAXLINELENGTH 1024 /* Maximum # of characters of in a line */

#define	TRUE (1==1)

#define	FALSE (1==0)

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

Macro Definition Documentation

◆ MAXLINELENGTH

#define MAXLINELENGTH 1024 /* Maximum # of characters of in a line */

Definition at line 70 of file CombSearch.c.

◆ TRUE

#define TRUE (1==1)

Definition at line 71 of file CombSearch.c.

◆ FALSE

#define FALSE (1==0)

Definition at line 72 of file CombSearch.c.

Function Documentation

◆ va()

const char * va	(	const char *	format,
			...
	)

◆ main()

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

MAIN function of sb_search code.

Calculate the C-statistic over a given portion of the parameter-space and write output into a file(default: 'Cstats').

Definition at line 152 of file CombSearch.c.

◆ initUserVars()

int initUserVars	(	int	argc,
		char *	argv[],
		UserInput_t *	uvar
	)

initUserVars function Register "user-variables" specified from cmd-line and/or config-file.

Set defaults for some user-variables and register them with the UserInput module.

Definition at line 253 of file CombSearch.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 288 of file CombSearch.c.

◆ ReadInput()

int ReadInput	(	UserInput_t *	uvar,
		ParamStruct *	userParams,
		VectorStruct *	Fstat,
		ExRegion *	exr
	)

ReadInput function reads user input and Fstat file and assigns parameter values and Fstat array.

Definition at line 314 of file CombSearch.c.

◆ createComb()

int createComb	(	ParamStruct *	userParams,
		VectorStruct *	comb,
		ExRegion *	exr
	)

createComb function use userParams to create comb template

function creates template of unit amplitude spikes at 1 zero spike +/- mm spikes on either side separated by 1/P

Definition at line 483 of file CombSearch.c.

◆ createTopHat()

int createTopHat	(	ParamStruct *	userParams,
		VectorStruct *	tophat,
		ExRegion *	exr
	)

createTopHat function use userParams to create tophat template if tophat flag is raised

function creates template of unit amplitude spikes for a band mm/P on either side of the central zero spike

Definition at line 531 of file CombSearch.c.

◆ ComputeCstat()

int ComputeCstat	(	VectorStruct *	template,
		VectorStruct *	Fstat,
		VectorStruct *	Cstat,
		ExRegion *	exr
	)

ComputeCstat function uses comb and Fstat structures to calculate the Cstat.

Definition at line 579 of file CombSearch.c.

◆ OutputCstats()

int OutputCstats	(	UserInput_t *	uvar,
		ParamStruct *	userParams,
		VectorStruct *	Fstat,
		VectorStruct *	Cstat,
		ExRegion *	exr
	)

Deprecated:: FIXME: the following code uses obsolete CVS ID tags. It should be modified to use git version information.

Definition at line 648 of file CombSearch.c.

Variable Documentation

◆ vrbflg

int vrbflg

extern

defined in lal/lib/std/LALError.c

Prototypes