GWSignal API Reference

Overview

This module provides a wrapper around the gwsignal library (part of LALSimulation), providing a clean interface for generating high-fidelity gravitational wave waveforms. The gwsignal interface is particularly useful when working with surrogate models and advanced waveform approximants.

For a high-level discussion of waveform generators and how GWSignal fits into the broader RIFT architecture, see GWSignal Interface.

Functions

GWSignal.hlmoft(P, Lmax=2, approx_string=None, no_trust_align_method=None, internal_phase_shift=π / 2, **kwargs)

Generates time-domain harmonic modes using the gwsignal library.

Parameters:

  • P (ChooseWaveformParams) – Waveform parameters object.

  • Lmax (int) – Maximum l-mode to generate. Default is 2.

  • approx_string (str, optional) – Approximant string. If None, P.approx is used.

  • no_trust_align_method (str, optional) – If ‘peak’, shifts epoch to the peak of the total signal power.

  • internal_phase_shift (float) – Phase shift applied to the modes. Default is π/2.

  • kwargs – Additional arguments (e.g., ‘lmax_nyquist’).

Returns:

A dictionary mapping (l, m) to LAL COMPLEX16TimeSeries objects.

Return type:

dict

GWSignal.hlmoff(P, Lmax=2, approx_string=None, **kwargs)

Generates Fourier-transformed harmonic modes.

Parameters:

  • P (ChooseWaveformParams) – Waveform parameters object.

  • Lmax (int) – Maximum l-mode to generate. Default is 2.

  • approx_string (str, optional) – Approximant string. If None, P.approx is used.

  • kwargs – Additional arguments passed to hlmoft.

Returns:

A dictionary mapping (l, m) to Fourier-transformed series.

Return type:

dict

GWSignal.std_and_conj_hlmoff(P, Lmax=2, approx_string=None, **kwargs)

Generates both the Fourier-transformed harmonic modes and their complex conjugates.

Parameters:

  • P (ChooseWaveformParams) – Waveform parameters object.

  • Lmax (int) – Maximum l-mode to generate. Default is 2.

  • approx_string (str, optional) – Approximant string. If None, P.approx is used.

  • kwargs – Additional arguments passed to hlmoft.

Returns:

A tuple (hlmsF, hlms_conj_F) where both are dictionaries mapping (l, m) to Fourier-transformed series.

Return type:

tuple

See Also