Detailed Description

This structure contains a frequency domain template used as input to the FindChirpFilter() routine.

This may either be a template generated in the frequency domain or the Fourier transform of template generated in the time domain.

Definition at line 132 of file FindChirpDatatypes.h.

Data Fields
InspiralTemplate	tmplt
	The template parameters of this `FindChirpTemplate`; In addition to the mass parameters the following fields of `tmplt` should populated by the template generation functions as the are used by `FindChirpFilterSegment()`: More...

COMPLEX8Vector *	data
	Vector of length \(N/2+1\) containing the frequency template data \(\tilde{T}_k\); For a template generated in the frequency domain template (FindChirpSP) this should contain More...

COMPLEX8VectorSequence *	ACTDtilde
	UNDOCUMENTED. More...

REAL4VectorSequence *	PTFQ
	UNDOCUMENTED. More...

COMPLEX8VectorSequence *	PTFQtilde
	UNDOCUMENTED. More...

REAL4Array *	PTFBinverse
	UNDOCUMENTED. More...

REAL4Array *	PTFB
	UNDOCUMENTED. More...

REAL4	tmpltNorm
	The template dependent normalisation constant \(\mathcal{T}\); For the stationary phase template FindChirpSP this is. More...

REAL4	norm
	UNDOCUMENTED. More...

REAL8	momentI
	Undocumented BCV normalization constant. More...

REAL8	momentJ
	Undocumented BCV normalization constant. More...

REAL8	momentK
	Undocumented BCV normalization constant. More...

REAL8	rootMomentI
	Undocumented BCV normalization constant. More...

REAL8	numFactor
	Undocumented BCV normalization constant. More...

REAL8	numFactor1
	Undocumented BCV normalization constant. More...

REAL8	numFactor2
	Undocumented BCV normalization constant. More...

REAL8	numFactor3
	Undocumented BCV normalization constant. More...

REAL8Vector *	A1BCVSpin
	Undocumented spinning BCV template data. More...

REAL8Vector *	A2BCVSpin
	Undocumented spinning BCV template data. More...

REAL8Vector *	A3BCVSpin
	Undocumented spinning BCV template data. More...

Field Documentation

◆ tmplt

InspiralTemplate FindChirpTemplate::tmplt

The template parameters of this FindChirpTemplate; In addition to the mass parameters the following fields of tmplt should populated by the template generation functions as the are used by FindChirpFilterSegment():

approximant: Used to check that the findchirp data segment and the template have been created for the same type of waveform
tC: The length of the chirp in seconds; Used by the max over chirp event finding algorithm
fFinal: The highest frequency component of the chirp; Used to pick the appropriate value of the segment normalization constant \(\mathcal{S}_k\) for this template

Definition at line 135 of file FindChirpDatatypes.h.

◆ data

COMPLEX8Vector* FindChirpTemplate::data

Vector of length \(N/2+1\) containing the frequency template data \(\tilde{T}_k\); For a template generated in the frequency domain template (FindChirpSP) this should contain

\begin{equation} \tilde{T}_k = \exp\left[i\Psi(f_k;M,\eta)\right] \Theta\left(k-k_\mathrm{isco}\right) \end{equation}

For a template generated in the time domain this should contain the discrete Fourier transform of the cosine phase chirp

\begin{equation} \tilde{T}_k = \tilde{h}_{ck} = \mathrm{DFT}\left[ h(t) \right] \end{equation}

where \(h(t)\) is an inspiral waveform generated by the LALInspiralWave() function if the approximant TaylorT1, TaylorT2, TaylorT3, PadeT1 or EOB; Alternatively \(h(t)\) can be generated by the LALGeneratePPNInspiral() function if the approximant is GeneratePPN; Findchirp always uses second order post-Newtonian templates

Definition at line 149 of file FindChirpDatatypes.h.

◆ ACTDtilde

COMPLEX8VectorSequence* FindChirpTemplate::ACTDtilde

UNDOCUMENTED.

Definition at line 166 of file FindChirpDatatypes.h.

◆ PTFQ

REAL4VectorSequence* FindChirpTemplate::PTFQ

UNDOCUMENTED.

Definition at line 167 of file FindChirpDatatypes.h.

◆ PTFQtilde

COMPLEX8VectorSequence* FindChirpTemplate::PTFQtilde

UNDOCUMENTED.

Definition at line 168 of file FindChirpDatatypes.h.

◆ PTFBinverse

REAL4Array* FindChirpTemplate::PTFBinverse

UNDOCUMENTED.

Definition at line 169 of file FindChirpDatatypes.h.

◆ PTFB

REAL4Array* FindChirpTemplate::PTFB

UNDOCUMENTED.

Definition at line 170 of file FindChirpDatatypes.h.

◆ tmpltNorm

REAL4 FindChirpTemplate::tmpltNorm

The template dependent normalisation constant \(\mathcal{T}\); For the stationary phase template FindChirpSP this is.

\begin{equation} \mathcal{T}(M,\mu) = \left[ \left(\frac{2dGM_\odot}{(1\,\mathrm{Mpc})c^2}\right) \left(\frac{5\mu}{96M_\odot}\right)^\frac{1}{2} \left(\frac{M}{\pi^2M_\odot}\right)^\frac{1}{3} \left(\frac{GM_\odot}{\Delta tc^3}\right)^{-\frac{1}{6}} \right]^2 \end{equation}

where \(d\) is the dynamic range parameter dynRange; For time domain templates generated by LALInspiralWave() (TaylorT1, TaylorT2, TaylorT3, PadeT1 and EOB) this is

\begin{equation} \mathcal{T}(\mu) = \left[ \left(\frac{4dGM_\odot}{(1\,\mathrm{Mpc})c^2}\right) \left(\frac{\mu}{M_\odot}\right) \right]^2; \end{equation}

For time domain templates generated by LALGeneratePPNInspiral() (GeneratePPN) it is

\begin{equation} \mathcal{T} = \left(\frac{d}{1\,\mathrm{Mpc}}\right)^2 \end{equation}

Definition at line 171 of file FindChirpDatatypes.h.

◆ norm

REAL4 FindChirpTemplate::norm

UNDOCUMENTED.

Definition at line 194 of file FindChirpDatatypes.h.