Pipeline
gwmock_signal.pipeline
¶
High-level CBC injection pipeline.
See docs/user_guide/cli.md (CLI) and docs/api/pipeline/index.md (API
reference).
inject_cbc_signal(waveform_model, params, detector_names, background, *, sampling_frequency, minimum_frequency, waveform_backend=None, earth_rotation=True, interpolate_if_offset=True)
¶
Inject a CBC signal into background strain for a network of detectors.
Orchestrates waveform generation, detector projection, and strain injection
for compact binary coalescence (CBC) sources. Returns a
DetectorStrainStack containing the injected strain for each detector.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
waveform_model
|
str
|
Time-domain approximant name (e.g. |
required |
params
|
dict[str, Any]
|
CBC injection parameters; must include |
required |
detector_names
|
Sequence[str | CustomDetector]
|
IFO codes for the target network
(e.g. |
required |
background
|
Mapping[str, TimeSeries]
|
Mapping of detector name to background |
required |
sampling_frequency
|
float
|
Sample rate in Hz. |
required |
minimum_frequency
|
float
|
Low-frequency cutoff in Hz, passed to the waveform generator. |
required |
waveform_backend
|
WaveformBackend | None
|
Optional waveform backend instance used to generate
polarizations. Defaults to |
None
|
earth_rotation
|
bool
|
If |
True
|
interpolate_if_offset
|
bool
|
If |
True
|
Returns:
| Type | Description |
|---|---|
DetectorStrainStack
|
|
DetectorStrainStack
|
|
Raises:
| Type | Description |
|---|---|
ValueError
|
If any required parameter key is missing from |
ValueError
|
If a detector name is not recognized by the detector registry. |
KeyError
|
If a detector name is missing from |
Source code in src/gwmock_signal/pipeline.py
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 | |
For CLI usage that wraps this workflow, see
Command-line interface. For the underlying
simulator class, see Simulator (CBCSimulator).