obspy.core.event.origin.Pick

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

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

A pick is the observation of an amplitude anomaly in a seismogram at a specific point in time. It is not necessarily related to a seismic event.

Parameters
  • resource_id (ResourceIdentifier) – Resource identifier of Pick.

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

  • time (UTCDateTime) – Observed onset time of signal (“pick time”).

  • time_errors (QuantityError) – AttribDict containing error quantities.

  • waveform_id (WaveformStreamID) – Identifies the waveform stream.

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

  • method_id (ResourceIdentifier) – Identifies the picker that produced the pick. This can be either a detection software program or a person.

  • horizontal_slowness (float, optional) – Observed horizontal slowness of the signal. Most relevant in array measurements. Unit: s·deg^(−1)

  • horizontal_slowness_errors (QuantityError) – AttribDict containing error quantities.

  • backazimuth (float, optional) – Observed backazimuth of the signal. Most relevant in array measurements. Unit: deg

  • backazimuth_errors (QuantityError) – AttribDict containing error quantities.

  • slowness_method_id (ResourceIdentifier) – Identifies the method that was used to determine the slowness.

  • onset (str, optional) – Flag that roughly categorizes the sharpness of the onset. See PickOnset for allowed values.

  • phase_hint (str, optional) – Tentative phase identification as specified by the picker.

  • polarity (str, optional) – Indicates the polarity of first motion, usually from impulsive onsets. See PickPolarity for allowed values.

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

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

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

  • creation_info (CreationInfo, optional) – CreationInfo for the Pick 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.

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

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

Pick._repr_pretty_(p, cycle)

Special Methods

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

Default dir() implementation.

Pick.__eq__(other)

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

Pick.__format__(format_spec, /)

Default object formatter.

Pick.__ge__(value, /)

Return self>=value.

Pick.__getattr__(name, default=None)

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

Pick.__getattribute__(name, /)

Return getattr(self, name).

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

Return self>value.

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

This method is called when a class is subclassed.

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

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

Return self<=value.

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

Return self<value.

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

Helper for pickle.

Pick.__reduce_ex__(protocol, /)

Helper for pickle.

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

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

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

Size of object in memory, in bytes.

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