obspy.core.event.Amplitude

class Amplitude(*args, **kwargs)[source]

Bases: obspy.core.event.__Amplitude

This class represents a single amplitude measurement or a measurement of the visible end of a record for duration magnitudes.

Parameters:
  • resource_id (ResourceIdentifier) Resource identifier of Pick.
  • generic_amplitude (float) Amplitude value.
  • generic_amplitude_errors (AttribDict) 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 ('AL'),
    • amplitude reading for body wave magnitude ('AB'),
    • amplitude reading for surface wave magnitude ('AS'), and
    • time of visible end of record for duration magnitude ('END').
  • category (str, optional)

    Amplitude category. Possible values are:

    • "point",
    • "mean",
    • "duration",
    • "period",
    • "integral",
    • "other"
  • unit (str, optional)

    Amplitude unit. Possible values are:

    • "m",
    • "s",
    • "m/s",
    • "m/(s*s)",
    • "m*s",
    • "dimensionless",
    • "other"
  • method_id (ResourceIdentifier, optional) Describes the method of amplitude determination.
  • period (float, optional) Measured period in the time_window 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. Mandatory for duration magnitudes.
  • pick_id (ResourceIdentifier, optional) Refers to the resource_id of an associated Pick object.
  • waveform_id (ResourceIdentifier, optional) Identifies the waveform stream on which the amplitude was measured.
  • filter_id (ResourceIdentifier, optional) 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 (AttribDict) 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. Allowed values are the following:

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

    Evaluation status of Amplitude. Allowed values are the following:

    • "preliminary"
    • "confirmed"
    • "reviewed"
    • "final"
    • "rejected"
    • "reported"
  • comments (list of Comment, optional) Additional comments.
  • 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
popitem
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