Version:

salvus.flow.collections.event_misfit_collection

salvus.flow.collections.event_misfit_collection salvus flow collections event_misfit_collection
Event misfit collection object.

Classes

EventMisfitCollection

A collection of event misfits.
SIGNATURE
class EventMisfitCollection(builtins.object):
    def __init__(
        self,
        observed_event_collection: EventDataCollection | None = None,
        synthetic_event_collection: EventDataCollection,
        misfit_function: str | collections.abc.Callable,
        extra_kwargs_misfit_function: dict | None = None,
        receiver_field: str,
    ): ...
ARGUMENTS
Optional
observed_event_collection
Type:EventDataCollection | None
Default value:None
Description:
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.
Required
synthetic_event_collection
Type:EventDataCollection
Description:
Synthetic data.
Required
misfit_function
Type:str | collections.abc.Callable
Description:
The misfit function as a string or Python function.j
Optional
extra_kwargs_misfit_function
Type:dict | None
Default value:None
Description:
Extra arguments passed to the misfit function.
Required
receiver_field
Type:str
Description:
The field on which to compute the adjoint sources.

Properties

  • misfit_dictionary(dict[str, float])-Misfit for every event.
  • total_misfit(float)-Cumulative misfit.
PAGE CONTENTS