obspy.core.event.origin.OriginQuality

class OriginQuality(*args, **kwargs)[source]

Bases: AbstractEventType

This type contains various attributes commonly used to describe the quality of an origin, e. g., errors, azimuthal coverage, etc. Origin objects have an optional attribute of the type OriginQuality.

Parameters:

  • associated_phase_count (int, optional) – Number of associated phases, regardless of their use for origin computation.

  • used_phase_count (int, optional) – Number of defining phases, i. e., phase observations that were actually used for computing the origin. Note that there may be more than one defining phase per station.

  • associated_station_count (int, optional) – Number of stations at which the event was observed.

  • used_station_count (int, optional) – Number of stations from which data was used for origin computation.

  • depth_phase_count (int, optional) – Number of depth phases (typically pP, sometimes sP) used in depth computation.

  • standard_error (float, optional) – RMS of the travel time residuals of the arrivals used for the origin computation. Unit: s

  • azimuthal_gap (float, optional) – Largest azimuthal gap in station distribution as seen from epicenter. For an illustration of azimuthal gap and secondary azimuthal gap (see below), see Fig. 5 of Bond ́ar et al. (2004). Unit: deg

  • secondary_azimuthal_gap (float, optional) – Secondary azimuthal gap in station distribution, i. e., the largest azimuthal gap a station closes. Unit: deg

  • ground_truth_level (str, optional) – String describing ground-truth level, e. g. GT0, GT5, etc.

  • minimum_distance (float, optional) – Epicentral distance of station closest to the epicenter. Unit: deg

  • maximum_distance (float, optional) – Epicentral distance of station farthest from the epicenter. Unit: deg

  • median_distance (float, optional) – Median epicentral distance of used stations. Unit: deg

Note

For handling additional information not covered by the QuakeML standard and how to output it to QuakeML see the ObsPy Tutorial.

Attributes

defaults

do_not_warn_on

item

key

readonly

warn_on_non_default_key

Public Methods

clear

Clear the class :return:

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

values

Private Methods

Warning

Private methods are mainly for internal/developer use and their API might change without notice.

OriginQuality._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.

OriginQuality._pretty_str(priorized_keys=[], min_label_length=16)

Return better readable string representation of AttribDict object.

Parameters:

  • priorized_keys (list[str], optional) – Keywords of current AttribDict which will be shown before all other keywords. Those keywords must exists otherwise an exception will be raised. Defaults to empty list.

  • min_label_length (int, optional) – Minimum label length for keywords. Defaults to 16.

Returns:

String representation of current AttribDict object.

OriginQuality._repr_pretty_(p, cycle)

Special Methods

OriginQuality.__bool__()
OriginQuality.__contains__(key)
OriginQuality.__delattr__(name)
OriginQuality.__delitem__(name)
OriginQuality.__dir__()

Default dir() implementation.

OriginQuality.__eq__(other)

Two instances are considered equal if all attributes and all lists are identical.

OriginQuality.__format__(format_spec, /)

Default object formatter.

OriginQuality.__ge__(value, /)

Return self>=value.

OriginQuality.__getattr__(name, default=None)

Py3k hasattr() expects an AttributeError no KeyError to be raised if the attribute is not found.

OriginQuality.__getattribute__(name, /)

Return getattr(self, name).

OriginQuality.__getitem__(name, default=None)
OriginQuality.__gt__(value, /)

Return self>value.

OriginQuality.__init__(*args, **kwargs)
OriginQuality.__init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

OriginQuality.__iter__()
OriginQuality.__le__(value, /)

Return self<=value.

OriginQuality.__len__()
OriginQuality.__lt__(value, /)

Return self<value.

OriginQuality.__ne__(other)
OriginQuality.__new__(**kwargs)
OriginQuality.__nonzero__()
OriginQuality.__reduce__()

Helper for pickle.

OriginQuality.__reduce_ex__(protocol, /)

Helper for pickle.

OriginQuality.__repr__()
OriginQuality.__setattr__(name, value)

Custom property implementation that works if the class is inheriting from AttribDict.

OriginQuality.__setitem__(key, value)
OriginQuality.__sizeof__()

Size of object in memory, in bytes.

OriginQuality.__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 OriginQuality.__subclasshook__(C)