HierarchicalSearch.h File Reference

Header file for DriveHoughFstat.c. More...

Prototypes
void	ComputeFstatHoughMap (LALStatus *status, SemiCohCandidateList *out, HOUGHPeakGramVector *pgV, SemiCoherentParams *params)
	Function for calculating Hough Maps and candidates. More...
void	LocalComputeFstatHoughMap (LALStatus *status, SemiCohCandidateList *out, HOUGHPeakGramVector *pgV, SemiCoherentParams *params)
void	FstatVectToPeakGram (LALStatus *status, HOUGHPeakGramVector *pgV, REAL4FrequencySeriesVector *FstatVect, REAL4 thr)
	Function for selecting frequency bins from a set of Fstatistic vectors. More...
void	SetUpStacks (LALStatus *status, SFTCatalogSequence *out, REAL8 tStack, SFTCatalog *in, UINT4 nStacks)
	Breaks up input sft catalog into specified number of stacks Loops over elements of the catalog, assigns a bin index and allocates memory to the output catalog sequence appropriately. More...
void	PrintHmap2file (LALStatus *status, HOUGHMapTotal *ht, CHAR *fnameOut, INT4 iHmap)
	Print single Hough map to a specified output file. More...
void	GetHoughCandidates_threshold (LALStatus *status, SemiCohCandidateList *out, HOUGHMapTotal *ht, HOUGHPatchGrid *patch, HOUGHDemodPar *parDem, REAL8 threshold)
	Get Hough candidates as a toplist using a fixed threshold. More...
void	GetHoughCandidates_toplist (LALStatus *status, toplist_t *list, HOUGHMapTotal *ht, HOUGHPatchGrid *patch, HOUGHDemodPar *parDem)
	Get Hough candidates as a toplist. More...
void	GetFstatCandidates_toplist (LALStatus *status, toplist_t *list, REAL8FrequencySeries *FstatVec, REAL8 alpha, REAL8 delta, REAL8 fdot)
void	GetChkPointIndex (LALStatus *status, INT4 *loopindex, const CHAR *fnameChkPoint)
	Read checkpointing file This does not (yet) check any consistency of the existing results file. More...

Detailed Description

Header file for DriveHoughFstat.c.

Author

Badri Krishnan, Alicia Sintes

Definition in file HierarchicalSearch.h.

Go to the source code of this file.

Data Structures
struct	SFTCatalogSequence
	sequence of SFT catalogs – for each segment More...
struct	SemiCoherentParams
	parameters for the semicoherent stage More...
struct	SemiCohCandidate
	one hough or stackslide candidate More...
struct	SemiCohCandidateList
	structure for storing candidates produced by Hough search More...

Macros
#define	HIERARCHICALSEARCH_ENORM   0
#define	HIERARCHICALSEARCH_ESUB   1
#define	HIERARCHICALSEARCH_EARG   2
#define	HIERARCHICALSEARCH_EBAD   3
#define	HIERARCHICALSEARCH_EFILE   4
#define	HIERARCHICALSEARCH_ENULL   5
#define	HIERARCHICALSEARCH_EVAL   6
#define	HIERARCHICALSEARCH_ENONULL   7
#define	HIERARCHICALSEARCH_EDLOPEN   8
#define	HIERARCHICALSEARCH_EWORKER   9
#define	HIERARCHICALSEARCH_ECHECKPT   10
#define	HIERARCHICALSEARCH_EMEM   11
#define	HIERARCHICALSEARCH_ESFT   12
#define	HIERARCHICALSEARCH_EXLAL   13
#define	HIERARCHICALSEARCH_MSGENORM   "Normal exit"
#define	HIERARCHICALSEARCH_MSGESUB   "Subroutine failed"
#define	HIERARCHICALSEARCH_MSGEARG   "Error parsing arguments"
#define	HIERARCHICALSEARCH_MSGEBAD   "Bad argument values"
#define	HIERARCHICALSEARCH_MSGEFILE   "Could not create output file"
#define	HIERARCHICALSEARCH_MSGENULL   "Null pointer"
#define	HIERARCHICALSEARCH_MSGEVAL   "Invalid value"
#define	HIERARCHICALSEARCH_MSGENONULL   "Pointer not null"
#define	HIERARCHICALSEARCH_MSGECHECKPT   "Could not resume from checkpoint"
#define	HIERARCHICALSEARCH_MSGEMEM   "Out of memory"
#define	HIERARCHICALSEARCH_MSGESFT   "SFT validity check failed"
#define	HIERARCHICALSEARCH_MSGEXLAL   "XLAL function call failed"

