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

#!/usr/bin/env python 

#------------------------------------------------------------------- 

# Filename: libgse1.py 

#  Purpose: Python wrapper for reading GSE1 files 

#   Author: Moritz Beyreuther 

#    Email: moritz.beyreuther@geophysik.uni-muenchen.de 

# 

# Copyright (C) 2008-2012 Moritz Beyreuther 

#--------------------------------------------------------------------- 

""" 

Low-level module internally used for handling GSE1 files 

 

:copyright: 

    The ObsPy Development Team (devs@obspy.org) 

:license: 

    GNU Lesser General Public License, Version 3 

    (http://www.gnu.org/copyleft/lesser.html) 

""" 

 

from obspy import UTCDateTime 

from obspy.gse2.libgse2 import uncompress_CM6, verifyChecksum 

import doctest 

import numpy as np 

 

 

def read(fh, verify_chksum=True): 

    """ 

    Read GSE1 file and return header and data. 

 

    Currently supports only CM6 compressed and plain integer GSE1 files, this 

    should be sufficient for most cases. Data are in circular frequency counts, 

    for correction of calper multiply by 2PI and calper: data * 2 * pi * 

    header['calper']. 

 

    :type fh: File Pointer 

    :param fh: Open file pointer of GSE1 file to read, opened in binary mode, 

        e.g. fh = open('myfile','rb') 

    :type verify_chksum: Bool 

    :param verify_chksum: If True verify Checksum and raise Exception if not 

        correct 

    :rtype: Dictionary, Numpy.ndarray int32 

    :return: Header entries and data as numpy.ndarray of type int32. 

    """ 

    header = readHeader(fh) 

    dtype = header['gse1']['datatype'] 

    if dtype == 'CMP6': 

        data = uncompress_CM6(fh, header['npts']) 

    elif dtype == 'INTV': 

        data = readIntegerData(fh, header['npts']) 

    else: 

        raise Exception("Unsupported data type %s in GSE1 file" % dtype) 

    # test checksum only if enabled 

    if verify_chksum: 

        verifyChecksum(fh, data, version=1) 

    return header, data 

 

 

def readIntegerData(fh, npts): 

    """ 

    Reads npts points of uncompressed integers from given file handler. 

    """ 

    # find next DAT1 section within file 

    buf = fh.readline() 

    while buf: 

        if buf.startswith("DAT1"): 

            data = np.fromfile(fh, dtype=np.int32, count=npts, sep=' ') 

            break 

        buf = fh.readline() 

    return data 

 

 

def readHeader(fh): 

    """ 

    Reads GSE1 header from file pointer and returns it as dictionary. 

 

    The method searches for the next available WID1 field beginning from the 

    current file position. 

    """ 

    # search for WID1 field 

    line = fh.readline() 

    while line: 

        if line.startswith("WID1"): 

            # valid GSE1 header 

            break 

        line = fh.readline() 

    if line == '': 

        raise EOFError 

    # fetch header 

    header = {} 

    header['gse1'] = {} 

    # first line 

    year = int(line[5:10]) 

    julday = int(line[10:13]) 

    hour = int(line[14:16]) 

    minute = int(line[17:19]) 

    second = int(line[20:22]) 

    millisec = int(line[23:26]) 

    header['starttime'] = UTCDateTime(year=year, julday=julday, 

                                      hour=hour, minute=minute, 

                                      second=second, 

                                      microsecond=millisec * 1000) 

    header['npts'] = int(line[27:35]) 

    header['station'] = line[36:42].strip() 

    header['gse1']['instype'] = line[43:51].strip() 

    header['channel'] = "%03s" % line[52:54].strip().upper() 

    header['sampling_rate'] = float(line[55:66]) 

    header['gse1']['type'] = line[67:73].strip() 

    header['gse1']['datatype'] = line[74:78].strip() 

    header['gse1']['dflag'] = int(line[79:80]) 

    # second line 

    line = fh.readline() 

    header['calib'] = float(line[0:10]) 

    header['gse1']['units'] = float(line[10:17]) 

    header['gse1']['cperiod'] = float(line[18:27]) 

    header['gse1']['lat'] = float(line[28:37]) 

    header['gse1']['lon'] = float(line[38:47]) 

    header['gse1']['alt'] = float(line[48:57]) 

    header['gse1']['unknown1'] = float(line[58:65]) 

    header['gse1']['unknown2'] = float(line[66:73]) 

    header['gse1']['unknown3'] = float(line[74:81]) 

    header['gse1']['unknown4'] = float(line[74:80]) 

    return header 

 

 

if __name__ == '__main__': 

    doctest.testmod(exclude_empty=True)