The inspiral waveform parameter structure containing information about the waveform to be generated.
Definition at line 203 of file LALInspiral.h.
Data Fields | |
LALSimInspiralFrameAxis | axisChoice |
UNDOCUMENTED. More... | |
struct tagInspiralTemplate * | next |
Linked list to the next coarse bank template (currently not filled by inspiral or bank codes) More... | |
struct tagInspiralTemplate * | fine |
Linked list to the next fine bank template (currently not filled by inspiral or bank codes) More... | |
Parameters needed to generate Taylor/Pade waveforms | |
Approximant | approximant |
Post-Newtonain approximant to be used in generating the wave (input) More... | |
LALPNOrder | order |
Post-Newtonain order to be used in generating the wave (input) More... | |
LALPNOrder | ampOrder |
UNDOCUMENTED. More... | |
REAL8 | mass1 |
Mass of the primary in solar mass (input/output) More... | |
REAL8 | mass2 |
Mass of the secondary in solar mass (mass1 need not be larger than mass2 (input/output) More... | |
REAL8 | fCutoff |
upper frequency cutoff in Hz to be used in generating the waveform; If the last stable orbit frequency is smaller than the upper cutoff it will be used in terminating the waveform instead of fCutoff (input) More... | |
REAL8 | fLower |
lower frequency cutoff of the detector in Hz (input) More... | |
REAL8 | tSampling |
Sampling rate in Hz (input) More... | |
REAL8 | distance |
Distance to the binary in seconds. More... | |
REAL8 | signalAmplitude |
dimensionless amplitude of the signal (input, currently unused) More... | |
REAL8 | startPhase |
starting phase of the waveform in radians (input) More... | |
REAL8 | startTime |
starting time of the waveform (in sec); if different from zero, the waveform will start with an instantaneous frequency different from fLower and reach fLower at time (approximately) zero (input, not used in Stationary phase approximation) More... | |
INT4 | ieta |
parameter that tells whether the symmetric mass ratio \(\eta\) should be set to zero in the PN expansions of GW flux and binding energy; If ieta=0 \(\eta\) will be set to zero, otherwise the appropriate value of \(\eta\) from the given parameters will be used More... | |
Additional parameters for EOB waveforms | |
REAL8 | Theta |
The 3PN unknown flux parameter; likely to be around unity; most waveform generation routines take theta to be zero; Robustness of the EOB waveform has been demonstrated for \(-2 < \) Theta \(< 2\) (input) More... | |
REAL8 | Zeta2 |
UNDOCUMENTED. More... | |
Parameters for BCV1 template | |
REAL8 | alpha |
BCV amplitude correction factor \(\alpha f_\mathrm{cut}^{2/3}\). More... | |
REAL8 | psi0 |
BCV parameter \(\psi_0\). More... | |
REAL8 | psi3 |
BCV parameter \(\psi_3\). More... | |
Additional parameters for BCV2 template | |
REAL8 | beta |
UNDOCUMENTED. More... | |
REAL8 | alpha1 |
UNDOCUMENTED. More... | |
REAL8 | alpha2 |
UNDOCUMENTED. More... | |
REAL8 | alpha3 |
UNDOCUMENTED. More... | |
REAL8 | alpha4 |
UNDOCUMENTED. More... | |
REAL8 | alpha5 |
UNDOCUMENTED. More... | |
REAL8 | alpha6 |
UNDOCUMENTED. More... | |
Parameters for spinning BH waveform | |
REAL8 | inclination |
Inclination of the orbit (currently not in use) More... | |
REAL8 | orbitTheta0 |
Initial co-latitute of the orbit. More... | |
REAL8 | orbitPhi0 |
Initial azimuth angle of the orbit. More... | |
REAL8 | spin1 [3] |
Spin vector of the primary. More... | |
REAL8 | spin2 [3] |
Spin vector of the secondary. More... | |
REAL8 | sourceTheta |
Co-latitute in the direction to the source. More... | |
REAL8 | sourcePhi |
Azimuth angle in the direction to the source. More... | |
REAL8 | polarisationAngle |
Spin parameters for the PTF template | |
REAL8 | chi |
dimensionless spin of black hole (ie mass1) More... | |
REAL8 | kappa |
cosine of angle between spin of mass1 and orb ang mom More... | |
Parameters which are currently might be used | |
REAL8 | eccentricity |
initial eccentricity of the orbit (currently not in use) More... | |
Paramters which are computed using LALInspiralParameterCalc | |
Note that tc and fFinal are computed during waveform generation!!! | |
REAL8 | chirpMass |
chirp mass of the binary \(=\eta^{3/5} m\) in solar mass (output) More... | |
REAL8 | eta |
symmetric mass ratio \(\eta=m_1m_2/m^2\) (input/output) More... | |
REAL8 | totalMass |
total mass of the binary \(m=m_1+m_2\) in solar mass (input/output) More... | |
REAL8 | fFinal |
final frequency reached, in units of Hz (output) More... | |
REAL8 | t0 |
Newtonain chirp time in seconds (input/output) More... | |
REAL8 | t2 |
first post-Newtonian chirp time in seconds (input/output) More... | |
REAL8 | t3 |
1.5 post-Newtonian chirp time in seconds (input/output) More... | |
REAL8 | t4 |
second post-Newtonian chirp time in seconds (output) More... | |
REAL8 | t5 |
2.5 post-Newtonian chirp time in seconds (output) More... | |
REAL8 | t6 |
third post-Newtonian chirp time in seconds (output) More... | |
REAL8 | t7 |
3.5 post-Newtonian chirp time in seconds (output) More... | |
REAL8 | tC |
total chirp time seconds (output) More... | |
REAL4 | minMatch |
The minimal match specified by the user when the bank that contains this template was created. More... | |
REAL8 | mu |
reduced mass (in solar mass) (input/output) More... | |
INT4 | level |
Flag used in heirarical serached to indicate if this is a coarse or a fine template. More... | |
INT4 | number |
Unique ID number for this template needed for the LDAS implementation of the inspiral search. More... | |
INT4 | nStartPad |
Number of leading elements in the signal generation to be set to zero (input) If template is requested, that value must be set to zero; In the injection routines related to inject package, that nStartPad is set to zero; However, for injection performed using the inspiral package, that value can be set to non zero. More... | |
INT4 | nEndPad |
Number of trailing bins to be set to zero, the resulting waveform will have at least this many bins zero at the end, probably more since we always deal with an integer power of 2 array (input) More... | |
REAL8 | OmegaS |
The 3PN (unknown) parameter; calculated to be equal to zero by Damour, Jaranowski and Schaffer (input) More... | |
REAL8 | vFinal |
final velocity parameter, in units of the speed of light (output) More... | |
InputMasses | massChoice |
The pair of (mass) parameters given (see structure defining this member for more details) (input) More... | |
INT4Vector * | segmentIdVec |
Vector of segment that have been filtered against this template needed for the LDAS implementation of the inspiral search More... | |
LIGOTimeGPS | end_time |
UNDOCUMENTED. More... | |
long | event_id |
UNDOCUMENTED. More... | |
CHAR | ifo [LIGOMETA_IFO_MAX] |
UNDOCUMENTED. More... | |
REAL4 | Gamma [10] |
Gamma[] is a vector that stores the upper triangular part of the metric in the space of parameters; For time domain searches, Gamma[0,...,5] stores the following information : Gamma[0] -> (tc,tc) metric component Gamma[1] -> (tc,t0) metric component Gamma[2] -> (tc,t3) metric component Gamma[3] -> (t0,t0) metric component Gamma[4] -> (t0,t3) metric component Gamma[5] -> (t3,t3) metric component For spinBCV searches, (in 4 dimensions) Gamma[0,...,9] would be required. More... | |
REAL4 | qmParameter [2] |
UNDOCUMENTED. More... | |
LALInspiralInteraction | interaction |
UNDOCUMENTED. More... | |
UINT4 | fixedStep |
UNDOCUMENTED. More... | |
UINT4 | inspiralOnly |
UNDOCUMENTED. More... | |
Approximant InspiralTemplate::approximant |
Post-Newtonain approximant to be used in generating the wave (input)
Definition at line 208 of file LALInspiral.h.
LALPNOrder InspiralTemplate::order |
Post-Newtonain order to be used in generating the wave (input)
Definition at line 209 of file LALInspiral.h.
LALPNOrder InspiralTemplate::ampOrder |
UNDOCUMENTED.
Definition at line 210 of file LALInspiral.h.
REAL8 InspiralTemplate::mass1 |
Mass of the primary in solar mass (input/output)
Definition at line 211 of file LALInspiral.h.
REAL8 InspiralTemplate::mass2 |
Mass of the secondary in solar mass (mass1
need not be larger than mass2
(input/output)
Definition at line 212 of file LALInspiral.h.
REAL8 InspiralTemplate::fCutoff |
upper frequency cutoff in Hz to be used in generating the waveform; If the last stable orbit frequency is smaller than the upper cutoff it will be used in terminating the waveform instead of fCutoff (input)
Definition at line 213 of file LALInspiral.h.
REAL8 InspiralTemplate::fLower |
lower frequency cutoff of the detector in Hz (input)
Definition at line 217 of file LALInspiral.h.
REAL8 InspiralTemplate::tSampling |
Sampling rate in Hz (input)
Definition at line 218 of file LALInspiral.h.
REAL8 InspiralTemplate::distance |
Distance to the binary in seconds.
Definition at line 219 of file LALInspiral.h.
REAL8 InspiralTemplate::signalAmplitude |
dimensionless amplitude of the signal (input, currently unused)
Definition at line 220 of file LALInspiral.h.
REAL8 InspiralTemplate::startPhase |
starting phase of the waveform in radians (input)
Definition at line 221 of file LALInspiral.h.
REAL8 InspiralTemplate::startTime |
starting time of the waveform (in sec); if different from zero, the waveform will start with an instantaneous frequency different from fLower and reach fLower at time (approximately) zero (input, not used in Stationary phase approximation)
Definition at line 222 of file LALInspiral.h.
INT4 InspiralTemplate::ieta |
parameter that tells whether the symmetric mass ratio \(\eta\) should be set to zero in the PN expansions of GW flux and binding energy; If ieta=0
\(\eta\) will be set to zero, otherwise the appropriate value of \(\eta\) from the given parameters will be used
Definition at line 226 of file LALInspiral.h.
REAL8 InspiralTemplate::Theta |
The 3PN unknown flux parameter; likely to be around unity; most waveform generation routines take theta to be zero; Robustness of the EOB waveform has been demonstrated for \(-2 < \) Theta
\(< 2\) (input)
Definition at line 235 of file LALInspiral.h.
REAL8 InspiralTemplate::Zeta2 |
UNDOCUMENTED.
Definition at line 239 of file LALInspiral.h.
REAL8 InspiralTemplate::alpha |
BCV amplitude correction factor \(\alpha f_\mathrm{cut}^{2/3}\).
Definition at line 244 of file LALInspiral.h.
REAL8 InspiralTemplate::psi0 |
BCV parameter \(\psi_0\).
Definition at line 245 of file LALInspiral.h.
REAL8 InspiralTemplate::psi3 |
BCV parameter \(\psi_3\).
Definition at line 246 of file LALInspiral.h.
REAL8 InspiralTemplate::beta |
UNDOCUMENTED.
Definition at line 251 of file LALInspiral.h.
REAL8 InspiralTemplate::alpha1 |
UNDOCUMENTED.
Definition at line 252 of file LALInspiral.h.
REAL8 InspiralTemplate::alpha2 |
UNDOCUMENTED.
Definition at line 253 of file LALInspiral.h.
REAL8 InspiralTemplate::alpha3 |
UNDOCUMENTED.
Definition at line 254 of file LALInspiral.h.
REAL8 InspiralTemplate::alpha4 |
UNDOCUMENTED.
Definition at line 255 of file LALInspiral.h.
REAL8 InspiralTemplate::alpha5 |
UNDOCUMENTED.
Definition at line 256 of file LALInspiral.h.
REAL8 InspiralTemplate::alpha6 |
UNDOCUMENTED.
Definition at line 257 of file LALInspiral.h.
REAL8 InspiralTemplate::inclination |
Inclination of the orbit (currently not in use)
Definition at line 262 of file LALInspiral.h.
REAL8 InspiralTemplate::orbitTheta0 |
Initial co-latitute of the orbit.
Definition at line 263 of file LALInspiral.h.
REAL8 InspiralTemplate::orbitPhi0 |
Initial azimuth angle of the orbit.
Definition at line 264 of file LALInspiral.h.
REAL8 InspiralTemplate::spin1[3] |
Spin vector of the primary.
Definition at line 265 of file LALInspiral.h.
REAL8 InspiralTemplate::spin2[3] |
Spin vector of the secondary.
Definition at line 266 of file LALInspiral.h.
REAL8 InspiralTemplate::sourceTheta |
Co-latitute in the direction to the source.
Definition at line 267 of file LALInspiral.h.
REAL8 InspiralTemplate::sourcePhi |
Azimuth angle in the direction to the source.
Definition at line 268 of file LALInspiral.h.
REAL8 InspiralTemplate::polarisationAngle |
Definition at line 269 of file LALInspiral.h.
REAL8 InspiralTemplate::chi |
dimensionless spin of black hole (ie mass1)
Definition at line 274 of file LALInspiral.h.
REAL8 InspiralTemplate::kappa |
cosine of angle between spin of mass1 and orb ang mom
Definition at line 275 of file LALInspiral.h.
REAL8 InspiralTemplate::eccentricity |
initial eccentricity of the orbit (currently not in use)
Definition at line 280 of file LALInspiral.h.
LALSimInspiralFrameAxis InspiralTemplate::axisChoice |
UNDOCUMENTED.
Definition at line 283 of file LALInspiral.h.
REAL8 InspiralTemplate::chirpMass |
chirp mass of the binary \(=\eta^{3/5} m\) in solar mass (output)
Definition at line 290 of file LALInspiral.h.
REAL8 InspiralTemplate::eta |
symmetric mass ratio \(\eta=m_1m_2/m^2\) (input/output)
Definition at line 291 of file LALInspiral.h.
REAL8 InspiralTemplate::totalMass |
total mass of the binary \(m=m_1+m_2\) in solar mass (input/output)
Definition at line 292 of file LALInspiral.h.
REAL8 InspiralTemplate::fFinal |
final frequency reached, in units of Hz (output)
Definition at line 293 of file LALInspiral.h.
REAL8 InspiralTemplate::t0 |
Newtonain chirp time in seconds (input/output)
Definition at line 294 of file LALInspiral.h.
REAL8 InspiralTemplate::t2 |
first post-Newtonian chirp time in seconds (input/output)
Definition at line 295 of file LALInspiral.h.
REAL8 InspiralTemplate::t3 |
1.5 post-Newtonian chirp time in seconds (input/output)
Definition at line 296 of file LALInspiral.h.
REAL8 InspiralTemplate::t4 |
second post-Newtonian chirp time in seconds (output)
Definition at line 297 of file LALInspiral.h.
REAL8 InspiralTemplate::t5 |
2.5 post-Newtonian chirp time in seconds (output)
Definition at line 298 of file LALInspiral.h.
REAL8 InspiralTemplate::t6 |
third post-Newtonian chirp time in seconds (output)
Definition at line 299 of file LALInspiral.h.
REAL8 InspiralTemplate::t7 |
3.5 post-Newtonian chirp time in seconds (output)
Definition at line 300 of file LALInspiral.h.
REAL8 InspiralTemplate::tC |
total chirp time seconds (output)
Definition at line 301 of file LALInspiral.h.
REAL4 InspiralTemplate::minMatch |
The minimal match specified by the user when the bank that contains this template was created.
Definition at line 303 of file LALInspiral.h.
REAL8 InspiralTemplate::mu |
reduced mass (in solar mass) (input/output)
Definition at line 304 of file LALInspiral.h.
INT4 InspiralTemplate::level |
Flag used in heirarical serached to indicate if this is a coarse or a fine template.
Definition at line 305 of file LALInspiral.h.
INT4 InspiralTemplate::number |
Unique ID number for this template needed for the LDAS implementation of the inspiral search.
Definition at line 306 of file LALInspiral.h.
INT4 InspiralTemplate::nStartPad |
Number of leading elements in the signal generation to be set to zero (input) If template is requested, that value must be set to zero; In the injection routines related to inject package, that nStartPad is set to zero; However, for injection performed using the inspiral package, that value can be set to non zero.
Definition at line 307 of file LALInspiral.h.
INT4 InspiralTemplate::nEndPad |
Number of trailing bins to be set to zero, the resulting waveform will have at least this many bins zero at the end, probably more since we always deal with an integer power of 2 array (input)
Definition at line 312 of file LALInspiral.h.
REAL8 InspiralTemplate::OmegaS |
The 3PN (unknown) parameter; calculated to be equal to zero by Damour, Jaranowski and Schaffer (input)
Definition at line 315 of file LALInspiral.h.
REAL8 InspiralTemplate::vFinal |
final velocity parameter, in units of the speed of light (output)
Definition at line 316 of file LALInspiral.h.
InputMasses InspiralTemplate::massChoice |
The pair of (mass) parameters given (see structure defining this member for more details) (input)
Definition at line 323 of file LALInspiral.h.
INT4Vector* InspiralTemplate::segmentIdVec |
Vector of segment that have been filtered against this template needed for the LDAS implementation of the inspiral search
Definition at line 324 of file LALInspiral.h.
LIGOTimeGPS InspiralTemplate::end_time |
UNDOCUMENTED.
Definition at line 325 of file LALInspiral.h.
long InspiralTemplate::event_id |
UNDOCUMENTED.
Definition at line 326 of file LALInspiral.h.
CHAR InspiralTemplate::ifo[LIGOMETA_IFO_MAX] |
UNDOCUMENTED.
Definition at line 327 of file LALInspiral.h.
REAL4 InspiralTemplate::Gamma[10] |
Gamma[] is a vector that stores the upper triangular part of the metric in the space of parameters; For time domain searches, Gamma[0,...,5] stores the following information :
Gamma[0] -> (tc,tc) metric component
Gamma[1] -> (tc,t0) metric component
Gamma[2] -> (tc,t3) metric component
Gamma[3] -> (t0,t0) metric component
Gamma[4] -> (t0,t3) metric component
Gamma[5] -> (t3,t3) metric component
For spinBCV searches, (in 4 dimensions) Gamma[0,...,9] would be required.
Definition at line 329 of file LALInspiral.h.
REAL4 InspiralTemplate::qmParameter[2] |
UNDOCUMENTED.
Definition at line 340 of file LALInspiral.h.
LALInspiralInteraction InspiralTemplate::interaction |
UNDOCUMENTED.
Definition at line 341 of file LALInspiral.h.
UINT4 InspiralTemplate::fixedStep |
UNDOCUMENTED.
Definition at line 343 of file LALInspiral.h.
UINT4 InspiralTemplate::inspiralOnly |
UNDOCUMENTED.
Definition at line 344 of file LALInspiral.h.
struct tagInspiralTemplate* InspiralTemplate::next |
Linked list to the next coarse bank template (currently not filled by inspiral or bank codes)
Definition at line 347 of file LALInspiral.h.
struct tagInspiralTemplate* InspiralTemplate::fine |
Linked list to the next fine bank template (currently not filled by inspiral or bank codes)
Definition at line 348 of file LALInspiral.h.