bilby.gw.detector.inject_signal_into_gwpy_timeseries

bilby.gw.detector.inject_signal_into_gwpy_timeseries(data, waveform_generator, parameters, det, power_spectral_density=None, outdir=None, label=None)[source]

Inject a signal into a gwpy timeseries

Parameters:
data: gwpy.timeseries.TimeSeries

The time-series data into which we want to inject the signal

waveform_generator: bilby.gw.waveform_generator.WaveformGenerator

An initialised waveform_generator

parameters: dict

A dictionary of the signal-parameters to inject

det: bilby.gw.detector.Interferometer

The interferometer for which the data refers too

power_spectral_density: bilby.gw.detector.PowerSpectralDensity

Power spectral density determining the sensitivity of the detector.

outdir, label: str

If given, the outdir and label used to generate a plot

Returns:
data_and_signal: gwpy.timeseries.TimeSeries

The data with the time-domain signal added

meta_data: dict

A dictionary of meta data about the injection