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

# http://pyrocko.org - GPLv3 

# 

# The Pyrocko Developers, 21st Century 

# ---|P------/S----------~Lg---------- 

from __future__ import absolute_import 

import math 

import numpy as num 

try: 

from StringIO import StringIO as BytesIO 

except ImportError: 

from io import BytesIO 

 

from pyrocko import trace 

 

d2r = math.pi/180. 

 

 

class SacPoleZeroError(Exception): 

pass 

 

 

def read_sac_zpk(filename=None, file=None, string=None, get_comments=False): 

''' 

Read SAC Pole-Zero file. 

 

:returns: ``(zeros, poles, constant)`` or 

``(zeros, poles, constant, comments)`` if ``get_comments`` is True. 

''' 

 

if filename is not None: 

f = open(filename, 'rb') 

 

elif file is not None: 

f = file 

 

elif string is not None: 

f = BytesIO(string) 

 

sects = ('ZEROS', 'POLES', 'CONSTANT') 

sectdata = {'ZEROS': [], 'POLES': []} 

npoles = 0 

nzeros = 0 

constant = 1.0 

atsect = None 

comments = [] 

for iline, line in enumerate(f): 

line = str(line.decode('ascii')) 

toks = line.split() 

if len(toks) == 0: 

continue 

 

if toks[0][0] in '*#': 

comments.append(line) 

continue 

 

if len(toks) != 2: 

f.close() 

raise SacPoleZeroError( 

'Expected 2 tokens in line %i of file %s' 

% (iline+1, filename)) 

 

if toks[0].startswith('*'): 

continue 

 

lsect = toks[0].upper() 

if lsect in sects: 

atsect = lsect 

sectdata[atsect] = [] 

if lsect.upper() == 'ZEROS': 

nzeros = int(toks[1]) 

elif toks[0].upper() == 'POLES': 

npoles = int(toks[1]) 

elif toks[0].upper() == 'CONSTANT': 

constant = float(toks[1]) 

else: 

if atsect: 

sectdata[atsect].append( 

complex(float(toks[0]), float(toks[1]))) 

 

if f != file: 

f.close() 

 

poles = sectdata['POLES'] 

zeros = sectdata['ZEROS'] 

npoles_ = len(poles) 

nzeros_ = len(zeros) 

if npoles_ > npoles: 

raise SacPoleZeroError( 

'Expected %i poles but found %i in pole-zero file "%s"' 

% (npoles, npoles_, filename)) 

if nzeros_ > nzeros: 

raise SacPoleZeroError( 

'Expected %i zeros but found %i in pole-zero file "%s"' 

% (nzeros, nzeros_, filename)) 

 

if npoles_ < npoles: 

poles.extend([complex(0.)]*(npoles-npoles_)) 

 

if nzeros_ < npoles: 

zeros.extend([complex(0.)]*(nzeros-nzeros_)) 

 

if len(poles) == 0 and len(zeros) == 0: 

raise SacPoleZeroError( 

'No poles and zeros found in file "%s"' % (filename)) 

 

if not num.all(num.isfinite(poles)): 

raise SacPoleZeroError( 

'Not finite pole(s) found in pole-zero file "%s"' 

% filename) 

 

if not num.all(num.isfinite(zeros)): 

raise SacPoleZeroError( 

'Not finite zero(s) found in pole-zero file "%s"' 

% filename) 

 

if not num.isfinite(constant): 

raise SacPoleZeroError( 

'Ivalid constant (%g) found in pole-zero file "%s"' 

% (constant, filename)) 

 

if get_comments: 

return zeros, poles, constant, comments 

else: 

return zeros, poles, constant 

 

 

def write_sac_zpk(zeros, poles, constant, filename): 

if hasattr(filename, 'write'): 

f = filename 

else: 

f = open('w', filename) 

 

def write_complex(x): 

f.write('%12.8g %12.8g\n' % (complex(x).real, complex(x).imag)) 

 

f.write('POLES %i\n' % len(poles)) 

for p in poles: 

if p != 0.0: 

write_complex(p) 

 

f.write('ZEROS %i\n' % len(zeros)) 

for z in zeros: 

if z != 0.0: 

write_complex(z) 

 

f.write('CONSTANT %12.8g\n' % constant) 

if not hasattr(filename, 'write'): 

f.close() 

 

 

def evaluate(zeros, poles, constant, fmin=0.001, fmax=100., nf=100): 

 

logfmin = math.log(fmin) 

logfmax = math.log(fmax) 

logf = num.linspace(logfmin, logfmax, nf) 

f = num.exp(logf) 

trans = trace.PoleZeroResponse(zeros, poles, constant) 

return f, trans.evaluate(f) 

 

 

def evaluate_at(zeros, poles, constant, f): 

jomeg = 1.0j * 2. * math.pi * f 

 

a = constant 

for z in zeros: 

a *= jomeg-z 

for p in poles: 

a /= jomeg-p 

 

return a 

 

 

def read_to_pyrocko_response(filename=None, file=None, string=None): 

''' 

Read SAC pole-zero file into Pyrocko response object. 

 

:returns: Response as a :py:class:~pyrocko.trace.PoleZeroResponse` object. 

''' 

 

from pyrocko import trace 

 

zeros, poles, constant = read_sac_zpk( 

filename=filename, file=file, string=string) 

return trace.PoleZeroResponse(zeros, poles, constant) 

 

 

def read_to_stationxml_response( 

input_unit, output_unit, normalization_frequency=1.0, 

filename=None, file=None, string=None): 

''' 

Read SAC pole-zero file into StationXML response object. 

 

:param input_unit: Input unit to be reported in the StationXML response. 

:type input_unit: str 

:param output_unit: Output unit to be reported in the StationXML response. 

:type output_unit: str 

:param normalization_frequency: Frequency where the normalization factor 

for the StationXML response should be computed. 

:type normalization_frequency: float 

 

:returns: Response as a :py:class:~pyrocko.io.stationxml.Response` object 

with a single pole-zero response stage. 

''' 

 

from pyrocko.io import stationxml 

 

presponse = read_to_pyrocko_response( 

filename=filename, file=file, string=string) 

 

return stationxml.Response.from_pyrocko_pz_response( 

presponse, input_unit, output_unit, normalization_frequency) 

 

 

def plot_amplitudes_zpk( 

zpks, filename_pdf, 

fmin=0.001, 

fmax=100., 

nf=100, 

fnorm=None): 

 

from pyrocko.plot import gmtpy 

 

p = gmtpy.LogLogPlot(width=30*gmtpy.cm, yexp=0) 

for i, (zeros, poles, constant) in enumerate(zpks): 

f, h = evaluate(zeros, poles, constant, fmin, fmax, nf) 

if fnorm is not None: 

h /= evaluate_at(zeros, poles, constant, fnorm) 

 

amp = num.abs(h) 

p.plot((f, amp), '-W2p,%s' % gmtpy.color(i)) 

 

p.save(filename_pdf) 

 

 

def plot_phases_zpk(zpks, filename_pdf, fmin=0.001, fmax=100., nf=100): 

 

from pyrocko.plot import gmtpy 

 

p = gmtpy.LogLinPlot(width=30*gmtpy.cm) 

for i, (zeros, poles, constant) in enumerate(zpks): 

f, h = evaluate(zeros, poles, constant, fmin, fmax, nf) 

phase = num.unwrap(num.angle(h)) / d2r 

p.plot((f, phase), '-W1p,%s' % gmtpy.color(i)) 

 

p.save(filename_pdf)