obspy.core.event.Magnitude

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

Bases: obspy.core.event.__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 (AttribDict) 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. Allowed values are the following:

    • "manual"
    • "automatic"
  • evaluation_status (EvaluationStatus, optional)

    Evaluation status of Magnitude. Allowed values are the following:

    • "preliminary"
    • "confirmed"
    • "reviewed"
    • "final"
    • "rejected"
    • "reported"
  • 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.

Attributes

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

Public Methods

clear
copy
get
items
iteritems
iterkeys
itervalues
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

_pretty_str Return better readable string representation of AttribDict object.

Special Methods

__contains__
__deepcopy__
__delattr__
__delitem__
__eq__ Two instances are considered equal if all attributes and all lists
__getattr__
__getitem__
__getstate__
__init__
__iter__
__len__
__ne__
__nonzero__
__repr__
__setattr__ Custom property implementation that works if the class is
__setitem__
__setstate__
__str__ Fairly extensive in an attempt to cover several use cases.
__subclasshook__

This Page