Loading [MathJax]/extensions/TeX/AMSsymbols.js
LALInspiral 5.0.3.1-8a6b96f
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
InspiralCoarseBankIn Struct Reference

Detailed Description

Input for choosing a template bank.

This is the structure that must be filled by a routine calling the code InspiralCreateCoarseBank() or InspiralCreateBCVBank(). Unless BCV template bank is needed (that is, InspiralCreateBCVBank()) then one can ignore the parameters psi0Min, psi0Max, psi3Min, psi3Max, alpha, numFcutTemplates.

Definition at line 397 of file LALInspiralBank.h.

Data Fields

InspiralBankMassRange massRange
 enum that determines whether templates should be chosen using fixed ranges for component masses or to use minimum component mass and maximum totalmass More...
 
CoordinateSpace space
 enum that decides whether to use \((\tau_0,\tau_2)\) or \((\tau_0,\tau_3)\) in constructing the template bank More...
 
REAL8 mMin
 minimum mass of components to search for More...
 
REAL8 mMax
 maximum mass of components to search for More...
 
REAL8 MMax
 alternatively, maximum total mass of binary to search for More...
 
REAL8 MMin
 UNDOCUMENTED. More...
 
REAL8 alpha
 the BCV amplitude correction parameter More...
 
REAL8 psi0Min
 minimum value of the parameter \(\psi_0\) More...
 
REAL8 psi0Max
 maximum value of the parameter \(\psi_0\) More...
 
REAL8 psi3Min
 minimum value of the parameter \(\psi_3\) More...
 
REAL8 psi3Max
 maximum value of the parameter \(\psi_3\) More...
 
REAL8 mmCoarse
 Coarse grid minimal match. More...
 
REAL8 mmFine
 Fine grid minimal match. More...
 
REAL8 fLower
 Lower frequency cutoff. More...
 
REAL8 fUpper
 Upper frequency cutoff. More...
 
REAL8 tSampling
 Sampling rate. More...
 
REAL8 etamin
 minimum value of eta in our search More...
 
REAL8 betaMin
 UNDOCUMENTED. More...
 
REAL8 betaMax
 UNDOCUMENTED. More...
 
REAL8 chiMin
 UNDOCUMENTED. More...
 
REAL8 chiMax
 UNDOCUMENTED. More...
 
REAL8 kappaMin
 UNDOCUMENTED. More...
 
REAL8 kappaMax
 UNDOCUMENTED. More...
 
INT4 nPointsChi
 UNDOCUMENTED. More...
 
INT4 nPointsKappa
 UNDOCUMENTED. More...
 
REAL8FrequencySeries shf
 Frequency series containing the PSD. More...
 
UINT4 ShMaxSz
 Maximum size of the power spectral density array for use in the computation of the metric in SBBH; typical values that assures that the code runs quickly are 1024-8192. More...
 
UINT4 iseed
 See for random number generation in RandomBank algorithm. More...
 
UINT4 nTIni
 nTIni is an estimate for the number of templates that might be required; this is used in the random bank generation routine with a seed number of templates = nTIni*sqrt(nTIni) More...
 
INT4 iflso
 iflso is an integer that tells whether to compute the moments using an upper limit defined by flso; this is not used anywhere at the moment More...
 
INT4 spinBank
 spinBank=0:use Owen+Hanna bank, spinBank=1:use extended bank by AEI/Cardiff/Osaka, spinBank=2:use random bank algorithm More...
 
UINT4 numFcutTemplates
 Number of templates required in the fCut (upper cutoff) dimension and the value of upper and lower cutoffs. More...
 
REAL4 HighGM
 UNDOCUMENTED. More...
 
REAL4 LowGM
 UNDOCUMENTED. More...
 
GridSpacing gridSpacing
 Type of gridspacing required. More...
 
LALPNOrder order
 Post-Newtonian order of the waveform. More...
 
Approximant approximant
 Approximant of the waveform. More...
 
LALPNOrder ampOrder
 
INT4 numFreqCut
 Number of different upper frequency cutoffs (spaced evenly between minFreqCut and maxFreqCut) to use when creating a template bank. More...
 
FreqCut maxFreqCut
 largest upper frequency cutoff to use More...
 