Macro Definition Documentation

HIERARCHICALSEARCH_ENORM

#define HIERARCHICALSEARCH_ENORM   0

Definition at line 84 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_ESUB

#define HIERARCHICALSEARCH_ESUB   1

Definition at line 85 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_EARG

#define HIERARCHICALSEARCH_EARG   2

Definition at line 86 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_EBAD

#define HIERARCHICALSEARCH_EBAD   3

Definition at line 87 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_EFILE

#define HIERARCHICALSEARCH_EFILE   4

Definition at line 88 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_ENULL

#define HIERARCHICALSEARCH_ENULL   5

Definition at line 89 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_EVAL

#define HIERARCHICALSEARCH_EVAL   6

Definition at line 90 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_ENONULL

#define HIERARCHICALSEARCH_ENONULL   7

Definition at line 91 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_EDLOPEN

#define HIERARCHICALSEARCH_EDLOPEN   8

Definition at line 92 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_EWORKER

#define HIERARCHICALSEARCH_EWORKER   9

Definition at line 93 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_ECHECKPT

#define HIERARCHICALSEARCH_ECHECKPT   10

Definition at line 94 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_EMEM

#define HIERARCHICALSEARCH_EMEM   11

Definition at line 95 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_ESFT

#define HIERARCHICALSEARCH_ESFT   12

Definition at line 96 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_EXLAL

#define HIERARCHICALSEARCH_EXLAL   13

Definition at line 97 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_MSGENORM

#define HIERARCHICALSEARCH_MSGENORM   "Normal exit"

Definition at line 100 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_MSGESUB

#define HIERARCHICALSEARCH_MSGESUB   "Subroutine failed"

Definition at line 101 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_MSGEARG

#define HIERARCHICALSEARCH_MSGEARG   "Error parsing arguments"

Definition at line 102 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_MSGEBAD

#define HIERARCHICALSEARCH_MSGEBAD   "Bad argument values"

Definition at line 103 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_MSGEFILE

#define HIERARCHICALSEARCH_MSGEFILE   "Could not create output file"

Definition at line 104 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_MSGENULL

#define HIERARCHICALSEARCH_MSGENULL   "Null pointer"

Definition at line 105 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_MSGEVAL

#define HIERARCHICALSEARCH_MSGEVAL   "Invalid value"

Definition at line 106 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_MSGENONULL

#define HIERARCHICALSEARCH_MSGENONULL   "Pointer not null"

Definition at line 107 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_MSGECHECKPT

#define HIERARCHICALSEARCH_MSGECHECKPT   "Could not resume from checkpoint"

Definition at line 108 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_MSGEMEM

#define HIERARCHICALSEARCH_MSGEMEM   "Out of memory"

Definition at line 109 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_MSGESFT

#define HIERARCHICALSEARCH_MSGESFT   "SFT validity check failed"

Definition at line 110 of file HierarchicalSearch.h.

HIERARCHICALSEARCH_MSGEXLAL

#define HIERARCHICALSEARCH_MSGEXLAL   "XLAL function call failed"

Definition at line 111 of file HierarchicalSearch.h.

Function Documentation

ComputeFstatHoughMap()

void ComputeFstatHoughMap	(	LALStatus *	status,
		SemiCohCandidateList *	out,
		HOUGHPeakGramVector *	pgV,
		SemiCoherentParams *	params
	)

Function for calculating Hough Maps and candidates.

This function takes a peakgram as input. This peakgram was constructed by setting a threshold on a sequence of Fstatistic vectors. The function produces a Hough map in the sky for each value of the frequency and spindown. The Hough nummber counts are then used to select candidates in parameter space to be followed up in a more refined search. This uses DriveHough_v3.c as a prototype suitably modified to work on demodulated data instead of SFTs.

Parameters

