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

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

1001

1002

1003

1004

1005

1006

1007

1008

1009

1010

1011

1012

1013

1014

1015

1016

1017

1018

1019

1020

1021

1022

1023

1024

1025

1026

1027

1028

1029

1030

1031

1032

1033

1034

1035

1036

1037

1038

1039

1040

1041

1042

1043

1044

1045

1046

1047

1048

1049

1050

1051

1052

1053

1054

1055

1056

1057

1058

1059

1060

1061

1062

1063

1064

1065

1066

1067

1068

1069

1070

1071

1072

1073

1074

1075

1076

1077

1078

1079

1080

1081

1082

1083

1084

1085

1086

1087

1088

1089

1090

1091

1092

1093

1094

1095

1096

1097

1098

1099

1100

1101

1102

1103

1104

1105

1106

1107

1108

1109

1110

1111

1112

1113

1114

1115

1116

1117

1118

1119

1120

1121

1122

1123

1124

1125

1126

1127

1128

1129

1130

1131

1132

1133

1134

1135

1136

1137

1138

1139

1140

1141

1142

1143

1144

1145

1146

1147

1148

1149

1150

1151

1152

1153

1154

1155

1156

1157

1158

1159

1160

1161

1162

1163

1164

1165

1166

1167

1168

1169

1170

1171

1172

1173

1174

1175

1176

1177

1178

1179

1180

1181

1182

1183

1184

1185

1186

1187

1188

1189

1190

1191

1192

1193

1194

1195

1196

1197

1198

1199

1200

1201

1202

1203

1204

1205

1206

1207

1208

1209

1210

1211

1212

1213

1214

1215

1216

1217

1218

1219

1220

1221

1222

1223

1224

1225

1226

1227

1228

1229

1230

1231

1232

1233

1234

1235

1236

1237

1238

1239

1240

1241

1242

1243

1244

1245

1246

1247

1248

1249

1250

1251

1252

1253

1254

1255

1256

1257

1258

1259

1260

1261

1262

1263

1264

1265

1266

1267

1268

1269

1270

1271

1272

1273

1274

1275

1276

1277

1278

1279

1280

1281

1282

1283

1284

1285

1286

1287

1288

1289

1290

1291

1292

1293

1294

1295

1296

1297

1298

1299

1300

1301

1302

1303

1304

1305

1306

1307

1308

1309

1310

1311

1312

1313

1314

1315

1316

1317

1318

1319

1320

1321

1322

1323

1324

1325

1326

1327

1328

1329

1330

1331

1332

1333

1334

1335

1336

1337

1338

1339

1340

1341

1342

1343

1344

1345

1346

1347

1348

1349

1350

1351

1352

1353

1354

1355

1356

1357

1358

1359

1360

1361

1362

1363

1364

1365

1366

1367

1368

1369

1370

1371

1372

1373

1374

1375

1376

1377

1378

1379

1380

1381

1382

1383

1384

1385

1386

1387

1388

1389

1390

1391

1392

1393

1394

1395

1396

1397

1398

1399

1400

1401

1402

1403

1404

1405

1406

1407

1408

1409

1410

1411

1412

1413

1414

1415

1416

1417

1418

1419

1420

1421

1422

1423

1424

1425

1426

1427

1428

1429

1430

1431

1432

1433

1434

1435

1436

1437

1438

1439

1440

1441

1442

1443

1444

1445

1446

1447

1448

1449

1450

1451

1452

1453

1454

1455

1456

1457

1458

1459

1460

1461

1462

1463

1464

1465

1466

1467

1468

1469

1470

1471

1472

1473

1474

1475

1476

1477

1478

1479

1480

1481

1482

1483

1484

1485

1486

1487

1488

1489

1490

1491

1492

1493

1494

1495

1496

1497

1498

1499

1500

1501

1502

1503

1504

1505

1506

1507

1508

1509

1510

1511

1512

1513

1514

1515

1516

1517

1518

1519

1520

1521

1522

1523

1524

1525

1526

1527

1528

1529

1530

1531

1532

1533

1534

1535

1536

1537

1538

1539

1540

1541

1542

1543

1544

1545

1546

1547

1548

1549

1550

1551

1552

1553

1554

1555

1556

1557

1558

1559

1560

1561

1562

1563

1564

1565

1566

1567

1568

1569

1570

1571

1572

1573

1574

1575

1576

1577

1578

1579

1580

1581

1582

1583

1584

1585

1586

1587

1588

1589

1590

1591

1592

1593

1594

1595

1596

1597

1598

1599

1600

1601

1602

1603

1604

1605

1606

1607

1608

1609

1610

1611

1612

1613

1614

1615

1616

1617

1618

1619

# http://pyrocko.org - GPLv3 

# 

# The Pyrocko Developers, 21st Century 

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

from __future__ import absolute_import, division 

 

import sys 

import time 

import logging 

import datetime 

import calendar 

import math 

import copy 

 

import numpy as num 

 

from pyrocko.guts import (StringChoice, StringPattern, UnicodePattern, String, 

Unicode, Int, Float, List, Object, Timestamp, 

ValidationError, TBase, re_tz) 

from pyrocko.guts import load_xml # noqa 

from pyrocko.util import hpfloat, time_to_str, get_time_float 

 

import pyrocko.model 

from pyrocko import trace, util 

 

try: 

newstr = unicode 

except NameError: 

newstr = str 

 

guts_prefix = 'sx' 

 

guts_xmlns = 'http://www.fdsn.org/xml/station/1' 

 

logger = logging.getLogger('pyrocko.io.stationxml') 

 

conversion = { 

('M', 'M'): None, 

('M/S', 'M'): trace.IntegrationResponse(1), 

('M/S**2', 'M'): trace.IntegrationResponse(2), 

('M', 'M/S'): trace.DifferentiationResponse(1), 

('M/S', 'M/S'): None, 

('M/S**2', 'M/S'): trace.IntegrationResponse(1), 

('M', 'M/S**2'): trace.DifferentiationResponse(2), 

('M/S', 'M/S**2'): trace.DifferentiationResponse(1), 

('M/S**2', 'M/S**2'): None} 

 

 

class NoResponseInformation(Exception): 

pass 

 

 

class MultipleResponseInformation(Exception): 

pass 

 

 

def wrap(s, width=80, indent=4): 

words = s.split() 

lines = [] 

t = [] 

n = 0 

for w in words: 

if n + len(w) >= width: 

lines.append(' '.join(t)) 

n = indent 

t = [' '*(indent-1)] 

 

t.append(w) 

n += len(w) + 1 

 

lines.append(' '.join(t)) 

return '\n'.join(lines) 

 

 

def same(x, eps=0.0): 

