gw.injection.GWSignal

gw.injection.GWSignal(wfg_kwargs, wfg_domain, data_domain, ifo_list, t_ref)

Base class for generating gravitational wave signals in interferometers. Generates waveform polarizations based on provided parameters, and then projects to detectors.

Includes option for whitening the signal based on a provided ASD.

Parameters

Name Type Description Default
wfg_kwargs dict Waveform generator parameters [approximant, f_ref, and (optionally) f_start]. required
wfg_domain UniformFrequencyDomain | MultibandedFrequencyDomain Domain used for waveform generation. This can potentially deviate from the final domain, having a wider frequency range needed for waveform generation. required
data_domain UniformFrequencyDomain | MultibandedFrequencyDomain Domain object for final signal. required
ifo_list list Names of interferometers for projection. required
t_ref float Reference time that specifies ifo locations. required

Attributes

Name Description
asd Amplitude spectral density.
calibration_marginalization_kwargs Dictionary with the following keys:
data_domain
ifo_list
t_ref
use_base_domain
waveform_generator
whiten Bool specifying whether to whiten (and scale) generated signals.

Methods

Name Description
signal Compute the GW signal for parameters theta.
signal_m Compute the GW signal for parameters theta. Same as self.signal(theta) method,

signal

gw.injection.GWSignal.signal(theta)

Compute the GW signal for parameters theta.

Step 1: Generate polarizations Step 2: Project polarizations onto detectors; optionally (depending on self.whiten) whiten and scale.

Parameters

Name Type Description Default
theta Signal parameters. Includes intrinsic parameters to be passed to waveform generator, and extrinsic parameters for detector projection. required

Returns

Name Type Description
dict keys: waveform: GW strain signal for each detector. extrinsic_parameters: {} parameters: waveform parameters asd (if set): amplitude spectral density for each detector

signal_m

gw.injection.GWSignal.signal_m(theta)

Compute the GW signal for parameters theta. Same as self.signal(theta) method, but it does not sum the contributions of the individual modes, and instead returns a dict {m: pol_m for m in [-l_max,…,0,…,l_max]} where each contribution pol_m transforms as exp(-1j * m * phase_shift) under phase shifts.

Step 1: Generate polarizations Step 2: Project polarizations onto detectors; optionally (depending on self.whiten) whiten and scale.

Parameters

Name Type Description Default
theta Signal parameters. Includes intrinsic parameters to be passed to waveform generator, and extrinsic parameters for detector projection. required

Returns

Name Type Description
dict keys: waveform: GW strain signal for each detector, with individual contributions {m: pol_m for m in [-l_max,…,0,…,l_max]} extrinsic_parameters: {} parameters: waveform parameters asd (if set): amplitude spectral density for each detector