obspy.core.event.source.FocalMechanism
- class FocalMechanism(force_resource_id=True, *args, **kwargs)[source]
Bases:
obspy.core.event.base._event_type_class_factory.<locals>.AbstractEventTypeWithResourceID
This class describes the focal mechanism of an event. It includes different descriptions like nodal planes, principal axes, and a moment tensor. The moment tensor description is provided by objects of the class MomentTensor which can be specified as child elements of FocalMechanism.
- Parameters
resource_id (
ResourceIdentifier
) – Resource identifier of FocalMechanism.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.
triggering_origin_id (
ResourceIdentifier
) – Refers to the resource_id of the triggering origin.nodal_planes (
NodalPlanes
, optional) – Nodal planes of the focal mechanism.principal_axes (
PrincipalAxes
, optional) – Principal axes of the focal mechanism.azimuthal_gap (float, optional) – Largest azimuthal gap in distribution of stations used for determination of focal mechanism. Unit: deg
station_polarity_count (int, optional) –
misfit (float, optional) – Fraction of misfit polarities in a first-motion focal mechanism determination. Decimal fraction between 0 and 1.
station_distribution_ratio (float, optional) – Station distribution ratio (STDR) parameter. Indicates how the stations are distributed about the focal sphere (Reasenberg and Oppenheimer 1985). Decimal fraction between 0 and 1.
method_id (
ResourceIdentifier
) – Resource identifier of the method used for determination of the focal mechanism.waveform_id (list of
WaveformStreamID
, optional) – Refers to a set of waveform streams from which the focal mechanism was derived.evaluation_mode (str, optional) – Evaluation mode of FocalMechanism. See
EvaluationMode
for allowed values.evaluation_status (str, optional) – Evaluation status of FocalMechanism. See
EvaluationStatus
for allowed values.moment_tensor (
MomentTensor
, optional) – Moment tensor description for this focal mechanism.comments (list of
Comment
, optional) – Additional comments.creation_info (
CreationInfo
, optional) – Creation information used to describe author, version, and creation time.
Note
For handling additional information not covered by the QuakeML standard and how to output it to QuakeML see the ObsPy Tutorial.
Attributes
Public Methods
Clear the class :return: |
|
If key is not found, d is returned if given, otherwise KeyError is raised. |
|
as a 2-tuple; but raise KeyError if D is empty. |
|
Private Methods
Warning
Private methods are mainly for internal/developer use and their API might change without notice.
- FocalMechanism._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.
- FocalMechanism._pretty_str(priorized_keys=[], min_label_length=16)
Return better readable string representation of AttribDict object.
- Parameters
- Returns
String representation of current AttribDict object.
- FocalMechanism._repr_pretty_(p, cycle)
Special Methods
- FocalMechanism.__bool__()
- FocalMechanism.__contains__(key)
- FocalMechanism.__delattr__(name)
- FocalMechanism.__delitem__(name)
- FocalMechanism.__dir__()
Default dir() implementation.
- FocalMechanism.__eq__(other)
Two instances are considered equal if all attributes and all lists are identical.
- FocalMechanism.__format__(format_spec, /)
Default object formatter.
- FocalMechanism.__ge__(value, /)
Return self>=value.
- FocalMechanism.__getattr__(name, default=None)
Py3k hasattr() expects an AttributeError no KeyError to be raised if the attribute is not found.
- FocalMechanism.__getattribute__(name, /)
Return getattr(self, name).
- FocalMechanism.__getitem__(name, default=None)
- FocalMechanism.__gt__(value, /)
Return self>value.
- FocalMechanism.__init__(force_resource_id=True, *args, **kwargs)
- FocalMechanism.__init_subclass__()
This method is called when a class is subclassed.
The default implementation does nothing. It may be overridden to extend subclasses.
- FocalMechanism.__iter__()
- FocalMechanism.__le__(value, /)
Return self<=value.
- FocalMechanism.__len__()
- FocalMechanism.__lt__(value, /)
Return self<value.
- FocalMechanism.__ne__(other)
- FocalMechanism.__new__(**kwargs)
- FocalMechanism.__nonzero__()
- FocalMechanism.__reduce__()
Helper for pickle.
- FocalMechanism.__reduce_ex__(protocol, /)
Helper for pickle.
- FocalMechanism.__repr__()
- FocalMechanism.__setattr__(name, value)
Custom property implementation that works if the class is inheriting from AttribDict.
- FocalMechanism.__setitem__(key, value)
- FocalMechanism.__sizeof__()
Size of object in memory, in bytes.
- FocalMechanism.__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 FocalMechanism.__subclasshook__(C)