if any(type(x[0]) != type(r) for r in x): 

return False 

 

if isinstance(x[0], float): 

return all(abs(r-x[0]) <= eps for r in x) 

else: 

return all(r == x[0] for r in x) 

 

 

class InconsistentResponseInformation(Exception): 

pass 

 

 

def check_resp(resp, value, frequency, limit_db, prelude=''): 

if not value or not frequency: 

logger.warn('Cannot validate frequency response') 

return 

 

value_resp = num.abs( 

resp.evaluate(num.array([frequency], dtype=float)))[0] 

 

if value_resp == 0.0: 

raise InconsistentResponseInformation( 

'%s\n' 

' computed response is zero' % prelude) 

 

diff_db = 20.0 * num.log10(value_resp/value) 

 

if num.abs(diff_db) > limit_db: 

raise InconsistentResponseInformation( 

'%s\n' 

' reported value: %g\n' 

' computed value: %g\n' 

' at frequency [Hz]: %g\n' 

' difference [dB]: %g\n' 

' limit [dB]: %g' % ( 

prelude, 

value, 

value_resp, 

frequency, 

diff_db, 

limit_db)) 

 

 

this_year = time.gmtime()[0] 

 

 

class DummyAwareOptionalTimestamp(Object): 

dummy_for = (hpfloat, float) 

dummy_for_description = 'time_float' 

 

class __T(TBase): 

 

def regularize_extra(self, val): 

time_float = get_time_float() 

 

if isinstance(val, datetime.datetime): 

tt = val.utctimetuple() 

val = time_float(calendar.timegm(tt)) + val.microsecond * 1e-6 

 

elif isinstance(val, datetime.date): 

tt = val.timetuple() 

val = time_float(calendar.timegm(tt)) 

 

elif isinstance(val, (str, newstr)): 

val = val.strip() 

 

tz_offset = 0 

 

m = re_tz.search(val) 

if m: 

sh = m.group(2) 

sm = m.group(4) 

tz_offset = (int(sh)*3600 if sh else 0) \ 

+ (int(sm)*60 if sm else 0) 

 

val = re_tz.sub('', val) 

 

if len(val) > 10 and val[10] == 'T': 

val = val.replace('T', ' ', 1) 

 

try: 

val = util.str_to_time(val) - tz_offset 

 

except util.TimeStrError: 

year = int(val[:4]) 

if sys.maxsize > 2**32: # if we're on 64bit 

if year > this_year + 100: 

return None # StationXML contained a dummy date 

 

if year < 1903: # for macOS, 1900-01-01 dummy dates 

return None 

 

else: # 32bit end of time is in 2038 

if this_year < 2037 and year > 2037 or year < 1903: 

return None # StationXML contained a dummy date 

 

raise 

 

elif isinstance(val, (int, float)): 

val = time_float(val) 

 

else: 

raise ValidationError( 

'%s: cannot convert "%s" to type %s' % ( 

self.xname(), val, time_float)) 

 

return val 

 

def to_save(self, val): 

return time_to_str(val, format='%Y-%m-%d %H:%M:%S.9FRAC')\ 

.rstrip('0').rstrip('.') 

 

def to_save_xml(self, val): 

return time_to_str(val, format='%Y-%m-%dT%H:%M:%S.9FRAC')\ 

.rstrip('0').rstrip('.') + 'Z' 

 

 

class Nominal(StringChoice): 

choices = [ 

'NOMINAL', 

'CALCULATED'] 

 

 

class Email(UnicodePattern): 

pattern = u'[\\w\\.\\-_]+@[\\w\\.\\-_]+' 

 

 

class RestrictedStatus(StringChoice): 

choices = [ 

'open', 

'closed', 

'partial'] 

 

 

class Type(StringChoice): 

choices = [ 

'TRIGGERED', 

'CONTINUOUS', 

'HEALTH', 

'GEOPHYSICAL', 

'WEATHER', 

'FLAG', 

'SYNTHESIZED', 

'INPUT', 

'EXPERIMENTAL', 

'MAINTENANCE', 

'BEAM'] 

 

class __T(StringChoice.T): 

def validate_extra(self, val): 

if val not in self.choices: 

logger.warn( 

'channel type: "%s" is not a valid choice out of %s' % 

(val, repr(self.choices))) 

 

 

class PzTransferFunction(StringChoice): 

choices = [ 

'LAPLACE (RADIANS/SECOND)', 

'LAPLACE (HERTZ)', 

'DIGITAL (Z-TRANSFORM)'] 

 

 

class Symmetry(StringChoice): 

choices = [ 

'NONE', 

'EVEN', 

'ODD'] 

 

 

class CfTransferFunction(StringChoice): 

 

class __T(StringChoice.T): 

def validate(self, val, regularize=False, depth=-1): 

if regularize: 

try: 

val = str(val) 

except ValueError: 

raise ValidationError( 

'%s: cannot convert to string %s' % (self.xname, 

repr(val))) 

 

val = self.dummy_cls.replacements.get(val, val) 

 

self.validate_extra(val) 

return val 

 

choices = [ 

'ANALOG (RADIANS/SECOND)', 

'ANALOG (HERTZ)', 

'DIGITAL'] 

 

replacements = { 

'ANALOG (RAD/SEC)': 'ANALOG (RADIANS/SECOND)', 

'ANALOG (HZ)': 'ANALOG (HERTZ)', 

} 

 

 

class Approximation(StringChoice): 

choices = [ 

'MACLAURIN'] 

 

 

class PhoneNumber(StringPattern): 

pattern = '[0-9]+-[0-9]+' 

 

 

class Site(Object): 

''' 

Description of a site location using name and optional geopolitical 

boundaries (country, city, etc.). 

''' 

 

name = Unicode.T(xmltagname='Name') 

description = Unicode.T(optional=True, xmltagname='Description') 

town = Unicode.T(optional=True, xmltagname='Town') 

county = Unicode.T(optional=True, xmltagname='County') 

region = Unicode.T(optional=True, xmltagname='Region') 

country = Unicode.T(optional=True, xmltagname='Country') 

 

 

class ExternalReference(Object): 

''' 

This type contains a URI and description for external data that users may 

want to reference in StationXML. 

''' 

 

uri = String.T(xmltagname='URI') 

description = Unicode.T(xmltagname='Description') 

 

 

class Units(Object): 

''' 

A type to document units. Corresponds to SEED blockette 34. 

''' 

 

def __init__(self, name=None, **kwargs): 

Object.__init__(self, name=name, **kwargs) 

 

name = String.T(xmltagname='Name') 

description = Unicode.T(optional=True, xmltagname='Description') 

 

 

class Counter(Int): 

pass 

 

 

class SampleRateRatio(Object): 

