Mondaic DocumentationRequired
data_array_synthetic| Type: | xr.DataArray |
| 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.data_normalizations.normalized_misfit
salvus.opt.data_normalizations.normalized_misfit salvus opt data_normalizations normalized_misfitCompute a per-trace normalized misfit and adjoint source.
Functions
compute_normalized_misfit()
Compute misfit and adjoint source on normalized data.
SIGNATURE
def compute_normalized_misfit(
data_array_synthetic: xr.DataArray,
data_array_observed: xr.DataArray | None,
misfit_function: MisfitFunctionProtocol,
event: Event,
extra_kwargs_misfit_function: dict[str, typing.Any] | None = None,
normalization: Normalization | None = None,
_extra_output: ExtraOutput | None = None,
_write_normalized_adjoint_source: typing.Callable | None = None,
_receiver_field: str | None = None,
) -> xr.Dataset: ...ARGUMENTS
Required
data_array_observed| Type: | xr.DataArray | None |
| Description: | observed waveforms. |
Required
misfit_function| Type: | MisfitFunctionProtocol |
| Description: | Callback function of actual misfit function. |
Required
event| Type: | Event |
| Description: | The event object. |
Optional
extra_kwargs_misfit_function| Type: | dict[str, typing.Any] | None |
| Default value: | None |
| Description: | Extra arguments passed to the misfit function. |
Optional
normalization| Type: | Normalization | None |
| Default value: | None |
| Description: | Optional data normalization. |
Optional
_extra_output| Type: | ExtraOutput | None |
| Default value: | None |
| Description: | Extra output configuration. |
Optional
_write_normalized_adjoint_source| Type: | typing.Callable | None |
| Default value: | None |
| Description: | Callback function to potentially write the normalized adjoint sources prior to the application of the jacobian of the normalization. |
Optional
_receiver_field| Type: | str | None |
| Default value: | None |
| Description: | Receiver field of extra output. |
RETURNS
Return type:
xr.Datasettuple of misfit value and adjoint source
compute_normalized_misfit_per_trace()
Compute misfit and adjoint source on normalized data.
SIGNATURE
def compute_normalized_misfit_per_trace(
data_synthetic: npt.NDArray,
data_observed: npt.NDArray | None,
sampling_rate_in_hertz: float,
misfit_function: TraceMisfitFunctionProtocol,
extra_kwargs_misfit_function: dict | None = None,
normalization: TraceNormalization | None = None,
) -> tuple[float, npt.NDArray]: ...ARGUMENTS
Required
data_synthetic| Type: | npt.NDArray |
| Description: | synthetic waveforms. |
Required
data_observed| Type: | npt.NDArray | None |
| Description: | observed waveforms. |
Required
sampling_rate_in_hertz| Type: | float |
| Description: | Sampling rate. |
Required
misfit_function| Type: | TraceMisfitFunctionProtocol |
| Description: | Callback function of actual misfit function. |
Optional
extra_kwargs_misfit_function| Type: | dict | None |
| Default value: | None |
| Description: | Extra arguments passed to the misfit function. |
Optional
normalization| Type: | TraceNormalization | None |
| Default value: | None |
| Description: | Optional data normalization. |
RETURNS
Return type:
tuple[float, npt.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