upperlimits.h File Reference

Prototypes
UpperLimitVector *	createUpperLimitVector (const UINT4 length)
	Allocate a new UpperLimitVector. More...
UpperLimitVector *	resizeUpperLimitVector (UpperLimitVector *vector, const UINT4 length)
	Resize an UpperLimitVector. More...
void	resetUpperLimitStruct (UpperLimit *ul)
	Reset an UpperLimitStruct. More...
void	destroyUpperLimitVector (UpperLimitVector *vector)
	Free an UpperLimitVector. More...
void	destroyUpperLimitStruct (UpperLimit *ul)
	Free an UpperLimit structure. More...
INT4	skypoint95UL (UpperLimit *ul, const UserInput_t *params, const ffdataStruct *ffdata, const ihsMaximaStruct *ihsmaxima, const ihsfarStruct *ihsfar, const REAL4VectorAligned *fbinavgs)
	Determine the 95% confidence level upper limit at a particular sky location from the loudest IHS value. More...
REAL8	gsl_ncx2cdf_solver (const REAL8 x, void *p)
REAL8	gsl_ncx2cdf_float_solver (const REAL8 x, void *p)
REAL8	gsl_ncx2cdf_withouttinyprob_solver (const REAL8 x, void *p)
REAL8	gsl_ncx2cdf_float_withouttinyprob_solver (const REAL8 x, void *p)
REAL8	ncx2cdf_withouttinyprob_withmatlabchi2cdf_solver (const REAL8 x, void *p)
REAL8	ncx2cdf_float_withouttinyprob_withmatlabchi2cdf_solver (const REAL8 x, void *p)
INT4	outputUpperLimitToFile (const CHAR *outputfile, const UpperLimit ul, const BOOLEAN printAllULvalues)
	Output the highest upper limit to a file unless printAllULvalues==1 in which case, all UL values are printed to a file. More...

Go to the source code of this file.

Data Structures
struct	ncx2cdf_solver_params

Function Documentation

createUpperLimitVector()

UpperLimitVector * createUpperLimitVector

(

const UINT4

length

)

Allocate a new UpperLimitVector.

Parameters

[in]

length

Length of the vector

Returns

Pointer to newly allocated UpperLimitVector

Definition at line 32 of file upperlimits.c.

resizeUpperLimitVector()

UpperLimitVector * resizeUpperLimitVector	(	UpperLimitVector *	vector,
		const UINT4	length
	)

Resize an UpperLimitVector.

Parameters

[in,out]	vector	Pointer to UpperLimitVector to resize
[in]	length	New length of the vector

Returns

Pointer to reallocated UpperLimitVector

Definition at line 59 of file upperlimits.c.

resetUpperLimitStruct()

void resetUpperLimitStruct

(

UpperLimit *

ul

)

Reset an UpperLimitStruct.

Parameters

[in]

ul

Pointer to an UpperLimit structure

Definition at line 111 of file upperlimits.c.

destroyUpperLimitVector()

void destroyUpperLimitVector

(

UpperLimitVector *

vector

)

Free an UpperLimitVector.

Parameters

[in]

vector

Pointer to an UpperLimitVector

Definition at line 87 of file upperlimits.c.

destroyUpperLimitStruct()

void destroyUpperLimitStruct

(

UpperLimit *

ul

)

Free an UpperLimit structure.

Parameters

[in]

ul

Pointer to an UpperLimit structure

Definition at line 125 of file upperlimits.c.

skypoint95UL()

INT4 skypoint95UL	(	UpperLimit *	ul,
		const UserInput_t *	params,
		const ffdataStruct *	ffdata,
		const ihsMaximaStruct *	ihsmaxima,
		const ihsfarStruct *	ihsfar,
		const REAL4VectorAligned *	fbinavgs
	)

Determine the 95% confidence level upper limit at a particular sky location from the loudest IHS value.

Parameters

[out]	ul	Pointer to an UpperLimit struct
[in]	params	Pointer to UserInput_t
[in]	ffdata	Pointer to ffdataStruct
[in]	ihsmaxima	Pointer to an ihsMaximaStruct
[in]	ihsfar	Pointer to an ihsfarStruct
[in]	fbinavgs	Pointer to a REAL4VectorAligned of the 2nd FFT background powers

Returns

Status value

Definition at line 155 of file upperlimits.c.

gsl_ncx2cdf_solver()

REAL8 gsl_ncx2cdf_solver	(	const REAL8	x,
		void *	p
	)

Definition at line 286 of file upperlimits.c.

gsl_ncx2cdf_float_solver()

REAL8 gsl_ncx2cdf_float_solver	(	const REAL8	x,
		void *	p
	)

Definition at line 298 of file upperlimits.c.

gsl_ncx2cdf_withouttinyprob_solver()

REAL8 gsl_ncx2cdf_withouttinyprob_solver	(	const REAL8	x,
		void *	p
	)

Definition at line 310 of file upperlimits.c.

gsl_ncx2cdf_float_withouttinyprob_solver()

REAL8 gsl_ncx2cdf_float_withouttinyprob_solver	(	const REAL8	x,
		void *	p
	)

Definition at line 322 of file upperlimits.c.

ncx2cdf_withouttinyprob_withmatlabchi2cdf_solver()

REAL8 ncx2cdf_withouttinyprob_withmatlabchi2cdf_solver	(	const REAL8	x,
		void *	p
	)

Definition at line 334 of file upperlimits.c.

ncx2cdf_float_withouttinyprob_withmatlabchi2cdf_solver()

REAL8 ncx2cdf_float_withouttinyprob_withmatlabchi2cdf_solver	(	const REAL8	x,
		void *	p
	)

Definition at line 346 of file upperlimits.c.

outputUpperLimitToFile()

INT4 outputUpperLimitToFile	(	const CHAR *	outputfile,
		const UpperLimit	ul,
		const BOOLEAN	printAllULvalues
	)

Output the highest upper limit to a file unless printAllULvalues==1 in which case, all UL values are printed to a file.

Parameters

[in]	outputfile	String of the filename
[in]	ul	UpperLimit structure to print to file
[in]	printAllULvalues	Option flag to print all UL values from a sky location (1) or only the largest (0)

Returns

Status value

Definition at line 364 of file upperlimits.c.