/
core.py
170 lines (143 loc) · 5.2 KB
/
core.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
# -*- coding: utf-8 -*-
"""
GSE2/GSE1 bindings to ObsPy core module.
"""
import numpy as np
from obspy import Stream, Trace
from . import libgse1, libgse2
def _is_gse2(filename):
"""
Checks whether a file is GSE2 or not.
:type filename: str
:param filename: GSE2 file to be checked.
:rtype: bool
:return: ``True`` if a GSE2 file.
"""
# Open file.
try:
with open(filename, 'rb') as f:
libgse2.is_gse2(f)
except Exception:
return False
return True
def _read_gse2(filename, headonly=False, verify_chksum=True,
**kwargs): # @UnusedVariable
"""
Reads a GSE2 file and returns a Stream object.
GSE2 files containing multiple WID2 entries/traces are supported.
.. warning::
This function should NOT be called directly, it registers via the
ObsPy :func:`~obspy.core.stream.read` function, call this instead.
:type filename: str
:param filename: GSE2 file to be read.
:type headonly: bool, optional
:param headonly: If True read only head of GSE2 file.
:type verify_chksum: bool, optional
:param verify_chksum: If True verify Checksum and raise Exception if
it is not correct.
:rtype: :class:`~obspy.core.stream.Stream`
:returns: Stream object containing header and data.
.. rubric:: Example
>>> from obspy import read
>>> st = read("/path/to/loc_RJOB20050831023349.z")
"""
traces = []
with open(filename, 'rb') as f:
# reading multiple gse2 parts
while True:
try:
if headonly:
header = libgse2.read_header(f)
traces.append(Trace(header=header))
else:
header, data = libgse2.read(f, verify_chksum=verify_chksum)
traces.append(Trace(header=header, data=data))
except EOFError:
break
return Stream(traces=traces)
def _write_gse2(stream, filename, inplace=False, **kwargs): # @UnusedVariable
"""
Write GSE2 file from a Stream object.
.. warning::
This function should NOT be called directly, it registers via the
the :meth:`~obspy.core.stream.Stream.write` method of an
ObsPy :class:`~obspy.core.stream.Stream` object, call this instead.
:type stream: :class:`~obspy.core.stream.Stream`
:param stream: The ObsPy Stream object to write.
:type filename: str
:param filename: Name of file to write.
:type inplace: bool, optional
:param inplace: If True, do compression not on a copy of the data but
on the data itself - note this will change the data values and make
them therefore unusable!
.. rubric:: Example
>>> from obspy import read
>>> st = read()
>>> st.write('filename.gse', format='GSE2') #doctest: +SKIP
"""
#
# Translate the common (renamed) entries
with open(filename, 'wb') as f:
# write multiple gse2 parts
for trace in stream:
dt = np.dtype(np.int32)
if trace.data.dtype.name == dt.name:
trace.data = np.ascontiguousarray(trace.data, dt)
else:
msg = "GSE2 data must be of type %s, but are of type %s" % \
(dt.name, trace.data.dtype)
raise Exception(msg)
libgse2.write(trace.stats, trace.data, f, inplace)
def _is_gse1(filename):
"""
Checks whether a file is GSE1 or not.
:type filename: str
:param filename: GSE1 file to be checked.
:rtype: bool
:return: ``True`` if a GSE1 file.
"""
# Open file.
with open(filename, 'rb') as f:
try:
data = f.readline()
except Exception:
return False
if data.startswith(b'WID1') or data.startswith(b'XW01'):
return True
return False
def _read_gse1(filename, headonly=False, verify_chksum=True,
**kwargs): # @UnusedVariable
"""
Reads a GSE1 file and returns a Stream object.
GSE1 files containing multiple WID1 entries/traces are supported.
.. warning::
This function should NOT be called directly, it registers via the
ObsPy :func:`~obspy.core.stream.read` function, call this instead.
:type filename: str
:param filename: GSE2 file to be read.
:type headonly: bool, optional
:param headonly: If True read only header of GSE1 file.
:type verify_chksum: bool, optional
:param verify_chksum: If True verify Checksum and raise Exception if
it is not correct.
:rtype: :class:`~obspy.core.stream.Stream`
:returns: Stream object containing header and data.
.. rubric:: Example
>>> from obspy import read
>>> st = read("/path/to/y2000.gse")
"""
traces = []
# read GSE1 file
with open(filename, 'rb') as fh:
while True:
try:
if headonly:
header = libgse1.read_header(fh)
traces.append(Trace(header=header))
else:
header, data = \
libgse1.read(fh, verify_chksum=verify_chksum)
traces.append(Trace(header=header, data=data))
except EOFError:
break
return Stream(traces=traces)