Skip to content

SineGaussian

Functions:

Name Description
gen_SineGaussian_hphc

Generate lalinference implementation of a sine-Gaussian waveform in JAX.
semi_major_minor_from_e

Calculate the semi-major and semi-minor axes of an ellipse given the

gen_SineGaussian_hphc(t: Float[Array, ' n_time'], theta: Float[Array, 5]) -> tuple[Float[Array, ' n_time'], Float[Array, ' n_time']] ¤

Generate lalinference implementation of a sine-Gaussian waveform in JAX. See git.ligo.org/lscsoft/lalsuite/-/blob/master/lalinference/lib/LALInferenceBurstRoutines.c#L381 for details on parameter definitions.

Parameters:

Name Type Description Default
t Array

Time grid (centered at t=0) on which to evaluate the waveform. Create it using jax.numpy.arange(-duration/2, duration/2, 1/fs) where duration is the duration of the waveform (in seconds) and fs is the sample rate at which the waveform is evaluated.

 required
theta Array

Array of waveform parameters [quality, frequency, hrss, phase, eccentricity]:

  • quality: Quality factor of the sine-Gaussian waveform.
  • frequency: Central frequency of the sine-Gaussian waveform.
  • hrss: Hrss of the sine-Gaussian waveform.
  • phase: Phase of the sine-Gaussian waveform.
  • eccentricity: Eccentricity of the sine-Gaussian waveform. Controls the relative amplitudes of the hplus and hcross polarizations.
 required

Returns:

Type Description
tuple[Float[Array, ' n_time'], Float[Array, ' n_time']]

tuple[Array, Array]: JAX Arrays of plus and cross polarizations (in that order).

semi_major_minor_from_e(e: FloatLike) -> tuple[FloatLike, FloatLike] ¤

Calculate the semi-major and semi-minor axes of an ellipse given the eccentricity of the ellipse.

Parameters:

Name Type Description Default
e FloatLike

Eccentricity of the ellipse

 required

Returns: Semi-major (a) and semi-minor (b) axes of the ellipse