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

salvus.flow.collections.event_misfit_collection

Event misfit collection object.

Classes

EventMisfitCollection

class EventMisfitCollection(builtins.object):
    def __init__(
        self,
        observed_event_collection: Optional[
            salvus.flow.collections.event_data_collection.EventDataCollection
        ] = None,
        synthetic_event_collection: salvus.flow.collections.event_data_collection.EventDataCollection,
        misfit_function: Union[str, Callable],
        extra_kwargs_misfit_function: Optional[Dict] = None,
        receiver_field: str,
    ):
        ...

A collection of event misfits.

Parameters
  • observed_event_collection Optional[salvus.flow.collections.event_data_collection.EventDataCollection] — The observed data. Optional because certain types of misfits can be computed without observed data. In that case the misfit function must also not take observed data.
  • synthetic_event_collection salvus.flow.collections.event_data_collection.EventDataCollection — Synthetic data.
  • misfit_function Union[str, Callable] — The misfit function as a string or Python function.j
  • extra_kwargs_misfit_function Optional[Dict] — Extra arguments passed to the misfit function.
  • receiver_field str — The field on which to compute the adjoint sources.
Attributes
misfit_dictionary Dict[str, float]

Misfit for every event.

total_misfit float

Cumulative misfit.