''' 

Sample rate expressed as number of samples in a number of seconds. 

''' 

 

number_samples = Int.T(xmltagname='NumberSamples') 

number_seconds = Int.T(xmltagname='NumberSeconds') 

 

 

class Gain(Object): 

''' 

Complex type for sensitivity and frequency ranges. This complex type can be 

used to represent both overall sensitivities and individual stage gains. 

The FrequencyRangeGroup is an optional construct that defines a pass band 

in Hertz ( FrequencyStart and FrequencyEnd) in which the SensitivityValue 

is valid within the number of decibels specified in FrequencyDBVariation. 

''' 

 

def __init__(self, value=None, **kwargs): 

Object.__init__(self, value=value, **kwargs) 

 

value = Float.T(optional=True, xmltagname='Value') 

frequency = Float.T(optional=True, xmltagname='Frequency') 

 

 

class NumeratorCoefficient(Object): 

i = Int.T(optional=True, xmlstyle='attribute') 

value = Float.T(xmlstyle='content') 

 

 

class FloatNoUnit(Object): 

def __init__(self, value=None, **kwargs): 

Object.__init__(self, value=value, **kwargs) 

 

plus_error = Float.T(optional=True, xmlstyle='attribute') 

minus_error = Float.T(optional=True, xmlstyle='attribute') 

value = Float.T(xmlstyle='content') 

 

 

class FloatWithUnit(FloatNoUnit): 

unit = String.T(optional=True, xmlstyle='attribute') 

 

 

class Equipment(Object): 

resource_id = String.T(optional=True, xmlstyle='attribute') 

type = String.T(optional=True, xmltagname='Type') 

description = Unicode.T(optional=True, xmltagname='Description') 

manufacturer = Unicode.T(optional=True, xmltagname='Manufacturer') 

vendor = Unicode.T(optional=True, xmltagname='Vendor') 

model = Unicode.T(optional=True, xmltagname='Model') 

serial_number = String.T(optional=True, xmltagname='SerialNumber') 

installation_date = DummyAwareOptionalTimestamp.T( 

optional=True, 

xmltagname='InstallationDate') 

removal_date = DummyAwareOptionalTimestamp.T( 

optional=True, 

xmltagname='RemovalDate') 

calibration_date_list = List.T(Timestamp.T(xmltagname='CalibrationDate')) 

 

 

class PhoneNumber(Object): 

description = Unicode.T(optional=True, xmlstyle='attribute') 

country_code = Int.T(optional=True, xmltagname='CountryCode') 

area_code = Int.T(xmltagname='AreaCode') 

phone_number = PhoneNumber.T(xmltagname='PhoneNumber') 

 

 

class BaseFilter(Object): 

''' 

The BaseFilter is derived by all filters. 

''' 

 

resource_id = String.T(optional=True, xmlstyle='attribute') 

name = String.T(optional=True, xmlstyle='attribute') 

description = Unicode.T(optional=True, xmltagname='Description') 

input_units = Units.T(optional=True, xmltagname='InputUnits') 

output_units = Units.T(optional=True, xmltagname='OutputUnits') 

 

 

class Sensitivity(Gain): 

''' 

Sensitivity and frequency ranges. The FrequencyRangeGroup is an optional 

construct that defines a pass band in Hertz (FrequencyStart and 

FrequencyEnd) in which the SensitivityValue is valid within the number of 

decibels specified in FrequencyDBVariation. 

''' 

 

input_units = Units.T(optional=True, xmltagname='InputUnits') 

output_units = Units.T(optional=True, xmltagname='OutputUnits') 

frequency_start = Float.T(optional=True, xmltagname='FrequencyStart') 

frequency_end = Float.T(optional=True, xmltagname='FrequencyEnd') 

frequency_db_variation = Float.T(optional=True, 

xmltagname='FrequencyDBVariation') 

 

 

class Coefficient(FloatNoUnit): 

number = Counter.T(optional=True, xmlstyle='attribute') 

 

 

class PoleZero(Object): 

''' 

Complex numbers used as poles or zeros in channel response. 

''' 

 

number = Int.T(optional=True, xmlstyle='attribute') 

real = FloatNoUnit.T(xmltagname='Real') 

imaginary = FloatNoUnit.T(xmltagname='Imaginary') 

 

def value(self): 

return self.real.value + 1J * self.imaginary.value 

 

 

class ClockDrift(FloatWithUnit): 

unit = String.T(default='SECONDS/SAMPLE', optional=True, 

xmlstyle='attribute') # fixed 

 

 

class Second(FloatWithUnit): 

''' 

A time value in seconds. 

''' 

 

unit = String.T(default='SECONDS', optional=True, xmlstyle='attribute') 

# fixed unit 

 

 

class Voltage(FloatWithUnit): 

unit = String.T(default='VOLTS', optional=True, xmlstyle='attribute') 

# fixed unit 

 

 

class Angle(FloatWithUnit): 

unit = String.T(default='DEGREES', optional=True, xmlstyle='attribute') 

# fixed unit 

 

 

class Azimuth(FloatWithUnit): 

''' 

Instrument azimuth, degrees clockwise from North. 

''' 

 

unit = String.T(default='DEGREES', optional=True, xmlstyle='attribute') 

# fixed unit 

 

 

class Dip(FloatWithUnit): 

''' 

Instrument dip in degrees down from horizontal. Together azimuth and dip 

describe the direction of the sensitive axis of the instrument. 

''' 

 

unit = String.T(default='DEGREES', optional=True, xmlstyle='attribute') 

# fixed unit 

 

 

class Distance(FloatWithUnit): 

''' 

Extension of FloatWithUnit for distances, elevations, and depths. 

''' 

 

unit = String.T(default='METERS', optional=True, xmlstyle='attribute') 

# NOT fixed unit! 

 

 

class Frequency(FloatWithUnit): 

unit = String.T(default='HERTZ', optional=True, xmlstyle='attribute') 

# fixed unit 

 

 

class SampleRate(FloatWithUnit): 

''' 

Sample rate in samples per second. 

''' 

 

unit = String.T(default='SAMPLES/S', optional=True, xmlstyle='attribute') 

# fixed unit 

 

 

class Person(Object): 

''' 

Representation of a person's contact information. A person can belong to 

multiple agencies and have multiple email addresses and phone numbers. 

''' 

 

name_list = List.T(Unicode.T(xmltagname='Name')) 

agency_list = List.T(Unicode.T(xmltagname='Agency')) 

email_list = List.T(Email.T(xmltagname='Email')) 

phone_list = List.T(PhoneNumber.T(xmltagname='Phone')) 

 

 

class FIR(BaseFilter): 

