Skip to content
This repository has been archived by the owner on Sep 9, 2022. It is now read-only.

Data exchange formats to communicate seismic event detection information

License

Notifications You must be signed in to change notification settings

usgs/earthquake-detection-formats

Repository files navigation

THIS PROJECT HAS BEEN ARCHIVED

Please see [https://code.usgs.gov/ghsc/neic/utilities/earthquake-detection-formats)

Detection Formats

Build Status codecov

The US Geological Survey (USGS) National Earthquake Information Center (NEIC) defines a number of data exchange formats to communicate seismic event detection information between processing systems. These formats are defined using objects as defined in the JSON standard.

License

The purpose of this project is to:

  1. Define formats to hold data representing the estimates of various types of seismic event detections.
  2. Store the format definitions in a source controlled manner.
  3. Host libraries used to generate and parse the formats

Defined formats:

  • Pick Format - A format for unassociated picks from a waveform arrival time picking algorithm.
  • Correlation Format - A format to contain a seismic event detection made using a cross correlation algorithm.
  • Detection Format - A format to contain a seismic event detection generated using an event detection or association algorithm.
  • Retract Format - A format to contain a seismic event retraction made using an event detection algorithm.
  • StationInfo Format - A format to contain basic station location and quality information.
  • StationInfoRequest Format - A format for requesting basic station location and quality information.

Supporting objects:

  • Hypocenter Object - An object that contains information about a hypocenter as part of a detection.
  • Amplitude Object - An object that contains information about an amplitude as part of a pick.
  • Beam Object - An object that contains information about a waveform beam as part of a pick.
  • Associated Object - An object that contains associated information if a pick or correlation is included in a detection.
  • Filter Object - An object that contains filter information as part of a pick.
  • Site Object - An object that defines the station used to create a pick, correlation, or station.
  • Source Object - An object that defines the creator/source of a pick, correlation, or detection.

Supported Languages:

Currently a library written in C++11, a Java 1.7 jar file, and a Python 3.6 implementation exist to generate and parse these formats.

Getting Started

C++11 library

Java 1.7 jar

Python 3.6