This API reference is not for the latest stable Salvus version.
salvus.project.tools.task_chains.prebuilt_workflows.results.result_collection
Classes
ResultCollection
ResultCollectionclass ResultCollection(builtins.object):
def __init__(
self,
task_chain_controller_run_time: float,
results_per_event: typing.Mapping[str, T],
all_result_folders: typing.List[pathlib.Path],
compute_misfit: bool,
compute_gradients: bool,
) -> None: ...Result collection for a misfit and/or gradient computation.
Parameters
task_chain_controller_run_timefloat — The run time.results_per_eventtyping.Mapping[str, T] — The results for each event.all_result_folderstyping.List[pathlib.Path] — The folders where the results are physically located.compute_misfitbool — True if the task chain controller should have computed a misfit.compute_gradientsbool — True if the task chain controller should have computed gradients.
Methods
delete_all_files()
delete_all_files()def delete_all_files(self) -> None: ...Delete all files for these results.
Returns None
get_failed_events()
get_failed_events()def get_failed_events(self) -> typing.Dict[str, FailedResult]: ...Retrieve all failed events.
Returns typing.Dict[str, FailedResult]
get_successfull_events()
get_successfull_events()def get_successfull_events(
self,
) -> typing.Dict[
str, typing.Union[MisfitResult, MisfitAndGradientResult, WaveformResult]
]: ...Retrieve the successful events.
Returns typing.Dict[str, typing.Union[MisfitResult, MisfitAndGradientResult, WaveformResult]]
list()
list()def list(self) -> typing.List[str]: ...Get a list of all events.
Returns typing.List[str]
print_timings()
print_timings()def print_timings(self) -> None: ...Print some timing information.
Returns None