ml4gw.waveforms.adhoc.sine_gaussian

Functions

semi_major_minor_from_e(e)

Classes

SineGaussian(sample_rate, duration)

Callable class for generating sine-Gaussian waveforms.
class ml4gw.waveforms.adhoc.sine_gaussian.SineGaussian(sample_rate, duration)

Bases: Module

Callable class for generating sine-Gaussian waveforms.

Parameters:

  • sample_rate (float) -- Sample rate of waveform

  • duration (float) -- Duration of waveform

forward(quality, frequency, hrss, phase, eccentricity)

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

Parameters:

  • frequency (Float[Tensor, 'batch']) -- Central frequency of the sine-Gaussian waveform

  • quality (Float[Tensor, 'batch']) -- Quality factor of the sine-Gaussian waveform

  • hrss (Float[Tensor, 'batch']) -- Hrss of the sine-Gaussian waveform

  • phase (Float[Tensor, 'batch']) -- Phase of the sine-Gaussian waveform

  • eccentricity (Float[Tensor, 'batch']) -- Eccentricity of the sine-Gaussian waveform. Controls the relative amplitudes of the hplus and hcross polarizations.

Returns:

Tensors of cross and plus polarizations

ml4gw.waveforms.adhoc.sine_gaussian.semi_major_minor_from_e(e)
Parameters:

e (Tensor)