/
basic_client.py
171 lines (149 loc) · 6.01 KB
/
basic_client.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
# -*- coding: utf-8 -*-
"""
SeedLink request client for ObsPy.
:copyright:
The ObsPy Development Team (devs@obspy.org)
:license:
GNU Lesser General Public License, Version 3
(https://www.gnu.org/copyleft/lesser.html)
"""
from __future__ import (absolute_import, division, print_function,
unicode_literals)
from future.builtins import * # NOQA @UnusedWildImport
import warnings
from obspy import Stream
from .slclient import SLClient, SLPacket
from .client.seedlinkconnection import SeedLinkConnection
class Client(object):
"""
SeedLink request client.
This client is intended for requests of specific, finite time windows.
To work with continuous realtime data streams please see
:class:`~obspy.clients.seedlink.slclient.SLClient` and
:class:`~obspy.clients.seedlink.easyseedlink.EasySeedLinkClient`.
:type server: str
:param server: Server name or IP address to connect to (e.g.
"localhost", "rtserver.ipgp.fr")
:type port: int
:param port: Port at which the seedlink server is operating (default is
`18000`).
:type timeout: float
:param timeout: Network timeout for low-level network connection in
seconds.
:type debug: bool
:param debug: Switches on debugging output.
"""
def __init__(self, server, port=18000, timeout=20, debug=False):
"""
Initializes the SeedLink request client.
"""
self.timeout = timeout
self.debug = debug
self._slclient = SLClient(loglevel=debug and "DEBUG" or "CRITICAL",
timeout=self.timeout)
self._server_url = "%s:%i" % (server, port)
def _connect(self):
"""
Open new connection to seedlink server.
"""
self._slclient.slconn = SeedLinkConnection(timeout=self.timeout)
self._slclient.slconn.set_sl_address(self._server_url)
self._slclient.slconn.netto = self.timeout
def get_waveforms(self, network, station, location, channel, starttime,
endtime):
"""
Request waveform data from the seedlink server.
>>> from obspy import UTCDateTime
>>> client = Client('rtserver.ipgp.fr')
>>> t = UTCDateTime() - 3600
>>> st = client.get_waveforms("G", "FDF", "00", "BHZ", t, t + 5)
>>> print(st) # doctest: +ELLIPSIS
1 Trace(s) in Stream:
G.FDF.00.BHZ | 20... | 20.0 Hz, ... samples
Most servers support '?' single-character wildcard in location and
channel code fields:
>>> st = client.get_waveforms("G", "FDF", "??", "B??", t, t + 5)
>>> st = st.sort(reverse=True)
>>> print(st) # doctest: +ELLIPSIS
3 Trace(s) in Stream:
G.FDF.00.BHZ | 20... | 20.0 Hz, ... samples
G.FDF.00.BHN | 20... | 20.0 Hz, ... samples
G.FDF.00.BHE | 20... | 20.0 Hz, ... samples
.. note::
Support of wildcards strongly depends on the queried seedlink
server. In general, '?' as single character wildcard seems to work
well in location code and channel code fields for most servers.
Usage of '*' for multiple characters in location and channel code
field is not supported. No wildcards are supported in
network and station code fields by ObsPy.
:type network: str
:param network: Network code. No wildcards supported by ObsPy.
:type station: str
:param station: Station code. No wildcards supported by ObsPy.
:type location: str
:param location: Location code. See note on wildcards above.
:type channel: str
:param channel: Channel code. See note on wildcards above.
:type starttime: :class:`~obspy.core.utcdatetime.UTCDateTime`
:param starttime: Start time of requested time window.
:type endtime: :class:`~obspy.core.utcdatetime.UTCDateTime`
:param endtime: End time of requested time window.
"""
if len(location) > 2:
msg = ("Location code ('%s') only supports a maximum of 2 "
"characters.") % location
raise ValueError(msg)
elif len(location) == 1:
msg = "Single character location codes are untested."
warnings.warn(msg)
if location:
loccha = "%2s%3s" % (location, channel)
else:
loccha = channel
seedlink_id = "%s_%s:%s" % (network, station, loccha)
self._slclient.multiselect = seedlink_id
self._slclient.begin_time = starttime
self._slclient.end_time = endtime
self._connect()
self._slclient.initialize()
self.stream = Stream()
self._slclient.run(packet_handler=self._packet_handler)
stream = self.stream
stream.trim(starttime, endtime)
self.stream = None
return stream
def _packet_handler(self, count, slpack):
"""
Custom packet handler that accumulates all waveform packets in a
stream.
"""
# check if not a complete packet
if slpack is None or (slpack == SLPacket.SLNOPACKET) or \
(slpack == SLPacket.SLERROR):
return False
# get basic packet info
type_ = slpack.get_type()
if self.debug:
print(type_)
# process INFO packets here
if type_ == SLPacket.TYPE_SLINF:
if self.debug:
print(SLPacket.TYPE_SLINF)
return False
elif type_ == SLPacket.TYPE_SLINFT:
if self.debug:
print("Complete INFO:" + self.slconn.get_info_string())
return False
# process packet data
trace = slpack.get_trace()
if trace is None:
if self.debug:
print("Blockette contains no trace")
return False
# new samples add to the main stream which is then trimmed
self.stream += trace
self.stream.merge(-1)
return False
if __name__ == '__main__':
import doctest
doctest.testmod(exclude_empty=True)