Skip to content

Latest commit

 

History

History
2892 lines (1498 loc) · 70.6 KB

level-channel.rst

File metadata and controls

2892 lines (1498 loc) · 70.6 KB

<Channel>

Warning, Future Change

endDate: This attribute should not be used if it is in the future.

Warning, Future Change

endDate: This attribute is likely to require timezone of Z.

Warning, Future Change

startDate: This attribute is likely to require timezone of Z.

The Channel container. A Description element may be included with other information. An Identifier element may be included to designate a persistent identifier (e.g. DOI) to use for citation or reference. A Comment element may be included for arbitrary comments.

An active Channel should not use the endDate attribute. Unlike SEED, do not use an endDate in the distant future to mean active.

Attributes of <Channel>:

attribute type required description example
alternateCode :ref:`string<type-glossary>` no A code used for display or association alternateCode="Z"
code :ref:`string<type-glossary>` yes Name of Channel code="BHZ"
endDate :ref:`dateTime<type-glossary>` no End date of channel epoch. Do not use if still active, endDate should not be in the future. endDate="2018-01-27T00:00:00Z"
historicalCode :ref:`string<type-glossary>` no A previously used code if different from the current code historicalCode="bhz"
locationCode :ref:`string<type-glossary>` yes The locationCode is typically used to group channels from a common sensor. For example, the channels of the primary sensor at global IDA-IRIS stations have locationCode = "00": 00_BHZ, 00_BHE, 00_BHN, 00_LHZ, ..., etc. Even though it is required, locationCode may be, and often is, an empty string, however, it is recommended that the locationCode not be empty. locationCode="30"
restrictedStatus :ref:`RestrictedStatusType<type-glossary>` no One of: "open", "closed", "partial" restrictedStatus="open"
sourceID :ref:`anyURI<type-glossary>` no A data source identifier in URI form. It is recommended that this follow the FDSN Source Identifiers specification, http://docs.fdsn.org/projects/source-identifiers sourceID="FDSN:XX_ABCD_00_B_H_Z"
startDate :ref:`dateTime<type-glossary>` no Start date of channel epoch startDate="2016-07-01T00:00:00Z"

Sub Elements of <Channel>:

element type number
:ref:`<Description><Channel-Description>` string optional
:ref:`<Identifier><Channel-Identifier>` string optional, many
:ref:`<Comment><Channel-Comment>`   optional, many
:ref:`<DataAvailability><Channel-DataAvailability>`   optional
:ref:`<ExternalReference><Channel-ExternalReference>`   optional, many
:ref:`<Latitude><Channel-Latitude>` double required
:ref:`<Longitude><Channel-Longitude>` double required
:ref:`<Elevation><Channel-Elevation>` double required
:ref:`<Depth><Channel-Depth>` double required
:ref:`<Azimuth><Channel-Azimuth>` double optional
:ref:`<Dip><Channel-Dip>` double optional
:ref:`<WaterLevel><Channel-WaterLevel>` double optional
:ref:`<Type><Channel-Type>` string optional, many
:ref:`<SampleRate><Channel-SampleRate>` double optional
:ref:`<SampleRateRatio><Channel-SampleRateRatio>`   optional
:ref:`<ClockDrift><Channel-ClockDrift>` double optional
:ref:`<CalibrationUnits><Channel-CalibrationUnits>`   optional
:ref:`<Sensor><Channel-Sensor>`   optional
:ref:`<PreAmplifier><Channel-PreAmplifier>`   optional
:ref:`<DataLogger><Channel-DataLogger>`   optional
:ref:`<Equipment><Channel-Equipment>`   optional, many
:ref:`<Response><Response>`   optional

<Description>

Channel Description
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Description of the Channel
Example: <Description>This is a description</Description>

<Identifier>

Channel Identifier
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
A type to document persistent identifiers. Identifier values should be specified without a URI scheme (prefix), instead the identifier type is documented as an attribute.
Example: <identifier type="DOI">10.1000/140</identifier>
Example: <identifier type="DOI">10.5555/12345678</identifier>BHZ.

