Loading [MathJax]/extensions/TeX/AMSsymbols.js
LALInspiral 5.0.3.1-ea7c608
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
LALInspiralBank.h File Reference

Prototypes

void LALInspiralCreateCoarseBank (LALStatus *status, InspiralTemplateList **list, INT4 *nlist, InspiralCoarseBankIn bankIn)
 
void LALInspiralCreatePNCoarseBank (LALStatus *status, InspiralTemplateList **list, INT4 *nlist, InspiralCoarseBankIn coarseIn)
 
void LALInspiralCreateBCVBank (LALStatus *status, InspiralTemplateList **list, INT4 *nlist, InspiralCoarseBankIn coarseIn)
 Lay a flat grid of BCV templates in the user specified range of the parameters \((\psi_0, \psi_3)\) in coarseIn structure. More...
 
void LALInspiralCreateFlatBankS3S4 (LALStatus *status, REAL4VectorSequence *list, InspiralBankParams *bankParams, InspiralCoarseBankIn coarseIn)
 UNDOCUMENTED. More...
 
void LALExcludeTemplate (LALStatus *status, INT4 *valid, InspiralBankParams *bankParams, REAL4 x, REAL4 y)
 
void LALInspiralBCVBankFcutS3S4 (LALStatus *status, InspiralTemplateList **list, INT4 *NList, InspiralCoarseBankIn coarseIn)
 UNDOCUMENTED. More...
 
void LALInspiralBCVFcutBank (LALStatus *status, InspiralTemplateList **list, INT4 *NList, InspiralCoarseBankIn coarseIn)
 Given a grid of templates with distinct values of \((\psi_0, \psi_3)\) this routine returns a new grid in which every template has numFcutTemplates partners differing from one another in the ending frequency fendBCV. More...
 
void LALEmpiricalPSItoMassesConversion (LALStatus *status, InspiralTemplate *params, UINT4 *valid, REAL4 lightring)
 UNDOCUMENTED. More...
 
void LALPSItoMasses (LALStatus *status, InspiralTemplate *params, UINT4 *valid, REAL4 thisfreq)
 UNDOCUMENTED. More...
 
void LALInspiralBCVRegularFcutBank (LALStatus *status, InspiralTemplateList **list, INT4 *NList, InspiralCoarseBankIn coarseIn)
 UNDOCUMENTED. More...
 
void LALNudgeTemplatesToConstantTotalMassLine (LALStatus *status, InspiralTemplateList **list, INT4 nlist, InspiralCoarseBankIn coarseIn)
 Anand: 26 October 2006 This function nudges the templates in the list to the (max-total-mass = constant) line. More...
 
REAL4 XLALInspiralTau3FromTau0AndEqualMassLine (REAL4 tau0, REAL4 fL)
 
REAL4 XLALInspiralTau3FromNonEqualMass (REAL4 m1, REAL4 m2, REAL4 fL)
 
REAL4 XLALInspiralTau0FromMEta (REAL4 M, REAL4 eta, REAL4 fL)
 
REAL8 XLALInspiralBissectionLine (REAL8 x, REAL8 fL, REAL8 mMin, REAL8 mMax)
 
REAL8 XLALInspiralMFromTau0AndNonEqualMass (REAL8 tau0, REAL8 extremMass, REAL8 fL)
 
void LALInspiralSpinBank (LALStatus *status, SnglInspiralTable **tiles, INT4 *ntiles, InspiralCoarseBankIn *coarseIn)
 This function creates a bank of BCVSpin templates to search for precessing binaries. More...
 
void LALInspiralBankGeneration (LALStatus *status, InspiralCoarseBankIn *in, SnglInspiralTable **out, INT4 *count)
 
void LALInspiralCreateFlatBank (LALStatus *status, REAL4VectorSequence *list, InspiralBankParams *bankParams)
 The code expects list->vectorLength=2 and allocates just the requisite amount of memory to list and returns the number of grid points in list->length. More...
 
void LALInspiralCreateFineBank (LALStatus *status, InspiralTemplateList **outlist, INT4 *nlist, InspiralFineBankIn fineIn)
 Function to create a fine grid of templates. More...
 
void LALInspiralComputeMetric (LALStatus *status, InspiralMetric *metric, InspiralTemplate *params, InspiralMomentsEtc *moments)
 
int XLALInspiralComputeMetric (InspiralMetric *metric, InspiralMomentsEtc *moments, REAL8 fLower, LALPNOrder order, REAL8 t0, REAL8 t3)
 Function to compute the components of the metric which is used to describe distances on the signal manifold. More...
 
void LALInspiralComputeMetricBCV (LALStatus *status, InspiralMetric *metric, REAL8FrequencySeries *psd, InspiralTemplate *params)
 UNDOCUMENTED. More...
 
void LALInspiralLongestTemplateInBank (LALStatus *status, UINT4 *templateLength, InspiralCoarseBankIn *coarseIn)
 Function to find the longest template in a template bank. More...
 
void LALGetInspiralMoments (LALStatus *status, InspiralMomentsEtc *moments, REAL8FrequencySeries *psd, InspiralTemplate *params)
 
