This API reference is not for the latest stable Salvus version.
salvus.opt.utils
Utility functions for inverse problems.
Functions
gradient_parameterization_from_fields()
gradient_parameterization_from_fields()def gradient_parameterization_from_fields(fields: Set[str]) -> str:
...Deduce a suitable gradient parameterization from a list of inversion parameters and physics.
Parameters
fieldsSet[str] — Set of model parameters.
Returns str — Gradient parameterization string for SalvusCompute.
sum_gradients()
sum_gradients()def sum_gradients(
iteration: salvus.opt.iteration.Iteration, events: Sequence[str], name: str
) -> salvus.opt.models.base_model.BaseModel:
...Return the sum of a list of gradients from an iteration. This
Parameters
iterationsalvus.opt.iteration.Iteration — Iteration object.eventsSequence[str] — List of events to sum their gradients.namestr — Name of the summed model.
Returns salvus.opt.models.base_model.BaseModel — Summed model.