Newer
Older
"""Factory that loads data from earthworm and writes to Edge."""
import obspy.core
from geomagio import TimeseriesFactory, TimeseriesFactoryException
from obspy import earthworm
from ObservatoryMetadata import ObservatoryMetadata
class EdgeFactory(TimeseriesFactory):
def __init__(self, host=None, port=None, observatory=None,
Hal Simpson
committed
channels=None, type=None, interval=None,
observatoryMetadata=None):
TimeseriesFactory.__init__(self, observatory, channels, type, interval)
self.client = earthworm.Client(host, port)
Hal Simpson
committed
if observatoryMetadata is None:
self.observatoryMetadata = ObservatoryMetadata()
else:
self.observatoryMetadata = observatoryMetadata
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
def get_timeseries(self, starttime, endtime, observatory=None,
channels=None, type=None, interval=None):
"""Get timeseries data
Parameters
----------
observatory : str
observatory code.
starttime : obspy.core.UTCDateTime
time of first sample.
endtime : obspy.core.UTCDateTime
time of last sample.
channels : array_like
list of channels to load
type : {'variation', 'quasi-definitive'}
data type.
interval : {'minute', 'second'}
data interval.
Returns
-------
obspy.core.Stream
timeseries object with requested data.
Raises
------
TimeseriesFactoryException
if invalid values are requested, or errors occur while
retrieving timeseries.
"""
observatory = observatory or self.observatory
channels = channels or self.channels
type = type or self.type
interval = interval or self.interval
Hal Simpson
committed
timeseries = obspy.core.Stream()
for channel in channels:
data = self._get_timeseries(starttime, endtime, observatory,
channel, type, interval)
Hal Simpson
committed
timeseries += data
timeseries.merge()
return timeseries
def put_timeseries(self, starttime, endtime, observatory=None,
channels=None, type=None, interval=None):
"""Put timeseries data
Parameters
----------
observatory : str
observatory code.
starttime : obspy.core.UTCDateTime
time of first sample.
endtime : obspy.core.UTCDateTime
time of last sample.
channels : array_like
list of channels to load
type : {'variation', 'quasi-definitive'}
data type.
interval : {'minute', 'second'}
data interval.
Returns
-------
obspy.core.Stream
timeseries object with requested data.
Raises
------
TimeseriesFactoryException
if invalid values are requested, or errors occur while
retrieving timeseries.
"""
Hal Simpson
committed
raise NotImplementedError('"put_timeseries" not implemented')
def get_type_from_edge(self, location):
"""Get type from edge location
Parameters
----------
location: {R0, R1, Q0, D0}
the edge location code.
Returns
-------
type: {variation, quasi-definitive, definitive}
the type of data
"""
type = None
Hal Simpson
committed
print location
if location == 'R0' or location == 'R1':
type = 'variation'
Hal Simpson
committed
elif location == 'Q0':
type = 'quasi-definitive'
Hal Simpson
committed
elif location == 'D0':
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
type = 'definitive'
return type
def _get_edge_network(self, observatory, channel, type, interval):
"""get edge network code.
Parameters
----------
observatory : str
observatory code
channels : array_like
list of single character channels {H, E, D, Z, F}
type : str
data type {Definitive, Quasi-definitive, Variation}
interval : str
interval length {minute, second}
Returns
-------
network
always NT
"""
return 'NT'
def _get_edge_station(self, observatory, channel, type, interval):
"""get edge station.
Parameters
----------
observatory : str
observatory code
channels : array_like
list of single character channels {H, E, D, Z, F}
type : str
data type {Definitive, Quasi-definitive, Variation}
interval : str
interval length {minute, second}
Returns
-------
station
the observatory is returned as the station
"""
return observatory
def _get_edge_channel(self, observatory, channel, type, interval):
"""get edge channel.
Parameters
----------
observatory : str
observatory code
channels : array_like
list of single character channels {H, E, D, Z, F}
type : str
data type {Definitive, Quasi-definitive, Variation}
interval : str
interval length {minute, second}
Returns
-------
edge_channel
{MVH, MVE, MVD, etc}
"""
edge_interval_code = self._get_interval_code(interval)
edge_channel = None
if channel == 'D':
edge_channel = edge_interval_code + 'VD'
elif channel == 'E':
edge_channel = edge_interval_code + 'VE'
elif channel == 'F':
edge_channel = edge_interval_code + 'SF'
elif channel == 'H':
edge_channel = edge_interval_code + 'VH'
elif channel == 'Z':
edge_channel = edge_interval_code + 'VZ'
else:
raise TimeseriesFactoryException(
'Unexpected channel code "%s"' % channel)
return edge_channel
def _get_edge_location(self, observatory, channel, type, interval):
"""get edge location.
The edge location code is currently determined by the type
passed in.
Parameters
----------
observatory : str
observatory code
channels : array_like
list of single character channels {H, E, D, Z, F}
type : str
data type {Definitive, Quasi-definitive, Variation}
interval : str
interval length {minute, second}
Returns
-------
location
returns an edge location code
"""
location = None
if type == 'variation':
location = 'R0'
elif type == 'quasi-definitive':
location = 'Q0'
Hal Simpson
committed
elif type == 'definitive':
location = 'D0'
return location
def _get_interval_from_code(self, interval):
"""get interval from edge Code.
The first character of an Edge code represents the interval.
Currently minute and second are represented.
Parameters
----------
observatory : str
observatory code
channels : array_like
list of single character channels {H, E, D, Z, F}
type : str
data type {Definitive, Quasi-definitive, Variation}
interval : str
interval length {minute, second}
Returns
-------
interval type
"""
interval_code = None
Hal Simpson
committed
if interval == 'M':
interval_code = 'minute'
Hal Simpson
committed
elif interval == 'S':
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
interval_code = 'second'
else:
raise TimeseriesFactoryException(
'Unexpected interval code "%s' % interval)
return interval_code
def _get_interval_code(self, interval):
"""get edge interval code.
Converts the metadata interval string, into an edge single character
edge code.
Parameters
----------
observatory : str
observatory code
channels : array_like
list of single character channels {H, E, D, Z, F}
type : str
data type {Definitive, Quasi-definitive, Variation}
interval : str
interval length {minute, second}
Returns
-------
interval type
"""
interval_code = None
if interval == 'daily':
interval_code = 'D'
elif interval == 'hourly':
interval_code = 'H'
elif interval == 'minute':
interval_code = 'M'
elif interval == 'second':
interval_code = 'S'
else:
raise TimeseriesFactoryException(
'Unexpected interval "%s"' % interval)
return interval_code
def _get_timeseries(self, starttime, endtime, observatory,
channel, type, interval):
"""get timeseries data for a single channel.
Parameters
----------
starttime: obspy.core.UTCDateTime
the starttime of the requested data
endtime: obspy.core.UTCDateTime
the endtime of the requested data
observatory : str
observatory code
channels : array_like
list of single character channels {H, E, D, Z, F}
type : str
data type {Definitive, Quasi-definitive, Variation}
interval : str
interval length {minute, second}
Returns
-------
obspy.core.trace
timeseries trace of the requested channel data
"""
station = self._get_edge_station(observatory, channel,
type, interval)
location = self._get_edge_location(observatory, channel,
type, interval)
network = self._get_edge_network(observatory, channel,
type, interval)
Hal Simpson
committed
edge_channel = self._get_edge_channel(observatory, channel,
type, interval)
data = self.client.getWaveform(network, station, location,
Hal Simpson
committed
edge_channel, starttime, endtime)
# stats = obspy.core.Stats(data[0].stats)
self._set_metadata(data,
observatory, channel, type, interval)
# data[0].stats = stats
return data
Hal Simpson
committed
def _set_metadata(self, stream, observatory, channel, type, interval):
"""set metadata for a given stream/channel """
print 'channel'
print channel
for trace in stream:
trace.stats['channel'] = channel
trace.stats['data_interval'] = interval
trace.stats['data_type'] = type
self.observatoryMetadata.set_metadata(trace.stats, observatory)