Attributes of <Identifier>:

attribute type required description example
type :ref:`string<type-glossary>` no Identifier type type="DOI"

<Comment>

Channel Comment
Container for a comment or log entry.

Attributes of <Comment>:

attribute type required description example
id :ref:`CounterType<type-glossary>` no An ID for this comment id="12345"
subject :ref:`string<type-glossary>` no A subject for this comment. Multiple comments with the same subject should be considered related. subject="Scheduled maintenance"

Sub Elements of <Comment>:

element type number
:ref:`<Value><Channel-Comment-Value>` string required
:ref:`<BeginEffectiveTime><Channel-Comment-BeginEffectiveTime>` dateTime optional
:ref:`<EndEffectiveTime><Channel-Comment-EndEffectiveTime>` dateTime optional
:ref:`<Author><Channel-Comment-Author>`   optional, many

<Value> required

Channel Comment Value
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Comment text.
Example: <Value>Large number of spikes</Value>

<BeginEffectiveTime>

Channel Comment BeginEffectiveTime
.. only:: latex

                content type: :ref:`dateTime<type-glossary>`

.. only:: html

                content type: `dateTime <appendices.html#glossary-datetime>`_
Start time for when comment applies.
Example: <BeginEffectiveTime>2008-09-15T00:00:00Z</BeginEffectiveTime>

<EndEffectiveTime>

Channel Comment EndEffectiveTime
.. only:: latex

                content type: :ref:`dateTime<type-glossary>`

.. only:: html

                content type: `dateTime <appendices.html#glossary-datetime>`_
End time for when comment applies.
Example: <EndEffectiveTime>2008-09-16T12:00:00Z</EndEffectiveTime>

<Author>

Channel Comment Author

Author of Comment.

Person's contact information. A person can belong to multiple agencies and have multiple email addresses and phone numbers.

Sub Elements of <Author>:

element type number
:ref:`<Name><Channel-Comment-Author-Name>` string optional, many
:ref:`<Agency><Channel-Comment-Author-Agency>` string optional, many
:ref:`<Email><Channel-Comment-Author-Email>` string optional, many
:ref:`<Phone><Channel-Comment-Author-Phone>`   optional, many

<Name>

Channel Comment Author Name
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Name of contact or author
Example: <Name>Dr. Jane Doe</Name>

<Agency>

Channel Comment Author Agency
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Agency of contact or author
Example: <Agency>USGS</Agency>

<Email>

Channel Comment Author Email
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Email of contact or author
Example: <Email>[email protected]</Email>

<Phone>

Channel Comment Author Phone
Phone of contact or author

Attributes of <Phone>:

attribute type required description example
description :ref:`string<type-glossary>` no    

Sub Elements of <Phone>:

element type number
:ref:`<CountryCode><Channel-Comment-Author-Phone-CountryCode>` integer optional
:ref:`<AreaCode><Channel-Comment-Author-Phone-AreaCode>` integer required
:ref:`<PhoneNumber><Channel-Comment-Author-Phone-PhoneNumber>` string required

<CountryCode>
Channel Comment Author Phone CountryCode
.. only:: latex

                content type: :ref:`integer<type-glossary>`

.. only:: html

                content type: `integer <appendices.html#glossary-integer>`_
Telephone country code
Example: <CountryCode>64</CountryCode>

<AreaCode> required
Channel Comment Author Phone AreaCode
.. only:: latex

                content type: :ref:`integer<type-glossary>`

.. only:: html

                content type: `integer <appendices.html#glossary-integer>`_
Telephone area code
Example: <AreaCode>408</AreaCode>

<PhoneNumber> required
Channel Comment Author Phone PhoneNumber
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Telephone number
Example: <PhoneNumber>5551212</PhoneNumber>

<DataAvailability>

Channel DataAvailability

