This API reference is not for the latest stable Salvus version.

`salvus.project.tools.task_chains.compute_misfits_and_gradients.results.misfit_and_gradient_result`

A misfit and gradient result object.

Classes

`MisfitAndGradientResult`

class MisfitAndGradientResult(builtins.object):
    def __init__(
        self,
        event_name: str,
        status: Optional[salvus.flow.sites.types.JobStatus],
        stdouterr: salvus.flow.sites.task_chain.task_chain_controller.StdOutErr,
        misfit_value: float,
        result_folder: pathlib.Path,
        gradient_simulation_folder: pathlib.Path,
        gradient_h5_file: pathlib.Path,
    ) -> None:
        ...

The results for a misfit and gradient computation for a single event.

Parameters

event_name str — Name of the event.
status Optional[salvus.flow.sites.types.JobStatus] — The task chain status.
stdouterr salvus.flow.sites.task_chain.task_chain_controller.StdOutErr — stdout, stderr, and timing information.
misfit_value float — The misfit value.
result_folder pathlib.Path — The folder of these results.
gradient_simulation_folder pathlib.Path — The folder of the gradient simulation output.
gradient_h5_file pathlib.Path — Path to the gradient file.