StackSlideFstat.h File Reference

Header file for StackSlideFstat.c. More...

Prototypes
void	StackSlideVecF (LALStatus *status, SemiCohCandidateList *out, REAL4FrequencySeriesVector *vecF, SemiCoherentParams *params)
	Function StackSlides a vector of Fstat frequency series or any REAL8FrequencySeriesVector. More...
void	StackSlideVecF_HoughMode (LALStatus *status, SemiCohCandidateList *out, REAL4FrequencySeriesVector *vecF, SemiCoherentParams *params)
	Function StackSlides a vector of Fstat frequency series or any REAL8FrequencySeriesVector. More...
void	FindFreqFromMasterEquation (LALStatus *status, PulsarDopplerParams *outputPoint, PulsarDopplerParams *inputPoint, REAL8 *vel, REAL8 deltaT, UINT2 numSpindown)
void	GetStackSlideCandidates_threshold (LALStatus *status, SemiCohCandidateList *out, REAL8FrequencySeries *stackslideSum, PulsarDopplerParams *outputPoint, PulsarDopplerParams *outputPointUnc, REAL8 threshold)
void	GetStackSlideCandidates_toplist (LALStatus *status, toplist_t *list, REAL8FrequencySeries *stackslideSum, PulsarDopplerParams *outputPoint, PulsarDopplerParams *outputPointUnc)

Detailed Description

Header file for StackSlideFstat.c.

Author

Gregory Mendell

Definition in file StackSlideFstat.h.

Go to the source code of this file.

Macros
#define	STACKSLIDEFSTAT_ENORM   0
#define	STACKSLIDEFSTAT_ESUB   1
#define	STACKSLIDEFSTAT_EARG   2
#define	STACKSLIDEFSTAT_EBAD   3
#define	STACKSLIDEFSTAT_EFILE   4
#define	STACKSLIDEFSTAT_ENULL   5
#define	STACKSLIDEFSTAT_EVAL   6
#define	STACKSLIDEFSTAT_ENONULL   7
#define	STACKSLIDEFSTAT_MSGENORM   "Normal exit"
#define	STACKSLIDEFSTAT_MSGESUB   "Subroutine failed"
#define	STACKSLIDEFSTAT_MSGEARG   "Error parsing arguments"
#define	STACKSLIDEFSTAT_MSGEBAD   "Bad argument values"
#define	STACKSLIDEFSTAT_MSGEFILE   "Could not create output file"
#define	STACKSLIDEFSTAT_MSGENULL   "Null pointer"
#define	STACKSLIDEFSTAT_MSGEVAL   "Invalid value"
#define	STACKSLIDEFSTAT_MSGENONULL   "Pointer not null"

Macro Definition Documentation

STACKSLIDEFSTAT_ENORM

#define STACKSLIDEFSTAT_ENORM   0

Definition at line 78 of file StackSlideFstat.h.

STACKSLIDEFSTAT_ESUB

#define STACKSLIDEFSTAT_ESUB   1

Definition at line 79 of file StackSlideFstat.h.

STACKSLIDEFSTAT_EARG

#define STACKSLIDEFSTAT_EARG   2

Definition at line 80 of file StackSlideFstat.h.

STACKSLIDEFSTAT_EBAD

#define STACKSLIDEFSTAT_EBAD   3

Definition at line 81 of file StackSlideFstat.h.

STACKSLIDEFSTAT_EFILE

#define STACKSLIDEFSTAT_EFILE   4

Definition at line 82 of file StackSlideFstat.h.

STACKSLIDEFSTAT_ENULL

#define STACKSLIDEFSTAT_ENULL   5

Definition at line 83 of file StackSlideFstat.h.

STACKSLIDEFSTAT_EVAL

#define STACKSLIDEFSTAT_EVAL   6

Definition at line 84 of file StackSlideFstat.h.

STACKSLIDEFSTAT_ENONULL

#define STACKSLIDEFSTAT_ENONULL   7

Definition at line 85 of file StackSlideFstat.h.

STACKSLIDEFSTAT_MSGENORM

#define STACKSLIDEFSTAT_MSGENORM   "Normal exit"

Definition at line 87 of file StackSlideFstat.h.

STACKSLIDEFSTAT_MSGESUB

