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