obspy.core.event.source.NodalPlane

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

Bases: AbstractEventType

This class describes a nodal plane using the attributes strike, dip, and rake. For a definition of the angles see Aki & Richards (1980).

Parameters:
  • strike (float) – Strike angle of nodal plane. Unit: deg

  • strike_errors (QuantityError) – AttribDict containing error quantities.

  • dip (float) – Dip angle of nodal plane. Unit: deg

  • dip_errors (QuantityError) – AttribDict containing error quantities.

  • rake (float) – Rake angle of nodal plane. Unit: deg

  • rake_errors (QuantityError) – AttribDict containing error quantities.

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.

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

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

NodalPlane._repr_pretty_(p, cycle)

Special Methods

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

Default dir() implementation.

NodalPlane.__eq__(other)

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

NodalPlane.__format__(format_spec, /)

Default object formatter.

NodalPlane.__ge__(value, /)

Return self>=value.

NodalPlane.__getattr__(name, default=None)

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

NodalPlane.__getattribute__(name, /)

Return getattr(self, name).

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

Return self>value.

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

This method is called when a class is subclassed.

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

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

Return self<=value.

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

Return self<value.

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

Helper for pickle.

NodalPlane.__reduce_ex__(protocol, /)

Helper for pickle.

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

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

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

Size of object in memory, in bytes.

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