Version:

salvus.opt.data_normalizations.l2_energy_per_measurement

salvus.opt.data_normalizations.l2_energy_per_measurement salvus opt data_normalizations l2_energy_per_measurement
L2 energy per measurement data normalization and its jacobian.

Functions

forward_data_normalization_l2_energy_per_measurement()

Normalize data traces their L2 energy norm.
SIGNATURE
def forward_data_normalization_l2_energy_per_measurement(
    data_array_synthetic: xr.DataArray, data_array_observed: T, event: Event
) -> tuple[xr.DataArray, T]: ...
ARGUMENTS
Required
data_array_synthetic
Type:xr.DataArray
Description:
The synthetic data traces without normalization.
Required
data_array_observed
Type:T
Description:
The observed data traces without normalization.
Required
event
Type:Event
Description:
The event.
RETURNS
Return type: tuple[xr.DataArray, T]

jacobian_data_normalization_l2_energy_per_measurement()

Apply the jacobian of L2 energy normalization to the adjoint sources.
SIGNATURE
def jacobian_data_normalization_l2_energy_per_measurement(
    data_array_adjoint_sources: xr.DataArray,
    data_array_synthetic: xr.DataArray,
    data_array_observed: xr.DataArray | None,
    event: Event,
) -> xr.DataArray: ...
ARGUMENTS
Required
data_array_adjoint_sources
Type:xr.DataArray
Description:
The adjoint sources.
Required
data_array_synthetic
Type:xr.DataArray
Description:
The synthetic data traces without normalization.
Required
data_array_observed
Type:xr.DataArray | None
Description:
The observed data traces without normalization.
Required
event
Type:Event
Description:
The event.
RETURNS
Return type: xr.DataArray

tracewise_forward_data_normalization_l2_energy_per_measurement()

Normalize a data trace by its L2 energy norm.
This is the per-trace version of forward_data_normalization_l2_energy_per_measurement().
SIGNATURE
def tracewise_forward_data_normalization_l2_energy_per_measurement(
    data_synthetic: npt.NDArray,
    data_observed: npt.NDArray | None,
    sampling_rate_in_hertz: float,
) -> tuple[npt.NDArray, npt.NDArray | None]: ...
ARGUMENTS
Required
data_synthetic
Type:npt.NDArray
Description:
The synthetic data trace without normalization.
Required
data_observed
Type:npt.NDArray | None
Description:
The observed data trace without normalization.
Required
sampling_rate_in_hertz
Type:float
Description:
The sampling rate of both data traces in Hz.
RETURNS
Return type: tuple[npt.NDArray, npt.NDArray | None]

tracewise_jacobian_data_normalization_l2_energy_per_measurement()

Apply the jacobian on L2 energy normalization to an adjoint source.
This is the per-trace version of jacobian_data_normalization_l2_energy_per_measurement().
SIGNATURE
def tracewise_jacobian_data_normalization_l2_energy_per_measurement(
    adjoint_source: npt.NDArray,
    data_synthetic: npt.NDArray,
    data_observed: npt.NDArray | None,
    sampling_rate_in_hertz: float,
) -> npt.NDArray: ...
ARGUMENTS
Required
adjoint_source
Type:npt.NDArray
Description:
The adjoint source.
Required
data_synthetic
Type:npt.NDArray
Description:
The synthetic data trace without normalization.
Required
data_observed
Type:npt.NDArray | None
Description:
The observed data trace without normalization.
Required
sampling_rate_in_hertz
Type:float
Description:
The sampling rate of the adjoint source and data in Hz.
RETURNS
Return type: npt.NDArray
PAGE CONTENTS