Loading [MathJax]/extensions/TeX/AMSsymbols.js
LALApps 10.1.0.1-b246709
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
FindChirpTmpltParams Struct Reference

Detailed Description

This structure contains the parameters for generation of templates by the various template generation functions provided in FindChirp Package.

Definition at line 77 of file FindChirpDatatypes.h.

Data Fields

REAL8 deltaT
 The sampling interval \(\Delta t\) of the input data channel. More...
 
REAL4 fLow
 The frequency domain low frequency cutoff \(f_\mathrm{low}\); All frequency domain data is zero below this frequency. More...
 
REAL4 dynRange
 A dynamic range factor \(d\) which cancels from the filter output; This allows quantities to be stored in the range of REAL4 rather than REAL8; This must be set to the same value as dynRange in the FindChirpDataParams; For LIGO data a value of \(d = 2^{69}\) is appropriate. More...
 
UINT4 invSpecTrunc
 The length to which to truncate the inverse power spectral density of the data in the time domain; If set to zero, no truncation is performed. More...
 
REAL4VectorxfacVec
 For frequency domain templates, this is a vector of length \(N/2+1\) which contains the quantity \(k^{-1/3}\); For time domain templates, this is a workspace vector of length \(N\) which contains the time domain template generated by the inspiral package, shifted so that the end of the template is at the end of the vector; This vector is Fourier transformed to obtain the quantity findchirp template \(\tilde{T}_k\). More...
 
REAL4VectorSequenceACTDVecs
 UNDOCUMENTED. More...
 
REAL4VectorPTFphi
 UNDOCUMENTED. More...
 
REAL4VectorPTFomega_2_3
 UNDOCUMENTED. More...
 
REAL4VectorSequencePTFe1
 UNDOCUMENTED. More...
 
REAL4VectorSequencePTFe2
 UNDOCUMENTED. More...
 
RealFFTPlanfwdPlan
 For time domain templates, an FFTW plan used to transform the time domain data stored in xfacVec into its DFT which is stored in the findchirp template. More...
 
Approximant approximant
 Generate templates of type approximant; Valid approximants are TaylorT1, TaylorT2, TaylorT3, PadeT1, EOB, FindChirpSP, BCV and BCVSpin; For time domain templates the post-Newtonian order is always two; For stationary phase templates, the post-Newtonian order is specified by order. More...
 
LALPNOrder order
 Specifies the post-Newtonian order of the templates; Valid pN orders are LAL_PNORDER_TWO, LAL_PNORDER_TWO_POINT_FIVE, LAL_PNORDER_THREE, LAL_PNORDER_THREE_POINT_FIVE, LAL_PNORDER_PSEUDO_FOUR; The latter is not the true four PN correction, but may increase the fitting factor between stationary phase and numerical relativity waveforms. More...
 
INT4 reverseChirpBank
 Switches a FindChirpSP template bank to be a reverse chirp template bank if true. More...
 
INT4 bandPassTmplt
 UNDOCUMENTED. More...
 
LALSimInspiralApplyTaper taperTmplt
 UNDOCUMENTED. More...
 
INT4 dynamicTmpltFlow
 Use longest template that will fit in pad length. More...
 
REAL4 maxTempLength
 This can be used to store the maximum allowed template length, given the pad length and spectrum truncation. More...
 

Field Documentation

◆ deltaT

REAL8 FindChirpTmpltParams::deltaT

The sampling interval \(\Delta t\) of the input data channel.

Definition at line 80 of file FindChirpDatatypes.h.

◆ fLow

REAL4 FindChirpTmpltParams::fLow

The frequency domain low frequency cutoff \(f_\mathrm{low}\); All frequency domain data is zero below this frequency.

Definition at line 81 of file FindChirpDatatypes.h.

◆ dynRange

REAL4 FindChirpTmpltParams::dynRange

A dynamic range factor \(d\) which cancels from the filter output; This allows quantities to be stored in the range of REAL4 rather than REAL8; This must be set to the same value as dynRange in the FindChirpDataParams; For LIGO data a value of \(d = 2^{69}\) is appropriate.