A description of time series data availability. This information should be considered transient and is primarily useful as a guide for generating time series data requests. The information for a DataAvailability:Span may be specific to the time range used in a request that resulted in the document or limited to the availability of data within the request range. These details may or may not be retained when synchronizing metadata between data centers.

A type for describing data availability.

Sub Elements of <DataAvailability>:

element type number
:ref:`<Extent><Channel-DataAvailability-Extent>`   optional
:ref:`<Span><Channel-DataAvailability-Span>`   optional, many

<Extent>

Channel DataAvailability Extent
Data availability extents, the earliest and latest data available. No information about the continuity of the data is included or implied.

Attributes of <Extent>:

attribute type required description example
end :ref:`dateTime<type-glossary>` yes end date of extent end="1988-12-31T00:00:00Z"
start :ref:`dateTime<type-glossary>` yes start date of extent start="1988-01-01T00:00:00Z"

<Span>

Channel DataAvailability Span
A type for describing data availability spans, with variable continuity. The time range described may be based on the request parameters that generated the document and not necessarily relate to continuity outside of the range. It may also be a smaller time window than the request depending on the data characteristics.

Attributes of <Span>:

attribute type required description example
end :ref:`dateTime<type-glossary>` yes end date of span end="1988-12-31T00:00:00Z"
maximumTimeTear :ref:`decimal<type-glossary>` no The maximum time tear (gap or overlap) in seconds between time series segments in the specified range. maximumTimeTear="0.01"
numberSegments :ref:`integer<type-glossary>` yes The number of continuous time series segments contained in the specified time range. A value of 1 indicates that the time series is continuous from start to end. numberSegments="2"
start :ref:`dateTime<type-glossary>` yes start date of span start="1988-01-01T00:00:00Z"

<ExternalReference>

Channel ExternalReference

URI of any type of external report, such as data quality reports.

This type contains a Uniform Resource Identifier (URI) and description for external information that users may want to reference.

Sub Elements of <ExternalReference>:

element type number
:ref:`<URI><Channel-ExternalReference-URI>` anyURI required
:ref:`<Description><Channel-ExternalReference-Description>` string required

<URI> required

Channel ExternalReference URI
.. only:: latex

                content type: :ref:`anyURI<type-glossary>`

.. only:: html

                content type: `anyURI <appendices.html#glossary-anyuri>`_
URI of the external reference.

<Description> required

Channel ExternalReference Description
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Description of the external reference.

<Latitude> required

Channel Latitude
.. only:: latex

                content type: :ref:`double<type-glossary>`

                range: -90.0 :math:`\le` Latitude :math:`\lt` 90.0

.. only:: html

                content type: `double <appendices.html#glossary-double>`_

                range: -90.0 :math:`\le` Latitude :math:`\lt` 90.0

Latitude of this channel's sensor, in degrees. Often the same as the station latitude, but when different the channel latitude is the true location of the sensor.

Latitude type extending the base type to add datum as an attribute with default.

Example: <Latitude>34.9459</Latitude>

Attributes of <Latitude>:

attribute type required description example
unit :ref:`string<type-glossary>` no The type of unit being used. This value is fixed to be DEGREES, setting it is redundant.  
plusError :ref:`double<type-glossary>` no plus uncertainty or error in measured value. plusError="0.1"
minusError :ref:`double<type-glossary>` no minus uncertainty or error in measured value. minusError="0.1"
measurementMethod :ref:`string<type-glossary>` no    
datum :ref:`NMTOKEN<type-glossary>` no    

<Longitude> required

Channel Longitude
.. only:: latex

                content type: :ref:`double<type-glossary>`

                range: -180.0 :math:`\le` Longitude :math:`\le` 180.0

.. only:: html

                content type: `double <appendices.html#glossary-double>`_

                range: -180.0 :math:`\le` Longitude :math:`\le` 180.0

Longitude of this channel's sensor, in degrees. Often the same as the station longitude, but when different the channel longitude is the true location of the sensor.

Longitude type extending the base type to add datum as an attribute with default.