status	pointer to LALStatus structure
out	Candidates from thresholding Hough number counts
pgV	HOUGHPeakGramVector obtained after thresholding Fstatistic vectors
params	pointer to HoughParams – parameters for calculating Hough maps

Definition at line 1490 of file HierarchicalSearch.c.

LocalComputeFstatHoughMap()

void LocalComputeFstatHoughMap	(	LALStatus *	status,
		SemiCohCandidateList *	out,
		HOUGHPeakGramVector *	pgV,
		SemiCoherentParams *	params
	)

Definition at line 114 of file LocalComputeFstatHoughMap.c.

FstatVectToPeakGram()

void FstatVectToPeakGram	(	LALStatus *	status,
		HOUGHPeakGramVector *	pgV,
		REAL4FrequencySeriesVector *	FstatVect,
		REAL4	thr
	)

Function for selecting frequency bins from a set of Fstatistic vectors.

Input is a vector of Fstatistic vectors. It allocates memory for the peakgrams based on the frequency span of the Fstatistic vectors and fills tyem up by setting a threshold on the Fstatistic. Peakgram must be deallocated outside the function.

Parameters

status	pointer to LALStatus structure
pgV	a vector of peakgrams
FstatVect	sequence of Fstatistic vectors
thr	REAL8 threshold for selecting frequency bins

Definition at line 2048 of file HierarchicalSearch.c.

SetUpStacks()

void SetUpStacks	(	LALStatus *	status,
		SFTCatalogSequence *	out,
		REAL8	tStack,
		SFTCatalog *	in,
		UINT4	nStacksMax
	)

Breaks up input sft catalog into specified number of stacks Loops over elements of the catalog, assigns a bin index and allocates memory to the output catalog sequence appropriately.

If there are long gaps in the data, then some of the catalogs in the output catalog sequence may be of zero length.

Breaks up input sft catalog into specified number of stacks Loops over elements of the catalog, assigns a bin index and allocates memory to the output catalog sequence appropriately.

Loops over elements of the catalog, assigns a bin index and allocates memory to the output catalog sequence appropriately. If there are long gaps in the data, then some of the catalogs in the output catalog sequence may be of zero length.

Parameters

status	pointer to LALStatus structure
out	Output catalog of sfts – one for each stack
tStack	Output duration of each stack
in	Input sft catalog to be broken up into stacks (ordered in increasing time)
nStacksMax	User specified number of stacks

Definition at line 2390 of file HierarchSearchGCT.c.

PrintHmap2file()

void PrintHmap2file	(	LALStatus *	status,
		HOUGHMapTotal *	ht,
		CHAR *	fnameOut,
		INT4	iHmap
	)

Print single Hough map to a specified output file.

Definition at line 2253 of file HierarchicalSearch.c.

GetHoughCandidates_threshold()

void GetHoughCandidates_threshold	(	LALStatus *	status,
		SemiCohCandidateList *	out,
		HOUGHMapTotal *	ht,
		HOUGHPatchGrid *	patch,
		HOUGHDemodPar *	parDem,
		REAL8	threshold
	)

Get Hough candidates as a toplist using a fixed threshold.

Definition at line 2675 of file HierarchicalSearch.c.

GetHoughCandidates_toplist()

void GetHoughCandidates_toplist	(	LALStatus *	status,
		toplist_t *	list,
		HOUGHMapTotal *	ht,
		HOUGHPatchGrid *	patch,
		HOUGHDemodPar *	parDem
	)

Get Hough candidates as a toplist.

Definition at line 2614 of file HierarchicalSearch.c.

GetFstatCandidates_toplist()

void GetFstatCandidates_toplist	(	LALStatus *	status,
		toplist_t *	list,
		REAL8FrequencySeries *	FstatVec,
		REAL8	alpha,
		REAL8	delta,
		REAL8	fdot
	)

Definition at line 2950 of file HierarchicalSearch.c.

GetChkPointIndex()

void GetChkPointIndex	(	LALStatus *	status,
		INT4 *	loopindex,
		const CHAR *	fnameChkPoint
	)

Read checkpointing file This does not (yet) check any consistency of the existing results file.

Definition at line 3088 of file HierarchicalSearch.c.