From d3be460aac3ad960d5cfb180dc322ab68e984bef Mon Sep 17 00:00:00 2001 From: chad-iris Date: Thu, 13 Aug 2020 10:57:18 -0700 Subject: [PATCH] Rename all position field descriptions to subsource. #13 --- background.rst | 9 ++--- channel-codes.rst | 91 ++++++++++++++++++++++++----------------------- definition.rst | 14 ++++---- index.rst | 4 +-- 4 files changed, 62 insertions(+), 56 deletions(-) diff --git a/background.rst b/background.rst index a6a8cbd..7c32059 100644 --- a/background.rst +++ b/background.rst @@ -31,14 +31,15 @@ codes as used in SEED 2.4. - Subdivide the channel code into individually delimited codes, allowing expansion of each: - - channel => “band_source_position”, where: + - channel => “band_source_subsource”, where: - **Band** indicates the general sampling rate and response band of the data source, same meaning as SEED. - **Source** is a code identifying an instrument or other data producer, - called the "instrument" code in SEED. - - **Position** is a code identifying orientation or otherwise relative position, - called the "orientation" code in SEED. + called the `instrument` code in SEED. + - **Subsource** is a code identifying a sub-category within the + source, often the orientation, relative positon, or sensor + type. Called the `orientation` code in SEED. - Single character versions of these individual codes are the same as SEED 2.4 diff --git a/channel-codes.rst b/channel-codes.rst index 719d800..786f8a6 100644 --- a/channel-codes.rst +++ b/channel-codes.rst @@ -6,8 +6,8 @@ Channel codes ============= -Band, source and position codes -------------------------------- +Band, source and subsource codes +-------------------------------- A *channel* is composed of a sequence of three codes that each describe an aspect of the instrumentation and its digitization as @@ -19,17 +19,19 @@ follows: **Source**: Identifies an instrument or other general data source. Cannot be empty. - **Position**: Identifies the orientation or otherwise relative position. - The position codes are specific to sources. May be empty. + **Subsource**: Identifies a sub-category within the source, often + the orientation, relative positon, or sensor type. The meaning of + subsource codes are specific to the containing source. May be + empty. A *channel* is the combination of these three codes separated by "_" -(ASCII 95) in the following pattern: ``band_source_position``, which +(ASCII 95) in the following pattern: ``band_source_subsource``, which forms the end of a source identifier. -For usage of Band codes **A** and **O**, the source and position codes may -be defined by the generator. In these cases, the source and position +For usage of Band codes **A** and **O**, the source and subsource codes may +be defined by the generator. In these cases, the source and subsource codes should not exceed three characters each in length. In all other -cases, source and position codes defined in this specification must be +cases, source and subsource codes defined in this specification must be used. Two sequences are reserved for special channels: **L_O_G** for the console @@ -37,7 +39,7 @@ log and the (deprecated) **S_O_H** for general state of health. .. note:: All *channels* with single-character *band*, *source*, and - *position* codes are equivalent to SEED 2.4 channel designations + *subsource* codes are equivalent to SEED 2.4 channel designations and vice versa. @@ -89,24 +91,25 @@ response band of the instrument (when applicable to the data source). -Source and Position Codes -------------------------- +Source and Subsource Codes +-------------------------- The source code specifies the family to which the sensor belongs or otherwise a general data source. In essence, this identifies what is being measured or simulated. Each of these source types are detailed in this section. -The position code provides a way to indicate the directionality of the -sensor measurement (orientation) or the relative location of the sensor. -Position codes are source-specific. When orthogonal directions are used, -there are traditional orientations of North (N), East (E), and Vertical -(Z), as well as other orientations that can be converted to traditional -ones. These options are detailed with each source type. Only use N or E -for the orientation when it is within 5 degrees of north or east. Use 1 -or 2 when orientations are more than 5 degrees from north or east or to -avoid any assumptions about the orientation and ensure that the metadata -is consulted. +The subsource code provides a way to indicate the directionality of +the sensor measurement (orientation), the relative location of the +sensor or the sensor type. Subsource codes are source-specific. When +orthogonal directions are indicated, there are traditional orientation +values of North (N), East (E), and Vertical (Z), as well as other +orientations that can be converted to traditional ones. These options +are detailed with each source type. Only use ``N`` or ``E`` for the +orientation when it is within 5 degrees of north or east. Use 1 or 2 +when orientations are more than 5 degrees from north or east or to +avoid any assumptions about the orientation and ensure that the +metadata is consulted. Seismometer ^^^^^^^^^^^ @@ -127,7 +130,7 @@ Seismometer **N** Accelerometer ====== ====== - *Position Code* + *Subsource Code* .. table:: :align: left @@ -154,7 +157,7 @@ Tilt Meter **A** - *Position Code* + *Subsource Code* **N**, **E** - Traditional @@ -180,7 +183,7 @@ Creep Meter **B** - *Position Code* + *Subsource Code* None defined @@ -201,7 +204,7 @@ Calibration Input **C** - *Position Code* + *Subsource Code* **A**, **B**, **C**, **D** - For when there are only a few cal sources for many devices. @@ -220,7 +223,7 @@ Pressure **D** - *Position Code* + *Subsource Code* .. table:: :align: left @@ -248,7 +251,7 @@ Electronic Test Point **E** - *Position Code* + *Subsource Code* Designate as desired, make mnemonic as possible, use numbers for test points, etc. @@ -278,7 +281,7 @@ Magnetometer **F** - *Position Code* + *Subsource Code* **Z**, **N**, **E** - Magnetic @@ -296,7 +299,7 @@ Humidity **I** - *Position Code* + *Subsource Code* .. table:: :align: left @@ -324,7 +327,7 @@ Rotational Sensor **J** - High Gain Seismometer - *Position Code* + *Subsource Code* .. table:: :align: left @@ -363,7 +366,7 @@ Temperature **K** - *Position Code* + *Subsource Code* .. table:: :align: left @@ -389,7 +392,7 @@ Water Current **O** - *Position Code* + *Subsource Code* None defined @@ -412,7 +415,7 @@ Geophone **P** - *Position Code* + *Subsource Code* **Z**, **N**, **E** - Traditional @@ -432,7 +435,7 @@ Electric Potential **Q** - *Position Code* + *Subsource Code* None defined @@ -449,7 +452,7 @@ Rainfall **R** - *Position Code* + *Subsource Code* **Z**, **N**, **E** - Traditional @@ -466,7 +469,7 @@ Linear Strain **S** - *Position Code* + *Subsource Code* **Z**, **N**, **E** - Vertical, North-South, East-West @@ -484,7 +487,7 @@ Tide **T** - *Position Code* + *Subsource Code* **Z** - Always vertical @@ -502,7 +505,7 @@ Bolometer **U** - *Position Code* + *Subsource Code* None defined @@ -515,7 +518,7 @@ Volumetric Strain **V** - *Position Code* + *Subsource Code* None defined @@ -533,7 +536,7 @@ Wind **W** - *Position Code* + *Subsource Code* .. table:: :align: left @@ -564,10 +567,10 @@ Derived or generated channel **X** - *Position Code* + *Subsource Code* Similar to the observable data that was modified or the observable - equivalent for generated time series (synthetics). See Position Codes + equivalent for generated time series (synthetics). See subsource codes for the corresponding observed channel. **Further Usage (DEPRECATED)** @@ -596,7 +599,7 @@ Non-specific instruments **Y** - *Position Code* + *Subsource Code* Instrument specific. @@ -619,7 +622,7 @@ Synthesized Beams **Z** - *Position Code* + *Subsource Code* .. table:: :align: left diff --git a/definition.rst b/definition.rst index 9d7a4bb..631f21d 100644 --- a/definition.rst +++ b/definition.rst @@ -7,7 +7,7 @@ Definition of identifiers Data sources are uniquely identified using a sequence of codes named **network**, **station**, **location** and **channel**, where the channel is further subdivided into **band**, **source** and -**position** codes. Each of these codes must be composed of the +**subsource** codes. Each of these codes must be composed of the following ASCII character sets: - Uppercase [A-Z], ASCII 65 through 90 @@ -35,20 +35,22 @@ The codes are further defined as follows: forbidden as it conflicts with previous usage for designating empty locations. *Channel*: A sequence of codes that identify the band, source and -position. Values for each of these codes are defined in :ref:`channel-codes`. +subsource. Definition and values for each of these codes are in +:ref:`channel-codes`. **Band**: Indicates the sampling rate range and response band of the data source. **Source**: Identifies an instrument or other data source. - **Position**: Identifies the orientation or otherwise relative position. + **Subsource**: Identifies a sub-category within the source. + Identifiers as a URN -------------------- The FDSN Source Identifier is a combination of the network, station, -location, band, source and position codes into a Uniform Resource Name +location, band, source and subsource codes into a Uniform Resource Name (URN) as defined by `RFC 3986 `_. The pattern of the source identifier URN is as follows: @@ -74,7 +76,7 @@ For identifying a data source, i.e. a specific channel: :: - FDSN:_____ + FDSN:_____ where the `network`, `station` and `source` codes are required to be non-empty. The underscore (ASCII 95) delimiters must always be present. @@ -198,7 +200,7 @@ Examples Permanent network NSLC: 'IU', 'ANMO', '00', 'BHZ' maps to ``FDSN:IU_ANMO_00_B_H_Z`` -Permanent network NSLC: 'IU', 'ANMO', '', 'BHZ' maps to ``FDSN:IU_ANMO__B_H_Z` +Permanent network NSLC: 'IU', 'ANMO', '', 'BHZ' maps to ``FDSN:IU_ANMO__B_H_Z`` Temporary network starting in 2002 NSLC: 'XA', 'ABCD', '00', 'BHZ' maps to ``FDSN:XA_ABCD_00_B_H_Z`` or to ``FDSN:XA2002_ABCD_00_B_H_Z`` diff --git a/index.rst b/index.rst index 1091ea0..1cabeb9 100644 --- a/index.rst +++ b/index.rst @@ -13,7 +13,7 @@ The FDSN defines, allocates and adopts a number of codes that, when combined in a hierarchy, uniquely identify a data source. The identifer is constructed by combining `network`, `station`, `location` and `channel` codes, where the channel code is further subdivided into -`band`, `source` and `position` codes. +`band`, `source` and `subsource` codes. This specification defines the meaning and rules for these codes in addition to how they are to be combined into a URI-like pattern as @@ -21,7 +21,7 @@ follows: :: - FDSN:_____ + FDSN:_____ This single-string identifier uniquely identifies a source in FDSN formats and services.