Example: <Longitude>-106.4572</Longitude>

Attributes of <Longitude>:

attribute type required description example
unit :ref:`string<type-glossary>` no The type of unit being used. This value is fixed to be DEGREES, setting it is redundant.  
plusError :ref:`double<type-glossary>` no plus uncertainty or error in measured value. plusError="0.1"
minusError :ref:`double<type-glossary>` no minus uncertainty or error in measured value. minusError="0.1"
measurementMethod :ref:`string<type-glossary>` no    
datum :ref:`NMTOKEN<type-glossary>` no    

<Elevation> required

Channel Elevation
.. only:: latex

                content type: :ref:`double<type-glossary>`

.. only:: html

                content type: `double <appendices.html#glossary-double>`_
Elevation of the sensor, in meters. To find the local ground surface level, add the Depth value to this elevation.

Attributes of <Elevation>:

attribute type required description example
unit :ref:`string<type-glossary>` no The type of unit being used. This value is fixed to be METERS, setting it is redundant.  
plusError :ref:`double<type-glossary>` no plus uncertainty or error in measured value. plusError="0.1"
minusError :ref:`double<type-glossary>` no minus uncertainty or error in measured value. minusError="0.1"
measurementMethod :ref:`string<type-glossary>` no    

<Depth> required

Channel Depth
.. only:: latex

                content type: :ref:`double<type-glossary>`

.. only:: html

                content type: `double <appendices.html#glossary-double>`_
The depth of the sensor relative to the local ground surface level, in meters.

Attributes of <Depth>:

attribute type required description example
unit :ref:`string<type-glossary>` no The type of unit being used. This value is fixed to be METERS, setting it is redundant.  
plusError :ref:`double<type-glossary>` no plus uncertainty or error in measured value. plusError="0.1"
minusError :ref:`double<type-glossary>` no minus uncertainty or error in measured value. minusError="0.1"
measurementMethod :ref:`string<type-glossary>` no    

<Azimuth>

Channel Azimuth
.. only:: latex

                content type: :ref:`double<type-glossary>`

                range: 0.0 :math:`\le` Azimuth :math:`\lt` 360.0

.. only:: html

                content type: `double <appendices.html#glossary-double>`_

                range: 0.0 :math:`\le` Azimuth :math:`\lt` 360.0
Azimuth of the component in degrees clockwise from geographic (true) north.

Attributes of <Azimuth>:

attribute type required description example
unit :ref:`string<type-glossary>` no The type of unit being used. This value is fixed to be DEGREES, setting it is redundant.  
plusError :ref:`double<type-glossary>` no plus uncertainty or error in measured value. plusError="0.1"
minusError :ref:`double<type-glossary>` no minus uncertainty or error in measured value. minusError="0.1"
measurementMethod :ref:`string<type-glossary>` no    

<Dip>

Channel Dip
.. only:: latex

                content type: :ref:`double<type-glossary>`

                range: -90.0 :math:`\le` Dip :math:`\le` 90.0

.. only:: html

                content type: `double <appendices.html#glossary-double>`_

                range: -90.0 :math:`\le` Dip :math:`\le` 90.0
Dip of the component in degrees, positive is down from horizontal. For horizontal dip=0, for vertical upwards dip=-90 and for vertical downwards dip=+90.

Attributes of <Dip>:

attribute type required description example
unit :ref:`string<type-glossary>` no The type of unit being used. This value is fixed to be DEGREES, setting it is redundant.  
plusError :ref:`double<type-glossary>` no plus uncertainty or error in measured value. plusError="0.1"
minusError :ref:`double<type-glossary>` no minus uncertainty or error in measured value. minusError="0.1"
measurementMethod :ref:`string<type-glossary>` no    

<WaterLevel>

Channel WaterLevel
.. only:: latex

                content type: :ref:`double<type-glossary>`

.. only:: html

                content type: `double <appendices.html#glossary-double>`_
