Prototypes
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	GetChkPointIndex (LALStatus status, INT4 loopindex, const CHAR *fnameChkPoint)
	Read checkpointing file This does not (yet) check any consistency of the existing results file. More...

Data Structures
struct	Segment_t
	type describing one coherent segment of data: ( start-time + duration ) More...

struct	SegmentVector_t
	a standard vector of data-segments More...

struct	SFTCatalogSequence
	sequence of SFT catalogs – for each segment More...

struct	SemiCoherentParams
	parameters for the semicoherent stage More...

struct	FineGrid

struct	CoarseGrid
	structure for storing coarse-grid points 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_ECG 13

#define	HIERARCHICALSEARCH_EXLAL 14

#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"

#define	FINEGRID_NC_T UINT4
	structure for storing fine-grid points More...

#define	FG_INDEX(fg, iFreq) ( (iFreq) )

#define	FG_FX_INDEX(fg, iDet, iFreq) ( ( (iDet) * (fg).freqlengthAL ) + (iFreq) )

#define	CG_INDEX(cg, iStack, iFreq) ( ( (iStack) * (cg).freqlength ) + (iFreq) )

#define	CG_FX_INDEX(cg, iDet, iStack, iFreq) ( ( (iDet) * (cg).length ) + ( (iStack) * (cg).freqlength ) + (iFreq) )

Macro Definition Documentation

◆ HIERARCHICALSEARCH_ENORM

#define HIERARCHICALSEARCH_ENORM 0

Definition at line 78 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_ESUB

#define HIERARCHICALSEARCH_ESUB 1

Definition at line 79 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_EARG

#define HIERARCHICALSEARCH_EARG 2

Definition at line 80 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_EBAD

#define HIERARCHICALSEARCH_EBAD 3

Definition at line 81 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_EFILE

#define HIERARCHICALSEARCH_EFILE 4

Definition at line 82 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_ENULL

#define HIERARCHICALSEARCH_ENULL 5

Definition at line 83 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_EVAL

#define HIERARCHICALSEARCH_EVAL 6

Definition at line 84 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_ENONULL

#define HIERARCHICALSEARCH_ENONULL 7

Definition at line 85 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_EDLOPEN

#define HIERARCHICALSEARCH_EDLOPEN 8

Definition at line 86 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_EWORKER

#define HIERARCHICALSEARCH_EWORKER 9

Definition at line 87 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_ECHECKPT

#define HIERARCHICALSEARCH_ECHECKPT 10

Definition at line 88 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_EMEM

#define HIERARCHICALSEARCH_EMEM 11

Definition at line 89 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_ESFT

#define HIERARCHICALSEARCH_ESFT 12

Definition at line 90 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_ECG

#define HIERARCHICALSEARCH_ECG 13

Definition at line 91 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_EXLAL

#define HIERARCHICALSEARCH_EXLAL 14

Definition at line 92 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_MSGENORM

#define HIERARCHICALSEARCH_MSGENORM "Normal exit"

Definition at line 94 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_MSGESUB

#define HIERARCHICALSEARCH_MSGESUB "Subroutine failed"

Definition at line 95 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_MSGEARG

#define HIERARCHICALSEARCH_MSGEARG "Error parsing arguments"

Definition at line 96 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_MSGEBAD

#define HIERARCHICALSEARCH_MSGEBAD "Bad argument values"

Definition at line 97 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_MSGEFILE

#define HIERARCHICALSEARCH_MSGEFILE "Could not create output file"

Definition at line 98 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_MSGENULL

#define HIERARCHICALSEARCH_MSGENULL "Null pointer"

Definition at line 99 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_MSGEVAL

#define HIERARCHICALSEARCH_MSGEVAL "Invalid value"

Definition at line 100 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_MSGENONULL

#define HIERARCHICALSEARCH_MSGENONULL "Pointer not null"

Definition at line 101 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_MSGECHECKPT

#define HIERARCHICALSEARCH_MSGECHECKPT "Could not resume from checkpoint"

Definition at line 102 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_MSGEMEM

#define HIERARCHICALSEARCH_MSGEMEM "Out of memory"

Definition at line 103 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_MSGESFT

#define HIERARCHICALSEARCH_MSGESFT "SFT validity check failed"

Definition at line 104 of file HierarchSearchGCT.h.

◆ HIERARCHICALSEARCH_MSGEXLAL

#define HIERARCHICALSEARCH_MSGEXLAL "XLAL function call failed"

Definition at line 105 of file HierarchSearchGCT.h.

◆ FINEGRID_NC_T

#define FINEGRID_NC_T UINT4

structure for storing fine-grid points

Definition at line 151 of file HierarchSearchGCT.h.

◆ FG_INDEX

#define FG_INDEX	(	fg,
		iFreq
	)	( (iFreq) )

Definition at line 175 of file HierarchSearchGCT.h.

◆ FG_FX_INDEX

#define FG_FX_INDEX	(	fg,
		iDet,
		iFreq
	)	( ( (iDet) * (fg).freqlengthAL ) + (iFreq) )

Definition at line 183 of file HierarchSearchGCT.h.

◆ CG_INDEX

#define CG_INDEX	(	cg,
		iStack,
		iFreq
	)	( ( (iStack) * (cg).freqlength ) + (iFreq) )

Definition at line 202 of file HierarchSearchGCT.h.

◆ CG_FX_INDEX

#define CG_FX_INDEX	(	cg,
		iDet,
		iStack,
		iFreq
	)	( ( (iDet) * (cg).length ) + ( (iStack) * (cg).freqlength ) + (iFreq) )

Definition at line 208 of file HierarchSearchGCT.h.

Function Documentation

◆ 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.