LALSimulation  5.4.0.1-fe68b98
Module LALSimInspiralWaveformTaper.c

Detailed Description

The code XLALInspiralREAL4WaveformTaper() and XLALInspiralREAL8WaveTaper() impose a smooth time tapering at the beginning and/or the end of REAL4 or REAL8 waveforms in the time domain.

Author
McKechan D J A

They take either a REAL4Vector or a REAL8Vector and search for the beginning and end points of the signal, in case there are null data points at either end. They then taper the waveform from the ends to the second maxima from each end in the waveform, according to formula 3.35 of gr-qc/0001023.

If the waveform does has less than 4 maxima, such that it cannot be tapered from the each end to the second peak then the waveform is tapered from the ends to the centre of the instead.

The bookends option is an LALSimInspiralApplyTaper enumerator and allows the user to specify whether just the start, just the end or both the start and end of the signal are tapered. These options are LAL_SIM_INSPIRAL_TAPER_START, LAL_SIM_INSPIRAL_TAPER_END and LAL_SIM_INSPIRAL_TAPER_STARTEND.

Prototypes

XLALInspiralREAL4WaveformTaper() XLALInspiralREAL8WaveformTaper()

Description

Uses

Notes

Prototypes

int XLALSimInspiralREAL4WaveTaper (REAL4Vector *signalvec, LALSimInspiralApplyTaper bookends)
 
int XLALSimInspiralREAL8WaveTaper (REAL8Vector *signalvec, LALSimInspiralApplyTaper bookends)
 

Function Documentation

◆ XLALSimInspiralREAL4WaveTaper()

int XLALSimInspiralREAL4WaveTaper ( REAL4Vector signalvec,
LALSimInspiralApplyTaper  bookends 
)
Parameters
signalvecpointer to waveform vector
bookendstaper type enumerator

Definition at line 71 of file LALSimInspiralWaveformTaper.c.

◆ XLALSimInspiralREAL8WaveTaper()

int XLALSimInspiralREAL8WaveTaper ( REAL8Vector signalvec,
LALSimInspiralApplyTaper  bookends 
)
Parameters
signalvecpointer to waveform vector
bookendstaper type enumerator

Definition at line 220 of file LALSimInspiralWaveformTaper.c.