Header file for the parameter estimation code for known pulsar searches using the nested sampling algorithm. More...

Detailed Description

Header file for the parameter estimation code for known pulsar searches using the nested sampling algorithm.

Author: Matthew Pitkin, John Veitch, Colin Gill

Definition in file pulsar_parameter_estimation_nested.h.

Macros
#define	ROUND(x) (floor(x+0.5))
	Macro to round a value to the nearest integer. More...

#define	LOGPLUS(x, y) ( x>y ? x+log(1.+exp(y-x)) : y+log(1.+exp(x-y)) )
	Macro to perform addition of two values within logarithm space \( \log{(e^x + e^y)} \) . More...

#define	FACTOR(x, y) ((INT4)floor(x/y))
	Macro that gives the integer number of times that `x` goes in to `y`. More...

#define	SQUARE(x) ( (x) * (x) )
	Macro to square a value. More...

#define	MAXLENGTH 1000000
	The maximum allowable length of the input data stream. More...

#define	PPEN_MAXLINELENGTH 1024
	The maximum line length (in characters) of a heterodyned data file. More...

#define	CHUNKMIN 5
	Default value of the minimum length into which the data can be split. More...

#define	CHUNKMAX 0
	Default value of the maximum length into which the data can be split. More...

#define	TIMEBINS 2880
	Default number of bins in time (over one sidereal day) for the time vs. More...

#define	NUMAMPPARS 29
	The total number of 'amplitude' parameters that can define a signal e.g. More...

#define	NUMSKYPARS 6
	The total number of sky position parameters that can define a signal e.g. More...

#define	NUMBINPARS 34
	The total number of binary system parameters that can define a signal e.g. More...

#define	NUMGLITCHPARS 7
	The total number of glitch parameters that can define a signal. More...

#define	MAXDETS 10
	The maximum number of different detectors allowable. More...

#define	USAGE
	The usage format for the code. More...

Variables
static const CHAR	amppars [NUMAMPPARS][VARNAME_MAX]
	A list of the amplitude parameters. More...

static const CHAR	skypars [NUMSKYPARS][VARNAME_MAX]
	A list of the sky position parameters. More...

static const CHAR	binpars [NUMBINPARS][VARNAME_MAX]
	A list of the binary system parameters. More...

static const CHAR	glitchpars [NUMGLITCHPARS][VARNAME_MAX] = {"GLEP", "GLPH", "GLF0", "GLF1", "GLF2", "GLF0D", "GLTD"}
	A list of the glitch parameters. More...

LALStringVector *	corlist

Macro Definition Documentation

◆ ROUND

#define ROUND ( x ) (floor(x+0.5))

Macro to round a value to the nearest integer.

Definition at line 93 of file pulsar_parameter_estimation_nested.h.

◆ LOGPLUS

#define LOGPLUS	(	x,
		y
	)	( x>y ? x+log(1.+exp(y-x)) : y+log(1.+exp(x-y)) )

Macro to perform addition of two values within logarithm space \( \log{(e^x + e^y)} \) .

Definition at line 96 of file pulsar_parameter_estimation_nested.h.

◆ FACTOR

#define FACTOR	(	x,
		y
	)	((INT4)floor(x/y))

Macro that gives the integer number of times that x goes in to y.

Definition at line 99 of file pulsar_parameter_estimation_nested.h.

◆ SQUARE

#define SQUARE ( x ) ( (x) * (x) )

Macro to square a value.

Definition at line 102 of file pulsar_parameter_estimation_nested.h.

◆ MAXLENGTH

#define MAXLENGTH 1000000

The maximum allowable length of the input data stream.

Note: this may be removed in the future with memory allocated dynamically.

Definition at line 108 of file pulsar_parameter_estimation_nested.h.

◆ PPEN_MAXLINELENGTH

#define PPEN_MAXLINELENGTH 1024

The maximum line length (in characters) of a heterodyned data file.

Definition at line 113 of file pulsar_parameter_estimation_nested.h.

◆ CHUNKMIN

#define CHUNKMIN 5

Default value of the minimum length into which the data can be split.

Definition at line 117 of file pulsar_parameter_estimation_nested.h.

◆ CHUNKMAX

#define CHUNKMAX 0

Default value of the maximum length into which the data can be split.

Definition at line 119 of file pulsar_parameter_estimation_nested.h.

◆ TIMEBINS

#define TIMEBINS 2880

Default number of bins in time (over one sidereal day) for the time vs.

\( \psi \) antenna pattern lookup table.

Definition at line 125 of file pulsar_parameter_estimation_nested.h.

◆ NUMAMPPARS

#define NUMAMPPARS 29

The total number of 'amplitude' parameters that can define a signal e.g.