FreqCut minFreqCut
 smallest upper frequency cutoff to use More...
 
InsidePolygonEnum insidePolygon
 UNDOCUMENTED. More...
 
ComputeMoments computeMoments
 ComputeMoments tells whether to re-compute the moments using an upper limit defined by flso; This is done after the template bank is gnerated. More...
 

Field Documentation

◆ massRange

InspiralBankMassRange InspiralCoarseBankIn::massRange

enum that determines whether templates should be chosen using fixed ranges for component masses or to use minimum component mass and maximum totalmass

Definition at line 400 of file LALInspiralBank.h.

◆ space

CoordinateSpace InspiralCoarseBankIn::space

enum that decides whether to use \((\tau_0,\tau_2)\) or \((\tau_0,\tau_3)\) in constructing the template bank

Definition at line 403 of file LALInspiralBank.h.

◆ mMin

REAL8 InspiralCoarseBankIn::mMin

minimum mass of components to search for

Definition at line 404 of file LALInspiralBank.h.

◆ mMax

REAL8 InspiralCoarseBankIn::mMax

maximum mass of components to search for

Definition at line 405 of file LALInspiralBank.h.

◆ MMax

REAL8 InspiralCoarseBankIn::MMax

alternatively, maximum total mass of binary to search for

Definition at line 406 of file LALInspiralBank.h.

◆ MMin

REAL8 InspiralCoarseBankIn::MMin

UNDOCUMENTED.

Definition at line 407 of file LALInspiralBank.h.

◆ alpha

REAL8 InspiralCoarseBankIn::alpha

the BCV amplitude correction parameter

Definition at line 408 of file LALInspiralBank.h.

◆ psi0Min

REAL8 InspiralCoarseBankIn::psi0Min

minimum value of the parameter \(\psi_0\)

Definition at line 409 of file LALInspiralBank.h.

◆ psi0Max

REAL8 InspiralCoarseBankIn::psi0Max

maximum value of the parameter \(\psi_0\)

Definition at line 410 of file LALInspiralBank.h.

◆ psi3Min

REAL8 InspiralCoarseBankIn::psi3Min

minimum value of the parameter \(\psi_3\)

Definition at line 411 of file LALInspiralBank.h.

◆ psi3Max

REAL8 InspiralCoarseBankIn::psi3Max

maximum value of the parameter \(\psi_3\)

Definition at line 412 of file LALInspiralBank.h.

◆ mmCoarse

REAL8 InspiralCoarseBankIn::mmCoarse

Coarse grid minimal match.

Definition at line 413 of file LALInspiralBank.h.

◆ mmFine

REAL8 InspiralCoarseBankIn::mmFine

Fine grid minimal match.

Definition at line 414 of file LALInspiralBank.h.

◆ fLower

REAL8 InspiralCoarseBankIn::fLower

Lower frequency cutoff.

Definition at line 415 of file LALInspiralBank.h.

◆ fUpper

REAL8 InspiralCoarseBankIn::fUpper

Upper frequency cutoff.

Definition at line 416 of file LALInspiralBank.h.

◆ tSampling

REAL8 InspiralCoarseBankIn::tSampling

Sampling rate.

Definition at line 417 of file LALInspiralBank.h.

◆ etamin

REAL8 InspiralCoarseBankIn::etamin

minimum value of eta in our search

Definition at line 418 of file LALInspiralBank.h.

◆ betaMin

REAL8 InspiralCoarseBankIn::betaMin

UNDOCUMENTED.

Definition at line 419 of file LALInspiralBank.h.

◆ betaMax

REAL8 InspiralCoarseBankIn::betaMax

UNDOCUMENTED.

Definition at line 420 of file LALInspiralBank.h.

◆ chiMin

REAL8 InspiralCoarseBankIn::chiMin

UNDOCUMENTED.

Definition at line 421 of file LALInspiralBank.h.

◆ chiMax

REAL8 InspiralCoarseBankIn::chiMax

UNDOCUMENTED.

Definition at line 422 of file LALInspiralBank.h.

◆ kappaMin

REAL8 InspiralCoarseBankIn::kappaMin

UNDOCUMENTED.

Definition at line 423 of file LALInspiralBank.h.

◆ kappaMax