Elevation of the water surface in meters for underwater sites, where 0 is mean sea level. If you put an OBS on a lake bottom, where the lake surface is at elevation=1200 meters, then you should set WaterLevel=1200. An OBS in the ocean would have WaterLevel=0.

Attributes of <WaterLevel>:

attribute type required description example
unit :ref:`string<type-glossary>` no The unit of measurement. Use SI unit names and symbols whenever possible (e.g., 'm' instead of 'METERS'). unit="m"
plusError :ref:`double<type-glossary>` no plus uncertainty or error in measured value. plusError="0.1"
minusError :ref:`double<type-glossary>` no minus uncertainty or error in measured value. minusError="0.1"
measurementMethod :ref:`string<type-glossary>` no    

<Type>

Channel Type

Warning, Future Change

<Type>: This element is likely to be removed.

.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_

Data type for this channel. One or more <Type> tags can be used to specify the nature of the data this channel collects. The value between the <Type> tags must be one of: TRIGGERED, CONTINUOUS, HEALTH, GEOPHYSICAL, WEATHER, FLAG or SYNTHESIZED.

This element existed primarily to hold the corresponding value from SEED, but should not be used for new StationXML.

Example: <Type>CONTINUOUS</Type>

<SampleRate>

Channel SampleRate
.. only:: latex

                content type: :ref:`double<type-glossary>`

.. only:: html

                content type: `double <appendices.html#glossary-double>`_
Sample rate in samples per second. SampleRate is optional unless SampleRateRatio is present, in which case SampleRate is required.
Example: <SampleRate>40.0</SampleRate>

Attributes of <SampleRate>:

attribute type required description example
unit :ref:`string<type-glossary>` no The type of unit being used. This value is fixed to be SAMPLES/S, setting it is redundant.  
plusError :ref:`double<type-glossary>` no plus uncertainty or error in measured value. plusError="0.1"
minusError :ref:`double<type-glossary>` no minus uncertainty or error in measured value. minusError="0.1"
measurementMethod :ref:`string<type-glossary>` no    

<SampleRateRatio>

Channel SampleRateRatio
Sample rate expressed as number of samples in a number of seconds. If present, then <SampleRate> must also be present. It can be useful for very slow data (e.g., less than a few samples per day), since it allows for greater precision in the stored value.

Example:

<SampleRate>0.000023148</SampleRate>
              <SampleRateRatio>
                <NumberSamples>2</NumberSamples>
                <NumberSeconds>86400</NumberSeconds>
              </SampleRateRatio>

Sub Elements of <SampleRateRatio>:

element type number
:ref:`<NumberSamples><Channel-SampleRateRatio-NumberSamples>` integer required
:ref:`<NumberSeconds><Channel-SampleRateRatio-NumberSeconds>` integer required

<NumberSamples> required

Channel SampleRateRatio NumberSamples
.. only:: latex

                content type: :ref:`integer<type-glossary>`

.. only:: html

                content type: `integer <appendices.html#glossary-integer>`_
Integer number of samples that span a number of seconds.

<NumberSeconds> required

Channel SampleRateRatio NumberSeconds
.. only:: latex

                content type: :ref:`integer<type-glossary>`

.. only:: html

                content type: `integer <appendices.html#glossary-integer>`_
Integer number of seconds that span a number of samples.

<ClockDrift>

Channel ClockDrift
.. only:: latex

                content type: :ref:`double<type-glossary>`

                range: ClockDrift :math:`\ge` 0.0

.. only:: html

                content type: `double <appendices.html#glossary-double>`_

                range: ClockDrift :math:`\ge` 0.0
Tolerance value, measured in seconds per sample, used as a threshold for time error detection in data from the channel.

Attributes of <ClockDrift>:

attribute type required description example
unit :ref:`string<type-glossary>` no The unit of drift value. This value is fixed to be SECONDS/SAMPLE, setting it is redundant.  
plusError :ref:`double<type-glossary>` no plus uncertainty or error in measured value. plusError="0.1"
minusError :ref:`double<type-glossary>` no minus uncertainty or error in measured value. minusError="0.1"
measurementMethod :ref:`string<type-glossary>` no    