''' 

Response: FIR filter. Corresponds to SEED blockette 61. FIR filters are 

also commonly documented using the Coefficients element. 

''' 

 

symmetry = Symmetry.T(xmltagname='Symmetry') 

numerator_coefficient_list = List.T( 

NumeratorCoefficient.T(xmltagname='NumeratorCoefficient')) 

 

 

class Coefficients(BaseFilter): 

''' 

Response: coefficients for FIR filter. Laplace transforms or IIR filters 

can be expressed using type as well but the PolesAndZeros should be used 

instead. Corresponds to SEED blockette 54. 

''' 

 

cf_transfer_function_type = CfTransferFunction.T( 

xmltagname='CfTransferFunctionType') 

numerator_list = List.T(FloatWithUnit.T(xmltagname='Numerator')) 

denominator_list = List.T(FloatWithUnit.T(xmltagname='Denominator')) 

 

 

class Latitude(FloatWithUnit): 

''' 

Type for latitude coordinate. 

''' 

 

unit = String.T(default='DEGREES', optional=True, xmlstyle='attribute') 

# fixed unit 

datum = String.T(default='WGS84', optional=True, xmlstyle='attribute') 

 

 

class Longitude(FloatWithUnit): 

''' 

Type for longitude coordinate. 

''' 

 

unit = String.T(default='DEGREES', optional=True, xmlstyle='attribute') 

# fixed unit 

datum = String.T(default='WGS84', optional=True, xmlstyle='attribute') 

 

 

class PolesZeros(BaseFilter): 

''' 

Response: complex poles and zeros. Corresponds to SEED blockette 53. 

''' 

 

pz_transfer_function_type = PzTransferFunction.T( 

xmltagname='PzTransferFunctionType') 

normalization_factor = Float.T(default=1.0, 

xmltagname='NormalizationFactor') 

normalization_frequency = Frequency.T(xmltagname='NormalizationFrequency') 

zero_list = List.T(PoleZero.T(xmltagname='Zero')) 

pole_list = List.T(PoleZero.T(xmltagname='Pole')) 

 

def get_pyrocko_response(self, nslc): 

if self.pz_transfer_function_type == 'DIGITAL (Z-TRANSFORM)': 

logger.warn( 

'unhandled pole-zero response of type "DIGITAL (Z-TRANSFORM)" ' 

'(%s)' % '.'.join(nslc)) 

 

return [] 

 

if self.pz_transfer_function_type not in ( 

'LAPLACE (RADIANS/SECOND)', 

'LAPLACE (HERTZ)'): 

 

raise NoResponseInformation( 

'cannot convert PoleZero response of type %s (%s)' % 

(self.pz_transfer_function_type, '.'.join(nslc))) 

 

factor = 1.0 

cfactor = 1.0 

if self.pz_transfer_function_type == 'LAPLACE (HERTZ)': 

factor = 2. * math.pi 

cfactor = (2. * math.pi)**( 

len(self.pole_list) - len(self.zero_list)) 

 

if self.normalization_factor is None \ 

or self.normalization_factor == 0.0: 

 

logger.warn( 

'no pole-zero normalization factor given. Assuming a value of ' 

'1.0 (%s)' % '.'.join(nslc)) 

 

nfactor = 1.0 

else: 

nfactor = self.normalization_factor 

 

resp = trace.PoleZeroResponse( 

constant=nfactor*cfactor, 

zeros=[z.value()*factor for z in self.zero_list], 

poles=[p.value()*factor for p in self.pole_list]) 

 

if not self.normalization_frequency.value: 

logger.warn( 

'cannot check pole-zero normalization factor (%s)' 

% '.'.join(nslc)) 

 

else: 

computed_normalization_factor = nfactor / abs( 

resp.evaluate( 

num.array([self.normalization_frequency.value]))[0]) 

 

db = 20.0 * num.log10( 

computed_normalization_factor / nfactor) 

 

if abs(db) > 0.17: 

logger.warn( 

'computed and reported normalization factors differ by ' 

'%g dB: computed: %g, reported: %g (%s)' % ( 

db, 

computed_normalization_factor, 

nfactor, 

'.'.join(nslc))) 

 

return [resp] 

 

 

class ResponseListElement(Object): 

frequency = Frequency.T(xmltagname='Frequency') 

amplitude = FloatWithUnit.T(xmltagname='Amplitude') 

phase = Angle.T(xmltagname='Phase') 

 

 

class Polynomial(BaseFilter): 

''' 

Response: expressed as a polynomial (allows non-linear sensors to be 

described). Corresponds to SEED blockette 62. Can be used to describe a 

stage of acquisition or a complete system. 

''' 

 

approximation_type = Approximation.T(default='MACLAURIN', 

xmltagname='ApproximationType') 

frequency_lower_bound = Frequency.T(xmltagname='FrequencyLowerBound') 

frequency_upper_bound = Frequency.T(xmltagname='FrequencyUpperBound') 

approximation_lower_bound = Float.T(xmltagname='ApproximationLowerBound') 

approximation_upper_bound = Float.T(xmltagname='ApproximationUpperBound') 

maximum_error = Float.T(xmltagname='MaximumError') 

coefficient_list = List.T(Coefficient.T(xmltagname='Coefficient')) 

 

 

class Decimation(Object): 

''' 

Corresponds to SEED blockette 57. 

''' 

 

input_sample_rate = Frequency.T(xmltagname='InputSampleRate') 

factor = Int.T(xmltagname='Factor') 

offset = Int.T(xmltagname='Offset') 

delay = FloatWithUnit.T(xmltagname='Delay') 

correction = FloatWithUnit.T(xmltagname='Correction') 

 

 

class Operator(Object): 

agency_list = List.T(Unicode.T(xmltagname='Agency')) 

contact_list = List.T(Person.T(xmltagname='Contact')) 

web_site = String.T(optional=True, xmltagname='WebSite') 

 

 

class Comment(Object): 

''' 

Container for a comment or log entry. Corresponds to SEED blockettes 31, 51 

and 59. 

''' 

 

id = Counter.T(optional=True, xmlstyle='attribute') 

value = Unicode.T(xmltagname='Value') 

begin_effective_time = DummyAwareOptionalTimestamp.T( 

optional=True, 

xmltagname='BeginEffectiveTime') 

end_effective_time = DummyAwareOptionalTimestamp.T( 

optional=True, 

xmltagname='EndEffectiveTime') 

author_list = List.T(Person.T(xmltagname='Author')) 

 

 

class ResponseList(BaseFilter): 

''' 

Response: list of frequency, amplitude and phase values. Corresponds to 

SEED blockette 55. 

''' 

 

response_list_element_list = List.T( 

ResponseListElement.T(xmltagname='ResponseListElement')) 

 

 

class Log(Object): 