REAL8 InspiralCoarseBankIn::kappaMax

UNDOCUMENTED.

Definition at line 424 of file LALInspiralBank.h.

◆ nPointsChi

INT4 InspiralCoarseBankIn::nPointsChi

UNDOCUMENTED.

Definition at line 425 of file LALInspiralBank.h.

◆ nPointsKappa

INT4 InspiralCoarseBankIn::nPointsKappa

UNDOCUMENTED.

Definition at line 426 of file LALInspiralBank.h.

◆ shf

REAL8FrequencySeries InspiralCoarseBankIn::shf

Frequency series containing the PSD.

Definition at line 427 of file LALInspiralBank.h.

◆ ShMaxSz

UINT4 InspiralCoarseBankIn::ShMaxSz

Maximum size of the power spectral density array for use in the computation of the metric in SBBH; typical values that assures that the code runs quickly are 1024-8192.

Definition at line 428 of file LALInspiralBank.h.

◆ iseed

UINT4 InspiralCoarseBankIn::iseed

See for random number generation in RandomBank algorithm.

Definition at line 432 of file LALInspiralBank.h.

◆ nTIni

UINT4 InspiralCoarseBankIn::nTIni

nTIni is an estimate for the number of templates that might be required; this is used in the random bank generation routine with a seed number of templates = nTIni*sqrt(nTIni)

Definition at line 433 of file LALInspiralBank.h.

◆ iflso

INT4 InspiralCoarseBankIn::iflso

iflso is an integer that tells whether to compute the moments using an upper limit defined by flso; this is not used anywhere at the moment

Definition at line 437 of file LALInspiralBank.h.

◆ spinBank

INT4 InspiralCoarseBankIn::spinBank

spinBank=0:use Owen+Hanna bank, spinBank=1:use extended bank by AEI/Cardiff/Osaka, spinBank=2:use random bank algorithm

Definition at line 442 of file LALInspiralBank.h.

◆ numFcutTemplates

UINT4 InspiralCoarseBankIn::numFcutTemplates

Number of templates required in the fCut (upper cutoff) dimension and the value of upper and lower cutoffs.

Definition at line 446 of file LALInspiralBank.h.

◆ HighGM

REAL4 InspiralCoarseBankIn::HighGM

UNDOCUMENTED.

Definition at line 449 of file LALInspiralBank.h.

◆ LowGM

REAL4 InspiralCoarseBankIn::LowGM

UNDOCUMENTED.

Definition at line 450 of file LALInspiralBank.h.

◆ gridSpacing

GridSpacing InspiralCoarseBankIn::gridSpacing

Type of gridspacing required.

Definition at line 451 of file LALInspiralBank.h.

◆ order

LALPNOrder InspiralCoarseBankIn::order

Post-Newtonian order of the waveform.

Definition at line 454 of file LALInspiralBank.h.

◆ approximant

Approximant InspiralCoarseBankIn::approximant

Approximant of the waveform.

Definition at line 455 of file LALInspiralBank.h.

◆ ampOrder

LALPNOrder InspiralCoarseBankIn::ampOrder

Definition at line 456 of file LALInspiralBank.h.

◆ numFreqCut

INT4 InspiralCoarseBankIn::numFreqCut

Number of different upper frequency cutoffs (spaced evenly between minFreqCut and maxFreqCut) to use when creating a template bank.

Definition at line 459 of file LALInspiralBank.h.

◆ maxFreqCut

FreqCut InspiralCoarseBankIn::maxFreqCut

largest upper frequency cutoff to use

Definition at line 460 of file LALInspiralBank.h.

◆ minFreqCut

FreqCut InspiralCoarseBankIn::minFreqCut

smallest upper frequency cutoff to use

Definition at line 461 of file LALInspiralBank.h.

◆ insidePolygon

InsidePolygonEnum InspiralCoarseBankIn::insidePolygon

UNDOCUMENTED.

Definition at line 463 of file LALInspiralBank.h.

◆ computeMoments

ComputeMoments InspiralCoarseBankIn::computeMoments

ComputeMoments tells whether to re-compute the moments using an upper limit defined by flso; This is done after the template bank is gnerated.

Definition at line 464 of file LALInspiralBank.h.