<CalibrationUnits>

Channel CalibrationUnits

Units of calibration (e.g., V (for Volts) or A (for amps))

Use SI units when possible

A type to document units; use SI whenever possible.

Example:

<CalibrationUnits>
  <Name>V</Name>
  <Description>Volts</Description>
</CalibrationUnits>

Sub Elements of <CalibrationUnits>:

element type number
:ref:`<Name><Channel-CalibrationUnits-Name>` string required
:ref:`<Description><Channel-CalibrationUnits-Description>` string optional

<Name> required

Channel CalibrationUnits Name
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Symbol or name of units, e.g. "m/s", "V", "Pa", "C". Use SI whenever possible, along with singular lowercase "count" for digital counts.

<Description>

Channel CalibrationUnits Description
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Description of units, e.g. "Velocity in meters per second", "Volts", "Pascals", "Degrees Celsius". Description is only needed when the unit name is not a well know SI unit or there is need for clarification. Prefer not to use a Description for common units like m/s, m/s**2, count, etc.

<Sensor>

Channel Sensor

Details of the (typically analog) sensor attached to this channel. If this was entered at the Station level, it is not necessary to do it for each Channel, unless you have differences in equipment.

A type for equipment related to data acquisition or processing.

Attributes of <Sensor>:

attribute type required description example
resourceId :ref:`string<type-glossary>` no An identifier that serves to uniquely identify this resource. This identifier can be interpreted differently depending on the datacenter/software that generated the document. Also, we recommend using a prefix, e.g., GENERATOR:Meaningful ID. It should be expected that equipment with the same ID should indicate the same information or be derived from the same base instruments.  

Sub Elements of <Sensor>:

element type number
:ref:`<Type><Channel-Sensor-Type>` string optional
:ref:`<Description><Channel-Sensor-Description>` string optional
:ref:`<Manufacturer><Channel-Sensor-Manufacturer>` string optional
:ref:`<Vendor><Channel-Sensor-Vendor>` string optional
:ref:`<Model><Channel-Sensor-Model>` string optional
:ref:`<SerialNumber><Channel-Sensor-SerialNumber>` string optional
:ref:`<InstallationDate><Channel-Sensor-InstallationDate>` dateTime optional
:ref:`<RemovalDate><Channel-Sensor-RemovalDate>` dateTime optional
:ref:`<CalibrationDate><Channel-Sensor-CalibrationDate>` dateTime optional, many

<Type>

Channel Sensor Type
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Type of equipment

<Description>

Channel Sensor Description
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Description of equipment

<Manufacturer>

Channel Sensor Manufacturer
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Manufacturer of equipment

<Vendor>

Channel Sensor Vendor
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Vendor of equipment

<Model>

Channel Sensor Model
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Model of equipment

<SerialNumber>

Channel Sensor SerialNumber
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Serial number of equipment

<InstallationDate>

Channel Sensor InstallationDate
.. only:: latex

                content type: :ref:`dateTime<type-glossary>`

.. only:: html

                content type: `dateTime <appendices.html#glossary-datetime>`_
Date this equipment was installed

<RemovalDate>

Channel Sensor RemovalDate
.. only:: latex

                content type: :ref:`dateTime<type-glossary>`

.. only:: html

                content type: `dateTime <appendices.html#glossary-datetime>`_
Date this equipment was removed

<CalibrationDate>

Channel Sensor CalibrationDate
.. only:: latex

                content type: :ref:`dateTime<type-glossary>`

.. only:: html

                content type: `dateTime <appendices.html#glossary-datetime>`_
Date this equipment was calibrated

<PreAmplifier>

Channel PreAmplifier

Preamplifier (if any) used by this channel. If this was entered at the Station level, it is not necessary to do it for each Channel, unless you have differences in equipment.

A type for equipment related to data acquisition or processing.

