obspy.core.event.magnitude.Amplitude

class Amplitude(force_resource_id=True, *args, **kwargs)

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

This class represents a quantification of the waveform anomaly, usually a single amplitude measurement or a measurement of the visible signal duration for duration magnitudes.

Parameters

• resource_id (ResourceIdentifier) – Resource identifier of Amplitude.

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

• generic_amplitude (float) – Measured amplitude value for the given waveformID. Note that this attribute can describe different physical quantities, depending on the type and category of the amplitude. These can be, e.g., displacement, velocity, or a period. If the only amplitude information is a period, it has to specified here, not in the period attribute. The latter can be used if the amplitude measurement contains information on, e.g., displacement and an additional period. Since the physical quantity described by this attribute is not fixed, the unit of measurement cannot be defined in advance. However, the quantity has to be specified in SI base units. The enumeration given in attribute unit provides the most likely units that could be needed here. For clarity, using the optional unit attribute is highly encouraged.

• generic_amplitude_errors (QuantityError) – AttribDict containing error quantities.

• type (str, optional) –

  Describes the type of amplitude using the nomenclature from Storchak et al. (2003). Possible values are:

  • unspecified amplitude reading ('A'),

  • amplitude reading for local magnitude ('AML'),

  • amplitude reading for body wave magnitude ('AMB'),

  • amplitude reading for surface wave magnitude ('AMS'), and

  • time of visible end of record for duration magnitude ('END').

• category (str, optional) – Amplitude category. This attribute describes the way the waveform trace is evaluated to derive an amplitude value. This can be just reading a single value for a given point in time (point), taking a mean value over a time interval (mean), integrating the trace over a time interval (integral), specifying just a time interval (duration), or evaluating a period (period). See AmplitudeCategory for allowed values.

• unit (str, optional) – Amplitude unit. This attribute provides the most likely measurement units for the physical quantity described in the genericAmplitude attribute. Possible values are specified as combinations of SI base units. See AmplitudeUnit for allowed values.

• method_id (ResourceIdentifier) – Describes the method of amplitude determination.

• period (float, optional) – Dominant period in the timeWindow in case of amplitude measurements. Not used for duration magnitude. Unit: s

• snr (float, optional) – Signal-to-noise ratio of the spectrogram at the location the amplitude was measured.

• time_window (TimeWindow, optional) – Description of the time window used for amplitude measurement. Recommended for duration magnitudes.

• pick_id (ResourceIdentifier) – Refers to the resource_id of an associated Pick object.

• waveform_id (WaveformStreamID,) – Identifies the waveform stream on which the amplitude was measured.

• filter_id (ResourceIdentifier) – Identifies the filter or filter setup used for filtering the waveform stream referenced by waveform_id.

• scaling_time (UTCDateTime, optional) – Scaling time for amplitude measurement.

• scaling_time_errors (QuantityError) – AttribDict containing error quantities.

• magnitude_hint (str, optional) –

  Type of magnitude the amplitude measurement is used for. 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.

• evaluation_mode (str, optional) – Evaluation mode of Amplitude. See EvaluationMode for allowed values.

• evaluation_status (str, optional) – Evaluation status of Amplitude. See EvaluationStatus for allowed values.

• comments (list of Comment, optional) – Additional comments.

• creation_info (CreationInfo, optional) – CreationInfo for the Amplitude object.

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.

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

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

Amplitude._repr_pretty_(p, cycle)

Special Methods

Amplitude.__bool__()

Amplitude.__contains__(key)

Amplitude.__delattr__(name)

Amplitude.__delitem__(name)

Amplitude.__dir__()

Default dir() implementation.

Amplitude.__eq__(other)

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

Amplitude.__format__(format_spec, /)

Default object formatter.

Amplitude.__ge__(value, /)

Return self>=value.

Amplitude.__getattr__(name, default=None)

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

Amplitude.__getattribute__(name, /)

Return getattr(self, name).

Amplitude.__getitem__(name, default=None)

Amplitude.__gt__(value, /)

Return self>value.

Amplitude.__init__(force_resource_id=True, *args, **kwargs)

Amplitude.__init_subclass__()

This method is called when a class is subclassed.

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

Amplitude.__iter__()

Amplitude.__le__(value, /)

Return self<=value.

Amplitude.__len__()

Amplitude.__lt__(value, /)

Return self<value.

Amplitude.__ne__(other)

Amplitude.__new__(**kwargs)

Amplitude.__nonzero__()

Amplitude.__reduce__()

Helper for pickle.

Amplitude.__reduce_ex__(protocol, /)

Helper for pickle.

Amplitude.__repr__()

Amplitude.__setattr__(name, value)

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

Amplitude.__setitem__(key, value)

Amplitude.__sizeof__()

Size of object in memory, in bytes.

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