obspy.core.event.origin.Arrival
- class Arrival(force_resource_id=True, *args, **kwargs)[source]
Bases:
AbstractEventTypeWithResourceIDSuccessful association of a pick with an origin qualifies this pick as an arrival. An arrival thus connects a pick with an origin and provides additional attributes that describe this relationship. Usually qualification of a pick as an arrival for a given origin is a hypothesis, which is based on assumptions about the type of arrival (phase) as well as observed and (on the basis of an earth model) computed arrival times, or the residual, respectively. Additional pick attributes like the horizontal slowness and backazimuth of the observed wave—especially if derived from array data—may further constrain the nature of the arrival.
- Parameters:
resource_id (
ResourceIdentifier) – Resource identifier of Arrival.force_resource_id (bool, optional) – If set to False, the automatic initialization of resource_id attribute in case it is not specified will be skipped.
pick_id (
ResourceIdentifier) – Refers to the resource_id of a Pick.phase (str) – Phase identification. For possible values, please refer to the description of the Phase object.
time_correction (float, optional) – Time correction value. Usually, a value characteristic for the station at which the pick was detected, sometimes also characteristic for the phase type or the slowness. Unit: s
azimuth (float, optional) – Azimuth of station as seen from the epicenter. Unit: deg
distance (float, optional) – Epicentral distance. Unit: deg
takeoff_angle (float, optional) – Angle of emerging ray at the source, measured against the downward normal direction. Unit: deg
takeoff_angle_errors (
QuantityError) – AttribDict containing error quantities.time_residual (float, optional) – Residual between observed and expected arrival time assuming proper phase identification and given the earth_model_ID of the Origin, taking into account the time_correction. Unit: s
horizontal_slowness_residual (float, optional) – Residual of horizontal slowness and the expected slowness given the current origin (refers to attribute horizontal_slowness of class Pick).
backazimuth_residual (float, optional) – Residual of backazimuth and the backazimuth computed for the current origin (refers to attribute backazimuth of class Pick).
time_weight (float, optional) – Weight of the arrival time for computation of the associated Origin. Note that the sum of all weights is not required to be unity.
horizontal_slowness_weight (float, optional) – Weight of the horizontal slowness for computation of the associated Origin. Note that the sum of all weights is not required to be unity.
backazimuth_weight (float, optional) – Weight of the backazimuth for computation of the associated Origin. Note that the sum of all weights is not required to be unity.
earth_model_id (
ResourceIdentifier) – Earth model which is used for the association of Arrival to Pick and computation of the residuals.comments (list of
Comment, optional) – Additional comments.creation_info (
CreationInfo, optional) – CreationInfo for the Arrival object.
Note
For handling additional information not covered by the QuakeML standard and how to output it to QuakeML see the ObsPy Tutorial.
Attributes
Public Methods
Clear the class :return: |
|
If key is not found, d is returned if given, otherwise KeyError is raised. |
|
as a 2-tuple; but raise KeyError if D is empty. |
|
Private Methods
Warning
Private methods are mainly for internal/developer use and their API might change without notice.
- Arrival._cast_type(key, value)
Cast type of value to type required in _types dict.
- Parameters:
key (str) – The key from __setattr__.
value – The value being set to key.
- Returns:
value cast to correct type.
- Arrival._pretty_str(priorized_keys=[], min_label_length=16)
Return better readable string representation of AttribDict object.
- Parameters:
- Returns:
String representation of current AttribDict object.
- Arrival._repr_pretty_(p, cycle)
Special Methods
- Arrival.__bool__()
- classmethod Arrival.__class_getitem__()
Represent a PEP 585 generic type
E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,).
- Arrival.__contains__(key)
- Arrival.__delattr__(name)
- Arrival.__delitem__(name)
- Arrival.__dir__()
Default dir() implementation.
- Arrival.__eq__(other)
Two instances are considered equal if all attributes and all lists are identical.
- Arrival.__format__(format_spec, /)
Default object formatter.
- Arrival.__ge__(value, /)
Return self>=value.
- Arrival.__getattr__(name, default=None)
Py3k hasattr() expects an AttributeError no KeyError to be raised if the attribute is not found.
- Arrival.__getattribute__(name, /)
Return getattr(self, name).
- Arrival.__getitem__(name, default=None)
- Arrival.__gt__(value, /)
Return self>value.
- Arrival.__init__(force_resource_id=True, *args, **kwargs)
- Arrival.__init_subclass__()
This method is called when a class is subclassed.
The default implementation does nothing. It may be overridden to extend subclasses.
- Arrival.__iter__()
- Arrival.__le__(value, /)
Return self<=value.
- Arrival.__len__()
- Arrival.__lt__(value, /)
Return self<value.
- Arrival.__ne__(other)
- Arrival.__new__(**kwargs)
- Arrival.__reduce__()
Helper for pickle.
- Arrival.__reduce_ex__(protocol, /)
Helper for pickle.
- Arrival.__repr__()
- Arrival.__setattr__(name, value)
Custom property implementation that works if the class is inheriting from AttribDict.
- Arrival.__setitem__(key, value)
- Arrival.__sizeof__()
Size of object in memory, in bytes.
- Arrival.__str__(force_one_line=False)
Fairly extensive in an attempt to cover several use cases. It is always possible to change it in the child class.
- classmethod Arrival.__subclasshook__(C)