gravitational wave amplitude from a triaxial star emitting from the \( l=m=2 \) mode we have \( h_0 \) , initial phase of the signal \( \phi_0 \) , polarisation angle \( psi \) , and cosine of the inclination angle \( \cos{\iota} \) . Or, more generally for emission from \( l=2 \) and \( m=1,2 \) instead of \( h_0 \) and \( \phi_0 \) there can be complex amplitude and phase parameters \( C_{22} \) , \( C_{21} \) , \( \phi_{22} \) and \( \phi_{21} \) .

Note: These should be increased if additional model parameters are added.

Definition at line 136 of file pulsar_parameter_estimation_nested.h.

◆ NUMSKYPARS

#define NUMSKYPARS 6

The total number of sky position parameters that can define a signal e.g.

right ascension, declination, proper motion, parallax and the positional epoch.

Definition at line 142 of file pulsar_parameter_estimation_nested.h.

◆ NUMBINPARS

#define NUMBINPARS 34

The total number of binary system parameters that can define a signal e.g.

binary period, orbital eccentricity, projected semi-major axis, time of periastron and angle of periastron.

Definition at line 149 of file pulsar_parameter_estimation_nested.h.

◆ NUMGLITCHPARS

#define NUMGLITCHPARS 7

The total number of glitch parameters that can define a signal.

Definition at line 154 of file pulsar_parameter_estimation_nested.h.

◆ MAXDETS

#define MAXDETS 10

The maximum number of different detectors allowable.

Definition at line 157 of file pulsar_parameter_estimation_nested.h.

◆ USAGE

#define USAGE

The usage format for the code.

Definition at line 160 of file pulsar_parameter_estimation_nested.h.

Variable Documentation

◆ amppars

const CHAR amppars[NUMAMPPARS][VARNAME_MAX]

static

Initial value:

= { "H0", "PHI0", "PSI",
                                                       "COSIOTA", "C22", "C21", "PHI22", "PHI21", "HPLUS", "HCROSS", "HSCALARB",
                                                       "HSCALARL", "HVECTORX", "HVECTORY", "PSIVECTOR", "PHI0VECTOR", "PSISCALAR",
                                                       "PHI0SCALAR", "PSITENSOR", "PHI0TENSOR", "I21", "I31", "LAMBDA", "COSTHETA",
                                                       "IOTA", "THETA", "Q22", "DIST", "H0_F"
                                                     }

A list of the amplitude parameters.

The names given here are those that are recognised within the code.

Definition at line 340 of file pulsar_parameter_estimation_nested.h.

◆ skypars

const CHAR skypars[NUMSKYPARS][VARNAME_MAX]

static

Initial value:

= { "RA", "PMRA", "DEC",
                                                       "PMDEC", "POSEPOCH", "PX"
                                                     }

A list of the sky position parameters.

The names given here are those that are recognised within the code.

Definition at line 351 of file pulsar_parameter_estimation_nested.h.

◆ binpars

const CHAR binpars[NUMBINPARS][VARNAME_MAX]

static

Initial value:

= { "PB", "ECC", "EPS1",
                                                       "EPS2", "T0", "TASC", "A1", "OM", "PB_2", "ECC_2", "T0_2", "A1_2", "OM_2", "PB_3", "ECC_3",
                                                       "T0_3", "A1_3", "OM_3", "XPBDOT", "EPS1DOT", "EPS2DOT", "OMDOT", "GAMMA", "PBDOT",
                                                       "XDOT", "EDOT", "SINI", "DR", "DTHETA", "A0", "B0", "MTOT", "M2", "FB"
                                                     }

A list of the binary system parameters.

The names given here are those that are recognised within the code.

Definition at line 359 of file pulsar_parameter_estimation_nested.h.

◆ glitchpars

const CHAR glitchpars[NUMGLITCHPARS][VARNAME_MAX] = {"GLEP", "GLPH", "GLF0", "GLF1", "GLF2", "GLF0D", "GLTD"}

static

A list of the glitch parameters.

Definition at line 366 of file pulsar_parameter_estimation_nested.h.

◆ corlist

LALStringVector* corlist

extern

Definition at line 144 of file pulsar_parameter_estimation_nested.c.

Detailed Description

Macros

Variables

Macro Definition Documentation

◆ ROUND

◆ LOGPLUS

◆ FACTOR

◆ SQUARE

◆ MAXLENGTH

◆ PPEN_MAXLINELENGTH

◆ CHUNKMIN

◆ CHUNKMAX

◆ TIMEBINS

◆ NUMAMPPARS

◆ NUMSKYPARS

◆ NUMBINPARS

◆ NUMGLITCHPARS

◆ MAXDETS

◆ USAGE

Variable Documentation

◆ amppars

◆ skypars

◆ binpars

◆ glitchpars

◆ corlist