Attributes of <PreAmplifier>:

attribute type required description example
resourceId :ref:`string<type-glossary>` no An identifier that serves to uniquely identify this resource. This identifier can be interpreted differently depending on the datacenter/software that generated the document. Also, we recommend using a prefix, e.g., GENERATOR:Meaningful ID. It should be expected that equipment with the same ID should indicate the same information or be derived from the same base instruments.  

Sub Elements of <PreAmplifier>:

element type number
:ref:`<Type><Channel-PreAmplifier-Type>` string optional
:ref:`<Description><Channel-PreAmplifier-Description>` string optional
:ref:`<Manufacturer><Channel-PreAmplifier-Manufacturer>` string optional
:ref:`<Vendor><Channel-PreAmplifier-Vendor>` string optional
:ref:`<Model><Channel-PreAmplifier-Model>` string optional
:ref:`<SerialNumber><Channel-PreAmplifier-SerialNumber>` string optional
:ref:`<InstallationDate><Channel-PreAmplifier-InstallationDate>` dateTime optional
:ref:`<RemovalDate><Channel-PreAmplifier-RemovalDate>` dateTime optional
:ref:`<CalibrationDate><Channel-PreAmplifier-CalibrationDate>` dateTime optional, many

<Type>

Channel PreAmplifier Type
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Type of equipment

<Description>

Channel PreAmplifier Description
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Description of equipment

<Manufacturer>

Channel PreAmplifier Manufacturer
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Manufacturer of equipment

<Vendor>

Channel PreAmplifier Vendor
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Vendor of equipment

<Model>

Channel PreAmplifier Model
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Model of equipment

<SerialNumber>

Channel PreAmplifier SerialNumber
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Serial number of equipment

<InstallationDate>

Channel PreAmplifier InstallationDate
.. only:: latex

                content type: :ref:`dateTime<type-glossary>`

.. only:: html

                content type: `dateTime <appendices.html#glossary-datetime>`_
Date this equipment was installed

<RemovalDate>

Channel PreAmplifier RemovalDate
.. only:: latex

                content type: :ref:`dateTime<type-glossary>`

.. only:: html

                content type: `dateTime <appendices.html#glossary-datetime>`_
Date this equipment was removed

<CalibrationDate>

Channel PreAmplifier CalibrationDate
.. only:: latex

                content type: :ref:`dateTime<type-glossary>`

.. only:: html

                content type: `dateTime <appendices.html#glossary-datetime>`_
Date this equipment was calibrated

<DataLogger>

Channel DataLogger

Datalogger that recorded this channel. If this was entered at the Station level, it is not necessary to do it for each Channel, unless you have differences in equipment.

A type for equipment related to data acquisition or processing.

Attributes of <DataLogger>:

attribute type required description example
resourceId :ref:`string<type-glossary>` no An identifier that serves to uniquely identify this resource. This identifier can be interpreted differently depending on the datacenter/software that generated the document. Also, we recommend using a prefix, e.g., GENERATOR:Meaningful ID. It should be expected that equipment with the same ID should indicate the same information or be derived from the same base instruments.  

Sub Elements of <DataLogger>:

element type number
:ref:`<Type><Channel-DataLogger-Type>` string optional
:ref:`<Description><Channel-DataLogger-Description>` string optional
:ref:`<Manufacturer><Channel-DataLogger-Manufacturer>` string optional
:ref:`<Vendor><Channel-DataLogger-Vendor>` string optional
:ref:`<Model><Channel-DataLogger-Model>` string optional
:ref:`<SerialNumber><Channel-DataLogger-SerialNumber>` string optional
:ref:`<InstallationDate><Channel-DataLogger-InstallationDate>` dateTime optional
:ref:`<RemovalDate><Channel-DataLogger-RemovalDate>` dateTime optional
:ref:`<CalibrationDate><Channel-DataLogger-CalibrationDate>` dateTime optional, many

<Type>

Channel DataLogger Type
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Type of equipment

