API reference¶
This section documents the public Python API of gwmock-signal. Pages are
generated with mkdocstrings from Google-style docstrings in the source
tree (src/gwmock_signal/).
How to use this site
- For workflow overview and example snippets, use User guide → Examples (sidebar).
- For exact signatures, types, and raised exceptions, use the API sections below only.
Sections¶
| Section | Contents |
|---|---|
| Waveform | pycbc_waveform_wrapper, WaveformFactory |
| Projection | project_polarizations_to_network |
| Injection | inject_strain, inject_strains_sequential |
| Multichannel | DetectorStrainStack |
| Utility | Logging and other helpers |
Main entry points (quick links)¶
- Waveform — Time-domain polarizations via PyCBC
(
pycbc_waveform_wrapper,WaveformFactory). - Projection — Strain per detector
(
project_polarizations_to_network). - Injection — Strain into segments (
inject_strain,inject_strains_sequential). - Multichannel — Stacked IFO strains
(
DetectorStrainStack). - Utility — Utility functions.