int XLALGetInspiralMoments (InspiralMomentsEtc *moments, REAL8 fLower, REAL8 fCutoff, REAL8FrequencySeries *psd)
 
void LALGetInspiralMomentsBCV (LALStatus *status, InspiralMomentsEtcBCV *moments, REAL8FrequencySeries *psd, InspiralTemplate *params)
 
void LALInspiralMoments (LALStatus *status, REAL8 *moment, InspiralMomentsIn pars)
 
REAL8 XLALInspiralMoments (REAL8 xmin, REAL8 xmax, REAL8 ndx, REAL8 norm, REAL8FrequencySeries *shf)
 
void LALInspiralSetSearchLimits (LALStatus *status, InspiralBankParams *bankParams, InspiralCoarseBankIn coarseIn)
 Function which calculates the minimum and maximum values of \(\tau_{0}\) and \(\tau_{3}\). More...
 
void LALInspiralNextTemplate (LALStatus *status, InspiralBankParams *bankPars, InspiralMetric metric)
 Routine to compute the parameters of the template next to the current template, but in the positive \(\tau_{2(3)}\) axis. More...
 
void LALInspiralComputeParams (LALStatus *status, InspiralTemplate *pars, InspiralBankParams bankParams, InspiralCoarseBankIn coarseIn)
 This function takes as input \(\tau_{0}\), \(\tau_{3}\) and \(f_a\) (the lower frequency of the detectors sensitivity), it then calculates \(m\) (the total mass of the binary), \(\eta\) (the symmetric mass ratio) and the individual mass of the compact objects. More...
 
void LALInspiralValidParams (LALStatus *status, INT4 *valid, InspiralBankParams bankParams, InspiralCoarseBankIn coarseIn)
 Function which checks whether or not a pair of parameter values are consistent with the search space. More...
 
void LALInspiralValidTemplate (LALStatus *status, INT4 *valid, InspiralBankParams bankParams, InspiralCoarseBankIn coarseIn)
 Function which checks whether or not a given template should be kept in the template list. More...
 
void LALInspiralUpdateParams (LALStatus *status, InspiralBankParams *bankParams, InspiralMetric metric, REAL8 minimalmatch)
 Function to update the parameters used in creating a coarse bank based on a square lattice. More...
 
void LALInspiralSetParams (LALStatus *status, InspiralTemplate *tempPars, InspiralCoarseBankIn coarseIn)
 A routine that fills an InspiralTemplate structure based on the values in the InspiralCoarseBankIn structure. More...
 
void LALRectangleVertices (LALStatus *status, RectangleOut *out, RectangleIn *in)
 Function to find the vertices of a rectangle given its centre, half side-lengths and orientation angle. More...
 
void LALHexagonVertices (LALStatus *status, HexagonOut *out, RectangleIn *in)
 
void LALInsidePolygon (LALStatus *status, REAL4 *inputx, REAL4 *inputy, INT4 n, REAL4 x, REAL4 y, INT4 *valid)
 Module to check whether a point with coordinates (x,y) is inside a polygon defined by the vectors (vx, vy), which size (n) must be provided. More...
 
void LALInspiralCreatePNCoarseBankHexa (LALStatus *status, InspiralTemplateList **list, INT4 *nlist, InspiralCoarseBankIn coarseIn)
 
void LALInspiralCreatePNCoarseBankHybridHexa (LALStatus *status, InspiralTemplateList **list, INT4 *nlist, InspiralCoarseBankIn coarseIn)
 
void LALInitHexagonalBank (LALStatus *status, InspiralCell **cell, INT4 id, InspiralMomentsEtc *moments, InspiralTemplate *paramsIn, HexaGridParam *gridParam, CellEvolution *cellEvolution, CellList **cellList)
 
void LALPopulateCell (LALStatus *status, InspiralMomentsEtc *moments, InspiralCell **cell, INT4 l, InspiralTemplate *paramsIn, HexaGridParam *gridParam, CellEvolution *cellEvolution, CellList **cellList)
 
void LALFindPosition (LALStatus *status, REAL4 dx0, REAL4 dx1, Position *position, InspiralTemplate *paramsIn, HexaGridParam *gridParam)
 
void LALSPAValidPosition (LALStatus *status, InspiralCell **cell, INT4 id1, InspiralMomentsEtc *moments, CellEvolution *cellEvolution, CellList **list)
 
void GetPositionRectangle (LALStatus *status, InspiralCell **cell, INT4 id, InspiralTemplate *params, HexaGridParam *gridParam, CellEvolution *cellEvolution, CellList **cellList, INT4 *valid)
 
void LALListAppend (CellList **headRef, INT4 id)
 
void LALListDelete (CellList **headRef, INT4 id)
 
UINT4 LALListLength (CellList *head)
 
void LALSPAF (LALStatus *status, REAL4 *result, REAL4 x, void *t3)
 
INT4 XLALInspiralComputePTFIntrinsicMetric (InspiralMetric *metric, REAL8Vector *fullmetric, REAL8FrequencySeries *psd, InspiralTemplate *params)
 