Definition at line 82 of file FindChirpDatatypes.h.

◆ invSpecTrunc

UINT4 FindChirpTmpltParams::invSpecTrunc

The length to which to truncate the inverse power spectral density of the data in the time domain; If set to zero, no truncation is performed.

Definition at line 86 of file FindChirpDatatypes.h.

◆ xfacVec

REAL4Vector* FindChirpTmpltParams::xfacVec

For frequency domain templates, this is a vector of length \(N/2+1\) which contains the quantity \(k^{-1/3}\); For time domain templates, this is a workspace vector of length \(N\) which contains the time domain template generated by the inspiral package, shifted so that the end of the template is at the end of the vector; This vector is Fourier transformed to obtain the quantity findchirp template \(\tilde{T}_k\).

Definition at line 90 of file FindChirpDatatypes.h.

◆ ACTDVecs

REAL4VectorSequence* FindChirpTmpltParams::ACTDVecs

UNDOCUMENTED.

Definition at line 97 of file FindChirpDatatypes.h.

◆ PTFphi

REAL4Vector* FindChirpTmpltParams::PTFphi

UNDOCUMENTED.

Definition at line 98 of file FindChirpDatatypes.h.

◆ PTFomega_2_3

REAL4Vector* FindChirpTmpltParams::PTFomega_2_3

UNDOCUMENTED.

Definition at line 99 of file FindChirpDatatypes.h.

◆ PTFe1

REAL4VectorSequence* FindChirpTmpltParams::PTFe1

UNDOCUMENTED.

Definition at line 100 of file FindChirpDatatypes.h.

◆ PTFe2

REAL4VectorSequence* FindChirpTmpltParams::PTFe2

UNDOCUMENTED.

Definition at line 101 of file FindChirpDatatypes.h.

◆ fwdPlan

RealFFTPlan* FindChirpTmpltParams::fwdPlan

For time domain templates, an FFTW plan used to transform the time domain data stored in xfacVec into its DFT which is stored in the findchirp template.

Definition at line 102 of file FindChirpDatatypes.h.

◆ approximant

Approximant FindChirpTmpltParams::approximant

Generate templates of type approximant; Valid approximants are TaylorT1, TaylorT2, TaylorT3, PadeT1, EOB, FindChirpSP, BCV and BCVSpin; For time domain templates the post-Newtonian order is always two; For stationary phase templates, the post-Newtonian order is specified by order.

Definition at line 106 of file FindChirpDatatypes.h.

◆ order

LALPNOrder FindChirpTmpltParams::order

Specifies the post-Newtonian order of the templates; Valid pN orders are LAL_PNORDER_TWO, LAL_PNORDER_TWO_POINT_FIVE, LAL_PNORDER_THREE, LAL_PNORDER_THREE_POINT_FIVE, LAL_PNORDER_PSEUDO_FOUR; The latter is not the true four PN correction, but may increase the fitting factor between stationary phase and numerical relativity waveforms.

Definition at line 112 of file FindChirpDatatypes.h.

◆ reverseChirpBank

INT4 FindChirpTmpltParams::reverseChirpBank

Switches a FindChirpSP template bank to be a reverse chirp template bank if true.

Definition at line 118 of file FindChirpDatatypes.h.

◆ bandPassTmplt

INT4 FindChirpTmpltParams::bandPassTmplt

UNDOCUMENTED.

Definition at line 119 of file FindChirpDatatypes.h.

◆ taperTmplt

LALSimInspiralApplyTaper FindChirpTmpltParams::taperTmplt

UNDOCUMENTED.

Definition at line 120 of file FindChirpDatatypes.h.

◆ dynamicTmpltFlow

INT4 FindChirpTmpltParams::dynamicTmpltFlow

Use longest template that will fit in pad length.

Definition at line 121 of file FindChirpDatatypes.h.

◆ maxTempLength

REAL4 FindChirpTmpltParams::maxTempLength

This can be used to store the maximum allowed template length, given the pad length and spectrum truncation.

Definition at line 122 of file FindChirpDatatypes.h.