 |
LALInference 4.1.9.1-eeff03c
|
|
|
LALInference 4.1.9.1-eeff03c
|
|
Main header file for LALInference signal template generating functions.
All template functions have a parameter
| [in,out] | IFOdata | used for both specifiying the signal parameter values and returning the waveform template. |
Signal parameter values are passed to the template generating functions via the IFOdata->modelParams parameter.
Signal templates are either in time domain or frequency domain, and subsequent functions (e.g. for likelihood computation) may then act accordingly by checking the IFOdata->modelDomain parameter.
The actual template waveforms then are stored in the IFOdata->freqModelhPlus / IFOdata->freqModelhCross or IFOdata->timeModelhPlus / IFOdata->timeModelhCross slots. The template's amplitude is (for physical models) scaled to 1 Mpc luminosity distance.
| void LALInferenceDumptemplateFreqDomain | ( | LALInferenceVariables * | currentParams, |
| LALInferenceModel * | model, | ||
| const char * | filename | ||
| ) |
De-bugging function writing a (frequency-domain) signal template to a CSV file.
File contains real & imaginary parts of plus & cross components. Template amplitude is (usually) scaled to 1 Mpc luminosity distance.
Definition at line 2287 of file LALInferenceTemplate.c.
| void LALInferenceDumptemplateTimeDomain | ( | LALInferenceVariables * | currentParams, |
| LALInferenceModel * | model, | ||
| const char * | filename | ||
| ) |
De-bugging function writing a (time-domain) signal template to a CSV file.
File contains time series of plus & cross components. Template amplitude is (usually) scaled to 1 Mpc luminosity distance.
Definition at line 2322 of file LALInferenceTemplate.c.
| void LALInferenceTemplateNullFreqdomain | ( | LALInferenceModel * | model | ) |
Returns a frequency-domain 'null' template (all zeroes, implying no signal present).
Definition at line 165 of file LALInferenceTemplate.c.
| void LALInferenceTemplateNullTimedomain | ( | LALInferenceModel * | model | ) |
Returns a time-domain 'null' template (all zeroes, implying no signal present).
Definition at line 186 of file LALInferenceTemplate.c.
| void LALInferenceTemplateSineGaussian | ( | LALInferenceModel * | model | ) |
Sine-Gaussian (burst) template.
The (plus-) waveform is given by:
\[ s(t) = a \times \exp(-((t - \mu) / \sigma)^2) \times \sin(2 \pi f (t-\mu) - \phi) \]
Note that by setting f=0, phi=pi/2 you get a "plain" Gaussian template.
Signal is (by now?) linearly polarised, i.e., the cross-component remains zero.
Required ( IFOdata->modelParams ) parameters are:
"time" (REAL8, the \( \mu \) parameter of the Gaussian part, in GPS seconds)"sigma" (REAL8, width, the \( \sigma \) parameter of the Gaussian part, seconds)"frequency" (REAL8, frequency \( f \) of the sine part, Hertz)"phase" (REAL8, phase \( \phi \) (at time \( \mu \)), radians)"amplitude" (REAL8, amplitude \( a \)) Definition at line 491 of file LALInferenceTemplate.c.
| void LALInferenceROQWrapperForXLALSimInspiralChooseFDWaveformSequence | ( | LALInferenceModel * | model | ) |
Definition at line 234 of file LALInferenceTemplate.c.
| void LALInferenceTemplateDampedSinusoid | ( | LALInferenceModel * | model | ) |
Damped Sinusoid template.
The (plus-) waveform is an exponentially decaying sine wave:
\[ s(t) = a \times \exp((t-time) / \tau) \times sin(2 \pi f (t-time)) \]
where "time" is the time parameter denoting the instant at which the signal starts.
Signal is (by now?) linearly polarised, i.e., the cross-component remains zero.
Required ( IFOdata->modelParams ) parameters are:
"time" (REAL8, the instant at which the signal starts, in GPS seconds)"tau" (REAL8, width parameter \( \tau \), seconds)"frequency" (REAL8, frequency \( f \) of the sine part, Hertz)"amplitude" (REAL8, amplitude \( a \)) Definition at line 540 of file LALInferenceTemplate.c.
| void LALInferenceTemplateSinc | ( | LALInferenceModel * | model | ) |
Sinc function (burst) template.
The (plus-) waveform is a sinc function of given frequency:
\[ s(t) = a \times sinc(2 \pi f (t-time)) = a \times \sin(2 \pi f (t-time)) / (2 \pi f (t-time)) \]
where "time" is the time parameter denoting the signal's central peak location.
Signal is (by now?) linearly polarised, i.e., the cross-component remains zero.
Required ( IFOdata->modelParams ) parameters are:
"time" (REAL8, the instant at which the signal peaks, in GPS seconds)"frequency" (REAL8, frequency \( f \) of the sine part, Hertz)"amplitude" (REAL8, amplitude \( a \)) Definition at line 586 of file LALInferenceTemplate.c.
| void LALInferenceTemplateASinOmegaT | ( | LALInferenceModel * | model | ) |
Trivial h(t) = A*sin(Omega*t) template.
Required ( IFOdata->modelParams ) parameters are:
"A" (REAL8, dimensionless amplitude)"Omega" (REAL8, frequency, radians/sec) Definition at line 625 of file LALInferenceTemplate.c.
| void LALInferenceTemplateXLALSimInspiralChooseWaveform | ( | LALInferenceModel * | model | ) |
"XLALSimInspiralChooseWaveform{TD,FD}" wrapper.
Required ( IFOdata->modelParams ) parameters are:
"m1" (REAL8, mass of object 1, solar masses)"m2" (REAL8, mass of object 1, solar masses)"inclination" (REAL8, inclination angle, radians)"coa_phase" (REAL8, phase angle, radians)"spin1x" (REAL8, x component of the spin of object 1)"spin1y" (REAL8, y component of the spin of object 1)"spin1z" (REAL8, z component of the spin of object 1)"spin2x" (REAL8, x component of the spin of object 2)"spin2y" (REAL8, y component of the spin of object 2)"spin2z" (REAL8, z component of the spin of object 2)"shift0" (REAL8, shift offset, radians)"time" (REAL8, coalescence time, or equivalent/analog/similar, GPS seconds)"PNorder" (REAL8, Phase PN order)" THIS IMPLEMENTATION IS NOT THREAD SAFE !!! (previous inclination value is stored as a static)
< +-polarization waveform [returned]
< x-polarization waveform [returned]
Definition at line 648 of file LALInferenceTemplate.c.
| void LALInferenceTemplateXLALSimBurstChooseWaveform | ( | LALInferenceModel * | model | ) |
< +-polarization waveform [returned]
< x-polarization waveform [returned]
Definition at line 1891 of file LALInferenceTemplate.c.
| void LALInferenceTemplateXLALSimInspiralChooseWaveformPhaseInterpolated | ( | LALInferenceModel * | model | ) |
< +-polarization waveform [returned]
< x-polarization waveform [returned]
Definition at line 1357 of file LALInferenceTemplate.c.
| void LALInferenceTemplateXLALSimBurstSineGaussianF | ( | LALInferenceModel * | model | ) |
< +-polarization waveform [returned]
< x-polarization waveform [returned]
Definition at line 2181 of file LALInferenceTemplate.c.
1.9.4