Mondaic DocumentationRequired
data_synthetic| Type: | np.ndarray |
| Description: | Synthetic waveforms. |
Version:
2026.5.0
Salvus documentation version
2026.5.0
2025.1.3
2024.1.3
0.12.16
No results found.
salvus.opt.misfits.phase_misfit
salvus.opt.misfits.phase_misfit salvus opt misfits phase_misfitPhase misfit and adjoint sources.
Functions
phase_misfit_and_adjoint_source()
Compute a phase difference misfit and associated adjoint source.
SIGNATURE
def phase_misfit_and_adjoint_source(
data_synthetic: np.ndarray,
data_observed: np.ndarray,
sampling_rate_in_hertz: float,
frequency_limits: typing.Sequence[float],
absolute_value_threshold: float = 0.001,
taper_type: str = "hanning",
plot: bool = False,
) -> tuple[float, np.ndarray]: ...ARGUMENTS
Required
data_observed| Type: | np.ndarray |
| Description: | Observed waveforms. |
Required
sampling_rate_in_hertz| Type: | float |
| Description: | Sampling rate. |
Required
frequency_limits| Type: | typing.Sequence[float] |
| Description: | Either (f1, f2, f3, f4) or (f2, f3). In the latter case it will set f1 = 0.5 * f2 and f4 = 2 * f3. These are frequency limits for a Fourier domain bandpass filter. Every frequency smaller than f1 and larger than f4 will be completely filtered out, frequencies between f2 and f3 will be fully retained with them being tapered for f1 < f < f2 and f3 < f < f4. |
Optional
absolute_value_threshold| Type: | float |
| Default value: | 0.001 |
| Description: | Only perform the phase difference measurement for frequencies whose absolute value is at least this fraction of the maximum absolute value of all frequencies. This is important because phase measurements for frequencies with little energy would otherwise distort the result and could potentially even dominate it. Frequencies with absolute values smaller than 0.5 * absolute_value_threshold * max_abs_value will be fully muted, those in between both bounds will be tapered. |
Optional
taper_type| Type: | str |
| Default value: | 'hanning' |
| Description: | Tapering function to use for the frequency and thresholding tapers. Currently supported are "hanning", "tanh", and "linear". |
Optional
plot| Type: | bool |
| Default value: | False |
| Description: | Optionally plot some details about the computation. Useful for debugging and tuning. |
RETURNS
Return type:
tuple[float, np.ndarray]Tuple of misfit value and adjoint source.
We use cookies to analyze our traffic, but won't track you until explicit consent is given. Using our contact form will create relevant cookies and transmit data to third party services to keep track of your request. Read more about how we use personal information in our Privacy Policy.
PAGE CONTENTS