ml4gw.waveforms.adhoc.ringdown

Classes

Ringdown(sample_rate, duration)

Callable class for generating ringdown waveforms.
class ml4gw.waveforms.adhoc.ringdown.Ringdown(sample_rate, duration)

Bases: Module

Callable class for generating ringdown waveforms.

Parameters:

  • sample_rate (float) -- Sample rate of waveform

  • duration (float) -- Duration of waveform

forward(frequency, quality, epsilon, phase, inclination, distance)

Generate ringdown waveform based on the damped sinusoid equation.

Parameters:

  • frequency (Float[Tensor, 'batch']) -- Central frequency of the ringdown waveform in Hz

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

  • epsilon (Float[Tensor, 'batch']) -- Fraction of black hole's mass radiated as gravitational waves

  • phase (Float[Tensor, 'batch']) -- Initial phase of the ringdown waveform in rad

  • inclination (Float[Tensor, 'batch']) -- Inclination angle of the source in rad

  • distance (Float[Tensor, 'batch']) -- Distance to the source in Mpc

Returns:

Tensors of cross and plus polarizations