obspy.core.event.source.NodalPlanes

class NodalPlanes(*args, **kwargs)

Bases: AbstractEventType

This class describes the nodal planes of a double-couple moment-tensor solution. The attribute preferred_plane can be used to define which plane is the preferred one.

Parameters:

• nodal_plane_1 (NodalPlane, optional) – First nodal plane of double-couple moment tensor solution.

• nodal_plane_2 (NodalPlane, optional) – Second nodal plane of double-couple moment tensor solution.

• preferred_plane (int, optional) – Indicator for preferred nodal plane of moment tensor solution. It can take integer values 1 or 2.

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.

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

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

NodalPlanes._repr_pretty_(p, cycle)

Special Methods

NodalPlanes.__bool__()

NodalPlanes.__contains__(key)

NodalPlanes.__delattr__(name)

NodalPlanes.__delitem__(name)

NodalPlanes.__dir__()

Default dir() implementation.

NodalPlanes.__eq__(other)

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

NodalPlanes.__format__(format_spec, /)

Default object formatter.

NodalPlanes.__ge__(value, /)

Return self>=value.

NodalPlanes.__getattr__(name, default=None)

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

NodalPlanes.__getattribute__(name, /)

Return getattr(self, name).

NodalPlanes.__getitem__(name, default=None)

NodalPlanes.__gt__(value, /)

Return self>value.

NodalPlanes.__init__(*args, **kwargs)

NodalPlanes.__init_subclass__()

This method is called when a class is subclassed.

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

NodalPlanes.__iter__()

NodalPlanes.__le__(value, /)

Return self<=value.

NodalPlanes.__len__()

NodalPlanes.__lt__(value, /)

Return self<value.

NodalPlanes.__ne__(other)

NodalPlanes.__new__(**kwargs)

NodalPlanes.__nonzero__()

NodalPlanes.__reduce__()

Helper for pickle.

NodalPlanes.__reduce_ex__(protocol, /)

Helper for pickle.

NodalPlanes.__repr__()

NodalPlanes.__setattr__(name, value)

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

NodalPlanes.__setitem__(key, value)

NodalPlanes.__sizeof__()

Size of object in memory, in bytes.

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