Header file for the inspiral injection interface code.
The code contained in GenerateInspiral.c is an interface between the injection package and the inspiral package. More precisely, the function GenerateInspiral.c is used within the FindChirpSimulation.c file of the FindChirp package in order to inject waveforms into real data. The injection is done through the inject package in order to take into account the interferometer position, binary orientation ...
GenerateInspiral has the capability of injecting both waveform designed within the inspiral package (TaylorT1, T2, T3, PadeT1, EOB, and spinning waveform) and the inject package (so-called PPN waveform). also a test code as well which allows to check the output of code. It is called InjectionInterfaceTest.c
LALGenerateInspiral()
create an inspiral binary waveform generated either by the Inspiral Waveforms (EOB, EOBNR, PadeT1, TaylorT1, TaylorT2, TaylorT3, SpinTaylor, PhenSpinTaylorRD, SpinQuadTaylor) or the inject
package (GeneratePPN). It is used in the module FindChirpSimulation
in FindChirp Package.
There are three parsed arguments
CoherentGW
structure which stores amplitude, frequency and phase of the waveform (output) thisEvent
structure which provides some waveform parameters (input) PPNParamStruc
which gives some input parameters needed by the GeneratePPN waveform generation. That arguments is also used as an output by all the different approximant (output/input). The input must be composed of a valid thisEvent structure as well as the variable deltaT of the PPNParamStruc. All others variables of the PPNParamStruc are populated within that function.
XLALGenerateInspiralPopulatePPN()
Populate the PPNParamsStruc with the input argument thisEvent
. That structure is used by both inspiral waveforms inject waveforms.
XLALGenerateInspiralPopulateInspiral()
Inject only time-domain waveforms for the time being such as GeneratePPN, TaylorT1, TaylorT2, TaylorT3, PadeT1 and EOB , SpinTaylor, PhenSpinTaylorRD.
Prototypes | |
void | LALGenerateInspiral (LALStatus *status, CoherentGW *waveform, SimInspiralTable *params, PPNParamStruc *ppnParamsInputOutput) |
int | XLALGenerateInspiralPopulatePPN (PPNParamStruc *_LAL_RESTRICT_ ppnParams, SimInspiralTable *_LAL_RESTRICT_ thisEvent) |
int | XLALGenerateInspiralPopulateInspiral (InspiralTemplate *_LAL_RESTRICT_ inspiralParams, SimInspiralTable *_LAL_RESTRICT_ thisEvent, PPNParamStruc *_LAL_RESTRICT_ ppnParams) |
Macros | |
#define | GENERATEINSPIRAL_DEFAULT_FLOWER 40 |
Default low freqnecy cutoff for injections. More... | |
Error Codes | |
#define | GENERATEINSPIRALH_ENORM 0 |
Normal exit. More... | |
#define | GENERATEINSPIRALH_ENULL 1 |
Null pointer. More... | |
#define | GENERATEINSPIRALH_EDFDT 2 |
Waveform sampling interval is too large. More... | |
#define | GENERATEINSPIRALH_EZERO 3 |
inclination zero for SpinTaylor waveform More... | |
Parameter for the EOB at 3PN. | |
In principle, the three following parameter should be set to zero. | |
#define | GENERATEINSPIRAL_ZETA2 0. |
#define | GENERATEINSPIRAL_OMEGAS 0. |
#define | GENERATEINSPIRAL_THETA 0. |
For the spinning case, might be changed later or include in the injection itself | |
#define | GENERATEINSPIRAL_SOURCETHETA 1. |
#define | GENERATEINSPIRAL_SOURCEPHI 2. |
void LALGenerateInspiral | ( | LALStatus * | status, |
CoherentGW * | waveform, | ||
SimInspiralTable * | thisEvent, | ||
PPNParamStruc * | ppnParams | ||
) |
status | UNDOCUMENTED |
waveform | UNDOCUMENTED |
thisEvent | UNDOCUMENTED |
ppnParams | UNDOCUMENTED |
Definition at line 91 of file GenerateInspiral.c.
int XLALGenerateInspiralPopulatePPN | ( | PPNParamStruc *_LAL_RESTRICT_ | ppnParams, |
SimInspiralTable *_LAL_RESTRICT_ | thisEvent | ||
) |
int XLALGenerateInspiralPopulateInspiral | ( | InspiralTemplate *_LAL_RESTRICT_ | inspiralParams, |
SimInspiralTable *_LAL_RESTRICT_ | thisEvent, | ||
PPNParamStruc *_LAL_RESTRICT_ | ppnParams | ||
) |
#define GENERATEINSPIRALH_ENORM 0 |
Normal exit.
Definition at line 104 of file GenerateInspiral.h.
#define GENERATEINSPIRALH_ENULL 1 |
Null pointer.
Definition at line 105 of file GenerateInspiral.h.
#define GENERATEINSPIRALH_EDFDT 2 |
Waveform sampling interval is too large.
Definition at line 106 of file GenerateInspiral.h.
#define GENERATEINSPIRALH_EZERO 3 |
inclination zero for SpinTaylor waveform
Definition at line 107 of file GenerateInspiral.h.
#define GENERATEINSPIRAL_ZETA2 0. |
Definition at line 123 of file GenerateInspiral.h.
#define GENERATEINSPIRAL_OMEGAS 0. |
Definition at line 124 of file GenerateInspiral.h.
#define GENERATEINSPIRAL_THETA 0. |
Definition at line 125 of file GenerateInspiral.h.
#define GENERATEINSPIRAL_SOURCETHETA 1. |
Definition at line 130 of file GenerateInspiral.h.
#define GENERATEINSPIRAL_SOURCEPHI 2. |
Definition at line 131 of file GenerateInspiral.h.
#define GENERATEINSPIRAL_DEFAULT_FLOWER 40 |
Default low freqnecy cutoff for injections.
Definition at line 135 of file GenerateInspiral.h.