Coverage for /usr/local/lib/python3.11/dist-packages/pyrocko/io/quakeml.py: 96%
465 statements
« prev ^ index » next coverage.py v6.5.0, created at 2023-10-06 15:01 +0000
1# http://pyrocko.org - GPLv3
2#
3# The Pyrocko Developers, 21st Century
4# ---|P------/S----------~Lg----------
6'''
7QuakeML 1.2 input, output, and data model.
9This modules provides support to read and write `QuakeML version 1.2
10<https://quake.ethz.ch/quakeml>`_. It defines a hierarchy of Python objects,
11closely following the QuakeML data model.
13QuakeML is a flexible, extensible and modular XML representation of
14seismological data which is intended to cover a broad range of fields of
15application in modern seismology. It covers basic seismic event description,
16including moment tensors.
18For convenience and ease of use, this documentation contains excerpts from the
19`QuakeML Manual
20<https://quake.ethz.ch/quakeml/docs/REC?action=AttachFile&do=get&target=QuakeML-BED-20130214b.pdf>`_.
21However, this information is not intended to be complete. Please refer to the
22QuakeML Manual for details.
23'''
25import logging
26from pyrocko.guts import StringPattern, StringChoice, String, Float, Int,\
27 Timestamp, Object, List, StringUnion, Bool, Unicode
28from pyrocko.model import event
29from pyrocko.gui.snuffler import marker
30from pyrocko import moment_tensor
31import numpy as num
33logger = logging.getLogger('pyrocko.io.quakeml')
35guts_prefix = 'quakeml'
36guts_xmlns = 'http://quakeml.org/xmlns/bed/1.2'
37polarity_choices = {'positive': 1, 'negative': -1, 'undecidable': None}
40class QuakeMLError(Exception):
41 pass
44class NoPreferredOriginSet(QuakeMLError):
45 pass
48def one_element_or_none(li):
49 if len(li) == 1:
50 return li[0]
51 elif len(li) == 0:
52 return None
53 else:
54 logger.warning('More than one element in list: {}'.format(li))
55 return None
58class ResourceIdentifier(StringPattern):
59 '''
60 Identifies resource origin.
62 They consist of an authority identifier, a unique resource identifier, and
63 an optional local identifier. The URI schema name smi stands for
64 seismological meta-information, thus indicating a connection to a set of
65 metadata associated with the resource.
66 '''
67 pattern = "^(smi|quakeml):[\\w\\d][\\w\\d\\-\\.\\*\\(\\)_~']{2,}/[\\w" +\
68 "\\d\\-\\.\\*\\(\\)_~'][\\w\\d\\-\\.\\*\\(\\)\\+\\?_~'=,;#/&]*$"
71class WhitespaceOrEmptyStringType(StringPattern):
72 pattern = '^\\s*$'
75class OriginUncertaintyDescription(StringChoice):
76 '''
77 Preferred uncertainty description.
78 '''
79 choices = [
80 'horizontal uncertainty',
81 'uncertainty ellipse',
82 'confidence ellipsoid']
85class AmplitudeCategory(StringChoice):
86 '''
87 Description of the way the waveform trace is evaluated to get an amplitude
88 value.
90 This can be just reading a single value for a given point in time (point),
91 taking a mean value over a time interval (mean), integrating the trace
92 over a time interval (integral), specifying just a time interval
93 (duration), or evaluating a period (period).
94 '''
95 choices = ['point', 'mean', 'duration', 'period', 'integral', 'other']
98class OriginDepthType(StringChoice):
99 '''
100 Type of depth determination.
101 '''
102 choices = [
103 'from location',
104 'from moment tensor inversion',
105 'from modeling of broad-band P waveforms',
106 'constrained by depth phases',
107 'constrained by direct phases',
108 'constrained by depth and direct phases',
109 'operator assigned',
110 'other']
113class OriginType(StringChoice):
114 '''
115 Describes the origin type.
116 '''
117 choices = [
118 'hypocenter',
119 'centroid',
120 'amplitude',
121 'macroseismic',
122 'rupture start',
123 'rupture end']
126class MTInversionType(StringChoice):
127 '''
128 Type of moment tensor inversion.
130 Users should avoid to give contradictory information in
131 :py:class:`MTInversionType` and :py:gattr:`MomentTensor.method_id`.
132 '''
133 choices = ['general', 'zero trace', 'double couple']
136class EvaluationMode(StringChoice):
137 '''
138 Mode of an evaluation.
140 Used in :py:class:`Pick`, :py:class:`Amplitude`, :py:class:`Magnitude`,
141 :py:class:`Origin`, :py:class:`FocalMechanism`.
142 '''
143 choices = ['manual', 'automatic']
146class EvaluationStatus(StringChoice):
147 '''
148 Status of an evaluation.
150 Used in :py:class:`Pick`, :py:class:`Amplitude`, :py:class:`Magnitude`,
151 :py:class:`Origin`, :py:class:`FocalMechanism`.
152 '''
153 choices = ['preliminary', 'confirmed', 'reviewed', 'final', 'rejected']
156class PickOnset(StringChoice):
157 '''
158 Flag that roughly categorizes the sharpness of the onset.
159 '''
160 choices = ['emergent', 'impulsive', 'questionable']
163class EventType(StringChoice):
164 '''
165 Describes the type of an event.
166 '''
167 choices = [
168 'not existing',
169 'not reported',
170 'earthquake',
171 'anthropogenic event',
172 'collapse',
173 'cavity collapse',
174 'mine collapse',
175 'building collapse',
176 'explosion',
177 'accidental explosion',
178 'chemical explosion',
179 'controlled explosion',
180 'experimental explosion',
181 'industrial explosion',
182 'mining explosion',
183 'quarry blast',
184 'road cut',
185 'blasting levee',
186 'nuclear explosion',
187 'induced or triggered event',
188 'rock burst',
189 'reservoir loading',
190 'fluid injection',
191 'fluid extraction',
192 'crash',
193 'plane crash',
194 'train crash',
195 'boat crash',
196 'other event',
197 'atmospheric event',
198 'sonic boom',
199 'sonic blast',
200 'acoustic noise',
201 'thunder',
202 'avalanche',
203 'snow avalanche',
204 'debris avalanche',
205 'hydroacoustic event',
206 'ice quake',
207 'slide',
208 'landslide',
209 'rockslide',
210 'meteorite',
211 'volcanic eruption',
212 'duplicate earthquake',
213 'rockburst']
216class DataUsedWaveType(StringChoice):
217 '''
218 Type of waveform data.
219 '''
220 choices = [
221 'P waves',
222 'body waves',
223 'surface waves',
224 'mantle waves',
225 'combined',
226 'unknown']
229class AmplitudeUnit(StringChoice):
230 '''
231 Provides the most likely measurement units.
233 The measurement units for physical quantity are described in the
234 :py:gattr:`Amplitude.generic_amplitude` attribute. Possible values are
235 specified as combination of SI base units.
236 '''
237 choices = ['m', 's', 'm/s', 'm/(s*s)', 'm*s', 'dimensionless', 'other']
240class EventDescriptionType(StringChoice):
241 '''
242 Category of earthquake description.
243 '''
244 choices = [
245 'felt report',
246 'Flinn-Engdahl region',
247 'local time',
248 'tectonic summary',
249 'nearest cities',
250 'earthquake name',
251 'region name']
254class MomentTensorCategory(StringChoice):
255 '''
256 Category of moment tensor inversion.
257 '''
258 choices = ['teleseismic', 'regional']
261class EventTypeCertainty(StringChoice):
262 '''
263 Denotes how certain the information on event type is.
264 '''
265 choices = ['known', 'suspected']
268class SourceTimeFunctionType(StringChoice):
269 '''
270 Type of source time function.
271 '''
272 choices = ['box car', 'triangle', 'trapezoid', 'unknown']
275class PickPolarity(StringChoice):
276 choices = list(polarity_choices.keys())
279class AgencyID(String):
280 pass
283class Author(Unicode):
284 pass
287class Version(String):
288 pass
291class Phase(Object):
292 value = String.T(xmlstyle='content')
295class GroundTruthLevel(String):
296 pass
299class AnonymousNetworkCode(String):
300 pass
303class AnonymousStationCode(String):
304 pass
307class AnonymousChannelCode(String):
308 pass
311class AnonymousLocationCode(String):
312 pass
315class Type(String):
316 pass
319class MagnitudeHint(String):
320 pass
323class Region(Unicode):
324 pass
327class RealQuantity(Object):
328 value = Float.T()
329 uncertainty = Float.T(optional=True)
330 lower_uncertainty = Float.T(optional=True)
331 upper_uncertainty = Float.T(optional=True)
332 confidence_level = Float.T(optional=True)
335class IntegerQuantity(Object):
336 value = Int.T()
337 uncertainty = Int.T(optional=True)
338 lower_uncertainty = Int.T(optional=True)
339 upper_uncertainty = Int.T(optional=True)
340 confidence_level = Float.T(optional=True)
343class ConfidenceEllipsoid(Object):
344 '''
345 Representation of the location uncertainty as a confidence ellipsoid with
346 arbitrary orientation in space.
347 '''
348 semi_major_axis_length = Float.T()
349 semi_minor_axis_length = Float.T()
350 semi_intermediate_axis_length = Float.T()
351 major_axis_plunge = Float.T()
352 major_axis_azimuth = Float.T()
353 major_axis_rotation = Float.T()
356class TimeQuantity(Object):
357 '''
358 Representation of a point in time.
360 It's given in ISO 8601 format, with optional symmetric or asymmetric
361 uncertainties given in seconds. The time has to be specified in UTC.
362 '''
363 value = Timestamp.T()
364 uncertainty = Float.T(optional=True)
365 lower_uncertainty = Float.T(optional=True)
366 upper_uncertainty = Float.T(optional=True)
367 confidence_level = Float.T(optional=True)
370class TimeWindow(Object):
371 '''
372 Representation of a time window for amplitude measurements.
374 Which is given by a central point in time, and points in time before and
375 after this central point. Both points before and after may coincide with
376 the central point.
377 '''
378 begin = Float.T()
379 end = Float.T()
380 reference = Timestamp.T()
383class ResourceReference(ResourceIdentifier):
384 '''
385 This type is used to refer to QuakeML resources as described in Sect. 3.1
386 in the `QuakeML manual <https://quake.ethz.ch/quakeml/docs/REC?action=Att\
387 achFile&do=get&target=QuakeML-BED-20130214b.pdf>`_.
388 '''
389 pass
392class DataUsed(Object):
393 '''
394 Description of the type of data used in a moment-tensor inversion.
395 '''
396 wave_type = DataUsedWaveType.T()
397 station_count = Int.T(optional=True)
398 component_count = Int.T(optional=True)
399 shortest_period = Float.T(optional=True)
400 longest_period = Float.T(optional=True)
403class EventDescription(Object):
404 '''
405 Free-form string with additional event description.
407 This can be a well-known name, like 1906 San Francisco Earthquake.
408 A number of categories can be given in :py:gattr:`type`.
409 '''
410 text = Unicode.T()
411 type = EventDescriptionType.T(optional=True)
414class SourceTimeFunction(Object):
415 '''
416 Source time function used in moment-tensor inversion.
417 '''
418 type = SourceTimeFunctionType.T()
419 duration = Float.T()
420 rise_time = Float.T(optional=True)
421 decay_time = Float.T(optional=True)
424class OriginQuality(Object):
425 '''
426 Description of an origin's quality.
428 It contains various attributes commonly used to describe the
429 quality of an origin, e. g., errors, azimuthal coverage, etc.
430 :py:class:`Origin` objects have an optional attribute of the type
431 :py:gattr:`OriginQuality`.
432 '''
433 associated_phase_count = Int.T(optional=True)
434 used_phase_count = Int.T(optional=True)
435 associated_station_count = Int.T(optional=True)
436 used_station_count = Int.T(optional=True)
437 depth_phase_count = Int.T(optional=True)
438 standard_error = Float.T(optional=True)
439 azimuthal_gap = Float.T(optional=True)
440 secondary_azimuthal_gap = Float.T(optional=True)
441 ground_truth_level = GroundTruthLevel.T(optional=True)
442 maximum_distance = Float.T(optional=True)
443 minimum_distance = Float.T(optional=True)
444 median_distance = Float.T(optional=True)
447class Axis(Object):
448 '''
449 Representation of an eigenvector of a moment tensor.
451 Which is expressed in its principal-axes system and uses the angles
452 :py:gattr:`azimuth`, :py:gattr:`plunge`, and the eigenvalue
453 :py:gattr:`length`.
454 '''
455 azimuth = RealQuantity.T()
456 plunge = RealQuantity.T()
457 length = RealQuantity.T()
460class Tensor(Object):
461 '''
462 Representation of the six independent moment-tensor elements in spherical
463 coordinates.
465 These are the moment-tensor elements Mrr, Mtt, Mpp, Mrt, Mrp, Mtp in the
466 spherical coordinate system defined by local upward vertical (r),
467 North-South (t), and West-East (p) directions.
468 '''
469 mrr = RealQuantity.T(xmltagname='Mrr')
470 mtt = RealQuantity.T(xmltagname='Mtt')
471 mpp = RealQuantity.T(xmltagname='Mpp')
472 mrt = RealQuantity.T(xmltagname='Mrt')
473 mrp = RealQuantity.T(xmltagname='Mrp')
474 mtp = RealQuantity.T(xmltagname='Mtp')
477class NodalPlane(Object):
478 '''
479 Description of a nodal plane of a focal mechanism.
480 '''
481 strike = RealQuantity.T()
482 dip = RealQuantity.T()
483 rake = RealQuantity.T()
486class CompositeTime(Object):
487 '''
488 Representation of a time instant.
490 If the specification is given with no greater accuracy than days (i.e., no
491 time components are given), the date refers to local time. However, if
492 time components are given, they have to refer to UTC.
493 '''
494 year = IntegerQuantity.T(optional=True)
495 month = IntegerQuantity.T(optional=True)
496 day = IntegerQuantity.T(optional=True)
497 hour = IntegerQuantity.T(optional=True)
498 minute = IntegerQuantity.T(optional=True)
499 second = RealQuantity.T(optional=True)
502class OriginUncertainty(Object):
503 '''
504 Description of the location uncertainties of an origin.
506 The uncertainty can be described either as a simple circular horizontal
507 uncertainty, an uncertainty ellipse according to IMS1.0, or a confidence
508 ellipsoid. If multiple uncertainty models are given, the preferred variant
509 can be specified in the attribute :py:gattr:`preferred_description`.
510 '''
511 horizontal_uncertainty = Float.T(optional=True)
512 min_horizontal_uncertainty = Float.T(optional=True)
513 max_horizontal_uncertainty = Float.T(optional=True)
514 azimuth_max_horizontal_uncertainty = Float.T(optional=True)
515 confidence_ellipsoid = ConfidenceEllipsoid.T(optional=True)
516 preferred_description = OriginUncertaintyDescription.T(optional=True)
517 confidence_level = Float.T(optional=True)
520class ResourceReferenceOptional(StringUnion):
521 members = [ResourceReference.T(), WhitespaceOrEmptyStringType.T()]
524class CreationInfo(Object):
525 '''
526 Description of creation metadata (author, version, and creation time) of a
527 resource.
528 '''
529 agency_id = AgencyID.T(optional=True, xmltagname='agencyID')
530 agency_uri = ResourceReference.T(optional=True, xmltagname='agencyURI')
531 author = Author.T(optional=True)
532 author_uri = ResourceReference.T(optional=True, xmltagname='authorURI')
533 creation_time = Timestamp.T(optional=True)
534 version = Version.T(optional=True)
537class StationMagnitudeContribution(Object):
538 '''
539 Description of the weighting of magnitude values from several
540 :py:class:`StationMagnitude` objects for computing a network magnitude
541 estimation.
542 '''
543 station_magnitude_id = ResourceReference.T(xmltagname='stationMagnitudeID')
544 residual = Float.T(optional=True)
545 weight = Float.T(optional=True)
548class PrincipalAxes(Object):
549 '''
550 Representation of the principal axes of a moment tensor.
552 :py:gattr:`t_axis` and :py:gattr:`p_axis` are required, while
553 :py:gattr:`n_axis` is optional.
554 '''
555 t_axis = Axis.T()
556 p_axis = Axis.T()
557 n_axis = Axis.T(optional=True)
560class NodalPlanes(Object):
561 '''
562 Representation of the nodal planes of a moment tensor.
564 The attribute :py:gattr:`preferred_plane` can be used to define which plane
565 is the preferred one.
566 '''
567 preferred_plane = Int.T(optional=True, xmlstyle='attribute')
568 nodal_plane1 = NodalPlane.T(optional=True)
569 nodal_plane2 = NodalPlane.T(optional=True)
572class WaveformStreamID(Object):
573 '''
574 Reference to a stream description in an inventory.
576 This is mostly equivalent to the combination of networkCode, stationCode,
577 locationCode, and channelCode. However, additional information, e.g.,
578 sampling rate, can be referenced by the resourceURI. It is recommended to
579 use resourceURI as a flexible, abstract, and unique stream ID that allows
580 to describe different processing levels, or resampled/filtered products of
581 the same initial stream, without violating the intrinsic meaning of the
582 legacy identifiers (:py:gattr:`network_code`, :py:gattr:`station_code`,
583 :py:gattr:`channel_code`, and :py:gattr:`location_code`). However, for
584 operation in the context of legacy systems, the classical identifier
585 components are supported.
586 '''
587 value = ResourceReferenceOptional.T(xmlstyle='content')
588 network_code = AnonymousNetworkCode.T(xmlstyle='attribute')
589 station_code = AnonymousStationCode.T(xmlstyle='attribute')
590 channel_code = AnonymousChannelCode.T(default='', xmlstyle='attribute')
591 location_code = AnonymousLocationCode.T(default='', xmlstyle='attribute')
593 @property
594 def nslc_id(self):
595 return (self.network_code, self.station_code, self.location_code,
596 self.channel_code)
599class Comment(Object):
600 '''
601 Comment to a resource together with author and creation time information.
602 '''
603 id = ResourceReference.T(optional=True, xmlstyle='attribute')
604 text = Unicode.T()
605 creation_info = CreationInfo.T(optional=True)
608class MomentTensor(Object):
609 '''
610 Representation of a moment tensor solution for an event.
612 It is an optional part of a :py:class:`FocalMechanism` description.
613 '''
614 public_id = ResourceReference.T(
615 xmlstyle='attribute', xmltagname='publicID')
616 data_used_list = List.T(DataUsed.T())
617 comment_list = List.T(Comment.T())
618 derived_origin_id = ResourceReference.T(
619 optional=True, xmltagname='derivedOriginID')
620 moment_magnitude_id = ResourceReference.T(
621 optional=True, xmltagname='momentMagnitudeID')
622 scalar_moment = RealQuantity.T(optional=True)
623 tensor = Tensor.T(optional=True)
624 variance = Float.T(optional=True)
625 variance_reduction = Float.T(optional=True)
626 double_couple = Float.T(optional=True)
627 clvd = Float.T(optional=True)
628 iso = Float.T(optional=True)
629 greens_function_id = ResourceReference.T(
630 optional=True, xmltagname='greensFunctionID')
631 filter_id = ResourceReference.T(optional=True, xmltagname='filterID')
632 source_time_function = SourceTimeFunction.T(optional=True)
633 method_id = ResourceReference.T(optional=True, xmltagname='methodID')
634 category = MomentTensorCategory.T(optional=True)
635 inversion_type = MTInversionType.T(optional=True)
636 creation_info = CreationInfo.T(optional=True)
638 def pyrocko_moment_tensor(self):
639 mrr = self.tensor.mrr.value
640 mtt = self.tensor.mtt.value
641 mpp = self.tensor.mpp.value
642 mrt = self.tensor.mrt.value
643 mrp = self.tensor.mrp.value
644 mtp = self.tensor.mtp.value
645 mt = moment_tensor.MomentTensor(m_up_south_east=num.array([
646 [mrr, mrt, mrp], [mrt, mtt, mtp], [mrp, mtp, mpp]]))
648 return mt
651class Amplitude(Object):
652 '''
653 Quantification of the waveform anomaly.
655 Usually it consists of a single amplitude measurement or a measurement of
656 the visible signal duration for duration magnitudes.
657 '''
658 public_id = ResourceReference.T(
659 xmlstyle='attribute', xmltagname='publicID')
660 comment_list = List.T(Comment.T())
661 generic_amplitude = RealQuantity.T()
662 type = Type.T(optional=True)
663 category = AmplitudeCategory.T(optional=True)
664 unit = AmplitudeUnit.T(optional=True)
665 method_id = ResourceReference.T(optional=True, xmltagname='methodID')
666 period = RealQuantity.T(optional=True)
667 snr = Float.T(optional=True)
668 time_window = TimeWindow.T(optional=True)
669 pick_id = ResourceReference.T(optional=True, xmltagname='pickID')
670 waveform_id = WaveformStreamID.T(optional=True, xmltagname='waveformID')
671 filter_id = ResourceReference.T(optional=True, xmltagname='filterID')
672 scaling_time = TimeQuantity.T(optional=True)
673 magnitude_hint = MagnitudeHint.T(optional=True)
674 evaluation_mode = EvaluationMode.T(optional=True)
675 evaluation_status = EvaluationStatus.T(optional=True)
676 creation_info = CreationInfo.T(optional=True)
679class Magnitude(Object):
680 '''
681 Description of a magnitude value.
683 It can, but does not need to be associated with an origin. Association
684 with an origin is expressed with the optional attribute
685 :py:gattr:`origin_id`. It is either a combination of different magnitude
686 estimations, or it represents the reported magnitude for the given event.
687 '''
688 public_id = ResourceReference.T(
689 xmlstyle='attribute', xmltagname='publicID')
690 comment_list = List.T(Comment.T())
691 station_magnitude_contribution_list = List.T(
692 StationMagnitudeContribution.T())
693 mag = RealQuantity.T()
694 type = Type.T(optional=True)
695 origin_id = ResourceReference.T(optional=True, xmltagname='originID')
696 method_id = ResourceReference.T(optional=True, xmltagname='methodID')
697 station_count = Int.T(optional=True)
698 azimuthal_gap = Float.T(optional=True)
699 evaluation_mode = EvaluationMode.T(optional=True)
700 evaluation_status = EvaluationStatus.T(optional=True)
701 creation_info = CreationInfo.T(optional=True)
704class StationMagnitude(Object):
705 '''
706 Description of a magnitude derived from a single waveform stream.
707 '''
708 public_id = ResourceReference.T(
709 xmlstyle='attribute', xmltagname='publicID')
710 comment_list = List.T(Comment.T())
711 origin_id = ResourceReference.T(optional=True, xmltagname='originID')
712 mag = RealQuantity.T()
713 type = Type.T(optional=True)
714 amplitude_id = ResourceReference.T(optional=True, xmltagname='amplitudeID')
715 method_id = ResourceReference.T(optional=True, xmltagname='methodID')
716 waveform_id = WaveformStreamID.T(optional=True, xmltagname='waveformID')
717 creation_info = CreationInfo.T(optional=True)
720class Arrival(Object):
721 '''
722 Successful association of a pick with an origin qualifies this pick as an
723 arrival.
725 An arrival thus connects a pick with an origin and provides
726 additional attributes that describe this relationship. Usually
727 qualification of a pick as an arrival for a given origin is a hypothesis,
728 which is based on assumptions about the type of arrival (phase) as well as
729 observed and (on the basis of an earth model) computed arrival times, or
730 the residual, respectively. Additional pick attributes like the horizontal
731 slowness and backazimuth of the observed wave—especially if derived from
732 array data—may further constrain the nature of the arrival.
733 '''
734 public_id = ResourceReference.T(
735 xmlstyle='attribute', xmltagname='publicID')
736 comment_list = List.T(Comment.T())
737 pick_id = ResourceReference.T(xmltagname='pickID')
738 phase = Phase.T()
739 time_correction = Float.T(optional=True)
740 azimuth = Float.T(optional=True)
741 distance = Float.T(optional=True)
742 takeoff_angle = RealQuantity.T(optional=True)
743 time_residual = Float.T(optional=True)
744 horizontal_slowness_residual = Float.T(optional=True)
745 backazimuth_residual = Float.T(optional=True)
746 time_weight = Float.T(optional=True)
747 time_used = Int.T(optional=True)
748 horizontal_slowness_weight = Float.T(optional=True)
749 backazimuth_weight = Float.T(optional=True)
750 earth_model_id = ResourceReference.T(
751 optional=True, xmltagname='earthModelID')
752 creation_info = CreationInfo.T(optional=True)
755class Pick(Object):
756 '''
757 A pick is the observation of an amplitude anomaly in a seismogram at a
758 specific point in time.
760 It is not necessarily related to a seismic event.
761 '''
762 public_id = ResourceReference.T(
763 xmlstyle='attribute', xmltagname='publicID')
764 comment_list = List.T(Comment.T())
765 time = TimeQuantity.T()
766 waveform_id = WaveformStreamID.T(xmltagname='waveformID')
767 filter_id = ResourceReference.T(optional=True, xmltagname='filterID')
768 method_id = ResourceReference.T(optional=True, xmltagname='methodID')
769 horizontal_slowness = RealQuantity.T(optional=True)
770 backazimuth = RealQuantity.T(optional=True)
771 slowness_method_id = ResourceReference.T(
772 optional=True, xmltagname='slownessMethodID')
773 onset = PickOnset.T(optional=True)
774 phase_hint = Phase.T(optional=True)
775 polarity = PickPolarity.T(optional=True)
776 evaluation_mode = EvaluationMode.T(optional=True)
777 evaluation_status = EvaluationStatus.T(optional=True)
778 creation_info = CreationInfo.T(optional=True)
780 @property
781 def pyrocko_polarity(self):
782 return polarity_choices.get(self.polarity, None)
784 def get_pyrocko_phase_marker(self, event=None):
785 if not self.phase_hint:
786 logger.warning('Pick %s: phase_hint undefined' % self.public_id)
787 phasename = 'undefined'
788 else:
789 phasename = self.phase_hint.value
791 return marker.PhaseMarker(
792 event=event, nslc_ids=[self.waveform_id.nslc_id],
793 tmin=self.time.value, tmax=self.time.value,
794 phasename=phasename,
795 polarity=self.pyrocko_polarity,
796 automatic=self.evaluation_mode)
799class FocalMechanism(Object):
800 '''
801 Description of the focal mechanism of an event.
803 It includes different descriptions like nodal planes, principal axes, and
804 a moment tensor. The moment tensor description is provided by objects of
805 the class :py:class:`MomentTensor` which can be specified as
806 child elements of :py:class:`FocalMechanism`.
807 '''
808 public_id = ResourceReference.T(
809 xmlstyle='attribute', xmltagname='publicID')
810 waveform_id_list = List.T(WaveformStreamID.T(xmltagname='waveformID'))
811 comment_list = List.T(Comment.T())
812 moment_tensor_list = List.T(MomentTensor.T())
813 triggering_origin_id = ResourceReference.T(
814 optional=True, xmltagname='triggeringOriginID')
815 nodal_planes = NodalPlanes.T(optional=True)
816 principal_axes = PrincipalAxes.T(optional=True)
817 azimuthal_gap = Float.T(optional=True)
818 station_polarity_count = Int.T(optional=True)
819 misfit = Float.T(optional=True)
820 station_distribution_ratio = Float.T(optional=True)
821 method_id = ResourceReference.T(optional=True, xmltagname='methodID')
822 evaluation_mode = EvaluationMode.T(optional=True)
823 evaluation_status = EvaluationStatus.T(optional=True)
824 creation_info = CreationInfo.T(optional=True)
827class Origin(Object):
828 '''
829 Representation of the focal time and geographical location of an earthquake
830 hypocenter, as well as additional meta-information.
832 :py:class:`Origin` can have objects of type :py:class:`OriginUncertainty`
833 and :py:class:`Arrival` as child elements.
834 '''
835 public_id = ResourceReference.T(
836 xmlstyle='attribute', xmltagname='publicID')
837 composite_time_list = List.T(CompositeTime.T())
838 comment_list = List.T(Comment.T())
839 origin_uncertainty_list = List.T(OriginUncertainty.T())
840 arrival_list = List.T(Arrival.T())
841 time = TimeQuantity.T()
842 longitude = RealQuantity.T()
843 latitude = RealQuantity.T()
844 depth = RealQuantity.T(optional=True)
845 depth_type = OriginDepthType.T(optional=True)
846 time_fixed = Bool.T(optional=True)
847 epicenter_fixed = Bool.T(optional=True)
848 reference_system_id = ResourceReference.T(
849 optional=True, xmltagname='referenceSystemID')
850 method_id = ResourceReference.T(optional=True, xmltagname='methodID')
851 earth_model_id = ResourceReference.T(
852 optional=True, xmltagname='earthModelID')
853 quality = OriginQuality.T(optional=True)
854 type = OriginType.T(optional=True)
855 region = Region.T(optional=True)
856 evaluation_mode = EvaluationMode.T(optional=True)
857 evaluation_status = EvaluationStatus.T(optional=True)
858 creation_info = CreationInfo.T(optional=True)
860 def position_values(self):
861 lat = self.latitude.value
862 lon = self.longitude.value
863 if not self.depth:
864 logger.warning(
865 'Origin %s: Depth is undefined. Set to depth=0.' %
866 self.public_id)
867 depth = 0.
868 else:
869 depth = self.depth.value
871 return lat, lon, depth
873 def get_pyrocko_event(self):
874 lat, lon, depth = self.position_values()
875 otime = self.time.value
876 if self.creation_info:
877 cat = self.creation_info.agency_id
878 else:
879 cat = None
881 return event.Event(
882 name=self.public_id,
883 lat=lat,
884 lon=lon,
885 time=otime,
886 depth=depth,
887 catalog=cat,
888 region=self.region)
891class Event(Object):
892 '''
893 Representation of a seismic event.
895 The Event does not necessarily need to be a tectonic earthquake. An event
896 is usually associated with one or more origins, which contain information
897 about focal time and geographical location of the event. Multiple origins
898 can cover automatic and manual locations, a set of location from different
899 agencies, locations generated with different location programs and earth
900 models, etc. Furthermore, an event is usually associated with one or more
901 magnitudes, and with one or more focal mechanism determinations. In
902 standard QuakeML-BED, :py:class:`Origin`, :py:class:`Magnitude`,
903 :py:class:`StationMagnitude`, and :py:class:`FocalMechanism` are child
904 elements of Event. In BED-RT all these elements are on the same hierarchy
905 level as child elements of :py:class:`EventParameters`. The association of
906 origins, magnitudes, and focal mechanisms to a particular event is
907 expressed using references inside :py:class:`Event`.
908 '''
909 public_id = ResourceReference.T(
910 xmlstyle='attribute', xmltagname='publicID')
911 description_list = List.T(EventDescription.T())
912 comment_list = List.T(Comment.T())
913 focal_mechanism_list = List.T(FocalMechanism.T())
914 amplitude_list = List.T(Amplitude.T())
915 magnitude_list = List.T(Magnitude.T())
916 station_magnitude_list = List.T(StationMagnitude.T())
917 origin_list = List.T(Origin.T())
918 pick_list = List.T(Pick.T())
919 preferred_origin_id = ResourceReference.T(
920 optional=True, xmltagname='preferredOriginID')
921 preferred_magnitude_id = ResourceReference.T(
922 optional=True, xmltagname='preferredMagnitudeID')
923 preferred_focal_mechanism_id = ResourceReference.T(
924 optional=True, xmltagname='preferredFocalMechanismID')
925 type = EventType.T(
926 optional=True)
927 type_certainty = EventTypeCertainty.T(
928 optional=True)
929 creation_info = CreationInfo.T(
930 optional=True)
931 region = Region.T(
932 optional=True)
934 def describe(self):
935 return '''%s:
936 origins: %i %s
937 magnitudes: %i %s
938 focal_machanisms: %i %s
939 picks: %i
940 amplitudes: %i
941 station_magnitudes: %i''' % (
942 self.public_id,
943 len(self.origin_list),
944 '@' if self.preferred_origin_id else '-',
945 len(self.magnitude_list),
946 '@' if self.preferred_magnitude_id else '-',
947 len(self.focal_mechanism_list),
948 '@' if self.preferred_focal_mechanism_id else '-',
949 len(self.pick_list),
950 len(self.amplitude_list),
951 len(self.station_magnitude_list))
953 def get_pyrocko_phase_markers(self):
954 event = self.get_pyrocko_event()
955 return [
956 p.get_pyrocko_phase_marker(event=event) for p in self.pick_list]
958 def get_pyrocko_event(self):
959 '''
960 Convert into Pyrocko event object.
962 Uses *preferred* origin, magnitude, and moment tensor. If no preferred
963 item is specified, it picks the first from the list and emits a
964 warning.
965 '''
967 origin = self.preferred_origin
968 if not origin and self.origin_list:
969 origin = self.origin_list[0]
970 if len(self.origin_list) > 1:
971 logger.warning(
972 'Event %s: No preferred origin set, '
973 'more than one available, using first' % self.public_id)
975 if not origin:
976 raise QuakeMLError(
977 'No origin available for event: %s' % self.public_id)
979 ev = origin.get_pyrocko_event()
981 foc_mech = self.preferred_focal_mechanism
982 if not foc_mech and self.focal_mechanism_list:
983 foc_mech = self.focal_mechanism_list[0]
984 if len(self.focal_mechanism_list) > 1:
985 logger.warning(
986 'Event %s: No preferred focal mechanism set, '
987 'more than one available, using first' % ev.name)
989 if foc_mech and foc_mech.moment_tensor_list:
990 ev.moment_tensor = \
991 foc_mech.moment_tensor_list[0].pyrocko_moment_tensor()
993 if len(foc_mech.moment_tensor_list) > 1:
994 logger.warning(
995 'more than one moment tensor available, using first')
997 mag = None
998 pref_mag = self.preferred_magnitude
999 if pref_mag:
1000 mag = pref_mag
1001 elif self.magnitude_list:
1002 mag = self.magnitude_list[0]
1003 if len(self.magnitude_list) > 1:
1004 logger.warning(
1005 'Event %s: No preferred magnitude set, '
1006 'more than one available, using first' % ev.name)
1008 if mag:
1009 ev.magnitude = mag.mag.value
1010 ev.magnitude_type = mag.type
1012 ev.region = self.get_effective_region()
1014 return ev
1016 def get_effective_region(self):
1017 if self.region:
1018 return self.region
1020 for desc in self.description_list:
1021 if desc.type in ('Flinn-Engdahl region', 'region name'):
1022 return desc.text
1024 return None
1026 @property
1027 def preferred_origin(self):
1028 return one_element_or_none(
1029 [x for x in self.origin_list
1030 if x.public_id == self.preferred_origin_id])
1032 @property
1033 def preferred_magnitude(self):
1034 return one_element_or_none(
1035 [x for x in self.magnitude_list
1036 if x.public_id == self.preferred_magnitude_id])
1038 @property
1039 def preferred_focal_mechanism(self):
1040 return one_element_or_none(
1041 [x for x in self.focal_mechanism_list
1042 if x.public_id == self.preferred_focal_mechanism_id])
1045class EventParameters(Object):
1046 '''
1047 In the bulletin-type (non real-time) model, this class serves as a
1048 container for Event objects.
1050 In the real-time version, it can hold objects of type :py:class:`Event`,
1051 :py:class:`Origin`, :py:class:`Magnitude`, :py:class:`StationMagnitude`,
1052 :py:class:`FocalMechanism`, Reading, :py:class:`Amplitude` and
1053 :py:class:`Pick` (real-time mode is not covered by this module at the
1054 moment).
1055 '''
1056 public_id = ResourceReference.T(
1057 xmlstyle='attribute', xmltagname='publicID')
1058 comment_list = List.T(Comment.T())
1059 event_list = List.T(Event.T(xmltagname='event'))
1060 description = Unicode.T(optional=True)
1061 creation_info = CreationInfo.T(optional=True)
1064class QuakeML(Object):
1065 '''
1066 QuakeML data container.
1067 '''
1068 xmltagname = 'quakeml'
1069 xmlns = 'http://quakeml.org/xmlns/quakeml/1.2'
1070 guessable_xmlns = [xmlns, guts_xmlns]
1072 event_parameters = EventParameters.T(optional=True)
1074 def get_events(self):
1075 return self.event_parameters.event_list
1077 def get_pyrocko_events(self):
1078 '''
1079 Get event information in Pyrocko's basic event format.
1081 :rtype:
1082 List of :py:class:`pyrocko.model.event.Event` objects.
1083 '''
1084 events = []
1085 for e in self.event_parameters.event_list:
1086 events.append(e.get_pyrocko_event())
1088 return events
1090 def get_pyrocko_phase_markers(self):
1091 '''
1092 Get pick information in Pyrocko's basic marker format.
1094 :rtype:
1095 List of :py:class:`pyrocko.gui.snuffler.marker.PhaseMarker`
1096 objects.
1097 '''
1098 markers = []
1099 for e in self.event_parameters.event_list:
1100 markers.extend(e.get_pyrocko_phase_markers())
1102 return markers
1104 @classmethod
1105 def load_xml(cls, stream=None, filename=None, string=None):
1106 '''
1107 Load QuakeML data from stream, file or string.
1109 :param stream:
1110 Stream open for reading in binary mode.
1111 :type stream:
1112 *file-like object*
1114 :param filename:
1115 Path to file to be opened for reading.
1116 :type filename:
1117 str
1119 :param string:
1120 String with QuakeML data to be deserialized.
1121 :type string:
1122 str
1124 The arguments ``stream``, ``filename``, and ``string`` are mutually
1125 exclusive.
1127 :returns:
1128 Parsed QuakeML data structure.
1129 :rtype:
1130 :py:class:`QuakeML` object
1132 '''
1134 return super(QuakeML, cls).load_xml(
1135 stream=stream,
1136 filename=filename,
1137 string=string,
1138 ns_hints=[
1139 'http://quakeml.org/xmlns/quakeml/1.2',
1140 'http://quakeml.org/xmlns/bed/1.2'],
1141 ns_ignore=True)