obspy.core.event.base.WaveformStreamID

class WaveformStreamID(network_code=None, station_code=None, location_code=None, channel_code=None, resource_uri=None, seed_string=None)[source]

Bases: AbstractEventType

Reference to a stream description in an inventory.

This is mostly equivalent to the combination of networkCode, stationCode, locationCode, and channelCode. However, additional information, e. g., sampling rate, can be referenced by the resourceURI. It is recommended to use resourceURI as a flexible, abstract, and unique stream ID that allows to describe different processing levels, or resampled/filtered products of the same initial stream, without violating the intrinsic meaning of the legacy identifiers (network, station, channel, and location codes). However, for operation in the context of legacy systems, the classical identifier components are supported.

Parameters:

network_code (str) – Network code.
station_code (str) – Station code.
location_code (str, optional) – Location code.
channel_code (str, optional) – Channel code.
resource_uri (ResourceIdentifier) – Resource identifier for the waveform stream.
seed_string (str, optional) – Provides an alternative initialization way by passing a SEED waveform string in the form network.station.location.channel, e.g. BW.FUR..EHZ, which will be used to populate the WaveformStreamID’s attributes. It will only be used if the network, station, location and channel keyword argument are ALL None.

Example

>>> # Can be initialized with a SEED string or with individual components.
>>> stream_id = WaveformStreamID(network_code="BW", station_code="FUR",
...                              location_code="", channel_code="EHZ")
>>> print(stream_id) 
WaveformStreamID
      network_code: 'BW'
      station_code: 'FUR'
      channel_code: 'EHZ'
     location_code: ''
>>> stream_id = WaveformStreamID(seed_string="BW.FUR..EHZ")
>>> print(stream_id) 
WaveformStreamID
      network_code: 'BW'
      station_code: 'FUR'
      channel_code: 'EHZ'
     location_code: ''
>>> # Can also return the SEED string.
>>> print(stream_id.get_seed_string())
BW.FUR..EHZ

Attributes

`defaults`
`do_not_warn_on`
`id`	Return the seed string representation.
`item`
`key`
`readonly`
`warn_on_non_default_key`

Public Methods

`clear`	Clear the class :return:
`copy`
`get`
`get_seed_string`	Return the seed string representation.
`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.

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

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

WaveformStreamID._repr_pretty_(p, cycle)

Special Methods

WaveformStreamID.__bool__()

classmethod WaveformStreamID.__class_getitem__()

Represent a PEP 585 generic type

E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,).

WaveformStreamID.__contains__(key)

WaveformStreamID.__delattr__(name)

WaveformStreamID.__delitem__(name)

WaveformStreamID.__dir__(): Default dir() implementation.

WaveformStreamID.__eq__(other): Two instances are considered equal if all attributes and all lists are identical.

WaveformStreamID.__format__(format_spec, /): Default object formatter.

WaveformStreamID.__ge__(value, /): Return self>=value.

WaveformStreamID.__getattr__(name, default=None): Py3k hasattr() expects an AttributeError no KeyError to be raised if the attribute is not found.

WaveformStreamID.__getattribute__(name, /): Return getattr(self, name).

WaveformStreamID.__getitem__(name, default=None)

WaveformStreamID.__gt__(value, /): Return self>value.

WaveformStreamID.__init__(network_code=None, station_code=None, location_code=None, channel_code=None, resource_uri=None, seed_string=None)[source]

WaveformStreamID.__init_subclass__()

This method is called when a class is subclassed.

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

WaveformStreamID.__iter__()

WaveformStreamID.__le__(value, /): Return self<=value.

WaveformStreamID.__len__()

WaveformStreamID.__lt__(value, /): Return self<value.

WaveformStreamID.__ne__(other)

WaveformStreamID.__new__(**kwargs)

WaveformStreamID.__reduce__(): Helper for pickle.

WaveformStreamID.__reduce_ex__(protocol, /): Helper for pickle.

WaveformStreamID.__repr__()

WaveformStreamID.__setattr__(name, value): Custom property implementation that works if the class is inheriting from AttribDict.

WaveformStreamID.__setitem__(key, value)

WaveformStreamID.__sizeof__(): Size of object in memory, in bytes.

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