''' 

Container for log entries. 

''' 

 

entry_list = List.T(Comment.T(xmltagname='Entry')) 

 

 

class ResponseStage(Object): 

''' 

This complex type represents channel response and covers SEED blockettes 53 

to 56. 

''' 

 

number = Counter.T(xmlstyle='attribute') 

resource_id = String.T(optional=True, xmlstyle='attribute') 

poles_zeros_list = List.T( 

PolesZeros.T(optional=True, xmltagname='PolesZeros')) 

coefficients_list = List.T( 

Coefficients.T(optional=True, xmltagname='Coefficients')) 

response_list = ResponseList.T(optional=True, xmltagname='ResponseList') 

fir = FIR.T(optional=True, xmltagname='FIR') 

polynomial = Polynomial.T(optional=True, xmltagname='Polynomial') 

decimation = Decimation.T(optional=True, xmltagname='Decimation') 

stage_gain = Gain.T(optional=True, xmltagname='StageGain') 

 

def get_pyrocko_response(self, nslc): 

responses = [] 

for pzs in self.poles_zeros_list: 

responses.extend(pzs.get_pyrocko_response(nslc)) 

 

if len(self.poles_zeros_list) > 1: 

logger.warn( 

'multiple poles and zeros records in single response stage ' 

'(%s.%s.%s.%s)' % nslc) 

 

if (self.coefficients_list or 

self.response_list or 

self.fir or 

self.polynomial): 

 

logger.debug('unhandled response at stage %i' % self.number) 

 

if self.stage_gain: 

responses.append( 

trace.PoleZeroResponse(constant=self.stage_gain.value)) 

 

return responses 

 

@property 

def input_units(self): 

for e in (self.poles_zeros_list + self.coefficients_list + 

[self.response_list, self.fir, self.polynomial]): 

if e is not None: 

return e.input_units 

 

@property 

def output_units(self): 

for e in (self.poles_zeros_list + self.coefficients_list + 

[self.response_list, self.fir, self.polynomial]): 

if e is not None: 

return e.output_units 

 

 

class Response(Object): 

resource_id = String.T(optional=True, xmlstyle='attribute') 

instrument_sensitivity = Sensitivity.T(optional=True, 

xmltagname='InstrumentSensitivity') 

instrument_polynomial = Polynomial.T(optional=True, 

xmltagname='InstrumentPolynomial') 

stage_list = List.T(ResponseStage.T(xmltagname='Stage')) 

 

def get_pyrocko_response(self, nslc, fake_input_units=None): 

responses = [] 

for stage in self.stage_list: 

responses.extend(stage.get_pyrocko_response(nslc)) 

 

if not self.stage_list and self.instrument_sensitivity: 

responses.append( 

trace.PoleZeroResponse( 

constant=self.instrument_sensitivity.value)) 

 

if self.instrument_sensitivity: 

trial = trace.MultiplyResponse(responses) 

sval = self.instrument_sensitivity.value 

sfreq = self.instrument_sensitivity.frequency 

try: 

check_resp( 

trial, sval, sfreq, 0.1, 

prelude='Instrument sensitivity value inconsistent with ' 

'sensitivity computed from complete response\n' 

' channel: %s' % '.'.join(nslc)) 

except InconsistentResponseInformation as e: 

logger.warn(str(e)) 

 

if fake_input_units is not None: 

if not self.instrument_sensitivity or \ 

self.instrument_sensitivity.input_units is None: 

 

raise NoResponseInformation('no input units given') 

 

input_units = self.instrument_sensitivity.input_units.name 

 

try: 

conresp = conversion[ 

fake_input_units.upper(), input_units.upper()] 

 

except KeyError: 

raise NoResponseInformation( 

'cannot convert between units: %s, %s' 

% (fake_input_units, input_units)) 

 

if conresp is not None: 

responses.append(conresp) 

 

return trace.MultiplyResponse(responses) 

 

@classmethod 

def from_pyrocko_pz_response(cls, presponse, input_unit, output_unit, 

normalization_frequency=1.0): 

''' 

Convert Pyrocko pole-zero response to StationXML response. 

 

:param presponse: Pyrocko pole-zero response 

:type presponse: :py:class:`~pyrocko.trace.PoleZeroResponse` 

: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 

''' 

 

norm_factor = 1.0/float(abs( 

presponse.evaluate(num.array([normalization_frequency]))[0] 

/ presponse.constant)) 

 

pzs = PolesZeros( 

pz_transfer_function_type='LAPLACE (RADIANS/SECOND)', 

normalization_factor=norm_factor, 

normalization_frequency=Frequency(normalization_frequency), 

zero_list=[PoleZero(real=FloatNoUnit(z.real), 

imaginary=FloatNoUnit(z.imag)) 

for z in presponse.zeros], 

pole_list=[PoleZero(real=FloatNoUnit(z.real), 

imaginary=FloatNoUnit(z.imag)) 

for z in presponse.poles]) 

 

pzs.validate() 

 

stage = ResponseStage( 

number=1, 

poles_zeros_list=[pzs], 

stage_gain=Gain(float(abs(presponse.constant))/norm_factor)) 

 

resp = Response( 

instrument_sensitivity=Sensitivity( 

value=stage.stage_gain.value, 

input_units=Units(input_unit), 

output_units=Units(output_unit)), 

 

stage_list=[stage]) 

 

return resp 

 

 

class BaseNode(Object): 

''' 

A base node type for derivation from: Network, Station and Channel types. 

''' 

 

code = String.T(xmlstyle='attribute') 

start_date = DummyAwareOptionalTimestamp.T(optional=True, 

xmlstyle='attribute') 

end_date = DummyAwareOptionalTimestamp.T(optional=True, 

xmlstyle='attribute') 

restricted_status = RestrictedStatus.T(optional=True, xmlstyle='attribute') 

alternate_code = String.T(optional=True, xmlstyle='attribute') 

historical_code = String.T(optional=True, xmlstyle='attribute') 

description = Unicode.T(optional=True, xmltagname='Description') 

comment_list = List.T(Comment.T(xmltagname='Comment')) 

 

def spans(self, *args): 

if len(args) == 0: 

return True 

elif len(args) == 1: 

return ((self.start_date is None or 

self.start_date <= args[0]) and 

(self.end_date is None or 

args[0] <= self.end_date)) 

 

elif len(args) == 2: 

return ((self.start_date is None or 

args[1] >= self.start_date) and 

(self.end_date is None or 

self.end_date >= args[0])) 

 

 

class Channel(BaseNode): 

''' 

Equivalent to SEED blockette 52 and parent element for the related the 

response blockettes. 

''' 

 

location_code = String.T(xmlstyle='attribute') 

