obspy.core.event.origin.Arrival¶
-
class
Arrival
(force_resource_id=True, *args, **kwargs)[source]¶ Bases:
obspy.core.event.base.__Arrival
Successful 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
, optional) – 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
__abstractmethods__
__dict__
__doc__
__hash__
__module__
__reversed__
__slots__
__weakref__
list of weak references to the object (if defined) defaults
do_not_warn_on
item
key
readonly
warn_on_non_default_key
Public Methods
clear
copy
get
items
keys
pop
If key is not found, d is returned if given, otherwise KeyError is raised. popitem
as a 2-tuple; but raise KeyError if D is empty. setdefault
update
If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v values
Private Methods
Warning
Private methods are mainly for internal/developer use and their API might change without notice.
_pretty_str
Return better readable string representation of AttribDict object. _repr_pretty_
Special Methods
__bool__
__contains__
__deepcopy__
reset resource_id’s object_id after deep copy to allow the object specific behavior of get_referred_object __delattr__
__delitem__
__dir__
Default dir() implementation. __eq__
Two instances are considered equal if all attributes and all lists are identical. __format__
Default object formatter. __getattr__
Py3k hasattr() expects an AttributeError no KeyError to be raised if the attribute is not found. __getitem__
__getstate__
__init__
__init_subclass__
This method is called when a class is subclassed. __iter__
__len__
__ne__
__new__
Create and return a new object. __nonzero__
__reduce__
Helper for pickle. __reduce_ex__
Helper for pickle. __repr__
__setattr__
Custom property implementation that works if the class is inheriting from AttribDict. __setitem__
__setstate__
__sizeof__
Size of object in memory, in bytes. __str__
Fairly extensive in an attempt to cover several use cases. __subclasshook__
Abstract classes can override this to customize issubclass(). - resource_id (