2. StationXML Reference¶
2.1. <FDSNStationXML> required¶
Top-level for StationXML. Contains information about who produced the StationXML and where it came from.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
schemaVersion |
yes |
The schema version compatible with the document. |
2.1.1. <Source> required¶
FDSNStationXML → Source
type:string
Initiator of the information contained in the document. Likely to be the Network ID of the institution sending the message.
2.1.2. <Sender>¶
2.1.3. <Module>¶
FDSNStationXML → Module
type:string
Name of the software module that that generated this document. The module is about the senders, e.g. seiscomp3.
Example: <Module>Seiscomp3</Module>
2.2. <Network> required¶
This represents the Network layer, all station metadata is contained within this element. The official name of the network or other descriptive information can be included in the Description element. The Network level contains 0 or more Stations.
Example: <Network code=”IU” startDate=2016-01-27T13:00:00>
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
alternateCode |
no |
A code used for display or association. |
alternateCode=’IX’ |
|
code |
yes |
Identifying code/name. |
For Network Name ‘IU’, code=’IU’ |
|
endDate |
no |
End date of network/station/channel epoch |
endDate=2018-01-27T00:00:00 |
|
historicalCode |
no |
A previously used code if different from the current code. |
historicalCode=’II’ |
|
restrictedStatus |
no |
One of: open, closed, partial |
restrictedStatus = open |
|
sourceID |
no |
A data source identifier in URI form |
sourceID=’http://some/path’ |
|
startDate |
no |
Start date of network/station/channel epoch |
startDate=2016-07-01T00:00:00 |
2.2.1. <Description>¶
Network → Description
type:string
Description of the Network.
Example: <Description>This is a description</Description>
2.2.2. <Identifier>¶
Network → Identifier
type:string
A type to document persistent identifiers. Identifier values should be specified without a URI scheme (prefix), instead the identifer type is documented as an attribute.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
type |
no |
2.2.3. <Comment>¶
Network → Comment
Container for a comment or log entry.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
id |
no |
An id for this comment |
id=12345 |
|
subject |
no |
A subject for this comment. Multiple comments with the same subject should be considered related. |
subject=’Scheduled maintenance’ |
<Value> required¶
Network → Comment → Value
type:string
This is where the comment text goes.
Example: <Value>GPS clock is lost</Value>
<BeginEffectiveTime>¶
Network → Comment → BeginEffectiveTime
type:dateTime
This is where the comment text goes.
Example: <BeginEffectiveTime>2008-09-15T00:00:00</BeginEffectiveTime>
<EndEffectiveTime>¶
Network → Comment → EndEffectiveTime
type:dateTime
End time for where comment applies.
Example: <EndEffectiveTime>2008-09-16T12:00:00</EndEffectiveTime>
<Author>¶
Network → Comment → Author
Element to hold contact information of Author of Comment. A person can belong to multiple agencies and have multiple email addresses and phone numbers.
<Name>¶
Network → Comment → Author → Name
type:string
Name of contact or author.
Example: <Name>Alfred E. Neuman</Name>
<Agency>¶
Network → Comment → Author → Agency
type:string
Agency of contact or author.
Example: <Agency>Mad Magazine, Inc.</Agency>
<Email>¶
Network → Comment → Author → Email
type:string
Email of contact or author.
Example: <Email>a.neuman@gmail.com</Email>
<Phone>¶
Network → Comment → Author → Phone
Phone of contact or author.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
description |
no |
<CountryCode>¶
Network → Comment → Author → Phone → CountryCode
type:integer
Telephone country code.
Example: <CountryCode>64</CountryCode>
2.2.4. <DataAvailability>¶
Network → 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 withing the request range. These details may or may not be retained when synchronizing metadata between data centers.
<Extent>¶
Network → DataAvailability → Extent
Data availability extents, the earliest and latest data available. No information is included about the continuity of the data is included or implied.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
end |
yes |
end date of extent |
end=1988-12-31T00:00:00 |
|
start |
yes |
start date of extent |
start=1988-01-01T00:00:00 |
<Span>¶
Network → 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.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
end |
yes |
end date of span |
end=1988-12-31T00:00:00 |
|
maximumTimeTear |
no |
The maximum time tear (gap or overlap) in seconds between time series segments in the specified range. |
maximumTimeTear=0.01 |
|
numberSegments |
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 |
yes |
start date of span |
start=1988-01-01T00:00:00 |
2.2.5. <Operator>¶
Network → Operator
Agency and contact persons who manage this network.
<Agency> required¶
Network → Operator → Agency
type:string
An operating agency and associated contact persons.
Example: <Agency>USGS</Agency>
<Contact>¶
Network → Operator → Contact
Person’s contact information. A person can belong to multiple agencies and have multiple email addresses and phone numbers.
<Name>¶
Network → Operator → Contact → Name
type:string
Name of contact or author.
Example: <Name>Alfred E. Neuman</Name>
<Agency>¶
Network → Operator → Contact → Agency
type:string
Agency of contact or author.
Example: <Agency>Mad Magazine, Inc.</Agency>
<Email>¶
Network → Operator → Contact → Email
type:string
Email of contact or author.
Example: <Email>a.neuman@gmail.com</Email>
<Phone>¶
Network → Operator → Contact → Phone
Phone of contact or author.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
description |
no |
<CountryCode>¶
Network → Operator → Contact → Phone → CountryCode
type:integer
Telephone country code.
Example: <CountryCode>64</CountryCode>
2.2.6. <TotalNumberStations>¶
Network → TotalNumberStations
Warning
This field isn’t super useful and is likely to be deprecated in future versions of StationXML
type:decimal range:TotalNumberStations \(\ge\) 0
The total number of stations contained in this network, including inactive or terminated stations.
Example: <TotalNumberStations>24</TotalNumberStations>
2.2.7. <SelectedNumberStations>¶
Network → SelectedNumberStations
Warning
This field isn’t super useful and is likely to be deprecated in future versions of StationXML
type:decimal range:SelectedNumberStations \(\ge\) 0
The SelectedNumberOfStations will be some number less than the possible number of stations for this Network. For instance, if you requested only 12 stations for a 24 station network, then SelectedNumberOfStations=12.
Example: <SelectedNumberStations>12</SelectedNumberStations>
2.3. <Station>¶
This type represents a Station epoch. It is common to only have a single station epoch with the station’s creation and termination dates as the epoch start and end dates.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
alternateCode |
no |
A code used for display or association. |
alternateCode=’IX’ |
|
code |
yes |
Identifying code/name. |
For Station Name ‘ANMO’, code=’ANMO’ |
|
endDate |
no |
End date of network/station/channel epoch |
endDate=2018-01-27T00:00:00 |
|
historicalCode |
no |
A previously used code if different from the current code. |
historicalCode=’II’ |
|
restrictedStatus |
no |
One of: open, closed, partial |
restrictedStatus = open |
|
sourceID |
no |
A data source identifier in URI form |
sourceID=’http://some/path’ |
|
startDate |
no |
Start date of network/station/channel epoch |
startDate=2016-07-01T00:00:00 |
2.3.1. <Description>¶
Station → Description
type:string
Description of the Station.
Example: <Description>This is a description</Description>
2.3.2. <Identifier>¶
Station → Identifier
type:string
A type to document persistent identifiers. Identifier values should be specified without a URI scheme (prefix), instead the identifer type is documented as an attribute.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
type |
no |
2.3.3. <Comment>¶
Station → Comment
Container for a comment or log entry.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
id |
no |
An id for this comment |
id=12345 |
|
subject |
no |
A subject for this comment. Multiple comments with the same subject should be considered related. |
subject=’Scheduled maintenance’ |
<Value> required¶
Station → Comment → Value
type:string
This is where the comment text goes.
Example: <Value>GPS clock is lost</Value>
<BeginEffectiveTime>¶
Station → Comment → BeginEffectiveTime
type:dateTime
This is where the comment text goes.
Example: <BeginEffectiveTime>2008-09-15T00:00:00</BeginEffectiveTime>
<EndEffectiveTime>¶
Station → Comment → EndEffectiveTime
type:dateTime
End time for where comment applies.
Example: <EndEffectiveTime>2008-09-16T12:00:00</EndEffectiveTime>
<Author>¶
Station → Comment → Author
Element to hold contact information of Author of Comment. A person can belong to multiple agencies and have multiple email addresses and phone numbers.
<Name>¶
Station → Comment → Author → Name
type:string
Name of contact or author.
Example: <Name>Alfred E. Neuman</Name>
<Agency>¶
Station → Comment → Author → Agency
type:string
Agency of contact or author.
Example: <Agency>Mad Magazine, Inc.</Agency>
<Email>¶
Station → Comment → Author → Email
type:string
Email of contact or author.
Example: <Email>a.neuman@gmail.com</Email>
<Phone>¶
Station → Comment → Author → Phone
Phone of contact or author.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
description |
no |
<CountryCode>¶
Station → Comment → Author → Phone → CountryCode
type:integer
Telephone country code.
Example: <CountryCode>64</CountryCode>
2.3.4. <DataAvailability>¶
Station → 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 withing the request range. These details may or may not be retained when synchronizing metadata between data centers.
<Extent>¶
Station → DataAvailability → Extent
Data availability extents, the earliest and latest data available. No information is included about the continuity of the data is included or implied.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
end |
yes |
end date of extent |
end=1988-12-31T00:00:00 |
|
start |
yes |
start date of extent |
start=1988-01-01T00:00:00 |
<Span>¶
Station → 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.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
end |
yes |
end date of span |
end=1988-12-31T00:00:00 |
|
maximumTimeTear |
no |
The maximum time tear (gap or overlap) in seconds between time series segments in the specified range. |
maximumTimeTear=0.01 |
|
numberSegments |
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 |
yes |
start date of span |
start=1988-01-01T00:00:00 |
2.3.5. <Latitude> required¶
Station → Latitude
type:double range:-90.0 \(\le\) Latitude
Station latitude coordinate, where the bulk of the equipment is located (or another appropriate site location).
Example: <Latitude unit=”DEGREES” datum=”WGS84”>34.9459</Latitude>
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
|||
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
|||
datum |
no |
2.3.6. <Longitude> required¶
Station → Longitude
type:double range:-180.0 \(\le\) Longitude
Station longitude coordinate, where the bulk of the equipment is located (or another appropriate site location).
Example: <Longitude unit=”DEGREES” datum=”WGS84”>-106.4572</Longitude>
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
|||
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
|||
datum |
no |
2.3.7. <Elevation> required¶
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
|||
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
2.3.8. <Site> required¶
Station → Site
These fields describe the location of the station using geopolitical entities (country, city, etc.).
<Name> required¶
<Description>¶
Station → Site → Description
type:string
A longer description of the location of this station.
Example: <Description>NW corner of Yellowstone National Park</Description>
<Town>¶
Station → Site → Town
type:string
The town or city closest to the station.
Example: <Town>Albuquerque</Town>
<County>¶
Station → Site → County
type:string
The county where the station is located.
Example: <County>Bernalillo</County>
2.3.9. <WaterLevel>¶
Station → WaterLevel
type:double
Elevation of the water surface in meters for underwater sites, where 0 is sea level. For example, an OBS on the bottom of a lake will have elevation equal to the elevation of the lake surface ??.
Example: <WaterLevel>1200.</WaterLevel>
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The unit of measurement |
unit=’DEGREES’ |
|
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
2.3.10. <Vault>¶
2.3.12. <Equipment>¶
Station → Equipment
Equipment used by all channels at a station.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
resourceId |
no |
This field contains a string that should serve as a unique resource identifier. This identifier can be interpreted differently depending on the datacenter/software that generated the document. Also, we recommend to use something like GENERATOR:Meaningful ID. As a common behaviour equipment with the same ID should contains the same information/be derived from the same base instruments. |
2.3.13. <Operator>¶
Station → Operator
An operator and associated contact persons.
<Agency> required¶
Station → Operator → Agency
type:string
An operating agency and associated contact persons.
Example: <Agency>USGS</Agency>
<Contact>¶
Station → Operator → Contact
Person’s contact information. A person can belong to multiple agencies and have multiple email addresses and phone numbers.
<Name>¶
Station → Operator → Contact → Name
type:string
Name of contact or author.
Example: <Name>Alfred E. Neuman</Name>
<Agency>¶
Station → Operator → Contact → Agency
type:string
Agency of contact or author.
Example: <Agency>Mad Magazine, Inc.</Agency>
<Email>¶
Station → Operator → Contact → Email
type:string
Email of contact or author.
Example: <Email>a.neuman@gmail.com</Email>
<Phone>¶
Station → Operator → Contact → Phone
Phone of contact or author.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
description |
no |
<CountryCode>¶
Station → Operator → Contact → Phone → CountryCode
type:integer
Telephone country code.
Example: <CountryCode>64</CountryCode>
2.3.14. <CreationDate>¶
2.3.15. <TerminationDate>¶
Station → TerminationDate
type:dateTime
Date and time (UTC) when the station was terminated or will be terminated. Do not include this field if it is irrelevant.
2.3.16. <TotalNumberChannels>¶
Station → TotalNumberChannels
Warning
This field isn’t super useful and is likely to be deprecated in future versions of StationXML
type:decimal range:TotalNumberChannels \(\ge\) 0
Total number of channels recorded at this station.
2.3.17. <SelectedNumberChannels>¶
Station → SelectedNumberChannels
Warning
This field isn’t super useful and is likely to be deprecated in future versions of StationXML
type:decimal range:SelectedNumberChannels \(\ge\) 0
Number of channels recorded at this station and selected by the query that produced this document.
2.4. <Channel>¶
Parent element for the related response blockettes.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
alternateCode |
no |
A code used for display or association. |
alternateCode=’IX’ |
|
code |
yes |
Identifying code/name. |
code=’IU’ or code=’ANMO’ |
|
endDate |
no |
End date of network/station/channel epoch |
endDate=2018-01-27T00:00:00 |
|
historicalCode |
no |
A previously used code if different from the current code. |
historicalCode=’II’ |
|
locationCode |
yes |
The locationCode is typically used to group channel coming from a common sensor. For example, the channels of the primary sensor at global IDA-IRIS stations has locationCode = ‘00’: 00-BHZ, 00-BHE, 00-BHN, 00-LHZ, …, etc. Even though it is required, it may be an empty string. |
locationCode=’30’ |
|
restrictedStatus |
no |
One of: open, closed, partial |
restrictedStatus = open |
|
sourceID |
no |
A data source identifier in URI form |
sourceID=’http://some/path’ |
|
startDate |
no |
Start date of network/station/channel epoch |
startDate=2016-07-01T00:00:00 |
2.4.1. <Description>¶
Channel → Description
type:string
Description of the Channel.
Example: <Description>This is a description</Description>
2.4.2. <Identifier>¶
Channel → Identifier
type:string
A type to document persistent identifiers. Identifier values should be specified without a URI scheme (prefix), instead the identifer type is documented as an attribute.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
type |
no |
2.4.3. <Comment>¶
Channel → Comment
Container for a comment or log entry.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
id |
no |
An id for this comment |
id=12345 |
|
subject |
no |
A subject for this comment. Multiple comments with the same subject should be considered related. |
subject=’Scheduled maintenance’ |
<Value> required¶
Channel → Comment → Value
type:string
This is where the comment text goes.
Example: <Value>GPS clock is lost</Value>
<BeginEffectiveTime>¶
Channel → Comment → BeginEffectiveTime
type:dateTime
This is where the comment text goes.
Example: <BeginEffectiveTime>2008-09-15T00:00:00</BeginEffectiveTime>
<EndEffectiveTime>¶
Channel → Comment → EndEffectiveTime
type:dateTime
End time for where comment applies.
Example: <EndEffectiveTime>2008-09-16T12:00:00</EndEffectiveTime>
<Author>¶
Channel → Comment → Author
Element to hold contact information of Author of Comment. A person can belong to multiple agencies and have multiple email addresses and phone numbers.
<Name>¶
Channel → Comment → Author → Name
type:string
Name of contact or author.
Example: <Name>Alfred E. Neuman</Name>
<Agency>¶
Channel → Comment → Author → Agency
type:string
Agency of contact or author.
Example: <Agency>Mad Magazine, Inc.</Agency>
<Email>¶
Channel → Comment → Author → Email
type:string
Email of contact or author.
Example: <Email>a.neuman@gmail.com</Email>
<Phone>¶
Channel → Comment → Author → Phone
Phone of contact or author.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
description |
no |
<CountryCode>¶
Channel → Comment → Author → Phone → CountryCode
type:integer
Telephone country code.
Example: <CountryCode>64</CountryCode>
2.4.4. <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 withing the request range. These details may or may not be retained when synchronizing metadata between data centers.
<Extent>¶
Channel → DataAvailability → Extent
Data availability extents, the earliest and latest data available. No information is included about the continuity of the data is included or implied.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
end |
yes |
end date of extent |
end=1988-12-31T00:00:00 |
|
start |
yes |
start date of extent |
start=1988-01-01T00:00:00 |
<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.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
end |
yes |
end date of span |
end=1988-12-31T00:00:00 |
|
maximumTimeTear |
no |
The maximum time tear (gap or overlap) in seconds between time series segments in the specified range. |
maximumTimeTear=0.01 |
|
numberSegments |
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 |
yes |
start date of span |
start=1988-01-01T00:00:00 |
2.4.5. <ExternalReference>¶
Channel → ExternalReference
URI of any type of external report, such as data quality reports.
2.4.6. <Latitude> required¶
Channel → Latitude
type:double range:-90.0 \(\le\) Latitude
Latitude coordinate of this channel’s sensor. Should be the same as the Station’s latitudee. If they are different, then the Channel’s latitude should be used and the Station’s shouldn’t be.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
|||
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
|||
datum |
no |
2.4.7. <Longitude> required¶
Channel → Longitude
type:double range:-180.0 \(\le\) Longitude
Longitude coordinate of this channel’s sensor. Should be the same as the Station’s longitude. If they are different, then the Channel’s longitude should be used and the Station’s shouldn’t be.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
|||
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
|||
datum |
no |
2.4.8. <Elevation> required¶
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
|||
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
2.4.9. <Depth> required¶
Channel → Depth
type:double
The local depth or overburden of the instrument’s location in meters. For downhole instruments, the depth of the instrument under the surface ground level. For underground vaults, the distance from the instrument to the local ground level. above.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
|||
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
2.4.10. <Azimuth>¶
Channel → Azimuth
type:double range:0.0 \(\le\) Azimuth
Azimuth of the sensor in degrees from True North, clockwise.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
|||
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
2.4.11. <Dip>¶
Channel → Dip
type:double range:-90.0 \(\le\) Dip
Dip of the instrument in degrees, down from horizontal.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
|||
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
2.4.12. <WaterLevel>¶
Channel → WaterLevel
type:double
Elevation of the water surface in meters for underwater sites, where 0 is sea level.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The unit of measurement |
unit=’DEGREES’ |
|
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
2.4.13. <Type>¶
Channel → Type
type:string
The type of data this channel collects. Corresponds to channel flags in SEED blockette 52. The SEED volume producer could use the first letter of an Output value as the SEED channel flag.
2.4.14. <SampleRate> required¶
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
|||
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
2.4.15. <SampleRateRatio>¶
Channel → SampleRateRatio
Sample rate expressed as number of samples in a number of seconds.
2.4.16. <ClockDrift>¶
Channel → ClockDrift
type:double range:ClockDrift \(\ge\) 0.0
A tolerance value, measured in seconds per sample, used as a threshold for time error detection in data from the channel.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
|||
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
2.4.17. <CalibrationUnits>¶
Channel → CalibrationUnits
A type to document true SI units.
<Name> required¶
2.4.18. <Sensor>¶
Channel → Sensor
If this was entered at the Station level, it is not necesary to do it for each Channel, unless you have differences in equipment. If using a sensor, use this field.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
resourceId |
no |
This field contains a string that should serve as a unique resource identifier. This identifier can be interpreted differently depending on the datacenter/software that generated the document. Also, we recommend to use something like GENERATOR:Meaningful ID. As a common behaviour equipment with the same ID should contains the same information/be derived from the same base instruments. |
2.4.19. <PreAmplifier>¶
Channel → PreAmplifier
If this was entered at the Station level, it is not necesary to do it for each Channel, unless you have differences in equipment. If using a preamplifier, use this field.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
resourceId |
no |
This field contains a string that should serve as a unique resource identifier. This identifier can be interpreted differently depending on the datacenter/software that generated the document. Also, we recommend to use something like GENERATOR:Meaningful ID. As a common behaviour equipment with the same ID should contains the same information/be derived from the same base instruments. |
2.4.20. <DataLogger>¶
Channel → DataLogger
If this was entered at the Station level, it is not necesary to do it for each Channel, unless you have differences in equipment. If using a datalogger, use this field.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
resourceId |
no |
This field contains a string that should serve as a unique resource identifier. This identifier can be interpreted differently depending on the datacenter/software that generated the document. Also, we recommend to use something like GENERATOR:Meaningful ID. As a common behaviour equipment with the same ID should contains the same information/be derived from the same base instruments. |
2.4.21. <Equipment>¶
Channel → Equipment
If the Equipment is entered at the Station level, it is not necesary to do it for each Channel, unless you have differences in equipment. If using a preamplifier, sensor, or datalogger, use their appropriate fields instead.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
resourceId |
no |
This field contains a string that should serve as a unique resource identifier. This identifier can be interpreted differently depending on the datacenter/software that generated the document. Also, we recommend to use something like GENERATOR:Meaningful ID. As a common behaviour equipment with the same ID should contains the same information/be derived from the same base instruments. |
2.5. <Response>¶
Instrument sensitivities, or the complete system sensitivity, can be expressed using either a sensitivity value or a polynomial. The information can be used to convert raw data to Earth at a specified frequency or within a range of frequencies. It is suggested that either InstrumentSensitivity or InstrumentPolynomial should be present.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
resourceId |
no |
Same meaning as Equipment:resourceId. |
2.5.1. <InstrumentSensitivity>¶
Response → InstrumentSensitivity
The total sensitivity for a channel, representing the complete acquisition system expressed as a scalar. Equivalent to SEED stage 0 gain (blockette 58) with the ability to specify a frequency range.
<Value> required¶
Response → InstrumentSensitivity → Value
type:double
A scalar that, when applied to the data values, converts the data to different units (e.g. Earth units).
<Frequency> required¶
Response → InstrumentSensitivity → Frequency
type:double
The frequency (in Hertz) at which the Value is valid.
<InputUnits> required¶
Response → InstrumentSensitivity → InputUnits
The units of the data as input from the perspective of data acquisition. After correcting data for this response, these would be the resulting units.
<OutputUnits> required¶
Response → InstrumentSensitivity → OutputUnits
The units of the data as output from the perspective of data acquisition. These would be the units of the data prior to correcting for this response.
2.5.2. <InstrumentPolynomial>¶
Response → InstrumentPolynomial
The total sensitivity for a channel, representing the complete acquisition system expressed as a polynomial. Equivalent to SEED stage 0 polynomial (blockette 62).
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
name |
no |
A name given to this filter. |
||
resourceId |
no |
Same meaning as Equipment:resourceId. |
<InputUnits> required¶
Response → InstrumentPolynomial → InputUnits
The units of the data as input from the perspective of data acquisition. After correcting data for this response, these would be the resulting units.
<OutputUnits> required¶
Response → InstrumentPolynomial → OutputUnits
The units of the data as output from the perspective of data acquisition. These would be the units of the data prior to correcting for this response.
<FrequencyLowerBound> required¶
Response → InstrumentPolynomial → FrequencyLowerBound
type:double
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
|||
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
<FrequencyUpperBound> required¶
Response → InstrumentPolynomial → FrequencyUpperBound
type:double
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
|||
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
<ApproximationLowerBound> required¶
Response → InstrumentPolynomial → ApproximationLowerBound
type:double
<ApproximationUpperBound> required¶
Response → InstrumentPolynomial → ApproximationUpperBound
type:double
<Coefficient> required¶
Response → InstrumentPolynomial → Coefficient
type:double
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
|||
number |
no |
2.5.3. <Stage>¶
Response → Stage
This complex type represents channel response and covers SEED blockettes 53 to 56.
<PolesZeros>¶
Response → Stage → PolesZeros
Response: complex poles and zeros. Corresponds to SEED blockette 53.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
name |
no |
A name given to this filter. |
||
resourceId |
no |
Same meaning as Equipment:resourceId. |
<InputUnits> required¶
Response → Stage → PolesZeros → InputUnits
The units of the data as input from the perspective of data acquisition. After correcting data for this response, these would be the resulting units.
<OutputUnits> required¶
Response → Stage → PolesZeros → OutputUnits
The units of the data as output from the perspective of data acquisition. These would be the units of the data prior to correcting for this response.
<PzTransferFunctionType> required¶
Response → Stage → PolesZeros → PzTransferFunctionType
type:string
<NormalizationFactor> required¶
<NormalizationFrequency> required¶
Response → Stage → PolesZeros → NormalizationFrequency
type:double
Should be within the passband, and the same for all stages.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
|||
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
<Zero>¶
Response → Stage → PolesZeros → Zero
Complex numbers used as poles or zeros in channel response.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
number |
no |
<Real> required¶
Response → Stage → PolesZeros → Zero → Real
type:double
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
<Pole>¶
Response → Stage → PolesZeros → Pole
Complex numbers used as poles or zeros in channel response.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
number |
no |
<Real> required¶
Response → Stage → PolesZeros → Pole → Real
type:double
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
<Coefficients>¶
Response → Stage → Coefficients
Response: coefficients for FIR filter. Laplace transforms or IIR filters can be expressed using type as well but the PolesAndZerosType should be used instead. Corresponds to SEED blockette 54.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
name |
no |
A name given to this filter. |
||
resourceId |
no |
Same meaning as Equipment:resourceId. |
<InputUnits> required¶
Response → Stage → Coefficients → InputUnits
The units of the data as input from the perspective of data acquisition. After correcting data for this response, these would be the resulting units.
<OutputUnits> required¶
Response → Stage → Coefficients → OutputUnits
The units of the data as output from the perspective of data acquisition. These would be the units of the data prior to correcting for this response.
<CfTransferFunctionType> required¶
Response → Stage → Coefficients → CfTransferFunctionType
type:string
<Numerator>¶
Response → Stage → Coefficients → Numerator
type:double
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
|||
number |
no |
<ResponseList>¶
Response → Stage → ResponseList
Response: list of frequency, amplitude and phase values. Corresponds to SEED blockette 55.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
name |
no |
A name given to this filter. |
||
resourceId |
no |
Same meaning as Equipment:resourceId. |
<InputUnits> required¶
Response → Stage → ResponseList → InputUnits
The units of the data as input from the perspective of data acquisition. After correcting data for this response, these would be the resulting units.
<OutputUnits> required¶
Response → Stage → ResponseList → OutputUnits
The units of the data as output from the perspective of data acquisition. These would be the units of the data prior to correcting for this response.
<ResponseListElement>¶
Response → Stage → ResponseList → ResponseListElement
<Frequency> required¶
Response → Stage → ResponseList → ResponseListElement → Frequency
type:double
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
|||
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
<Amplitude> required¶
Response → Stage → ResponseList → ResponseListElement → Amplitude
type:double
Representation of floating-point numbers used as measurements.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The unit of measurement |
unit=’DEGREES’ |
|
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
<Phase> required¶
Response → Stage → ResponseList → ResponseListElement → Phase
type:double range:-360.0 \(\le\) Phase
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
|||
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
<FIR>¶
Response → Stage → FIR
Response: FIR filter. Specifically for symmetrical filters. Corresponds to SEED blockette 61. FIR filters are also commonly documented using the CoefficientsType element.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
name |
no |
A name given to this filter. |
||
resourceId |
no |
Same meaning as Equipment:resourceId. |
<InputUnits> required¶
Response → Stage → FIR → InputUnits
The units of the data as input from the perspective of data acquisition. After correcting data for this response, these would be the resulting units.
<OutputUnits> required¶
Response → Stage → FIR → OutputUnits
The units of the data as output from the perspective of data acquisition. These would be the units of the data prior to correcting for this response.
<Decimation>¶
Response → Stage → Decimation
Corresponds to SEED blockette 57.
<InputSampleRate> required¶
Response → Stage → Decimation → InputSampleRate
type:double
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
|||
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
<Delay> required¶
Response → Stage → Decimation → Delay
type:double
The estimated pure delay for the stage. This value will almost always b positive to indicate a delayed signal. Due to the difficulty in estimating the pure delay of a stage and because dispersion is neglected, this value should be considered nominal. Normally the delay would be corrected by the recording system and the correction applied would be specified in <Correction> below. See Decimation Section Fig. XX for a schematic description of delay sign convention.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The unit of measurement |
unit=’DEGREES’ |
|
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
<Correction> required¶
Response → Stage → Decimation → Correction
type:double
The time shift, if any, applied to correct for the delay at this stage. The sign convention used is opposite the <Delay> above; a positive sign here indicates that the trace was corrected to an earlier time to cancel the delay caused by the stage and indicated in the <Delay> element. Commonly, the estimated delay and the applied correction are both positive to cancel each other. A zero indicates no correction was applied. See Decimation Section Fig. XX for a schematic description of delay sign convention.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The unit of measurement |
unit=’DEGREES’ |
|
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
<StageGain> required¶
Response → Stage → StageGain
The gain at the stage of the encapsulating response element at a specific frequencey and corresponds to SEED blockette 58. In the SEED convention, stage 0 gain represents the overall sensitivity of the channel. In this schema, stage 0 gains are allowed but are considered deprecated. Overall sensitivity should be specified in the InstrumentSensitivity element.
<Polynomial> required¶
Response → Stage → Polynomial
Response: expressed as a polynomial (allows non-linear sensors to be described). Corresponds to SEED blockette 62. Can be used to describe a stage of acquisition or a complete system.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
name |
no |
A name given to this filter. |
||
resourceId |
no |
Same meaning as Equipment:resourceId. |
<InputUnits> required¶
Response → Stage → Polynomial → InputUnits
The units of the data as input from the perspective of data acquisition. After correcting data for this response, these would be the resulting units.
<OutputUnits> required¶
Response → Stage → Polynomial → OutputUnits
The units of the data as output from the perspective of data acquisition. These would be the units of the data prior to correcting for this response.
<FrequencyLowerBound> required¶
Response → Stage → Polynomial → FrequencyLowerBound
type:double
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
|||
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
<FrequencyUpperBound> required¶
Response → Stage → Polynomial → FrequencyUpperBound
type:double
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
|||
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
<ApproximationLowerBound> required¶
Response → Stage → Polynomial → ApproximationLowerBound
type:double
<ApproximationUpperBound> required¶
Response → Stage → Polynomial → ApproximationUpperBound
type:double
<Coefficient> required¶
Response → Stage → Polynomial → Coefficient
type:double
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
plusError |
no |
plus uncertainty or error in measured value. |
plusError=0.1 |
|
minusError |
no |
minus uncertainty or error in measured value. |
minusError=0.1 |
|
measurementMethod |
no |
|||
number |
no |