external_reference_list = List.T( 

ExternalReference.T(xmltagname='ExternalReference')) 

latitude = Latitude.T(xmltagname='Latitude') 

longitude = Longitude.T(xmltagname='Longitude') 

elevation = Distance.T(xmltagname='Elevation') 

depth = Distance.T(xmltagname='Depth') 

azimuth = Azimuth.T(optional=True, xmltagname='Azimuth') 

dip = Dip.T(optional=True, xmltagname='Dip') 

type_list = List.T(Type.T(xmltagname='Type')) 

sample_rate = SampleRate.T(optional=True, xmltagname='SampleRate') 

sample_rate_ratio = SampleRateRatio.T(optional=True, 

xmltagname='SampleRateRatio') 

storage_format = String.T(optional=True, xmltagname='StorageFormat') 

clock_drift = ClockDrift.T(optional=True, xmltagname='ClockDrift') 

calibration_units = Units.T(optional=True, xmltagname='CalibrationUnits') 

sensor = Equipment.T(optional=True, xmltagname='Sensor') 

pre_amplifier = Equipment.T(optional=True, xmltagname='PreAmplifier') 

data_logger = Equipment.T(optional=True, xmltagname='DataLogger') 

equipment = Equipment.T(optional=True, xmltagname='Equipment') 

response = Response.T(optional=True, xmltagname='Response') 

 

@property 

def position_values(self): 

lat = self.latitude.value 

lon = self.longitude.value 

elevation = value_or_none(self.elevation) 

depth = value_or_none(self.depth) 

return lat, lon, elevation, depth 

 

 

class Station(BaseNode): 

''' 

This type represents a Station epoch. It is common to only have a single 

station epoch with the station's creation and termination dates as the 

epoch start and end dates. 

''' 

 

latitude = Latitude.T(xmltagname='Latitude') 

longitude = Longitude.T(xmltagname='Longitude') 

elevation = Distance.T(xmltagname='Elevation') 

site = Site.T(optional=True, xmltagname='Site') 

vault = Unicode.T(optional=True, xmltagname='Vault') 

geology = Unicode.T(optional=True, xmltagname='Geology') 

equipment_list = List.T(Equipment.T(xmltagname='Equipment')) 

operator_list = List.T(Operator.T(xmltagname='Operator')) 

creation_date = DummyAwareOptionalTimestamp.T( 

optional=True, xmltagname='CreationDate') 

termination_date = DummyAwareOptionalTimestamp.T( 

optional=True, xmltagname='TerminationDate') 

total_number_channels = Counter.T( 

optional=True, xmltagname='TotalNumberChannels') 

selected_number_channels = Counter.T( 

optional=True, xmltagname='SelectedNumberChannels') 

external_reference_list = List.T( 

ExternalReference.T(xmltagname='ExternalReference')) 

channel_list = List.T(Channel.T(xmltagname='Channel')) 

 

@property 

def position_values(self): 

lat = self.latitude.value 

lon = self.longitude.value 

elevation = value_or_none(self.elevation) 

return lat, lon, elevation 

 

 

class Network(BaseNode): 

''' 

This type represents the Network layer, all station metadata is contained 

within this element. The official name of the network or other descriptive 

information can be included in the Description element. The Network can 

contain 0 or more Stations. 

''' 

 

total_number_stations = Counter.T(optional=True, 

xmltagname='TotalNumberStations') 

selected_number_stations = Counter.T(optional=True, 

xmltagname='SelectedNumberStations') 

station_list = List.T(Station.T(xmltagname='Station')) 

 

@property 

def station_code_list(self): 

return sorted(set(s.code for s in self.station_list)) 

 

@property 

def sl_code_list(self): 

sls = set() 

for station in self.station_list: 

for channel in station.channel_list: 

sls.add((station.code, channel.location_code)) 

 

return sorted(sls) 

 

def summary(self, width=80, indent=4): 

sls = self.sl_code_list or [(x,) for x in self.station_code_list] 

lines = ['%s (%i):' % (self.code, len(sls))] 

if sls: 

ssls = ['.'.join(x for x in c if x) for c in sls] 

w = max(len(x) for x in ssls) 

n = (width - indent) / (w+1) 

while ssls: 

lines.append( 

' ' * indent + ' '.join(x.ljust(w) for x in ssls[:n])) 

 

ssls[:n] = [] 

 

return '\n'.join(lines) 

 

 

def value_or_none(x): 

if x is not None: 

return x.value 

else: 

return None 

 

 

def pyrocko_station_from_channels(nsl, channels, inconsistencies='warn'): 

 

pos = lat, lon, elevation, depth = \ 

channels[0].position_values 

 

if not all(pos == x.position_values for x in channels): 

info = '\n'.join( 

' %s: %s' % (x.code, x.position_values) for 

x in channels) 

 

mess = 'encountered inconsistencies in channel ' \ 

'lat/lon/elevation/depth ' \ 

'for %s.%s.%s: \n%s' % (nsl + (info,)) 

 

if inconsistencies == 'raise': 

raise InconsistentChannelLocations(mess) 

 

elif inconsistencies == 'warn': 

logger.warn(mess) 

logger.warn(' -> using mean values') 

 

apos = num.array([x.position_values for x in channels], dtype=float) 

mlat, mlon, mele, mdep = num.nansum(apos, axis=0) \ 

/ num.sum(num.isfinite(apos), axis=0) 

 

groups = {} 

for channel in channels: 

if channel.code not in groups: 

groups[channel.code] = [] 

 

groups[channel.code].append(channel) 

 

pchannels = [] 

for code in sorted(groups.keys()): 

data = [ 

(channel.code, value_or_none(channel.azimuth), 

value_or_none(channel.dip)) 

for channel in groups[code]] 

 

azimuth, dip = util.consistency_merge( 

data, 

message='channel orientation values differ:', 

error=inconsistencies) 

 

pchannels.append( 

pyrocko.model.Channel(code, azimuth=azimuth, dip=dip)) 

 

return pyrocko.model.Station( 

*nsl, 

lat=mlat, 

lon=mlon, 

elevation=mele, 

depth=mdep, 

channels=pchannels) 

 

 

class FDSNStationXML(Object): 

''' 

Top-level type for Station XML. Required field are Source (network ID of 

the institution sending the message) and one or more Network containers or 

one or more Station containers. 

''' 

 

schema_version = Float.T(default=1.0, xmlstyle='attribute') 

source = String.T(xmltagname='Source') 

sender = String.T(optional=True, xmltagname='Sender') 

module = String.T(optional=True, xmltagname='Module') 

module_uri = String.T(optional=True, xmltagname='ModuleURI') 

created = Timestamp.T(optional=True, xmltagname='Created') 

