LALSimulation  5.4.0.1-fe68b98
LALSimBurst.c File Reference

Prototypes

static void gaussian_noise (REAL8TimeSeries *series, double rms, gsl_rng *rng)
 
static void semi_major_minor_from_e (double e, double *a, double *b)
 
COMPLEX16 XLALMeasureHPeak (const REAL8TimeSeries *hplus, const REAL8TimeSeries *hcross, unsigned *index)
 Return the strain of the sample with the largest magnitude. More...
 
REAL8 XLALMeasureIntS1S2DT (const REAL8TimeSeries *s1, const REAL8TimeSeries *s2)
 Computes the integral of the product of two time series. More...
 
REAL8 XLALMeasureHrss (const REAL8TimeSeries *hplus, const REAL8TimeSeries *hcross)
 Computes "root-sum-square strain", or \(h_{\mathrm{rss}}\). More...
 
REAL8 XLALMeasureIntHDotSquaredDT (const COMPLEX16FrequencySeries *fseries)
 Computes the integral of the square of a real-valued time series' first derivative from its Fourier transform. More...
 
REAL8 XLALMeasureEoverRsquared (REAL8TimeSeries *hplus, REAL8TimeSeries *hcross)
 Computes the areal energy density carried by a gravitational wave. More...
 
int XLALGenerateImpulseBurst (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 hpeak, REAL8 delta_t)
 Genereates a single-sample impulse waveform. More...
 
int XLALGenerateBandAndTimeLimitedWhiteNoiseBurst (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 duration, REAL8 frequency, REAL8 bandwidth, REAL8 eccentricity, REAL8 phase, REAL8 int_hdot_squared, REAL8 delta_t, gsl_rng *rng)
 Generate a band- and time-limited white-noise burst waveform with Gaussian envelopes in the time and frequency domains. More...
 
double XLALSimBurstSineGaussianQ (double duration, double centre_frequency)
 Compute the Q of a sine-Gaussian waveform from the duration and centre frequency. More...
 
double XLALSimBurstSineGaussianDuration (double Q, double centre_frequency)
 Compute the duration of a sine-Gaussian waveform from the Q and centre frequency. More...
 
int XLALSimBurstSineGaussian (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 Q, REAL8 centre_frequency, REAL8 hrss, REAL8 eccentricity, REAL8 phase, REAL8 delta_t)
 Generate sine- and cosine-Gaussian waveforms with various polarizations and phases. More...
 
int XLALSimBurstGaussian (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 duration, REAL8 hrss, REAL8 delta_t)
 Generate Gaussian waveforms. More...
 
static int XLALGenerateString (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, const char *waveform, REAL8 amplitude, REAL8 f_high, REAL8 delta_t)
 Function for generating cosmic string waveforms. More...
 
int XLALGenerateStringCusp (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 amplitude, REAL8 f_high, REAL8 delta_t)
 Generates cosmic string cusp waveforms. More...
 
int XLALGenerateStringKink (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 amplitude, REAL8 f_high, REAL8 delta_t)
 Generates cosmic string kink waveforms. More...
 
int XLALGenerateStringKinkKink (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, REAL8 amplitude, REAL8 delta_t)
 Generates cosmic string kink waveforms. More...
 
int XLALSimBurstCherenkovRadiation (REAL8TimeSeries **hplus, REAL8TimeSeries **hcross, double source_length, double dE_over_dA, double deltaT)
 Generates Cherenkov like waveforms. More...
 
double XLALSimBurstCherenkov_dE_dA (double power, double beta, double r)
 energy calculating function for Cherenkov burst. More...
 

Go to the source code of this file.

Function Documentation

◆ gaussian_noise()

static void gaussian_noise ( REAL8TimeSeries series,
double  rms,
gsl_rng *  rng 
)
static

Definition at line 61 of file LALSimBurst.c.

◆ semi_major_minor_from_e()

static void semi_major_minor_from_e ( double  e,
double *  a,
double *  b 
)
static

Definition at line 77 of file LALSimBurst.c.

◆ XLALGenerateString()

static int XLALGenerateString ( REAL8TimeSeries **  hplus,
REAL8TimeSeries **  hcross,
const char waveform,
REAL8  amplitude,
REAL8  f_high,
REAL8  delta_t 
)
static

Function for generating cosmic string waveforms.

Generates the \(h_{+}\) and \(h_{\times}\) components of a cosmic string cusp, kink, and kink-kink waveform. These waveforms are linearly polarized and placed in the \(h_{+}\) compnent. The \(h_{\times}\) component is set to 0. The waveform peaks at t = 0 (as defined by the epoch and deltaT)

In the frequency domain, the waveform is \(A f^{-q}\) with a (non-physical) low-frequency cut-off and a (physical) high-frequency cut-off. For kink-kinks the high-frequency cutoff doesn't exist, and the argument given is ignored.

\begin{equation} \tilde{h}_{+}(f) = A f^{-q} \left(1 + \frac{f_{\mathrm{low}}^{2}}{f^{2}}\right)^{-4} \begin{cases} \exp(1 - f/f_{\mathrm{high}}) & f > f_{\mathrm{high}} \\ 1 & f \leq f_{\mathrm{high}} \end{cases} \end{equation}

The output has a Tukey window applied to force it to go to 0 smoothly at the start and end. The low frequnecy cut-off is fixed at \(f_{\mathrm{low}} = 1 \mathrm{Hz}\), so these waveforms should be high-pass filtered before being used as injections or search templates.

String cusp examples.
Parameters
[out]hplusAddress of a REAL8TimeSeries pointer to be set to the address of the newly allocated \(h_{+}\) time series. Set to NULL on failure.
[out]hcrossAddress of a REAL8TimeSeries pointer to be set to the address of the newly allocated \(h_{\times}\) time series. Set to NULL on failure.
[in]waveformName of waveform. Should be cusp, kink, or kinkkink.
[in]amplitudeWaveform's amplitude parameter, \(A\), in units of \(\mathrm{strain}\,\mathrm{s}^{-\frac{1}{3}}\).
[in]f_highHigh frequency cut-off, \(f_{\mathrm{high}}\), in Hertz.
[in]delta_tSample period of output time series in seconds.
Return values
0Success
<0Failure

Definition at line 1340 of file LALSimBurst.c.