obspy.core.event.base.ConfidenceEllipsoid

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

Bases: obspy.core.event.base._event_type_class_factory.<locals>.AbstractEventType

This class represents a description of the location uncertainty as a confidence ellipsoid with arbitrary orientation in space. See the QuakeML documentation for the full details

Parameters
  • semi_major_axis_length – Largest uncertainty, corresponding to the semi-major axis of the confidence ellipsoid. Unit: m

  • semi_minor_axis_length – Smallest uncertainty, corresponding to the semi-minor axis of the confidence ellipsoid. Unit: m

  • semi_intermediate_axis_length – Uncertainty in direction orthogonal to major and minor axes of the confidence ellipsoid. Unit: m

  • major_axis_plunge – Plunge angle of major axis of confidence ellipsoid. Corresponds to Tait-Bryan angle φ. Unit: deg

  • major_axis_azimuth – Azimuth angle of major axis of confidence ellipsoid. Corresponds to Tait-Bryan angle ψ. Unit: deg

  • major_axis_rotation – This angle describes a rotation about the confidence ellipsoid’s major axis which is required to define the direction of the ellipsoid’s minor axis. Corresponds to Tait-Bryan angle θ. 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.

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

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

ConfidenceEllipsoid._repr_pretty_(p, cycle)

Special Methods

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

Default dir() implementation.

ConfidenceEllipsoid.__eq__(other)

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

ConfidenceEllipsoid.__format__(format_spec, /)

Default object formatter.

ConfidenceEllipsoid.__ge__(value, /)

Return self>=value.

ConfidenceEllipsoid.__getattr__(name, default=None)

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

ConfidenceEllipsoid.__getattribute__(name, /)

Return getattr(self, name).

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

Return self>value.

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

This method is called when a class is subclassed.

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

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

Return self<=value.

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

Return self<value.

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

Helper for pickle.

ConfidenceEllipsoid.__reduce_ex__(protocol, /)

Helper for pickle.

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

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

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

Size of object in memory, in bytes.

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