#define STACKSLIDEFSTAT_MSGESUB   "Subroutine failed"

Definition at line 88 of file StackSlideFstat.h.

STACKSLIDEFSTAT_MSGEARG

#define STACKSLIDEFSTAT_MSGEARG   "Error parsing arguments"

Definition at line 89 of file StackSlideFstat.h.

STACKSLIDEFSTAT_MSGEBAD

#define STACKSLIDEFSTAT_MSGEBAD   "Bad argument values"

Definition at line 90 of file StackSlideFstat.h.

STACKSLIDEFSTAT_MSGEFILE

#define STACKSLIDEFSTAT_MSGEFILE   "Could not create output file"

Definition at line 91 of file StackSlideFstat.h.

STACKSLIDEFSTAT_MSGENULL

#define STACKSLIDEFSTAT_MSGENULL   "Null pointer"

Definition at line 92 of file StackSlideFstat.h.

STACKSLIDEFSTAT_MSGEVAL

#define STACKSLIDEFSTAT_MSGEVAL   "Invalid value"

Definition at line 93 of file StackSlideFstat.h.

STACKSLIDEFSTAT_MSGENONULL

#define STACKSLIDEFSTAT_MSGENONULL   "Pointer not null"

Definition at line 94 of file StackSlideFstat.h.

Function Documentation

StackSlideVecF()

void StackSlideVecF	(	LALStatus *	status,
		SemiCohCandidateList *	out,
		REAL4FrequencySeriesVector *	vecF,
		SemiCoherentParams *	params
	)

Function StackSlides a vector of Fstat frequency series or any REAL8FrequencySeriesVector.

Parameters

status	pointer to LALStatus structure
out	output candidates
vecF	vector with Fstat values or any REAL8FrequencySeriesVector
params	input parameters

Definition at line 62 of file StackSlideFstat.c.

StackSlideVecF_HoughMode()

void StackSlideVecF_HoughMode	(	LALStatus *	status,
		SemiCohCandidateList *	out,
		REAL4FrequencySeriesVector *	vecF,
		SemiCoherentParams *	params
	)

Function StackSlides a vector of Fstat frequency series or any REAL8FrequencySeriesVector.

This is similar to StackSlideVecF but adapted to calculate the hough number count and to be as similar to Hough as possible but without using the hough look-up-tables.

Parameters

status	pointer to LALStatus structure
out	output candidates
vecF	vector with Fstat values or any REAL8FrequencySeriesVector
params	input parameters

Definition at line 373 of file StackSlideFstat.c.

FindFreqFromMasterEquation()

void FindFreqFromMasterEquation	(	LALStatus *	status,
		PulsarDopplerParams *	outputPoint,
		PulsarDopplerParams *	inputPoint,
		REAL8 *	vel,
		REAL8	deltaT,
		UINT2	numSpindown
	)

Parameters

status	pointer to LALStatus structure
outputPoint	outputs f(t) for output sky position and spindown values
inputPoint	input demodulation f0, sky position, and spindown values
vel	vx = vel[0], vy = vel[1], vz = vel[2] = ave detector velocity
deltaT	time since the reference time
numSpindown	Number of spindown values == high deriv. of include == 1 if just df/dt, etc...

Definition at line 703 of file StackSlideFstat.c.

GetStackSlideCandidates_threshold()

void GetStackSlideCandidates_threshold	(	LALStatus *	status,
		SemiCohCandidateList *	out,
		REAL8FrequencySeries *	stackslideSum,
		PulsarDopplerParams *	outputPoint,
		PulsarDopplerParams *	outputPointUnc,
		REAL8	threshold
	)

Parameters

status	pointer to LALStatus structure
out	output list of candidates
stackslideSum	input stackslide sum of F stat values
outputPoint	parameter space point for which to output candidate
outputPointUnc	uncertainties in parameter space point for which to output candidate
threshold	threshold on significance

Definition at line 789 of file StackSlideFstat.c.

GetStackSlideCandidates_toplist()

void GetStackSlideCandidates_toplist	(	LALStatus *	status,
		toplist_t *	list,
		REAL8FrequencySeries *	stackslideSum,
		PulsarDopplerParams *	outputPoint,
		PulsarDopplerParams *	outputPointUnc
	)

Definition at line 894 of file StackSlideFstat.c.