pyrocko.io.quakeml¶

QuakeML 1.2 input, output, and data model.

This modules provides support to read and write QuakeML version 1.2. It defines a hierarchy of Python objects, closely following the QuakeML data model.

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. It covers basic seismic event description, including moment tensors.

For convenience and ease of use, this documentation contains excerpts from the QuakeML Manual. However, this information is not intended to be complete. Please refer to the QuakeML Manual for details.

Classes

`AgencyID`(...)	Undocumented.
`Amplitude`(**kwargs)	Quantification of the waveform anomaly.
`AmplitudeCategory`(...)	Description of the way the waveform trace is evaluated to get an amplitude value.
`AmplitudeUnit`(...)	Provides the most likely measurement units.
`AnonymousChannelCode`(...)	Undocumented.
`AnonymousLocationCode`(...)	Undocumented.
`AnonymousNetworkCode`(...)	Undocumented.
`AnonymousStationCode`(...)	Undocumented.
`Arrival`(**kwargs)	Successful association of a pick with an origin qualifies this pick as an arrival.
`Author`(...)	Undocumented.
`Axis`(**kwargs)	Representation of an eigenvector of a moment tensor.
`Comment`(**kwargs)	Comment to a resource together with author and creation time information.
`CompositeTime`(**kwargs)	Representation of a time instant.
`ConfidenceEllipsoid`(**kwargs)	Representation of the location uncertainty as a confidence ellipsoid with arbitrary orientation in space.
`CreationInfo`(**kwargs)	Description of creation metadata (author, version, and creation time) of a resource.
`DataUsed`(**kwargs)	Description of the type of data used in a moment-tensor inversion.
`DataUsedWaveType`(...)	Type of waveform data.
`EvaluationMode`(...)	Mode of an evaluation.
`EvaluationStatus`(...)	Status of an evaluation.
`Event`(**kwargs)	Representation of a seismic event.
`EventDescription`(**kwargs)	Free-form string with additional event description.
`EventDescriptionType`(...)	Category of earthquake description.
`EventParameters`(**kwargs)	In the bulletin-type (non real-time) model, this class serves as a container for Event objects.
`EventType`(...)	Describes the type of an event.
`EventTypeCertainty`(...)	Denotes how certain the information on event type is.
`FocalMechanism`(**kwargs)	Description of the focal mechanism of an event.
`GroundTruthLevel`(...)	Undocumented.
`IntegerQuantity`(**kwargs)	Undocumented.
`MTInversionType`(...)	Type of moment tensor inversion.
`Magnitude`(**kwargs)	Description of a magnitude value.
`MagnitudeHint`(...)	Undocumented.
`MomentTensor`(**kwargs)	Representation of a moment tensor solution for an event.
`MomentTensorCategory`(...)	Category of moment tensor inversion.
`NodalPlane`(**kwargs)	Description of a nodal plane of a focal mechanism.
`NodalPlanes`(**kwargs)	Representation of the nodal planes of a moment tensor.
`Origin`(**kwargs)	Representation of the focal time and geographical location of an earthquake hypocenter, as well as additional meta-information.
`OriginDepthType`(...)	Type of depth determination.
`OriginQuality`(**kwargs)	Description of an origin's quality.
`OriginType`(...)	Describes the origin type.
`OriginUncertainty`(**kwargs)	Description of the location uncertainties of an origin.
`OriginUncertaintyDescription`(...)	Preferred uncertainty description.
`Phase`(**kwargs)	Undocumented.
`Pick`(**kwargs)	A pick is the observation of an amplitude anomaly in a seismogram at a specific point in time.
`PickOnset`(...)	Flag that roughly categorizes the sharpness of the onset.
`PickPolarity`(...)	Any `str` out of `['positive', 'negative', 'undecidable']`.
`PrincipalAxes`(**kwargs)	Representation of the principal axes of a moment tensor.
`QuakeML`(**kwargs)	QuakeML data container.
`RealQuantity`(**kwargs)	Undocumented.
`Region`(...)	Undocumented.
`ResourceIdentifier`(...)	Identifies resource origin.
`ResourceReference`(...)	This type is used to refer to QuakeML resources as described in Sect.
`ResourceReferenceOptional`(...)	Undocumented.
`SourceTimeFunction`(**kwargs)	Source time function used in moment-tensor inversion.
`SourceTimeFunctionType`(...)	Type of source time function.
`StationMagnitude`(**kwargs)	Description of a magnitude derived from a single waveform stream.
`StationMagnitudeContribution`(**kwargs)	Description of the weighting of magnitude values from several `StationMagnitude` objects for computing a network magnitude estimation.
`Tensor`(**kwargs)	Representation of the six independent moment-tensor elements in spherical coordinates.
`TimeQuantity`(**kwargs)	Representation of a point in time.
`TimeWindow`(**kwargs)	Representation of a time window for amplitude measurements.
`Type`(...)	Undocumented.
`Version`(...)	Undocumented.
`WaveformStreamID`(**kwargs)	Reference to a stream description in an inventory.
`WhitespaceOrEmptyStringType`(...)	Any `str` matching pattern `'^\\s*$'`.

class ResourceIdentifier(...) → str[source]¶

Bases: StringPattern

Identifies resource origin.

They consist of an authority identifier, a unique resource identifier, and an optional local identifier. The URI schema name smi stands for seismological meta-information, thus indicating a connection to a set of metadata associated with the resource.

class WhitespaceOrEmptyStringType(...) → str[source]¶

Bases: StringPattern

Any str matching pattern '^\\s*$'.

class OriginUncertaintyDescription(...) → str[source]¶

Bases: StringChoice

Preferred uncertainty description.

class AmplitudeCategory(...) → str[source]¶

Bases: StringChoice

Description of the way the waveform trace is evaluated to get an amplitude value.

This can be just reading a single value for a given point in time (point), taking a mean value over a time interval (mean), integrating the trace over a time interval (integral), specifying just a time interval (duration), or evaluating a period (period).

class OriginDepthType(...) → str[source]¶

Bases: StringChoice

Type of depth determination.

class OriginType(...) → str[source]¶

Bases: StringChoice

Describes the origin type.

class MTInversionType(...) → str[source]¶

Bases: StringChoice

Type of moment tensor inversion.

Users should avoid to give contradictory information in MTInversionType and MomentTensor.method_id.

class EvaluationMode(...) → str[source]¶

Bases: StringChoice

Mode of an evaluation.

Used in Pick, Amplitude, Magnitude, Origin, FocalMechanism.

class EvaluationStatus(...) → str[source]¶

Bases: StringChoice

Status of an evaluation.

Used in Pick, Amplitude, Magnitude, Origin, FocalMechanism.

class PickOnset(...) → str[source]¶

Bases: StringChoice

Flag that roughly categorizes the sharpness of the onset.

class EventType(...) → str[source]¶

Bases: StringChoice

Describes the type of an event.

class DataUsedWaveType(...) → str[source]¶

Bases: StringChoice

Type of waveform data.

class AmplitudeUnit(...) → str[source]¶

Bases: StringChoice

Provides the most likely measurement units.

The measurement units for physical quantity are described in the Amplitude.generic_amplitude attribute. Possible values are specified as combination of SI base units.

class EventDescriptionType(...) → str[source]¶