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

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

Classes

`ResultCollection`

class ResultCollection(builtins.object):
    def __init__(
        self,
        task_chain_controller_run_time: float,
        results_per_event: Mapping[
            str,
            Union[
                salvus.project.tools.task_chains.compute_misfits_and_gradients.results.failed_result.FailedResult,
                salvus.project.tools.task_chains.compute_misfits_and_gradients.results.misfit_result.MisfitResult,
                salvus.project.tools.task_chains.compute_misfits_and_gradients.results.misfit_and_gradient_result.MisfitAndGradientResult,
            ],
        ],
        all_result_folders: List[pathlib.Path],
        compute_gradients: bool,
    ) -> None:
        ...

Result collection for a misfit and/or gradient computation.

Parameters

task_chain_controller_run_time float — The run time.
results_per_event Mapping[str, Union[salvus.project.tools.task_chains.compute_misfits_and_gradients.results.failed_result.FailedResult, salvus.project.tools.task_chains.compute_misfits_and_gradients.results.misfit_result.MisfitResult, salvus.project.tools.task_chains.compute_misfits_and_gradients.results.misfit_and_gradient_result.MisfitAndGradientResult]] — The results for each event.
all_result_folders List[pathlib.Path] — The folders where the results are physically located.
compute_gradients bool — True if the task chain controller should have computed gradients.

Methods

`delete_all_files()`

def delete_all_files(self) -> None:
    ...

Delete all files for these results.

Returns None

`get_failed_events()`

def get_failed_events(
    self,
) -> Dict[
    str,
    salvus.project.tools.task_chains.compute_misfits_and_gradients.results.failed_result.FailedResult,
]:
    ...

Retrieve all failed events.

Returns Dict[str, salvus.project.tools.task_chains.compute_misfits_and_gradients.results.failed_result.FailedResult]

`get_successfull_events()`

def get_successfull_events(
    self,
) -> Dict[
    str,
    Union[
        salvus.project.tools.task_chains.compute_misfits_and_gradients.results.misfit_result.MisfitResult,
        salvus.project.tools.task_chains.compute_misfits_and_gradients.results.misfit_and_gradient_result.MisfitAndGradientResult,
    ],
]:
    ...

Retrieve the successful events.

Returns Dict[str, Union[salvus.project.tools.task_chains.compute_misfits_and_gradients.results.misfit_result.MisfitResult, salvus.project.tools.task_chains.compute_misfits_and_gradients.results.misfit_and_gradient_result.MisfitAndGradientResult]]

`list()`

def list(self) -> List[str]:
    ...

Get a list of all events.

Returns List[str]

`print_timings()`

def print_timings(self) -> None:
    ...

Print some timing information.

Returns None