<Description>

Channel DataLogger Description
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Description of equipment

<Manufacturer>

Channel DataLogger Manufacturer
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Manufacturer of equipment

<Vendor>

Channel DataLogger Vendor
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Vendor of equipment

<Model>

Channel DataLogger Model
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Model of equipment

<SerialNumber>

Channel DataLogger SerialNumber
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Serial number of equipment

<InstallationDate>

Channel DataLogger InstallationDate
.. only:: latex

                content type: :ref:`dateTime<type-glossary>`

.. only:: html

                content type: `dateTime <appendices.html#glossary-datetime>`_
Date this equipment was installed

<RemovalDate>

Channel DataLogger RemovalDate
.. only:: latex

                content type: :ref:`dateTime<type-glossary>`

.. only:: html

                content type: `dateTime <appendices.html#glossary-datetime>`_
Date this equipment was removed

<CalibrationDate>

Channel DataLogger CalibrationDate
.. only:: latex

                content type: :ref:`dateTime<type-glossary>`

.. only:: html

                content type: `dateTime <appendices.html#glossary-datetime>`_
Date this equipment was calibrated

<Equipment>

Channel Equipment

Any equipment that does not have type-specific fields. Equipment such as sensor, data logger and preamplifier that has type-specific fields should be documented in those structures. If the same Equipment is entered at the Station level, it is not necessary to include it for each Channel. If using a preamplifier, sensor, or datalogger, use their appropriate fields instead.

A type for equipment related to data acquisition or processing.

Attributes of <Equipment>:

attribute type required description example
resourceId :ref:`string<type-glossary>` no An identifier that serves to uniquely identify this resource. This identifier can be interpreted differently depending on the datacenter/software that generated the document. Also, we recommend using a prefix, e.g., GENERATOR:Meaningful ID. It should be expected that equipment with the same ID should indicate the same information or be derived from the same base instruments.  

Sub Elements of <Equipment>:

element type number
:ref:`<Type><Channel-Equipment-Type>` string optional
:ref:`<Description><Channel-Equipment-Description>` string optional
:ref:`<Manufacturer><Channel-Equipment-Manufacturer>` string optional
:ref:`<Vendor><Channel-Equipment-Vendor>` string optional
:ref:`<Model><Channel-Equipment-Model>` string optional
:ref:`<SerialNumber><Channel-Equipment-SerialNumber>` string optional
:ref:`<InstallationDate><Channel-Equipment-InstallationDate>` dateTime optional
:ref:`<RemovalDate><Channel-Equipment-RemovalDate>` dateTime optional
:ref:`<CalibrationDate><Channel-Equipment-CalibrationDate>` dateTime optional, many

<Type>

Channel Equipment Type
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Type of equipment

<Description>

Channel Equipment Description
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Description of equipment

<Manufacturer>

Channel Equipment Manufacturer
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Manufacturer of equipment

<Vendor>

Channel Equipment Vendor
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Vendor of equipment

<Model>

Channel Equipment Model
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Model of equipment

<SerialNumber>

Channel Equipment SerialNumber
.. only:: latex

                content type: :ref:`string<type-glossary>`

.. only:: html

                content type: `string <appendices.html#glossary-string>`_
Serial number of equipment

<InstallationDate>

Channel Equipment InstallationDate
.. only:: latex

                content type: :ref:`dateTime<type-glossary>`

.. only:: html

                content type: `dateTime <appendices.html#glossary-datetime>`_
Date this equipment was installed

<RemovalDate>

Channel Equipment RemovalDate
.. only:: latex

                content type: :ref:`dateTime<type-glossary>`

.. only:: html

                content type: `dateTime <appendices.html#glossary-datetime>`_
Date this equipment was removed

<CalibrationDate>

Channel Equipment CalibrationDate
.. only:: latex

                content type: :ref:`dateTime<type-glossary>`

.. only:: html

                content type: `dateTime <appendices.html#glossary-datetime>`_
Date this equipment was calibrated