Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

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

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

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

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

327

328

329

330

331

332

#!/usr/bin/env python 

# -*- coding: utf-8 -*- 

""" 

The gse2.core test suite. 

""" 

 

from obspy import Stream, Trace, UTCDateTime, read 

from obspy.core.util import NamedTemporaryFile 

from obspy.gse2.libgse2 import ChksumError 

import copy 

import numpy as np 

import os 

import unittest 

 

 

class CoreTestCase(unittest.TestCase): 

    """ 

    Test cases for libgse2 core interface 

    """ 

    def setUp(self): 

        # directory where the test files are located 

        self.path = os.path.dirname(__file__) 

 

    def test_readViaObsPy(self): 

        """ 

        Read files via L{obspy.Trace} 

        """ 

        gse2file = os.path.join(self.path, 'data', 'loc_RJOB20050831023349.z') 

        testdata = [12, -10, 16, 33, 9, 26, 16, 7, 17, 6, 1, 3, -2] 

        # read 

        st = read(gse2file, verify_checksum=True) 

        st.verify() 

        tr = st[0] 

        self.assertEqual(tr.stats['station'], 'RJOB') 

        self.assertEqual(tr.stats.npts, 12000) 

        self.assertEqual(tr.stats['sampling_rate'], 200) 

        self.assertEqual(tr.stats.get('channel'), 'Z') 

        self.assertAlmostEqual(tr.stats.get('calib'), 9.49e-02) 

        self.assertEqual(tr.stats.gse2.get('vang'), -1.0) 

        self.assertEqual(tr.stats.gse2.get('hang'), -1.0) 

        self.assertEqual(tr.stats.gse2.get('calper'), 1.0) 

        self.assertEqual(tr.stats.gse2.get('instype'), '      ') 

        self.assertAlmostEqual(tr.stats.starttime.timestamp, 

                               1125455629.849998, 6) 

        self.assertEqual(tr.data[0:13].tolist(), testdata) 

 

    def test_readHeadViaObsPy(self): 

        """ 

        Read header of files via L{obspy.Trace} 

        """ 

        gse2file = os.path.join(self.path, 'data', 'loc_RJOB20050831023349.z') 

        # read 

        st = read(gse2file, headonly=True) 

        tr = st[0] 

        self.assertEqual(tr.stats['station'], 'RJOB') 

        self.assertEqual(tr.stats.npts, 12000) 

        self.assertEqual(tr.stats['sampling_rate'], 200) 

        self.assertEqual(tr.stats.get('channel'), 'Z') 

        self.assertAlmostEqual(tr.stats.get('calib'), 9.49e-02) 

        self.assertEqual(tr.stats.gse2.get('vang'), -1.0) 

        self.assertEqual(tr.stats.gse2.get('calper'), 1.0) 

        self.assertAlmostEqual(tr.stats.starttime.timestamp, 

                               1125455629.849998, 6) 

        self.assertEqual(str(tr.data), '[]') 

 

    def test_readAndWriteViaObsPy(self): 

        """ 

        Read and Write files via L{obspy.Trace} 

        """ 

        tempfile = NamedTemporaryFile().name 

        gse2file = os.path.join(self.path, 'data', 'loc_RNON20040609200559.z') 

        # read trace 

        st1 = read(gse2file) 

        st1.verify() 

        tr1 = st1[0] 

        # write comparison trace 

        st2 = Stream() 

        st2.traces.append(Trace()) 

        tr2 = st2[0] 

        tr2.data = copy.deepcopy(tr1.data) 

        tr2.stats = copy.deepcopy(tr1.stats) 

        st2.write(tempfile, format='GSE2') 

        # read comparison trace 

        st3 = read(tempfile) 

        os.remove(tempfile) 

        st3.verify() 

        tr3 = st3[0] 

        # check if equal 

        self.assertEqual(tr3.stats['station'], tr1.stats['station']) 

        self.assertEqual(tr3.stats.npts, tr1.stats.npts) 

        self.assertEqual(tr3.stats['sampling_rate'], 

                         tr1.stats['sampling_rate']) 

        self.assertEqual(tr3.stats.get('channel'), 

                         tr1.stats.get('channel')) 

        self.assertEqual(tr3.stats.get('starttime'), 

                         tr1.stats.get('starttime')) 

        self.assertEqual(tr3.stats.get('calib'), 

                         tr1.stats.get('calib')) 

        self.assertEqual(tr3.stats.gse2.get('vang'), 

                         tr1.stats.gse2.get('vang')) 

        self.assertEqual(tr3.stats.gse2.get('calper'), 

                         tr1.stats.gse2.get('calper')) 

        np.testing.assert_equal(tr3.data, tr1.data) 

 

    def test_readAndWriteStreamsViaObsPy(self): 

        """ 

        Read and Write files containing multiple GSE2 parts via L{obspy.Trace} 

        """ 

        # setup test 

        tmpfile1 = NamedTemporaryFile().name 

        tmpfile2 = NamedTemporaryFile().name 

        files = [os.path.join(self.path, 'data', 'loc_RNON20040609200559.z'), 

                 os.path.join(self.path, 'data', 'loc_RJOB20050831023349.z')] 

        testdata = [12, -10, 16, 33, 9, 26, 16, 7, 17, 6, 1, 3, -2] 

        # write test file containing multiple GSE2 parts 

        f = open(tmpfile1, 'wb') 

        for i in xrange(2): 

            f1 = open(files[i], 'rb') 

            f.write(f1.read()) 

            f1.close() 

        f.close() 

        # read 

        st1 = read(tmpfile1) 

        st1.verify() 

        self.assertEqual(len(st1), 2) 

        tr11 = st1[0] 

        tr12 = st1[1] 

        self.assertEqual(tr11.stats['station'], 'RNON') 

        self.assertEqual(tr12.stats['station'], 'RJOB') 

        self.assertEqual(tr12.data[0:13].tolist(), testdata) 

        # write and read 

        st1.write(tmpfile2, format='GSE2') 

        st2 = read(tmpfile2) 

        st2.verify() 

        self.assertEqual(len(st2), 2) 

        tr21 = st1[0] 

        tr22 = st1[1] 

        self.assertEqual(tr21.stats['station'], 'RNON') 

        self.assertEqual(tr22.stats['station'], 'RJOB') 

        self.assertEqual(tr22.data[0:13].tolist(), testdata) 

        np.testing.assert_equal(tr21.data, tr11.data) 

        np.testing.assert_equal(tr22.data, tr12.data) 

        os.remove(tmpfile1) 

        os.remove(tmpfile2) 

 

    def test_writeIntegersViaObsPy(self): 

        """ 

        Write file test via L{obspy.Trace}. 

        """ 

        tempfile = NamedTemporaryFile().name 

        npts = 1000 

        # data cloud of integers - float won't work! 

        np.random.seed(815)  # make test reproducable 

        data = np.random.randint(-1000, 1000, npts).astype('int32') 

        stats = {'network': 'BW', 'station': 'TEST', 'location': '', 

                 'channel': 'EHE', 'npts': npts, 'sampling_rate': 200.0} 

        start = UTCDateTime(2000, 1, 1) 

        stats['starttime'] = start 

        tr = Trace(data=data, header=stats) 

        st = Stream([tr]) 

        st.verify() 

        # write 

        st.write(tempfile, format="GSE2") 

        # read again 

        stream = read(tempfile) 

        os.remove(tempfile) 

        stream.verify() 

        np.testing.assert_equal(data, stream[0].data) 

        # test default attributes 

        self.assertEqual('CM6', stream[0].stats.gse2.datatype) 

        self.assertEqual(-1, stream[0].stats.gse2.vang) 

        self.assertEqual(1.0, stream[0].stats.gse2.calper) 

        self.assertEqual(1.0, stream[0].stats.calib) 

 

    def test_tabCompleteStats(self): 

        """ 

        Read files via L{obspy.Trace} 

        """ 

        gse2file = os.path.join(self.path, 'data', 'loc_RJOB20050831023349.z') 

        # read 

        tr = read(gse2file)[0] 

        self.assertTrue('station' in dir(tr.stats)) 

        self.assertTrue('npts' in dir(tr.stats)) 

        self.assertTrue('sampling_rate' in dir(tr.stats)) 

        self.assertEqual(tr.stats['station'], 'RJOB') 

        self.assertEqual(tr.stats.npts, 12000) 

        self.assertEqual(tr.stats['sampling_rate'], 200) 

 

    def test_writeWrongFormat(self): 

        """ 

        Write floating point encoded data 

        """ 

        np.random.seed(815) 

        tmpfile = NamedTemporaryFile().name 

        st = Stream([Trace(data=np.random.randn(1000))]) 

        self.assertRaises(Exception, st.write, tmpfile, format="GSE2") 

        os.remove(tmpfile) 

 

    def test_readWithWrongChecksum(self): 

        """ 

        Test if additional kwarg verify_chksum can be given 

        """ 

        # read original file 

        gse2file = os.path.join(self.path, 'data', 

                                'loc_RJOB20050831023349.z.wrong_chksum') 

        # should not fail 

        _st = read(gse2file, verify_chksum=False) 

        # should fail 

        self.assertRaises(ChksumError, read, gse2file, verify_chksum=True) 

 

    def test_readWithWrongParameters(self): 

        """ 

        Test if additional kwargs can be given 

        """ 

        # read original file 

        gse2file = os.path.join(self.path, 'data', 

                                'loc_RJOB20050831023349.z.wrong_chksum') 

        # add wrong starttime flag of mseed, should also not fail 

        _st = read(gse2file, verify_chksum=False, starttime=None) 

 

    def test_readGSE1ViaObsPy(self): 

        """ 

        Read files via L{obspy.Trace} 

        """ 

        gse1file = os.path.join(self.path, 'data', 'loc_STAU20031119011659.z') 

        testdata = [-818, -814, -798, -844, -806, -818, -800, -790, -818, -780] 

        # read 

        st = read(gse1file, verify_checksum=True) 

        st.verify() 

        tr = st[0] 

        self.assertEqual(tr.stats['station'], 'LE0083') 

        self.assertEqual(tr.stats.npts, 3000) 

        self.assertAlmostEqual(tr.stats['sampling_rate'], 124.9999924) 

        self.assertEqual(tr.stats.get('channel'), '  Z') 

        self.assertAlmostEqual(tr.stats.get('calib'), 16.0000001) 

        self.assertEqual(str(tr.stats.starttime), 

                         '2003-11-19T01:16:59.990000Z') 

        self.assertEqual(tr.data[0:10].tolist(), testdata) 

 

    def test_readGSE1HeadViaObsPy(self): 

        """ 

        Read header via L{obspy.Trace} 

        """ 

        gse1file = os.path.join(self.path, 'data', 'loc_STAU20031119011659.z') 

        # read 

        st = read(gse1file, headonly=True) 

        tr = st[0] 

        self.assertEqual(tr.stats['station'], 'LE0083') 

        self.assertEqual(tr.stats.npts, 3000) 

        self.assertAlmostEqual(tr.stats['sampling_rate'], 124.9999924) 

        self.assertEqual(tr.stats.get('channel'), '  Z') 

        self.assertAlmostEqual(tr.stats.get('calib'), 16.0000001) 

        self.assertEqual(str(tr.stats.starttime), 

                         '2003-11-19T01:16:59.990000Z') 

 

    def test_readINTVGSE1ViaObsPy(self): 

        """ 

        Read file via L{obspy.Trace} 

        """ 

        gse1file = os.path.join(self.path, 'data', 

                                'GRF_031102_0225.GSE.wrong_chksum') 

        data1 = [-334, -302, -291, -286, -266, -252, -240, -214] 

        data2 = [-468, -480, -458, -481, -481, -435, -432, -389] 

 

        # verify checksum fails 

        self.assertRaises(ChksumError, read, gse1file, verify_chksum=True) 

        # reading header only 

        st = read(gse1file, headonly=True) 

        self.assertEquals(len(st), 2) 

        # reading without checksum verification 

        st = read(gse1file, verify_chksum=False) 

        st.verify() 

        # first trace 

        self.assertEquals(len(st), 2) 

        self.assertEqual(st[0].stats['station'], 'GRA1') 

        self.assertEqual(st[0].stats.npts, 6000) 

        self.assertAlmostEqual(st[0].stats['sampling_rate'], 19.9999997) 

        self.assertEqual(st[0].stats.get('channel'), ' BZ') 

        self.assertAlmostEqual(st[0].stats.get('calib'), 0.9900001) 

        self.assertEqual(st[0].stats.starttime, 

                         UTCDateTime('2003-11-02T02:25:00.000000Z')) 

        # second trace 

        self.assertEquals(len(st), 2) 

        self.assertEqual(st[1].stats['station'], 'GRA1') 

        self.assertEqual(st[1].stats.npts, 6000) 

        self.assertAlmostEqual(st[1].stats['sampling_rate'], 19.9999997) 

        self.assertEqual(st[1].stats.get('channel'), ' BN') 

        self.assertAlmostEqual(st[1].stats.get('calib'), 0.9200001) 

        self.assertEqual(st[1].stats.starttime, 

                         UTCDateTime('2003-11-02T02:25:00.000000Z')) 

        # check first 8 samples 

        self.assertEqual(st[0].data[0:8].tolist(), data1) 

        # check last 8 samples 

        self.assertEqual(st[1].data[-8:].tolist(), data2) 

 

    def test_readDos(self): 

        """ 

        Read file with dos newlines / encoding, that is 

        Line Feed (LF) and Carriage Return (CR) 

        see #355 

        """ 

        filedos = os.path.join(self.path, 'data', 

                               'loc_RJOB20050831023349_first100_dos.z') 

        fileunix = os.path.join(self.path, 'data', 'loc_RJOB20050831023349.z') 

        st = read(filedos, verify_chksum=True) 

        st2 = read(fileunix, verify_chksum=True) 

        np.testing.assert_equal(st[0].data, st2[0].data[:100]) 

        self.assertEqual(st[0].stats['station'], 'RJOB') 

 

    def test_read_apply_calib(self): 

        """ 

        Tests apply_calib parameter in read method. 

        """ 

        gse2file = os.path.join(self.path, 'data', 'loc_RJOB20050831023349.z') 

        testdata = [12, -10, 16, 33, 9, 26, 16, 7, 17, 6, 1, 3, -2] 

        # read w/ apply_calib = False 

        st = read(gse2file, apply_calib=False) 

        tr = st[0] 

        self.assertEqual(tr.data[0:13].tolist(), testdata) 

        # read w/ apply_calib = True 

        st = read(gse2file, apply_calib=True) 

        tr = st[0] 

        testdata = [n * tr.stats.calib for n in testdata] 

        self.assertEqual(tr.data[0:13].tolist(), testdata) 

 

 

def suite(): 

    return unittest.makeSuite(CoreTestCase, 'test') 

 

 

if __name__ == '__main__': 

    unittest.main(defaultTest='suite')