-
Notifications
You must be signed in to change notification settings - Fork 530
/
core.py
1926 lines (1759 loc) · 78.7 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
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
# -*- coding: utf-8 -*-
"""
QuakeML read and write support.
QuakeML is a flexible, extensible and modular XML representation of
seismological data which is intended to cover a broad range of fields of
application in modern seismology. QuakeML is an open standard and is developed
by a distributed team in a transparent collaborative manner.
.. seealso:: https://quake.ethz.ch/quakeml/
.. note::
For handling additional information not covered by the QuakeML standard and
how to output it to QuakeML see the :ref:`ObsPy Tutorial <quakeml-extra>`.
:copyright:
The ObsPy Development Team (devs@obspy.org)
:license:
GNU Lesser General Public License, Version 3
(https://www.gnu.org/copyleft/lesser.html)
"""
import inspect
import io
from pathlib import Path
import re
import warnings
from collections.abc import Mapping
from lxml import etree
from obspy.core.event import (Amplitude, Arrival, Axis, Catalog, Comment,
CompositeTime, ConfidenceEllipsoid, CreationInfo,
DataUsed, Event, EventDescription,
FocalMechanism, Magnitude, MomentTensor,
NodalPlane, NodalPlanes, Origin, OriginQuality,
OriginUncertainty, Pick, PrincipalAxes,
QuantityError, ResourceIdentifier,
SourceTimeFunction, StationMagnitude,
StationMagnitudeContribution, Tensor, TimeWindow,
WaveformStreamID)
from obspy.core.utcdatetime import UTCDateTime
from obspy.core.util import AttribDict, Enum
QUAKEML_ROOTTAG_REGEX = r'^{(http://quakeml.org/xmlns/quakeml/([^}]*))}quakeml'
NS_QUAKEML_PATTERN = 'http://quakeml.org/xmlns/quakeml/{version}'
NS_QUAKEML_BED_PATTERN = 'http://quakeml.org/xmlns/bed/{version}'
NSMAP_QUAKEML = {None: NS_QUAKEML_BED_PATTERN.format(version="1.2"),
'q': NS_QUAKEML_PATTERN.format(version="1.2")}
def _get_first_child_namespace(element):
"""
Helper function extracting the namespace of an element.
"""
try:
element = element[0]
except IndexError:
return None
return etree.QName(element.tag).namespace
def _xml_doc_from_anything(source):
"""
Helper function attempting to create an xml etree element from either a
filename, a file-like object, or a (byte)string.
Will raise a ValueError if it fails.
"""
try:
xml_doc = etree.parse(source).getroot()
except Exception:
try:
xml_doc = etree.fromstring(source)
except Exception:
try:
xml_doc = etree.fromstring(source.encode())
except Exception:
raise ValueError("Could not parse '%s' to an etree element." %
source)
return xml_doc
def _is_quakeml(filename):
"""
Checks whether a file is QuakeML format.
:type filename: str
:param filename: Name of the QuakeML file to be checked.
:rtype: bool
:return: ``True`` if QuakeML file.
.. rubric:: Example
>>> _is_quakeml('/path/to/quakeml.xml') # doctest: +SKIP
True
"""
if hasattr(filename, "tell") and hasattr(filename, "seek") and \
hasattr(filename, "read"):
file_like_object = True
position = filename.tell()
else:
file_like_object = False
try:
xml_doc = _xml_doc_from_anything(filename)
except Exception:
return False
finally:
if file_like_object:
filename.seek(position, 0)
# check if node "*/eventParameters/event" for the global namespace exists
try:
if hasattr(xml_doc, "getroot"):
namespace = _get_first_child_namespace(xml_doc.getroot())
else:
namespace = _get_first_child_namespace(xml_doc)
xml_doc.xpath('q:eventParameters', namespaces={"q": namespace})[0]
except Exception:
return False
return True
class Unpickler(object):
"""
De-serializes a QuakeML string into an ObsPy Catalog object.
"""
def __init__(self, xml_doc=None):
self.xml_doc = xml_doc
@property
def xml_root(self):
try:
return self.xml_doc.getroot()
except AttributeError:
return self.xml_doc
def load(self, file):
"""
Reads QuakeML file into ObsPy catalog object.
:type file: str
:param file: File name to read.
:rtype: :class:`~obspy.core.event.catalog.Catalog`
:returns: ObsPy Catalog object.
"""
self.xml_doc = _xml_doc_from_anything(file)
return self._deserialize()
def loads(self, string):
"""
Parses QuakeML string into ObsPy catalog object.
:type string: str
:param string: QuakeML string to parse.
:rtype: :class:`~obspy.core.event.catalog.Catalog`
:returns: ObsPy Catalog object.
"""
self.xml_doc = etree.parse(io.BytesIO(string))
return self._deserialize()
def _xpath2obj(self, xpath, element=None, convert_to=str, namespace=None):
q = self._xpath(xpath, element=element, namespace=namespace)
if not q:
return None
text = q[0].text
if text is None or text == '':
return None
if convert_to == bool:
if text.lower() in ["true", "1"]:
return True
elif text.lower() in ["false", "0"]:
return False
return None
try:
return convert_to(text)
except Exception:
msg = "Could not convert %s to type %s. Returning None."
warnings.warn(msg % (text, convert_to))
return None
def _set_enum(self, xpath, element, obj, key):
obj_type = obj._property_dict[key]
if not isinstance(obj_type, Enum): # pragma: no cover
raise ValueError
value = self._xpath2obj(xpath, element)
try:
setattr(obj, key, value)
except ValueError as e:
msg = ('%s. The attribute "%s" will not be set and will be missing'
' in the resulting object.' % (e.args[0], key))
warnings.warn(msg)
def _xpath(self, xpath, element=None, namespace=None):
if element is None:
element = self.xml_root
namespaces = None
if namespace:
xpath = "b:%s" % xpath
namespaces = {"b": namespace}
elif hasattr(element, "nsmap") and None in element.nsmap:
xpath = "b:%s" % xpath
namespaces = {"b": element.nsmap[None]}
elif hasattr(self, "nsmap") and None in self.nsmap:
xpath = "b:%s" % xpath
namespaces = {"b": self.nsmap[None]}
return element.xpath(xpath, namespaces=namespaces)
def _comments(self, parent):
obj = []
for el in self._xpath('comment', parent):
comment = Comment(force_resource_id=False)
comment.text = self._xpath2obj('text', el)
comment.creation_info = self._creation_info(el)
comment.resource_id = el.get('id', None)
self._extra(el, comment)
obj.append(comment)
return obj
def _station_magnitude_contributions(self, parent):
obj = []
for el in self._xpath("stationMagnitudeContribution", parent):
contrib = StationMagnitudeContribution()
contrib.weight = self._xpath2obj("weight", el, float)
contrib.residual = self._xpath2obj("residual", el, float)
contrib.station_magnitude_id = \
self._xpath2obj("stationMagnitudeID", el, str)
self._extra(el, contrib)
obj.append(contrib)
return obj
def _creation_info(self, parent):
elements = self._xpath("creationInfo", parent)
if len(elements) > 1:
raise NotImplementedError("Only one CreationInfo allowed.")
elif len(elements) == 0:
return None
element = elements[0]
obj = CreationInfo()
obj.agency_uri = self._xpath2obj('agencyURI', element)
obj.author_uri = self._xpath2obj('authorURI', element)
obj.agency_id = self._xpath2obj('agencyID', element)
obj.author = self._xpath2obj('author', element)
obj.creation_time = self._xpath2obj(
'creationTime', element, UTCDateTime)
obj.version = self._xpath2obj('version', element)
self._extra(element, obj)
return obj
def _origin_quality(self, parent):
elements = self._xpath("quality", parent)
if len(elements) > 1:
raise NotImplementedError("Only one OriginQuality allowed.")
# Do not add an element if it is not given in the XML file.
elif len(elements) == 0:
return None
element = elements[0]
obj = OriginQuality()
obj.associated_phase_count = self._xpath2obj(
'associatedPhaseCount', element, int)
obj.used_phase_count = self._xpath2obj(
'usedPhaseCount', element, int)
obj.associated_station_count = self._xpath2obj(
'associatedStationCount', element, int)
obj.used_station_count = self._xpath2obj(
'usedStationCount', element, int)
obj.depth_phase_count = self._xpath2obj(
'depthPhaseCount', element, int)
obj.standard_error = self._xpath2obj(
'standardError', element, float)
obj.azimuthal_gap = self._xpath2obj(
'azimuthalGap', element, float)
obj.secondary_azimuthal_gap = self._xpath2obj(
'secondaryAzimuthalGap', element, float)
obj.ground_truth_level = self._xpath2obj(
'groundTruthLevel', element)
obj.minimum_distance = self._xpath2obj(
'minimumDistance', element, float)
obj.maximum_distance = self._xpath2obj(
'maximumDistance', element, float)
obj.median_distance = self._xpath2obj(
'medianDistance', element, float)
self._extra(element, obj)
return obj
def _event_description(self, parent):
out = []
for el in self._xpath('description', parent):
desc = EventDescription()
desc.text = self._xpath2obj('text', el)
self._set_enum('type', el, desc, 'type')
out.append(desc)
self._extra(el, out[-1])
return out
def _value(self, parent, name, quantity_type=float):
try:
el = self._xpath(name, parent)[0]
except IndexError:
return None, None
value = self._xpath2obj('value', el, quantity_type)
# All errors are QuantityError.
error = QuantityError()
# Don't set the errors if they are not set.
confidence_level = self._xpath2obj('confidenceLevel', el, float)
if confidence_level is not None:
error.confidence_level = confidence_level
if quantity_type != int:
uncertainty = self._xpath2obj('uncertainty', el, float)
if uncertainty is not None:
error.uncertainty = uncertainty
lower_uncertainty = self._xpath2obj('lowerUncertainty', el, float)
if lower_uncertainty is not None:
error.lower_uncertainty = lower_uncertainty
upper_uncertainty = self._xpath2obj('upperUncertainty', el, float)
if upper_uncertainty is not None:
error.upper_uncertainty = upper_uncertainty
else:
uncertainty = self._xpath2obj('uncertainty', el, int)
if uncertainty is not None:
error.uncertainty = uncertainty
lower_uncertainty = self._xpath2obj('lowerUncertainty', el, int)
if lower_uncertainty is not None:
error.lower_uncertainty = lower_uncertainty
upper_uncertainty = self._xpath2obj('upperUncertainty', el, int)
if upper_uncertainty is not None:
error.upper_uncertainty = upper_uncertainty
# Silent QuantityError warning for extra attribute
error.do_not_warn_on.append('extra')
self._extra(el, error)
return value, error
def _float_value(self, element, name):
return self._value(element, name, float)
def _int_value(self, element, name):
return self._value(element, name, int)
def _time_value(self, element, name):
return self._value(element, name, UTCDateTime)
def _composite_times(self, parent):
obj = []
for el in self._xpath('compositeTime', parent):
ct = CompositeTime()
ct.year, ct.year_errors = self._int_value(el, 'year')
ct.month, ct.month_errors = self._int_value(el, 'month')
ct.day, ct.day_errors = self._int_value(el, 'day')
ct.hour, ct.hour_errors = self._int_value(el, 'hour')
ct.minute, ct.minute_errors = self._int_value(el, 'minute')
ct.second, ct.second_errors = self._float_value(el, 'second')
self._extra(el, ct)
obj.append(ct)
return obj
def _confidence_ellipsoid(self, element):
obj = ConfidenceEllipsoid()
obj.semi_major_axis_length = self._xpath2obj(
'semiMajorAxisLength', element, float)
obj.semi_minor_axis_length = self._xpath2obj(
'semiMinorAxisLength', element, float)
obj.semi_intermediate_axis_length = self._xpath2obj(
'semiIntermediateAxisLength', element, float)
obj.major_axis_plunge = self._xpath2obj(
'majorAxisPlunge', element, float)
obj.major_axis_azimuth = self._xpath2obj(
'majorAxisAzimuth', element, float)
obj.major_axis_rotation = self._xpath2obj(
'majorAxisRotation', element, float)
self._extra(element, obj)
return obj
def _origin_uncertainty(self, parent):
elements = self._xpath("originUncertainty", parent)
if len(elements) > 1:
raise NotImplementedError("Only one OriginUncertainty allowed.")
# Do not add an element if it is not given in the XML file.
elif len(elements) == 0:
return None
element = elements[0]
obj = OriginUncertainty()
self._set_enum('preferredDescription', element,
obj, 'preferred_description')
obj.horizontal_uncertainty = self._xpath2obj(
'horizontalUncertainty', element, float)
obj.min_horizontal_uncertainty = self._xpath2obj(
'minHorizontalUncertainty', element, float)
obj.max_horizontal_uncertainty = self._xpath2obj(
'maxHorizontalUncertainty', element, float)
obj.azimuth_max_horizontal_uncertainty = self._xpath2obj(
'azimuthMaxHorizontalUncertainty', element, float)
obj.confidence_level = self._xpath2obj(
'confidenceLevel', element, float)
ce_el = self._xpath('confidenceEllipsoid', element)
try:
ce_el = ce_el[0]
except IndexError:
obj.confidence_ellipsoid = ConfidenceEllipsoid()
else:
obj.confidence_ellipsoid = self._confidence_ellipsoid(ce_el)
self._extra(element, obj)
return obj
def _waveform_ids(self, parent):
objs = []
for wid_el in self._xpath('waveformID', parent):
obj = WaveformStreamID()
obj.network_code = wid_el.get('networkCode') or ''
obj.station_code = wid_el.get('stationCode') or ''
obj.location_code = wid_el.get('locationCode')
obj.channel_code = wid_el.get('channelCode')
obj.resource_uri = wid_el.text
objs.append(obj)
return objs
def _waveform_id(self, parent):
try:
return self._waveform_ids(parent)[0]
except IndexError:
return None
def _arrival(self, element):
"""
Converts an etree.Element into an Arrival object.
:type element: :class:`~lxml.etree._Element`
:rtype: :class:`~obspy.core.event.origin.Arrival`
"""
obj = Arrival(force_resource_id=False)
# required parameter
obj.pick_id = self._xpath2obj('pickID', element) or ''
obj.phase = self._xpath2obj('phase', element) or ''
# optional parameter
obj.time_correction = self._xpath2obj('timeCorrection', element, float)
obj.azimuth = self._xpath2obj('azimuth', element, float)
obj.distance = self._xpath2obj('distance', element, float)
obj.takeoff_angle, obj.takeoff_angle_errors = \
self._float_value(element, 'takeoffAngle')
obj.time_residual = self._xpath2obj('timeResidual', element, float)
obj.horizontal_slowness_residual = \
self._xpath2obj('horizontalSlownessResidual', element, float)
obj.backazimuth_residual = \
self._xpath2obj('backazimuthResidual', element, float)
obj.time_weight = self._xpath2obj('timeWeight', element, float)
obj.horizontal_slowness_weight = \
self._xpath2obj('horizontalSlownessWeight', element, float)
obj.backazimuth_weight = \
self._xpath2obj('backazimuthWeight', element, float)
obj.earth_model_id = self._xpath2obj('earthModelID', element)
obj.comments = self._comments(element)
obj.creation_info = self._creation_info(element)
obj.resource_id = element.get('publicID')
self._extra(element, obj)
return obj
def _pick(self, element):
"""
Converts an etree.Element into a Pick object.
:type element: :class:`~lxml.etree._Element`
:rtype: :class:`~obspy.core.event.origin.Pick`
"""
obj = Pick(force_resource_id=False)
# required parameter
obj.time, obj.time_errors = self._time_value(element, 'time')
obj.waveform_id = self._waveform_id(element)
# optional parameter
obj.filter_id = self._xpath2obj('filterID', element)
obj.method_id = self._xpath2obj('methodID', element)
obj.horizontal_slowness, obj.horizontal_slowness_errors = \
self._float_value(element, 'horizontalSlowness')
obj.backazimuth, obj.backazimuth_errors = \
self._float_value(element, 'backazimuth')
obj.slowness_method_id = self._xpath2obj('slownessMethodID', element)
self._set_enum('onset', element, obj, 'onset')
obj.phase_hint = self._xpath2obj('phaseHint', element)
self._set_enum('polarity', element, obj, 'polarity')
self._set_enum('evaluationMode', element, obj, 'evaluation_mode')
self._set_enum('evaluationStatus', element, obj, 'evaluation_status')
obj.comments = self._comments(element)
obj.creation_info = self._creation_info(element)
obj.resource_id = element.get('publicID')
self._extra(element, obj)
return obj
def _time_window(self, element):
"""
Converts an etree.Element into a TimeWindow object.
:type element: :class:`~lxml.etree._Element`
:rtype: :class:`~obspy.core.event.base.TimeWindow`
"""
obj = TimeWindow(force_resource_id=False)
# required parameter
obj.begin = self._xpath2obj('begin', element, convert_to=float)
obj.end = self._xpath2obj('end', element, convert_to=float)
obj.reference = self._xpath2obj('reference', element,
convert_to=UTCDateTime)
self._extra(element, obj)
return obj
def _amplitude(self, element):
"""
Converts an etree.Element into a Amplitude object.
:type element: :class:`~lxml.etree._Element`
:rtype: :class:`~obspy.core.event.magnitude.Amplitude`
"""
obj = Amplitude(force_resource_id=False)
# required parameter
obj.generic_amplitude, obj.generic_amplitude_errors = \
self._float_value(element, 'genericAmplitude')
# optional parameter
obj.type = self._xpath2obj('type', element)
self._set_enum('category', element, obj, 'category')
self._set_enum('unit', element, obj, 'unit')
obj.method_id = self._xpath2obj('methodID', element)
obj.period, obj.period_errors = self._float_value(element, 'period')
obj.snr = self._xpath2obj('snr', element)
time_window_el = self._xpath('timeWindow', element) or None
if time_window_el is not None:
obj.time_window = self._time_window(time_window_el[0])
obj.pick_id = self._xpath2obj('pickID', element)
obj.waveform_id = self._waveform_id(element)
obj.filter_id = self._xpath2obj('filterID', element)
obj.scaling_time, obj.scaling_time_errors = \
self._time_value(element, 'scalingTime')
obj.magnitude_hint = self._xpath2obj('magnitudeHint', element)
self._set_enum('evaluationMode', element, obj, 'evaluation_mode')
self._set_enum('evaluationStatus', element, obj, 'evaluation_status')
obj.comments = self._comments(element)
obj.creation_info = self._creation_info(element)
obj.resource_id = element.get('publicID')
self._extra(element, obj)
return obj
def _origin(self, element, arrivals):
"""
Converts an etree.Element into an Origin object.
:type element: :class:`~lxml.etree._Element`
:rtype: :class:`~obspy.core.event.origin.Origin`
.. rubric:: Example
>>> from lxml import etree
>>> XML = b'''<?xml version="1.0" encoding="UTF-8"?>
... <origin>
... <latitude><value>34.23</value></latitude>
... </origin>'''
>>> xml_doc = etree.fromstring(XML)
>>> unpickler = Unpickler(xml_doc)
>>> origin = unpickler._origin(xml_doc, arrivals=[])
>>> print(origin.latitude)
34.23
"""
obj = Origin(force_resource_id=False)
# required parameter
obj.time, obj.time_errors = self._time_value(element, 'time')
obj.latitude, obj.latitude_errors = \
self._float_value(element, 'latitude')
obj.longitude, obj.longitude_errors = \
self._float_value(element, 'longitude')
# optional parameter
obj.depth, obj.depth_errors = self._float_value(element, 'depth')
self._set_enum('depthType', element, obj, 'depth_type')
obj.time_fixed = self._xpath2obj('timeFixed', element, bool)
obj.epicenter_fixed = self._xpath2obj('epicenterFixed', element, bool)
obj.reference_system_id = self._xpath2obj('referenceSystemID', element)
obj.method_id = self._xpath2obj('methodID', element)
obj.earth_model_id = self._xpath2obj('earthModelID', element)
obj.composite_times = self._composite_times(element)
obj.quality = self._origin_quality(element)
self._set_enum('type', element, obj, 'origin_type')
obj.region = self._xpath2obj('region', element)
self._set_enum('evaluationMode', element, obj, 'evaluation_mode')
self._set_enum('evaluationStatus', element, obj, 'evaluation_status')
obj.creation_info = self._creation_info(element)
obj.comments = self._comments(element)
obj.origin_uncertainty = self._origin_uncertainty(element)
obj.arrivals = arrivals
obj.resource_id = element.get('publicID')
self._extra(element, obj)
return obj
def _magnitude(self, element):
"""
Converts an etree.Element into a Magnitude object.
:type element: :class:`~lxml.etree._Element`
:rtype: :class:`~obspy.core.event.magnitude.Magnitude`
.. rubric:: Example
>>> from lxml import etree
>>> XML = b'''<?xml version="1.0" encoding="UTF-8"?>
... <magnitude>
... <mag><value>3.2</value></mag>
... </magnitude>'''
>>> xml_doc = etree.fromstring(XML)
>>> unpickler = Unpickler(xml_doc)
>>> magnitude = unpickler._magnitude(xml_doc)
>>> print(magnitude.mag)
3.2
"""
obj = Magnitude(force_resource_id=False)
# required parameter
obj.mag, obj.mag_errors = self._float_value(element, 'mag')
# optional parameter
obj.magnitude_type = self._xpath2obj('type', element)
obj.origin_id = self._xpath2obj('originID', element)
obj.method_id = self._xpath2obj('methodID', element)
obj.station_count = self._xpath2obj('stationCount', element, int)
obj.azimuthal_gap = self._xpath2obj('azimuthalGap', element, float)
self._set_enum('evaluationMode', element, obj, 'evaluation_mode')
self._set_enum('evaluationStatus', element, obj, 'evaluation_status')
obj.creation_info = self._creation_info(element)
obj.station_magnitude_contributions = \
self._station_magnitude_contributions(element)
obj.comments = self._comments(element)
obj.resource_id = element.get('publicID')
self._extra(element, obj)
return obj
def _station_magnitude(self, element):
"""
Converts an etree.Element into a StationMagnitude object.
:type element: :class:`~lxml.etree._Element`
:rtype: :class:`~obspy.core.event.magnitude.StationMagnitude`
.. rubric:: Example
>>> from lxml import etree
>>> XML = b'''<?xml version="1.0" encoding="UTF-8"?>
... <stationMagnitude>
... <mag><value>3.2</value></mag>
... </stationMagnitude>'''
>>> xml_doc = etree.fromstring(XML)
>>> unpickler = Unpickler(xml_doc)
>>> station_mag = unpickler._station_magnitude(xml_doc)
>>> print(station_mag.mag)
3.2
"""
obj = StationMagnitude(force_resource_id=False)
# required parameter
obj.origin_id = self._xpath2obj('originID', element) or ''
obj.mag, obj.mag_errors = self._float_value(element, 'mag')
# optional parameter
obj.station_magnitude_type = self._xpath2obj('type', element)
obj.amplitude_id = self._xpath2obj('amplitudeID', element)
obj.method_id = self._xpath2obj('methodID', element)
obj.waveform_id = self._waveform_id(element)
obj.creation_info = self._creation_info(element)
obj.comments = self._comments(element)
obj.resource_id = element.get('publicID')
self._extra(element, obj)
return obj
def _axis(self, parent, name):
"""
Converts an etree.Element into an Axis object.
:type parent: :class:`~lxml.etree._Element`
:type name: str
:param name: tag name of axis
:rtype: :class:`~obspy.core.event.source.Axis`
"""
obj = Axis()
try:
sub_el = self._xpath(name, parent)[0]
except IndexError:
return obj
# required parameter
obj.azimuth, obj.azimuth_errors = self._float_value(sub_el, 'azimuth')
obj.plunge, obj.plunge_errors = self._float_value(sub_el, 'plunge')
obj.length, obj.length_errors = self._float_value(sub_el, 'length')
self._extra(sub_el, obj)
return obj
def _principal_axes(self, parent):
"""
Converts an etree.Element into an PrincipalAxes object.
:type parent: :class:`~lxml.etree._Element`
:rtype: :class:`~obspy.core.event.source.PrincipalAxes`
"""
try:
sub_el = self._xpath('principalAxes', parent)[0]
except IndexError:
return None
obj = PrincipalAxes()
# required parameter
obj.t_axis = self._axis(sub_el, 'tAxis')
obj.p_axis = self._axis(sub_el, 'pAxis')
# optional parameter
obj.n_axis = self._axis(sub_el, 'nAxis')
self._extra(sub_el, obj)
return obj
def _nodal_plane(self, parent, name):
"""
Converts an etree.Element into an NodalPlane object.
:type parent: :class:`~lxml.etree._Element`
:type name: str
:param name: tag name of sub nodal plane
:rtype: :class:`~obspy.core.event.source.NodalPlane`
"""
try:
sub_el = self._xpath(name, parent)[0]
except IndexError:
return None
obj = NodalPlane()
# required parameter
obj.strike, obj.strike_errors = self._float_value(sub_el, 'strike')
obj.dip, obj.dip_errors = self._float_value(sub_el, 'dip')
obj.rake, obj.rake_errors = self._float_value(sub_el, 'rake')
self._extra(sub_el, obj)
return obj
def _nodal_planes(self, parent):
"""
Converts an etree.Element into an NodalPlanes object.
:type parent: :class:`~lxml.etree._Element`
:rtype: :class:`~obspy.core.event.source.NodalPlanes`
"""
try:
sub_el = self._xpath('nodalPlanes', parent)[0]
except IndexError:
return None
obj = NodalPlanes()
# optional parameter
obj.nodal_plane_1 = self._nodal_plane(sub_el, 'nodalPlane1')
obj.nodal_plane_2 = self._nodal_plane(sub_el, 'nodalPlane2')
# optional attribute
try:
obj.preferred_plane = int(sub_el.get('preferredPlane'))
except Exception:
obj.preferred_plane = None
self._extra(sub_el, obj)
return obj
def _source_time_function(self, parent):
"""
Converts an etree.Element into an SourceTimeFunction object.
:type parent: :class:`~lxml.etree._Element`
:rtype: :class:`~obspy.core.event.source.SourceTimeFunction`
"""
try:
sub_el = self._xpath('sourceTimeFunction', parent)[0]
except IndexError:
return None
obj = SourceTimeFunction()
# required parameters
self._set_enum('type', sub_el, obj, 'type')
obj.duration = self._xpath2obj('duration', sub_el, float)
# optional parameter
obj.rise_time = self._xpath2obj('riseTime', sub_el, float)
obj.decay_time = self._xpath2obj('decayTime', sub_el, float)
self._extra(sub_el, obj)
return obj
def _tensor(self, parent):
"""
Converts an etree.Element into an Tensor object.
:type parent: :class:`~lxml.etree._Element`
:rtype: :class:`~obspy.core.event.source.Tensor`
"""
try:
sub_el = self._xpath('tensor', parent)[0]
except IndexError:
return None
obj = Tensor()
# required parameters
obj.m_rr, obj.m_rr_errors = self._float_value(sub_el, 'Mrr')
obj.m_tt, obj.m_tt_errors = self._float_value(sub_el, 'Mtt')
obj.m_pp, obj.m_pp_errors = self._float_value(sub_el, 'Mpp')
obj.m_rt, obj.m_rt_errors = self._float_value(sub_el, 'Mrt')
obj.m_rp, obj.m_rp_errors = self._float_value(sub_el, 'Mrp')
obj.m_tp, obj.m_tp_errors = self._float_value(sub_el, 'Mtp')
self._extra(sub_el, obj)
return obj
def _data_used(self, parent):
"""
Converts an etree.Element into a list of DataUsed objects.
:type parent: :class:`~lxml.etree._Element`
:rtype: list of :class:`~obspy.core.event.base.DataUsed`
"""
obj = []
for el in self._xpath('dataUsed', parent):
data_used = DataUsed()
# required parameters
self._set_enum('waveType', el, data_used, 'wave_type')
# optional parameter
data_used.station_count = \
self._xpath2obj('stationCount', el, int)
data_used.component_count = \
self._xpath2obj('componentCount', el, int)
data_used.shortest_period = \
self._xpath2obj('shortestPeriod', el, float)
data_used.longest_period = \
self._xpath2obj('longestPeriod', el, float)
self._extra(el, data_used)
obj.append(data_used)
return obj
def _moment_tensor(self, parent):
"""
Converts an etree.Element into an MomentTensor object.
:type parent: :class:`~lxml.etree._Element`
:rtype: :class:`~obspy.core.event.source.MomentTensor`
"""
try:
mt_el = self._xpath('momentTensor', parent)[0]
except IndexError:
return None
obj = MomentTensor(force_resource_id=False)
# required parameters
obj.derived_origin_id = self._xpath2obj('derivedOriginID', mt_el)
# optional parameter
obj.moment_magnitude_id = self._xpath2obj('momentMagnitudeID', mt_el)
obj.scalar_moment, obj.scalar_moment_errors = \
self._float_value(mt_el, 'scalarMoment')
obj.tensor = self._tensor(mt_el)
obj.variance = self._xpath2obj('variance', mt_el, float)
obj.variance_reduction = \
self._xpath2obj('varianceReduction', mt_el, float)
obj.double_couple = self._xpath2obj('doubleCouple', mt_el, float)
obj.clvd = self._xpath2obj('clvd', mt_el, float)
obj.iso = self._xpath2obj('iso', mt_el, float)
obj.greens_function_id = self._xpath2obj('greensFunctionID', mt_el)
obj.filter_id = self._xpath2obj('filterID', mt_el)
obj.source_time_function = self._source_time_function(mt_el)
obj.data_used = self._data_used(mt_el)
obj.method_id = self._xpath2obj('methodID', mt_el)
self._set_enum('category', mt_el, obj, 'category')
self._set_enum('inversionType', mt_el, obj, 'inversion_type')
obj.creation_info = self._creation_info(mt_el)
obj.comments = self._comments(mt_el)
obj.resource_id = mt_el.get('publicID')
self._extra(mt_el, obj)
return obj
def _focal_mechanism(self, element):
"""
Converts an etree.Element into a FocalMechanism object.
:type element: :class:`~lxml.etree._Element`
:rtype: :class:`~obspy.core.event.source.FocalMechanism`
.. rubric:: Example
>>> from lxml import etree
>>> XML = b'''<?xml version="1.0" encoding="UTF-8"?>
... <focalMechanism>
... <methodID>smi:ISC/methodID=Best_double_couple</methodID>
... </focalMechanism>'''
>>> xml_doc = etree.fromstring(XML)
>>> unpickler = Unpickler(xml_doc)
>>> fm = unpickler._focal_mechanism(xml_doc)
>>> print(fm.method_id)
smi:ISC/methodID=Best_double_couple
"""
obj = FocalMechanism(force_resource_id=False)
# required parameter
# optional parameter
obj.waveform_id = self._waveform_ids(element)
obj.triggering_origin_id = \
self._xpath2obj('triggeringOriginID', element)
obj.azimuthal_gap = self._xpath2obj('azimuthalGap', element, float)
obj.station_polarity_count = \
self._xpath2obj('stationPolarityCount', element, int)
obj.misfit = self._xpath2obj('misfit', element, float)
obj.station_distribution_ratio = \
self._xpath2obj('stationDistributionRatio', element, float)
obj.method_id = self._xpath2obj('methodID', element)
obj.moment_tensor = self._moment_tensor(element)
obj.nodal_planes = self._nodal_planes(element)
obj.principal_axes = self._principal_axes(element)
self._set_enum('evaluationMode', element, obj, 'evaluation_mode')
self._set_enum('evaluationStatus', element, obj, 'evaluation_status')
obj.creation_info = self._creation_info(element)
obj.comments = self._comments(element)
obj.resource_id = element.get('publicID')
self._extra(element, obj)
return obj
def _deserialize(self):
# check node "quakeml/eventParameters" for global namespace
try:
namespace = _get_first_child_namespace(self.xml_root)
catalog_el = self._xpath('eventParameters', namespace=namespace)[0]
except IndexError:
raise Exception("Not a QuakeML compatible file or string")
root_namespace, quakeml_version = re.match(
QUAKEML_ROOTTAG_REGEX, self.xml_root.tag).groups()
self._quakeml_namespaces = [
root_namespace,
NS_QUAKEML_BED_PATTERN.format(version=quakeml_version)]
# create catalog
catalog = Catalog(force_resource_id=False)
# add any custom namespace abbreviations of root element to Catalog
catalog.nsmap = self.xml_root.nsmap.copy()
# optional catalog attributes
catalog.description = self._xpath2obj('description', catalog_el)
catalog.comments = self._comments(catalog_el)
catalog.creation_info = self._creation_info(catalog_el)
# loop over all events
for event_el in self._xpath('event', catalog_el):
# create new Event object
event = Event(force_resource_id=False)
# optional event attributes
event.preferred_origin_id = \
self._xpath2obj('preferredOriginID', event_el)
event.preferred_magnitude_id = \
self._xpath2obj('preferredMagnitudeID', event_el)
event.preferred_focal_mechanism_id = \
self._xpath2obj('preferredFocalMechanismID', event_el)
event_type = self._xpath2obj('type', event_el)
# Change for QuakeML 1.2RC4. 'null' is no longer acceptable as an
# event type. Will be replaced with 'not reported'.
if event_type == "null":
event_type = "not reported"
# USGS event types contain '_' which is not compliant with
# the QuakeML standard
if isinstance(event_type, str):
event_type = event_type.replace("_", " ")
try:
event.event_type = event_type
except ValueError:
msg = "Event type '%s' does not comply " % event_type
msg += "with QuakeML standard -- event will be ignored."
warnings.warn(msg, UserWarning)
continue
self._set_enum('typeCertainty', event_el,
event, 'event_type_certainty')
event.creation_info = self._creation_info(event_el)
event.event_descriptions = self._event_description(event_el)
event.comments = self._comments(event_el)
# origins
event.origins = []
for origin_el in self._xpath('origin', event_el):
# Have to be created before the origin is created to avoid a
# rare issue where a warning is read when the same event is
# read twice - the warnings does not occur if two referred
# to objects compare equal - for this the arrivals have to
# be bound to the event before the resource id is assigned.
arrivals = []
for arrival_el in self._xpath('arrival', origin_el):
arrival = self._arrival(arrival_el)
arrivals.append(arrival)
origin = self._origin(origin_el, arrivals=arrivals)
# append origin with arrivals
event.origins.append(origin)
# magnitudes
event.magnitudes = []
for magnitude_el in self._xpath('magnitude', event_el):
magnitude = self._magnitude(magnitude_el)
event.magnitudes.append(magnitude)
# station magnitudes
event.station_magnitudes = []
for magnitude_el in self._xpath('stationMagnitude', event_el):
magnitude = self._station_magnitude(magnitude_el)
event.station_magnitudes.append(magnitude)
# picks
event.picks = []
for pick_el in self._xpath('pick', event_el):
pick = self._pick(pick_el)
event.picks.append(pick)
# amplitudes
event.amplitudes = []
for el in self._xpath('amplitude', event_el):
amp = self._amplitude(el)
event.amplitudes.append(amp)
# focal mechanisms
event.focal_mechanisms = []
for fm_el in self._xpath('focalMechanism', event_el):
fm = self._focal_mechanism(fm_el)
event.focal_mechanisms.append(fm)
# finally append newly created event to catalog
event.resource_id = event_el.get('publicID')
self._extra(event_el, event)
# bind event scoped resource IDs to this event
event.scope_resource_ids()