INT4 XLALInspiralComputePTFWaveform (REAL8Vector *ptfwave, InspiralTemplate *params)
 
INT4 XLALInspiralComputePTFWDeriv (COMPLEX16Vector *Wderiv, REAL8FrequencySeries *psd, InspiralTemplate *params, INT4 paramid, REAL8 initdelta, REAL8 tolerance)
 

Go to the source code of this file.

Data Structures

struct  InspiralMetric
 Structure to store metric at various points the signal manifold. More...
 
struct  InspiralTemplateList
 A grid of inspiral templates (ie a template list). More...
 
struct  HexaGridParam
 This is a structure needed in the inner workings of the LALInspiralHexagonalBank code. More...
 
struct  CellEvolution
 This is a structure needed in the inner workings of the LALInspiralHexagonalBank code. More...
 
struct  CellList
 This is a structure needed in the inner workings of the LALInspiralHexagonalBank code. More...
 
struct  InspiralCell
 This is a structure needed in the inner workings of the LALInspiralHexagonalBank code. More...
 
struct  InspiralBankParams
 This is a structure needed in the inner workings of the LALInspiralCreateCoarseBank code. More...
 
struct  InspiralCoarseBankIn
 Input for choosing a template bank. More...
 
struct  InspiralMomentsIn
 Inputs to the function that computes the moments of the PSD. More...
 
struct  InspiralFineBankIn
 Structure needed by the function LALInspiralCreateFineBank. More...
 
struct  InspiralMomentsEtc
 Parameter structure that holds the moments of the PSD and other useful constants required in the computation of the metric. More...
 
struct  InspiralMomentsEtcBCV
 UNDOCUMENTED. More...
 
struct  RectangleIn
 Input structure to function LALRectangleVertices() More...
 
struct  RectangleOut
 Output structure to function LALRectangleVertices(). More...
 
struct  HexagonOut
 UNDOCUMENTED. More...
 
struct  PRIN
 UNDOCUMENTED. More...
 

Macros

Error Codes
#define LALINSPIRALBANKH_ENULL   1
 Null pointer. More...
 
#define LALINSPIRALBANKH_EMEM   2
 Memory allocation failure. More...
 
#define LALINSPIRALBANKH_ECHOICE   3
 Invalid choice for an input parameter. More...
 
#define LALINSPIRALBANKH_EDIV0   4
 Division by zero. More...
 
#define LALINSPIRALBANKH_ESIZE   8
 Invalid input range. More...
 
#define LALINSPIRALBANKH_EFRANGE   16
 Limits outside range of frequency series. More...
 
#define LALINSPIRALBANKH_EORDER   32
 Inappropriate PN order. More...
 
#define LALINSPIRALBANKH_EGRIDSPACING   64
 Inappropriate grid spacing parameter [SquareNotOriented or Hexagonal]. More...
 
#define LALINSPIRALBANKH_EHEXAINIT   128
 Empty bank. More...
 
#define LALINSPIRALBANKH_EFCUT   5
 Inappropriate cutoff frequency [SchwarzISCO, BKLISCO, LightRing, ERD, FRD or LRD]. More...
 
#define LALINSPIRALBANKH_EFHIGH   6
 Final frequency is less than the low frequency cutoff. More...
 
#define LALINSPIRALBANKH_ENUMFCUT   7
 Number of fcut must be greater or equal to 1. More...
 

Enumerations

enum  ComputeMoments { disable , enable }
 UNDOCUMENTED. More...
 
enum  CoordinateSpace {
  Tau0Tau2 , Tau0Tau3 , Psi0Psi3 , PTFIntrinsic ,
  PTFFull
}
 Choose templates either in the \((\tau_0,\tau_2)\) or \((\tau_0,\tau_3)\) space. More...
 
enum  GridSpacing {
  SquareNotOriented , Square , HexagonalNotOriented , Hexagonal ,
  HybridHexagonal , S2BCV
}
 This enum is set by the user to specify the type of placement requested. More...
 
enum  Position {
  In , Above , Below , Out ,
  Edge
}
 This enum can take the following values In, Out, Below, Edge, Above and is used only by the Hexagonal placement. More...
 
enum  InsidePolygonEnum { False , True }
 This enum is set to true or false, it is just a boolean variable for the purpose of BCV placement but can be used in an other context. More...
 
enum  Generation { Sterile , Fertile }
 This enum is either fertile,sterile, and is a boolean expression used only by the Hexagonal placement. More...
 
enum  InspiralBankMassRange { MinComponentMassMaxTotalMass , MinMaxComponentMass , MinMaxComponentTotalMass }
 An enum that appears in the InspiralCoarseBankIn structure which fixes the way templates are chosen: The choice MinComponentMassMaxTotalMass means the minimum of the component masses will be given by mMin and maximum total mass is given by MMax of the InspiralBankCoarseIn structure. More...
 
enum  FreqCut {
  FreqCut_SchwarzISCO , FreqCut_BKLISCO , FreqCut_LightRing , FreqCut_ERD ,
  FreqCut_FRD , FreqCut_LRD
}
 An enum that lists all the formulas that can be used to specify an upper frequency cutoff. More...