def getWaveform(self,
network,
station,
location,
channel,
starttime,
endtime,
cleanup=True):
"""
Retrieves waveform data from Earthworm Wave Server and returns an ObsPy
Stream object.
:type filename: str
:param filename: Name of the output file.
:type network: str
:param network: Network code, e.g. ``'UW'``.
:type station: str
:param station: Station code, e.g. ``'TUCA'``.
:type location: str
:param location: Location code, e.g. ``'--'``.
:type channel: str
:param channel: Channel code, e.g. ``'BHZ'``. Last character (i.e.
component) can be a wildcard ('?' or '*') to fetch `Z`, `N` and
`E` component.
:type starttime: :class:`~obspy.core.utcdatetime.UTCDateTime`
:param starttime: Start date and time.
:type endtime: :class:`~obspy.core.utcdatetime.UTCDateTime`
:param endtime: End date and time.
:return: ObsPy :class:`~obspy.core.stream.Stream` object.
:type cleanup: bool
:param cleanup: Specifies whether perfectly aligned traces should be
merged or not. See :meth:`obspy.core.stream.Stream.merge` for
``method=-1``.
.. rubric:: Example
>>> from obspy.earthworm import Client
>>> client = Client("pele.ess.washington.edu", 16017)
>>> dt = UTCDateTime(2013, 1, 17) - 2000 # now - 2000 seconds
>>> st = client.getWaveform('UW', 'TUCA', '', 'BHZ', dt, dt + 10)
>>> st.plot() # doctest: +SKIP
>>> st = client.getWaveform('UW', 'TUCA', '', 'BH*', dt, dt + 10)
>>> st.plot() # doctest: +SKIP
.. plot::
from obspy.earthworm import Client
from obspy import UTCDateTime
client = Client("pele.ess.washington.edu", 16017, timeout=5)
dt = UTCDateTime(2013, 1, 17) - 2000 # now - 2000 seconds
st = client.getWaveform('UW', 'TUCA', '', 'BHZ', dt, dt + 10)
st.plot()
st = client.getWaveform('UW', 'TUCA', '', 'BH*', dt, dt + 10)
st.plot()
"""
# replace wildcards in last char of channel and fetch all 3 components
if channel[-1] in "?*":
st = Stream()
for comp in ("Z", "N", "E"):
channel_new = channel[:-1] + comp
st += self.getWaveform(network,
station,
location,
channel_new,
starttime,
endtime,
cleanup=cleanup)
return st
if location == '':
location = '--'
scnl = (station, channel, network, location)
# fetch waveform
tbl = readWaveServerV(self.host,
self.port,
scnl,
starttime,
endtime,
timeout=self.timeout)
# create new stream
st = Stream()
for tb in tbl:
st.append(tb.getObspyTrace())
if cleanup:
st._cleanup()
st.trim(starttime, endtime)
return st
def getWaveform(self, network, station, location, channel, starttime,
endtime, cleanup=True):
"""
Retrieves waveform data from Earthworm Wave Server and returns an ObsPy
Stream object.
:type filename: str
:param filename: Name of the output file.
:type network: str
:param network: Network code, e.g. ``'UW'``.
:type station: str
:param station: Station code, e.g. ``'TUCA'``.
:type location: str
:param location: Location code, e.g. ``'--'``.
:type channel: str
:param channel: Channel code, e.g. ``'BHZ'``. Last character (i.e.
component) can be a wildcard ('?' or '*') to fetch `Z`, `N` and
`E` component.
:type starttime: :class:`~obspy.core.utcdatetime.UTCDateTime`
:param starttime: Start date and time.
:type endtime: :class:`~obspy.core.utcdatetime.UTCDateTime`
:param endtime: End date and time.
:return: ObsPy :class:`~obspy.core.stream.Stream` object.
:type cleanup: bool
:param cleanup: Specifies whether perfectly aligned traces should be
merged or not. See :meth:`obspy.core.stream.Stream.merge` for
``method=-1``.
.. rubric:: Example
>>> from obspy.earthworm import Client
>>> client = Client("pele.ess.washington.edu", 16017)
>>> dt = UTCDateTime(2013, 1, 17) - 2000 # now - 2000 seconds
>>> st = client.getWaveform('UW', 'TUCA', '', 'BHZ', dt, dt + 10)
>>> st.plot() # doctest: +SKIP
>>> st = client.getWaveform('UW', 'TUCA', '', 'BH*', dt, dt + 10)
>>> st.plot() # doctest: +SKIP
.. plot::
from obspy.earthworm import Client
from obspy import UTCDateTime
client = Client("pele.ess.washington.edu", 16017, timeout=5)
dt = UTCDateTime(2013, 1, 17) - 2000 # now - 2000 seconds
st = client.getWaveform('UW', 'TUCA', '', 'BHZ', dt, dt + 10)
st.plot()
st = client.getWaveform('UW', 'TUCA', '', 'BH*', dt, dt + 10)
st.plot()
"""
# replace wildcards in last char of channel and fetch all 3 components
if channel[-1] in "?*":
st = Stream()
for comp in ("Z", "N", "E"):
channel_new = channel[:-1] + comp
st += self.getWaveform(network, station, location,
channel_new, starttime, endtime,
cleanup=cleanup)
return st
if location == '':
location = '--'
scnl = (station, channel, network, location)
# fetch waveform
tbl = readWaveServerV(self.host, self.port, scnl, starttime, endtime,
timeout=self.timeout)
# create new stream
st = Stream()
for tb in tbl:
st.append(tb.getObspyTrace())
if cleanup:
st._cleanup()
st.trim(starttime, endtime)
return st