obspy.core.event.magnitude.StationMagnitude

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

Bases: obspy.core.event.base._event_type_class_factory.<locals>.AbstractEventTypeWithResourceID

This class describes the magnitude derived from a single waveform stream.

Parameters

  • resource_id (ResourceIdentifier) – Resource identifier of StationMagnitude.

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

  • origin_id (ResourceIdentifier) – Reference to an origin’s resource_id if the StationMagnitude has an associated Origin.

  • mag (float) – Estimated magnitude.

  • mag_errors (QuantityError) – AttribDict containing error quantities.

  • station_magnitude_type (str, optional) – See Magnitude

  • amplitude_id (ResourceIdentifier) – Identifies the data source of the StationMagnitude. For magnitudes derived from amplitudes in waveforms (e.g., local magnitude ML), amplitudeID points to publicID in class Amplitude.

  • method_id (ResourceIdentifier) – See Magnitude

  • waveform_id (WaveformStreamID, optional) – Identifies the waveform stream. This element can be helpful if no amplitude is referenced, or the amplitude is not available in the context. Otherwise, it would duplicate the waveform_id provided there and can be omitted.

  • 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

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.

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

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

StationMagnitude._repr_pretty_(p, cycle)

Special Methods

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

Default dir() implementation.

StationMagnitude.__eq__(other)

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

StationMagnitude.__format__(format_spec, /)

Default object formatter.

StationMagnitude.__ge__(value, /)

Return self>=value.

StationMagnitude.__getattr__(name, default=None)

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

StationMagnitude.__getattribute__(name, /)

Return getattr(self, name).

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

Return self>value.

StationMagnitude.__init__(force_resource_id=True, *args, **kwargs)
StationMagnitude.__init_subclass__()

This method is called when a class is subclassed.

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

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

Return self<=value.

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

Return self<value.

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

Helper for pickle.

StationMagnitude.__reduce_ex__(protocol, /)

Helper for pickle.

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

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

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

Size of object in memory, in bytes.

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