network_list = List.T(Network.T(xmltagname='Network')) 

 

xmltagname = 'FDSNStationXML' 

guessable_xmlns = [guts_xmlns] 

 

def get_pyrocko_stations(self, nslcs=None, nsls=None, 

time=None, timespan=None, 

inconsistencies='warn'): 

 

assert inconsistencies in ('raise', 'warn') 

 

if nslcs is not None: 

nslcs = set(nslcs) 

 

if nsls is not None: 

nsls = set(nsls) 

 

tt = () 

if time is not None: 

tt = (time,) 

elif timespan is not None: 

tt = timespan 

 

pstations = [] 

for network in self.network_list: 

if not network.spans(*tt): 

continue 

 

for station in network.station_list: 

if not station.spans(*tt): 

continue 

 

if station.channel_list: 

loc_to_channels = {} 

for channel in station.channel_list: 

if not channel.spans(*tt): 

continue 

 

loc = channel.location_code.strip() 

if loc not in loc_to_channels: 

loc_to_channels[loc] = [] 

 

loc_to_channels[loc].append(channel) 

 

for loc in sorted(loc_to_channels.keys()): 

channels = loc_to_channels[loc] 

if nslcs is not None: 

channels = [channel for channel in channels 

if (network.code, station.code, loc, 

channel.code) in nslcs] 

 

if not channels: 

continue 

 

nsl = network.code, station.code, loc 

if nsls is not None and nsl not in nsls: 

continue 

 

pstations.append( 

pyrocko_station_from_channels( 

nsl, 

channels, 

inconsistencies=inconsistencies)) 

else: 

pstations.append(pyrocko.model.Station( 

network.code, station.code, '*', 

lat=station.latitude.value, 

lon=station.longitude.value, 

elevation=value_or_none(station.elevation), 

name=station.description or '')) 

 

return pstations 

 

@classmethod 

def from_pyrocko_stations( 

cls, pyrocko_stations, add_flat_responses_from=None): 

 

''' 

Generate :py:class:`FDSNStationXML` from list of 

:py:class;`pyrocko.model.Station` instances. 

 

:param pyrocko_stations: list of :py:class;`pyrocko.model.Station` 

instances. 

:param add_flat_responses_from: unit, 'M', 'M/S' or 'M/S**2' 

''' 

from collections import defaultdict 

network_dict = defaultdict(list) 

 

if add_flat_responses_from: 

assert add_flat_responses_from in ('M', 'M/S', 'M/S**2') 

extra = dict( 

response=Response( 

instrument_sensitivity=Sensitivity( 

value=1.0, 

frequency=1.0, 

input_units=Units(name=add_flat_responses_from)))) 

else: 

extra = {} 

 

have_offsets = set() 

for s in pyrocko_stations: 

 

if s.north_shift != 0.0 or s.east_shift != 0.0: 

have_offsets.add(s.nsl()) 

 

network, station, location = s.nsl() 

channel_list = [] 

for c in s.channels: 

channel_list.append( 

Channel( 

location_code=location, 

code=c.name, 

latitude=Latitude(value=s.effective_lat), 

longitude=Longitude(value=s.effective_lon), 

elevation=Distance(value=s.elevation), 

depth=Distance(value=s.depth), 

azimuth=Azimuth(value=c.azimuth), 

dip=Dip(value=c.dip), 

**extra 

) 

) 

 

network_dict[network].append( 

Station( 

code=station, 

latitude=Latitude(value=s.effective_lat), 

longitude=Longitude(value=s.effective_lon), 

elevation=Distance(value=s.elevation), 

channel_list=channel_list) 

) 

 

if have_offsets: 

logger.warn( 

'StationXML does not support Cartesian offsets in ' 

'coordinates. Storing effective lat/lon for stations: %s' % 

', '.join('.'.join(nsl) for nsl in sorted(have_offsets))) 

 

timestamp = util.to_time_float(time.time()) 

network_list = [] 

for k, station_list in network_dict.items(): 

 

network_list.append( 

Network( 

code=k, station_list=station_list, 

total_number_stations=len(station_list))) 

 

sxml = FDSNStationXML( 

source='from pyrocko stations list', created=timestamp, 

network_list=network_list) 

 

sxml.validate() 

return sxml 

 

def iter_network_stations( 

self, net=None, sta=None, time=None, timespan=None): 

 

tt = () 

if time is not None: 

tt = (time,) 

elif timespan is not None: 

tt = timespan 

 

for network in self.network_list: 

if not network.spans(*tt) or ( 

net is not None and network.code != net): 

continue 

 

for station in network.station_list: 

if not station.spans(*tt) or ( 

sta is not None and station.code != sta): 

continue 

 

yield (network, station) 

 

def iter_network_station_channels( 

self, net=None, sta=None, loc=None, cha=None, 

time=None, timespan=None): 

 

if loc is not None: 

loc = loc.strip() 

 

tt = () 

if time is not None: 

tt = (time,) 

elif timespan is not None: 

tt = timespan 

 

for network in self.network_list: 

if not network.spans(*tt) or ( 

net is not None and network.code != net): 

continue 

 

for station in network.station_list: 

if not station.spans(*tt) or ( 

sta is not None and station.code != sta): 

continue 

 

if station.channel_list: 

for channel in station.channel_list: 

if (not channel.spans(*tt) or 

(cha is not None and channel.code != cha) or 

(loc is not None and 

channel.location_code.strip() != loc)): 

continue 

 

yield (network, station, channel) 

 

def get_channel_groups(self, net=None, sta=None, loc=None, cha=None, 

time=None, timespan=None): 

 

groups = {} 

for network, station, channel in self.iter_network_station_channels( 

net, sta, loc, cha, time=time, timespan=timespan): 

 

net = network.code 

sta = station.code 

cha = channel.code 

loc = channel.location_code.strip() 

if len(cha) == 3: 

bic = cha[:2] # band and intrument code according to SEED 

elif len(cha) == 1: 

bic = '' 

else: 

bic = cha 

 

if channel.response and \ 

channel.response.instrument_sensitivity and \ 

channel.response.instrument_sensitivity.input_units: 

 

unit = channel.response.instrument_sensitivity.input_units.name 

else: 

unit = None 

 

bic = (bic, unit) 

 

k = net, sta, loc 

if k not in groups: 

groups[k] = {} 

 

if bic not in groups[k]: 

groups[k][bic] = [] 

 

groups[k][bic].append(channel) 

 

for nsl, bic_to_channels in groups.items(): 

bad_bics = [] 

for bic, channels in bic_to_channels.items(): 

sample_rates = [] 

for channel in channels: 

sample_rates.append(channel.sample_rate.value) 

 

if not same(sample_rates): 

scs = ','.join(channel.code for channel in channels) 

