obspy.core.event.magnitude.Magnitude

class Magnitude(force_resource_id=True, *args, **kwargs)[source]

Bases: obspy.core.event.base.__Magnitude

Describes a magnitude which can, but does not need to be associated with an origin.

Association with an origin is expressed with the optional attribute originID. It is either a combination of different magnitude estimations, or it represents the reported magnitude for the given event.

Parameters:
  • resource_id (ResourceIdentifier) Resource identifier of Magnitude.
  • 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.
  • mag (float) Resulting magnitude value from combining values of type StationMagnitude. If no estimations are available, this value can represent the reported magnitude.
  • mag_errors (QuantityError) AttribDict containing error quantities.
  • magnitude_type (str, optional)

    Describes the type of magnitude. This is a free-text field because it is impossible to cover all existing magnitude type designations with an enumeration. Possible values are:

    • unspecified magnitude ('M'),
    • local magnitude ('ML'),
    • body wave magnitude ('Mb'),
    • surface wave magnitude ('MS'),
    • moment magnitude ('Mw'),
    • duration magnitude ('Md')
    • coda magnitude ('Mc')
    • 'MH', 'Mwp', 'M50', 'M100', etc.
  • origin_id (ResourceIdentifier, optional) Reference to an origin’s resource_id if the magnitude has an associated Origin.
  • method_id (ResourceIdentifier, optional) Identifies the method of magnitude estimation. Users should avoid to give contradictory information in method_id and magnitude_type.
  • station_count (int, optional) Number of used stations for this magnitude computation.
  • azimuthal_gap (float, optional) Azimuthal gap for this magnitude computation. Unit: deg
  • evaluation_mode (str, optional) Evaluation mode of Magnitude. See EvaluationMode for allowed values.
  • evaluation_status (str, optional) Evaluation status of Magnitude. See EvaluationStatus for allowed values.
  • comments (list of Comment, optional) Additional comments.
  • station_magnitude_contributions (list of StationMagnitudeContribution.) StationMagnitudeContribution instances associated with the Magnitude.
  • 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

__abstractmethods__ frozenset() -> empty frozenset object
__dict__
__doc__ str(object=’‘) -> str
__hash__
__module__ str(object=’‘) -> str
__slots__ tuple() -> empty tuple
__weakref__ list of weak references to the object (if defined)
defaults dict() -> new empty dictionary
do_not_warn_on list() -> new empty list
item tuple() -> empty tuple
key str(object=’‘) -> str
readonly list() -> new empty list
warn_on_non_default_key bool(x) -> bool

Public Methods

clear
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.

_pretty_str Return better readable string representation of AttribDict object.
_repr_pretty_

Special Methods

__bool__
__contains__
__deepcopy__
__delattr__
__delitem__
__dir__ default dir() implementation
__eq__ Two instances are considered equal if all attributes and all lists
__format__ default object formatter
__getattr__ Py3k hasattr() expects an AttributeError no KeyError to be
__getitem__
__getstate__
__init__
__iter__
__len__
__ne__
__new__ Create and return a new object.
__nonzero__
__reduce__ helper for pickle
__reduce_ex__ helper for pickle
__repr__
__setattr__ Custom property implementation that works if the class is
__setitem__
__setstate__
__sizeof__ size of object in memory, in bytes
__str__ Fairly extensive in an attempt to cover several use cases.
__subclasshook__