Version:

salvus.opt.utils

salvus.opt.utils salvus opt utils
Utility functions for inverse problems.

Functions

gradient_parameterization_from_fields()

Deduce a suitable gradient parameterization from a list of inversion parameters and physics.
SIGNATURE
def gradient_parameterization_from_fields(fields: set[str]) -> str: ...
ARGUMENTS
Required
fields
Type:set[str]
Description:
Set of model parameters.
RETURNS
Return type: str
Gradient parameterization string for SalvusCompute.

sum_gradients()

Return the sum of a list of gradients from an iteration. This.
SIGNATURE
def sum_gradients(
    iteration: Iteration[ModelType], events: typing.Sequence[str], name: str
) -> ModelType: ...
ARGUMENTS
Required
iteration
Type:Iteration[ModelType]
Description:
Iteration object.
Required
events
Type:typing.Sequence[str]
Description:
List of events to sum their gradients.
Required
name
Type:str
Description:
Name of the summed model.
RETURNS
Return type: ModelType
Summed model.
PAGE CONTENTS