LALInspiral 5.0.3.1-eeff03c
LALInspiralWaveLength.c File Reference

Module to calculate the number of data points (to the nearest power of 2) needed to store a waveform. More...

Prototypes

void LALInspiralWaveLength (LALStatus *status, UINT4 *length, InspiralTemplate params)
 

Detailed Description

Module to calculate the number of data points (to the nearest power of 2) needed to store a waveform.

Author
Sathyaprakash, B. S.

Prototypes

LALInspiralWaveLength()

  • length: output, number of bins to the nearest power of 2 greater than the minimum length required to store a wave of parameters as in params.
  • params: input, parameters of the binary system.

Description

This module first calls LALInspiralChooseModel(), which gives the length of the waveform in seconds. That function returns an estimated waveform length. However, the length might not be appropriate in some extreme cases (large masses and large lower cut-off frequency). It is especially true in the EOB case. Therefore, we introduce two constants namely LALINSPIRAL_LENGTHOVERESTIMATION (in percentage) which overestimate the length of the waveform and LALINSPIRAL_MINIMALWAVELENGTH which is the minimal waveform length in seconds. Multiplying this by the sampling rate params.tSampling gives the minimum number of samples needed to hold the waveform. To this are added the number of bins of leading and trailing zeroes requested by the user in params.nStartPad and params.nEndPad. The resulting number is rounded to an upward power of 2 and returned in length.

Algorithm

Uses

This function calls:

void LALInspiralSetup(LALStatus *status, expnCoeffs *ak, InspiralTemplate *params)
void LALInspiralChooseModel(LALStatus *status, expnFunc *func, expnCoeffs *ak, InspiralTemplate *params)

Definition in file LALInspiralWaveLength.c.

Go to the source code of this file.

Macros

#define LALINSPIRAL_LENGTHOVERESTIMATION   0.1 /* 10 % */
 
#define LALINSPIRAL_MINIMALWAVELENGTH   0.03125 /* 64 bins with a 2048Hz sampling*/
 

Macro Definition Documentation

◆ LALINSPIRAL_LENGTHOVERESTIMATION

#define LALINSPIRAL_LENGTHOVERESTIMATION   0.1 /* 10 % */

Definition at line 68 of file LALInspiralWaveLength.c.

◆ LALINSPIRAL_MINIMALWAVELENGTH

#define LALINSPIRAL_MINIMALWAVELENGTH   0.03125 /* 64 bins with a 2048Hz sampling*/

Definition at line 69 of file LALInspiralWaveLength.c.

Function Documentation

◆ LALInspiralWaveLength()

void LALInspiralWaveLength ( LALStatus status,
UINT4 length,
InspiralTemplate  params 
)

Definition at line 72 of file LALInspiralWaveLength.c.