Header TemplateBankGeneration.h

Detailed Description

This header file includes all the necessary types and function prototypes for LALNDTemplateBank() and LALMakeTemplateBank().

Author

Hanna, C. R.

Synopsis

#include <lal/TemplateBankGeneration.h>

NDTemplateBank() provides a general way to tile a parameter space with a constant metric ( currently only for less than 12 dimensions). MakeTemplateBank() provides a general way for applications to generate a template bank with suitable I/O.

Prototypes
void	LALNDTemplateBank (LALStatus *, NDTemplateBankInput *, NDTemplateBankFunctionPtrs *, NDTemplateBankOutput **)

Data Structures
struct	NDTemplateBankInput
struct	NDTemplateBankOutput
struct	NDTemplateBankFunctionPtrs

Typedefs
typedef void(*	NDTemplateBankMetricPtr) (LALStatus *, NDTemplateBankInput *, REAL4Array *)
typedef void(*	NDTemplateBankTestPtr) (LALStatus *, NDTemplateBankInput *, NDTemplateBankOutput *, INT2 *)

Enumerations
enum	TemplateBankType {   BCVType , BCVSpinType , PrecessingType , Pulsar ,   Burst }

Files
file	NDTemplateBank.c
	This module handles template bank generation for up to searches with \(<=\) 12 dimensional parameter spaces.

Error Codes
#define	TEMPLATEBANKGENERATIONH_ENULL   1
#define	TEMPLATEBANKGENERATIONH_MSGENULL   "Unexpected NULL pointer to an input type"

Function Documentation

LALNDTemplateBank()

void LALNDTemplateBank	(	LALStatus *	status,
		NDTemplateBankInput *	input,
		NDTemplateBankFunctionPtrs *	functionPtrs,
		NDTemplateBankOutput **	output
	)

Definition at line 81 of file NDTemplateBank.c.

Typedef Documentation

NDTemplateBankMetricPtr

typedef void(* NDTemplateBankMetricPtr) (LALStatus *, NDTemplateBankInput *, REAL4Array *)

Definition at line 103 of file TemplateBankGeneration.h.

NDTemplateBankTestPtr

typedef void(* NDTemplateBankTestPtr) (LALStatus *, NDTemplateBankInput *, NDTemplateBankOutput *, INT2 *)

Definition at line 104 of file TemplateBankGeneration.h.

Enumeration Type Documentation

TemplateBankType

enum TemplateBankType

Enumerator
BCVType
BCVSpinType
PrecessingType
Pulsar
Burst

Definition at line 69 of file TemplateBankGeneration.h.

Macro Definition Documentation

TEMPLATEBANKGENERATIONH_ENULL

#define TEMPLATEBANKGENERATIONH_ENULL   1

Definition at line 65 of file TemplateBankGeneration.h.

TEMPLATEBANKGENERATIONH_MSGENULL

#define TEMPLATEBANKGENERATIONH_MSGENULL   "Unexpected NULL pointer to an input type"

Definition at line 66 of file TemplateBankGeneration.h.