srs = ', '.join('%e' % x for x in sample_rates) 

err = 'ignoring channels with inconsistent sampling ' + \ 

'rates (%s.%s.%s.%s: %s)' % (nsl + (scs, srs)) 

 

logger.warn(err) 

bad_bics.append(bic) 

 

for bic in bad_bics: 

del bic_to_channels[bic] 

 

return groups 

 

def choose_channels( 

self, 

target_sample_rate=None, 

priority_band_code=['H', 'B', 'M', 'L', 'V', 'E', 'S'], 

priority_units=['M/S', 'M/S**2'], 

priority_instrument_code=['H', 'L'], 

time=None, 

timespan=None): 

 

nslcs = {} 

for nsl, bic_to_channels in self.get_channel_groups( 

time=time, timespan=timespan).items(): 

 

useful_bics = [] 

for bic, channels in bic_to_channels.items(): 

rate = channels[0].sample_rate.value 

 

if target_sample_rate is not None and \ 

rate < target_sample_rate*0.99999: 

continue 

 

if len(bic[0]) == 2: 

if bic[0][0] not in priority_band_code: 

continue 

 

if bic[0][1] not in priority_instrument_code: 

continue 

 

unit = bic[1] 

 

prio_unit = len(priority_units) 

try: 

prio_unit = priority_units.index(unit) 

except ValueError: 

pass 

 

prio_inst = len(priority_instrument_code) 

prio_band = len(priority_band_code) 

if len(channels[0].code) == 3: 

try: 

prio_inst = priority_instrument_code.index( 

channels[0].code[1]) 

except ValueError: 

pass 

 

try: 

prio_band = priority_band_code.index( 

channels[0].code[0]) 

except ValueError: 

pass 

 

if target_sample_rate is None: 

rate = -rate 

 

useful_bics.append((-len(channels), prio_band, rate, prio_unit, 

prio_inst, bic)) 

 

useful_bics.sort() 

 

for _, _, rate, _, _, bic in useful_bics: 

channels = sorted( 

bic_to_channels[bic], 

key=lambda channel: channel.code) 

 

if channels: 

for channel in channels: 

nslcs[nsl + (channel.code,)] = channel 

 

break 

 

return nslcs 

 

def get_pyrocko_response( 

self, nslc, time=None, timespan=None, fake_input_units=None): 

 

net, sta, loc, cha = nslc 

resps = [] 

for _, _, channel in self.iter_network_station_channels( 

net, sta, loc, cha, time=time, timespan=timespan): 

resp = channel.response 

if resp: 

resps.append(resp.get_pyrocko_response( 

nslc, fake_input_units=fake_input_units)) 

 

if not resps: 

raise NoResponseInformation('%s.%s.%s.%s' % nslc) 

elif len(resps) > 1: 

raise MultipleResponseInformation('%s.%s.%s.%s' % nslc) 

 

return resps[0] 

 

@property 

def n_code_list(self): 

return sorted(set(x.code for x in self.network_list)) 

 

@property 

def ns_code_list(self): 

nss = set() 

for network in self.network_list: 

for station in network.station_list: 

nss.add((network.code, station.code)) 

 

return sorted(nss) 

 

@property 

def nsl_code_list(self): 

nsls = set() 

for network in self.network_list: 

for station in network.station_list: 

for channel in station.channel_list: 

nsls.add( 

(network.code, station.code, channel.location_code)) 

 

return sorted(nsls) 

 

@property 

def nslc_code_list(self): 

nslcs = set() 

for network in self.network_list: 

for station in network.station_list: 

for channel in station.channel_list: 

nslcs.add( 

(network.code, station.code, channel.location_code, 

channel.code)) 

 

return sorted(nslcs) 

 

def summary(self): 

lst = [ 

'number of n codes: %i' % len(self.n_code_list), 

'number of ns codes: %i' % len(self.ns_code_list), 

'number of nsl codes: %i' % len(self.nsl_code_list), 

'number of nslc codes: %i' % len(self.nslc_code_list) 

] 

 

return '\n'.join(lst) 

 

 

class InconsistentChannelLocations(Exception): 

pass 

 

 

class InvalidRecord(Exception): 

def __init__(self, line): 

Exception.__init__(self) 

self._line = line 

 

def __str__(self): 

return 'Invalid record: "%s"' % self._line 

 

 

def load_channel_table(stream): 

 

networks = {} 

stations = {} 

 

for line in stream: 

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

if line.startswith('#'): 

continue 

 

t = line.rstrip().split('|') 

 

if len(t) != 17: 

logger.warn('Invalid channel record: %s' % line) 

continue 

 

(net, sta, loc, cha, lat, lon, ele, dep, azi, dip, sens, scale, 

scale_freq, scale_units, sample_rate, start_date, end_date) = t 

 

try: 

scale = float(scale) 

except ValueError: 

scale = None 

 

try: 

scale_freq = float(scale_freq) 

except ValueError: 

scale_freq = None 

 

try: 

depth = float(dep) 

except ValueError: 

depth = 0.0 

 

try: 

azi = float(azi) 

dip = float(dip) 

except ValueError: 

azi = None 

dip = None 

 

try: 

if net not in networks: 

network = Network(code=net) 

else: 

network = networks[net] 

 

if (net, sta) not in stations: 

station = Station( 

code=sta, latitude=lat, longitude=lon, elevation=ele) 

 

station.regularize() 

else: 

station = stations[net, sta] 

 

if scale: 

resp = Response( 

instrument_sensitivity=Sensitivity( 

value=scale, 

frequency=scale_freq, 

input_units=scale_units)) 

else: 

resp = None 

 

channel = Channel( 

code=cha, 

location_code=loc.strip(), 

latitude=lat, 

longitude=lon, 

elevation=ele, 

depth=depth, 

azimuth=azi, 

dip=dip, 

sensor=Equipment(description=sens), 

response=resp, 

sample_rate=sample_rate, 

start_date=start_date, 

end_date=end_date or None) 

 

channel.regularize() 

 

except ValidationError: 

raise InvalidRecord(line) 

 

if net not in networks: 

networks[net] = network 

 

if (net, sta) not in stations: 

stations[net, sta] = station 

network.station_list.append(station) 

 

station.channel_list.append(channel) 

 

return FDSNStationXML( 

source='created from table input', 

created=time.time(), 

network_list=sorted(networks.values(), key=lambda x: x.code)) 

 

 

def primitive_merge(sxs): 

networks = [] 

for sx in sxs: 

networks.extend(sx.network_list) 

 

return FDSNStationXML( 

source='merged from different sources', 

created=time.time(), 

network_list=copy.deepcopy( 

sorted(networks, key=lambda x: x.code)))