LALSimulation  5.4.0.1-fe68b98
LALSimUtils.c File Reference

Prototypes

static REAL8FrequencySeriescreate_interpolated_psd (double f0, double deltaF, size_t length, const REAL8FrequencySeries *old)
 Creates a new interpolated psd from an existing psd (if necessary). More...
 
double XLALMeasureStandardSirenSenseMonitorRange (const REAL8FrequencySeries *psd, double f_min, double f_max)
 Computes the sense-monitor range for a binary neutron star standard siren signal for a given one-sided detector noise power spectral density. More...
 
double XLALMeasureStandardSirenHorizonDistance (const REAL8FrequencySeries *psd, double f_min, double f_max)
 Computes the horizon distance for a binary neutron star standard siren signal for a given one-sided detector noise power spectral density. More...
 
double XLALMeasureStandardSirenSNR (const REAL8FrequencySeries *psd, double f_min, double f_max)
 Computes the characteristic signal-to-noise for a binary neutron star standard siren signal located at an effective distance of 1 Mpc for a given one-sided detector noise power spectral density. More...
 
double XLALMeasureSNRFD (const COMPLEX16FrequencySeries *htilde, const REAL8FrequencySeries *psd, double f_min, double f_max)
 Measures the characteristic signal-to-noise ratio of a gravitational waveform represented in the frequency domain. More...
 
double XLALMeasureSNR (const REAL8TimeSeries *h, const REAL8FrequencySeries *psd, double f_min, double f_max)
 Measures the characteristic signal-to-noise ratio of a gravitational waveform. More...
 

Go to the source code of this file.

Function Documentation

◆ create_interpolated_psd()

static REAL8FrequencySeries* create_interpolated_psd ( double  f0,
double  deltaF,
size_t  length,
const REAL8FrequencySeries old 
)
static

Creates a new interpolated psd from an existing psd (if necessary).

The returned frequency series will have the specified values of f0, deltaF, and length. If the original frequency series old had the same values, this routine simply returns a pointer to the old. Otherwise, this routine allocates a new frequency series.

The interpolation in performed is linear-in-log (since a psd is positive-definite). Any component of the psd that is 0 is taken to be invalid, and any component of the returned psd that would depend on a 0 component of the original psd is also set to 0. Likewise, any components of the new psd that would require extrapolation of the original psd are set to zero. The routines defined here adhere to the convention that frequency components in which the psd is 0 are ignored.

Warning
If this routines returns a pointer to the original frequency series, it discards the const qualifier.
Note
The calling routine must test if the pointer to the psd returned by this routine is the same as the pointer to the psd passed to this routine to determine if the returned psd needs to be freed separately.

Definition at line 54 of file LALSimUtils.c.