anss-formats 0.0.4__tar.gz → 0.1.0__tar.gz

{anss_formats-0.0.4 → anss_formats-0.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anss-formats
-Version: 0.0.4
+Version: 0.1.0
 Summary: Python implementation of the library used to communicate seismic event detection information between systems
 License: CC0-1.0
 Keywords: anss,earthquakes,formats,detection
@@ -24,6 +24,17 @@ Project-URL: Repository, https://gitlab.com/anss-netops/anss-data-formats
 Description-Content-Type: text/markdown
 
 # ANSS Data Formats
+
+This is the Python implementation of the library used to generate and parse the 
+ANSS Formats.
+
+Dependencies
+------
+* ANSS Formats utilizes [JSON](www.json.org) for formatting.
+* ANSS Formats was written in Python 3.6
+* ANSS Formats uses [poetry](https://python-poetry.org/) for
+Package, dependency and environment management.
+
 The US Geological Survey (USGS) Advanced National Seismic System (ANSS) 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](http://www.json.org).
 
 The purpose of this project is to:
@@ -36,18 +47,20 @@ seismic event detections.
 ## Defined formats:
 
 * [Pick](format-docs/Pick.md) Format - A format for unassociated picks from a waveform arrival time picking algorithm.
+* [Detection](format-docs/Detection.md) Format - A format for an earthquake detection picks from a seismic detection algorithm.
 
 ## Supporting format objects:
 
 * [Amplitude](format-docs/Amplitude.md) Object - An object that contains information about an amplitude as part of a pick.
-* [Beam](format-docs/Beam.md) Object  - An object that contains information about a waveform beam as part of a pick.
 * [Associated](format-docs/Associated.md) Object - An object that contains associated information if a pick is included in a detection.
+* [Channel](format-docs/Channel.md) Object - A geoJSON object that contains channel/location information as part of a pick.
+* [EventType](format-docs/EventType.md) Object - An object that defines the event type for MachineLearning info.
 * [Filter](format-docs/Filter.md) Object - An object that contains filter information as part of a pick.
-* [Site](format-docs/Site.md) Object - An object that defines the station used to create a pick.
-* [Source](format-docs/Source.md) Object - An object that defines the creator/source of a pick.
-* [Quality](format-docs/Quality.md) Object - An object that defines the data quality of a pick.
+* [Hypocenter](format-docs/Hypocenter.md) Object - A geoJSON object that contains the hypocentral location, arrival time, and error information as part of a detection.
 * [MachineLearning](format-docs/MachineLearning.md) Object - An object that defines the machine learning information for a pick.
-* [EventType](format-docs/EventType.md) Object - An object that defines the event type for MachineLearning info.
+* [Magnitude](format-docs/Magnitude.md) Object - An object that defines an earthquake magnitude estimation, as part of a Machine Learning classification or earthquake detection.
+* [Quality](format-docs/Quality.md) Object - An object that defines the data quality of a pick.
+* [Source](format-docs/Source.md) Object - An object that defines the creator/source of a pick.
 
 # Amplitude Object Specification
 
@@ -119,99 +132,151 @@ association.
 * residual - A decimal number containing residual in seconds of the data if Association.
 * sigma - A decimal number reflecting the number of standard deviations of the data from the calculated value if Association.
 
-# Beam Object Specification
+# Site Object Specification
 
 ## Description
 
-The Beam object is an object designed to encode waveform beam information
-that may or may not be part of the [Pick](Pick.md) Format.  Beam uses the
-[JSON standard](http://www.json.org).
+The Site object is an object designed to define the seismic station used to
+produce a [Pick](Pick.md) message.  Site uses the [JSON](https://www.json.org) and [GeoJSON](https://geojson.org/) standards.
 
 ## Usage
 
-The Beam object is intended for use as part of the [Pick](Pick.md) Format
-in seismic data messaging between seismic applications and organizations.
+Site is intended for use as part of the [Pick](Pick.md) Format in seismic data messaging between seismic applications and organizations.
 
 ## Output
 
 ```json
-    {
-      "backAzimuth"      : Number,
-      "backAzimuthError" : Number,
-      "slowness"         : Number,
-      "slownessError"    : Number,
-      "powerRatio"       : Number,
-      "powerRatioError"  : Number
-    }
+{
+  "type": "Feature",
+  "geometry": {
+    "type": "Point",
+    "coordinates": [125.6, 10.1]
+  },
+  "properties": {
+    "station"   : String,
+    "channel"   : String,
+    "network"   : String,
+    "location"  : String
+  }
+}
 ```
 
 ## Glossary
 
 **Required Values:**
 
-These are the values **required** to define a beam.
+These are the properties **required** to define a Site.
 
-* backAzimuth - A decimal number containing the back azimuth.
-* slowness - A decimal number containing the horizontal slowness.
+* type - A string indicating the geojson feature type
+* geometry - A geojson point containing the station coordinates in the form [Latitude, Longitude, Elevation (in meters)]
+* properties - The associated properties for this geojson feature
 
-**Optional Values:**
+**Required Properties:**
 
-The following are supplementary values that **may or may not** be provided by
+These geojson feature properties are **required** to define a Site.
+* station - A string the station code.
+* network - A string containing network code.
+
+**Optional Properties:**
+
+The following are supplementary geojson feature properties that **may or may not** be provided by
 various algorithms.
 
-* backAzimuthError - A decimal number containing the back azimuth error.
-* slownessError - A decimal number containing the horizontal slowness error.
-* powerRatio - A decimal number containing the power ratio.
-* powerRatioError - A decimal number containing the power ratio error.
+* channel - A string containing the channel code.
+* location - A string containing the location code.
 
-# Site Object Specification
+# Detection Format Specification
 
 ## Description
 
-The Site object is an object designed to define the seismic station used to
-produce a [Pick](Pick.md) message.  Site uses the [JSON](https://www.json.org) and [GeoJSON](https://geojson.org/) standards.
+Detection is a format designed to encode the basic information of an earthquake
+event Detection.  Detection uses the [JSON standard](http://www.json.org).
 
 ## Usage
 
-Site is intended for use as part of the [Pick](Pick.md) Format in seismic data
-messaging between seismic applications and organizations.
+Detection is intended for use in seismic data messaging between seismic
+applications.
 
 ## Output
 
 ```json
-{
-  "type": "Feature",
-  "geometry": {
-    "type": "Point",
-    "coordinates": [125.6, 10.1]
-  },
-  "properties": {
-    "Station"   : String,
-    "Channel"   : String,
-    "Network"   : String,
-    "Location"  : String
-  }
-}
+    {
+      "type"        : "Detection",
+      "id"          : String,
+      "source"      :
+      {
+         "agencyID" : String,
+         "author"   : String
+      },
+      "hypocenter"  :
+        {
+          "type": "Feature",
+          "geometry": {
+            "type": "Point",
+            "coordinates": [125.6, 10.1, 1589.0]
+        },
+          "properties": {
+            "originTime"      : ISO8601,
+            "latitudeError"   : Number,
+            "longitudeError"  : Number,
+            "depthError"      : Number,
+            "originTimeError" : Number
+        }      
+      },
+      "detectionType"   : String,
+      "detectionTime"   : ISO8601,
+      "eventType" :
+      {
+          "type"      : String,
+          "certainty" : String
+      },
+      "minimumDistance" : Number,
+      "rms"             : Number,
+      "maximumGap"      : Number,
+      "detector"        : String,
+      "pickData"  : [Pick Objects],
+      "magnitudeData" :
+      [ 
+        {
+          "type" : String,
+          "id" : String,
+          "value" : Number,
+          "source" :
+          {
+            "agencyID" : String,
+            "author"   : String
+          },  
+          "error" : Number,
+          "probability" : Number
+        }, ...
+      ]
+    }
 ```
 
 ## Glossary
 
 **Required Values:**
 
-These are the properties **required** to define a Site.
+These are the values **required** to define a detection.
 
-* type - A string indicating the geojson feature type
-* geometry - A geojson point containing the station coordinates in the form [Latitude, Longitude, Elevation (in meters)]
-* station - A string the station code.
-* network - A string containing network code.
+* type - A string that identifies this message as a detection.
+* id - A string containing an unique identifier for this Detection.
+* source - An object containing the source of the Detection, see [Source](Source.md).
+* hypocenter - An object containing the hypocenter of the Detection, see [Hypocenter](Hypocenter.md).
 
 **Optional Values:**
 
-The following are supplementary properties that **may or may not** be provided as
-part of a Site.
+The following are supplementary values that **may or may not** be provided as part of a detection.
 
-* channel - A string containing the channel code.
-* location - A string containing the location code.
+* detectionType - A string that identifies whether the Detection is `New`, `Update`, or `Final`.
+* detectionTime - A string containing the UTC time this detection was made, i.e. how quickly after origin time was this detection created, in the ISO8601 format `YYYY-MM-DDTHH:MM:SS.SSSZ`.
+* eventType - An object containing the event type of the correlation, see [EventType](EventType.md).
+* rms - A decimal number containing the rms estimate for the detction
+* minimumDistance - A decimal number representing the minimum distance to the closest supporting station.
+* maximumGap - A decimal number representing the maximum gap in degrees between supporting stations.
+* detector - A string identifying the detection grid, algorithm, or other information.
+* pickData - An array of [Pick](Pick.md) objects used to generate this Detection.
+* magnitudeData - An array of [Magnitude](Magnitude.md) objects for this Detection.
 
 # EventType Object Specification
 
@@ -287,6 +352,60 @@ The following are values that **may or may not** be provided as part of a filter
 Note: The Type of filter is assumed to be "BandPass", and the Units are assumed
 to be "Hertz"
 
+# Hypocenter Object Specification
+
+## Description
+
+The Hypocenter object is an object designed to define a Hypocenter as part of a [Detection](Detection.md) message.  Hypocenter uses the [JSON standard](http://www.json.org) and [GeoJSON](https://geojson.org/) standards.
+
+
+## Usage
+
+Hypocenter is intended for use as part of the [Detection](Detection.md) Format in seismic data messaging between seismic applications and organizations.
+
+## Output
+
+```json
+    {
+      "type": "Feature",
+      "geometry": {
+        "type": "Point",
+        "coordinates": [125.6, 10.1, 1589.0]
+      },
+      "properties": {
+        "originTime"      : ISO8601,
+        "latitudeError"   : Number,
+        "longitudeError"  : Number,
+        "depthError"      : Number,
+        "originTimeError" : Number
+      }      
+    }
+```
+
+## Glossary
+
+**Required Values:**
+
+These are the values **required** to define a hypocenter.
+* type - A string indicating the geojson feature type, always a point
+* geometry - A geojson point containing the station coordinates in the form [Latitude, Longitude, Depth (in meters)]
+* properties - The associated properties for this geojson feature
+
+**Required Properties:**
+
+These geojson feature properties are **required** to define a hypocenter.
+* originTime - A string containing the UTC origin time of this hypocenter, in the ISO8601 format `YYYY-MM-DDTHH:MM:SS.SSSZ`.
+
+**Optional Properties:**
+
+The following are supplementary geojson feature properties that **may or may not** be provided by
+various algorithms.
+
+* latitudeError - A decimal number that identifies the error of the latitude of this hypocenter in kilometers.
+* longitudeError - A decimal number that identifies the error of the longitude of this hypocenter in kilometers.
+* depthError - A decimal number that identifies the depth error of this hypocenter in kilometers.
+* originTimeError - A decimal number that identifies the error of the origin time in seconds.
+
 # MachineLearning Object Specification
 
 ## Description
@@ -313,9 +432,19 @@ applications and organizations.
         "distanceRangeSigma"       : Number,
         "backAzimuth"              : Number,
         "backAzimuthProbability"   : Number,
-        "magnitude"            : Number,
-        "magnitudeType"        : String,
-        "magnitudeProbability" : Number,
+        "magnitude" :
+        {
+            "type" : String,
+            "id" : String,
+            "value" : Number,
+            "source" :
+            {
+                "agencyID" : String,
+                "author"   : String
+            },  
+            "error" : Number,
+            "probability" : Number
+        }, 
         "depth"                : Number,
         "depthProbability"     : Number,
         "eventType" :
@@ -350,9 +479,7 @@ The following are values that **may or may not** be provided as part of MachineL
 * distanceRangeSigma - A decimal number containing the standard deviation for a probability PDF curve for Distance (e.g. Distance is 15 deg +/- 3 * DistanceRangeSigma where DistanceProbability is modified by the PDF probability, lowering as it gets further from Distance ).  DistanceRangeSigma is mutually exclusive of DistanceRangeHalfWidth, and if both are provided DistanceRangeSigma should be used. 
 * backAzimuth - A decimal number containing a backazimuth estimation in degrees
 * backAzimuthProbability - A decimal number containing the probability of the backazimuth estimation
-* magnitude - A decimal number containing the magnitude estimation
-* magnitudeType - A string that identifies the magnitude type
-* magnitudeProbability - A decimal number containing the probability of the magnitude estimation
+* magnitude - A [Magnitude](Magnitude.md) object containing the machine learning magnitude estimation
 * depth - A decimal number containing a depth estimation in kilometers
 * depthProbability - A decimal number containing the probability of the depth estimation
 * eventType - An object containing the event type, see [EventType](EventType.md).
@@ -363,6 +490,53 @@ The following are values that **may or may not** be provided as part of MachineL
 * repickCredibleIntervalUpper - A decimal number containing the repick shift credible interval upper
 * source - An object containing the source of the MachineLearning, see [Source](Source.md).
 
+# Magnitude Object Specification
+
+## Description
+
+The Magnitude object is an object designed to hold data quality for a [Detection](Detection.md) message.
+Site uses the [JSON standard](http://www.json.org).
+
+## Usage
+
+Magnitude is intended for use as part of the [Detection](Detection.md) Format in seismic data
+messaging between seismic applications and organizations.
+
+## Output
+
+```json
+    {
+      "type" : String,
+      "id" : String,
+      "value" : Number,
+      "source" :
+      {
+         "agencyID" : String,
+         "author"   : String
+      },  
+      "error" : Number,
+      "probability" : Number
+    }
+```
+
+## Glossary
+
+**Required Values:**
+
+These are the values **required** to define a Magnitude
+
+* type - A string containing the name of the magnitude type.
+* value - A decimal number containing numarical value of the magnitude.
+
+**Optional Values:**
+
+The following are supplementary values that **may or may not** be provided as part of a Magnitude.
+
+* id - A string containing an unique identifier for this Magnitude.
+* source - An object containing the source of the Magnitude, see [Source](Source.md).
+* error - A decimal number containing numarical error estimate of the magnitude.
+* probability - A decimal number containing the probability of the magnitude
+
 # Pick Format Specification
 
 ## Description
@@ -417,15 +591,6 @@ applications and organizations.
          "period"    : Number,
          "snr"       : Number
       },
-      "beamInfo" :
-      {
-        "backAzimuth"      : Number,
-        "backAzimuthError" : Number,
-        "slowness"         : Number,
-        "slownessError"    : Number,
-        "powerRatio"       : Number,
-        "powerRatioError"  : Number,
-      },
       "associationInfo" :
       {
          "phase"    : String,
@@ -448,9 +613,19 @@ applications and organizations.
         "distanceRangeSigma"       : Number,
         "backAzimuth"              : Number,
         "backAzimuthProbability"   : Number,
-        "magnitude"            : Number,
-        "magnitudeType"        : String,
-        "magnitudeProbability" : Number,
+        "magnitude" :
+        {
+          "type" : String,
+          "id" : String,
+          "value" : Number,
+          "source" :
+          {
+            "agencyID" : String,
+            "author"   : String
+          },  
+          "error" : Number,
+          "probability" : Number
+        },
         "depth"                : Number,
         "depthProbability"     : Number,
         "eventType" : {
@@ -493,7 +668,6 @@ various picking algorithms.
 * pickerType - A string describing the type of picker; "manual", "raypicker", "filterpicker", "earthworm", or "other".
 * filter - An array of objects containing the filter frequencies when the pick was made, see [Filter](Filter.md).
 * amplitude - An object containing the amplitude associated with the pick, see [Amplitude](Amplitude.md).
-* beam - An object containing the waveform beam information associated with the pick, see [Beam](Beam.md).
 * associationInfo - An object containing the association information if this pick is used as data in a Detection, see [Associated](Associated.md).
 * machineLearningInfo - An object containing the machine learning  information of this pick, see [MachineLearning](MachineLearning.md).
 * qualityInfo - An array of objects containing the containing the quality metric information for this pick, see [Quality](Quality.md).