2. StationXML Reference¶
2.1. <FDSNStationXML> required¶
Root-level for StationXML documents.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
schemaVersion |
yes |
The StationXML schema version of this document. |
schemaVersion=”1.1” |
2.1.1. <Source> required¶
2.1.3. <Module>¶
FDSNStationXML → Module
type:string
Name of the software module that generated this document.
Example: <Module>SeisComp3</Module>
2.2. <Network> required¶
The Network container. All station metadata for this network is contained within this element. A Description element may be included with the official network name and other descriptive information. An Identifier element may be included to designate a persistent identifier (e.g. DOI) to use for citation. A Comment element may be included for additional comments.
Example: <Network code=”XX” startDate=”2016-01-27T13:00:00” />
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
alternateCode |
no |
A code use for display or association |
alternateCode=”GSN” |
|
code |
yes |
Name of Network |
code=”XX” |
|
endDate |
no |
End date of network |
endDate=”2018-01-27T00:00:00” |
|
historicalCode |
no |
LevelDefault:A previously used code if different from the current code |
historicalCode=”XX” |
|
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 |
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 identifier type is documented as an attribute.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
type |
no |
Identifier type |
type=”DOI” |
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
Comment text.
Example: <Value>Temporary network deployment</Value>
<BeginEffectiveTime>¶
Network → Comment → BeginEffectiveTime
type:dateTime
Start time for when comment applies.
Example: <BeginEffectiveTime>2008-09-15T00:00:00</BeginEffectiveTime>
<EndEffectiveTime>¶
Network → Comment → EndEffectiveTime
type:dateTime
End time for when comment applies.
Example: <EndEffectiveTime>2008-09-16T12:00:00</EndEffectiveTime>
<Author>¶
Network → Comment → Author
Author of Comment. Person’s contact information. 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@nosuchsite.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 within the request range. These details may or may not be retained when synchronizing metadata between data centers. A type for describing data availability.
<Extent>¶
Network → DataAvailability → Extent
Data availability extents, the earliest and latest data available. No information 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. An operating agency and associated contact persons. Since the Contact element is a generic type that represents any contact person, it also has its own optional Agency element. It is expected that typically the contact’s optional Agency tag will match the Operator Agency. Only contacts appropriate for the enclosing element should be include in the Operator tag.
<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@nosuchsite.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 is likely to be deprecated in future versions of StationXML
type:decimal range:TotalNumberStations \(\ge\) 0
The total number of stations in this network, including inactive or terminated stations.
Example: <TotalNumberStations>24</TotalNumberStations>
2.2.7. <SelectedNumberStations>¶
Network → SelectedNumberStations
Warning
This field is likely to be deprecated in future versions of StationXML
type:decimal range:SelectedNumberStations \(\ge\) 0
The number of stations selected in the request that resulted in this document.
Example: <SelectedNumberStations>12</SelectedNumberStations>
2.3. <Station>¶
The Station container. All channel metadata for this station is contained within this element. A Description element may be included with the official station name and other descriptive 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 additional comments.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
alternateCode |
no |
A code use for display or association |
alternateCode=”ALQ” |
|
code |
yes |
Name of Station |
code=”ABCD” |
|
endDate |
no |
End date of station epoch |
endDate=”2018-01-27T00:00:00” |
|
historicalCode |
no |
LevelDefault:A previously used code if different from the current code |
historicalCode=”albq” |
|
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 station 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 identifier type is documented as an attribute.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
type |
no |
Identifier type |
type=”DOI” |
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¶
<BeginEffectiveTime>¶
Station → Comment → BeginEffectiveTime
type:dateTime
Start time for when comment applies.
Example: <BeginEffectiveTime>2008-09-15T00:00:00</BeginEffectiveTime>
<EndEffectiveTime>¶
Station → Comment → EndEffectiveTime
type:dateTime
End time for when comment applies.
Example: <EndEffectiveTime>2008-09-16T12:00:00</EndEffectiveTime>
<Author>¶
Station → Comment → Author
Author of Comment. Person’s contact information. 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@nosuchsite.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 within the request range. These details may or may not be retained when synchronizing metadata between data centers. A type for describing data availability.
<Extent>¶
Station → DataAvailability → Extent
Data availability extents, the earliest and latest data available. No information 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 \(\lt\) 90.0
Station latitude, by default in degrees. Where the bulk of the equipment is located (or another appropriate site location). Latitude type extending the base type to add datum as an attribute with default.
Example: <Latitude unit=”DEGREES” datum=”WGS84”>34.9459</Latitude>
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The type of unit being used. |
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 |
|||
datum |
no |
2.3.6. <Longitude> required¶
Station → Longitude
type:double range:-180.0 \(\le\) Longitude \(\le\) 180.0
Station longitude, by default in degrees. Where the bulk of the equipment is located (or another appropriate site location). Longitude type extending the base type to add datum as an attribute with default.
Example: <Longitude unit=”DEGREES” datum=”WGS84”>-106.4572</Longitude>
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The type of unit being used. |
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 |
|||
datum |
no |
2.3.7. <Elevation> required¶
Station → Elevation
type:double
Elevation of local ground surface level at station, by default in meters. Extension of FloatType for distances, elevations, and depths.
Example: <Elevation unit=”m”>1850.0</Elevation>
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The type of unit being used. |
unit=”m” |
|
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
Description of the location of the station using geopolitical entities (country, city, etc.). Description of a site location using name and optional geopolitical boundaries (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 mean sea level. If you put an ocean-bottom seismometer (OBS) on a lake bottom, where the lake surface is at elevation=0, then you should set WaterLevel=0. Representation of floating-point numbers used as measurements.
Example: <WaterLevel>1200</WaterLevel>
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The unit of measurement. Use SI unit names and symbols whenever possible (e.g., ‘m’ instead of ‘METERS’). |
unit=”m” |
|
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>¶
Station → Vault
type:string
Type of vault, e.g. World-Wide Standardized Seismograph Network (WWSSN), tunnel, USArray Transportable Array Generation 2, etc.
2.3.11. <Geology>¶
2.3.12. <Equipment>¶
Station → Equipment
Equipment used by all channels at a station. A type for equipment related to data acquisition or processing.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
resourceId |
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/be derived from the same base instruments. |
<InstallationDate>¶
2.3.13. <Operator>¶
Station → Operator
Operator and associated contact persons An operating agency and associated contact persons. Since the Contact element is a generic type that represents any contact person, it also has its own optional Agency element. It is expected that typically the contact’s optional Agency tag will match the Operator Agency. Only contacts appropriate for the enclosing element should be include in the Operator tag.
<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@nosuchsite.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>¶
Station → CreationDate
Warning
This field is likely to be deprecated in future versions of StationXML
type:dateTime
Date and time (UTC) when the station was first installed.
2.3.15. <TerminationDate>¶
Station → TerminationDate
Warning
This field is likely to be deprecated in future versions of StationXML
type:dateTime
Date and time (UTC) when the station was terminated or will be terminated. Do not include this field if a termination date is not available or is not relevant.
2.3.16. <TotalNumberChannels>¶
Station → TotalNumberChannels
Warning
This field 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 is likely to be deprecated in future versions of StationXML.
type:decimal range:SelectedNumberChannels \(\ge\) 0
The number of channels selected in the request that resulted in this document.
2.3.18. <ExternalReference>¶
Station → ExternalReference
URI of any type of external report This type contains a Uniform Resource Identifier (URI) and and description for external information that users may want to reference.
2.4. <Channel>¶
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.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
alternateCode |
no |
A code use for display or association |
alternateCode=”Z” |
|
code |
yes |
Name of Channel |
code=”BHZ” |
|
endDate |
no |
End date of channel epoch |
endDate=”2018-01-27T00:00:00” |
|
historicalCode |
no |
LevelDefault:A previously used code if different from the current code |
historicalCode=”bhz” |
|
locationCode |
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 |
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 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 identifier type is documented as an attribute.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
type |
no |
Identifier type |
type=”DOI” |
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¶
<BeginEffectiveTime>¶
Channel → Comment → BeginEffectiveTime
type:dateTime
Start time for when comment applies.
Example: <BeginEffectiveTime>2008-09-15T00:00:00</BeginEffectiveTime>
<EndEffectiveTime>¶
Channel → Comment → EndEffectiveTime
type:dateTime
End time for when comment applies.
Example: <EndEffectiveTime>2008-09-16T12:00:00</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.
<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@nosuchsite.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 within the request range. These details may or may not be retained when synchronizing metadata between data centers. A type for describing data availability.
<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.
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. This type contains a Uniform Resource Identifier (URI) and and description for external information that users may want to reference.
2.4.6. <Latitude> required¶
Channel → Latitude
type:double range:-90.0 \(\le\) Latitude \(\lt\) 90.0
Latitude of this channel’s sensor, by default 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 unit=”DEGREES” datum=”WGS84”>34.9459</Latitude>
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The type of unit being used. |
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 |
|||
datum |
no |
2.4.7. <Longitude> required¶
Channel → Longitude
type:double range:-180.0 \(\le\) Longitude \(\le\) 180.0
Longitude of this channel’s sensor, by default 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 unit=”DEGREES” datum=”WGS84”>-106.4572</Longitude>
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The type of unit being used. |
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 |
|||
datum |
no |
2.4.8. <Elevation> required¶
Channel → Elevation
type:double
Elevation of the sensor, by default in meters. To find the local ground surface level, add the Depth value to this elevation. Extension of FloatType for distances, elevations, and depths.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The type of unit being used. |
unit=”m” |
|
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 depth of the sensor relative to the local ground surface level, in meters. Extension of FloatType for distances, elevations, and depths.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The type of unit being used. |
unit=”m” |
|
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 \(\lt\) 360.0
Azimuth of the sensor in degrees clockwise from geographic (true) north. Instrument azimuth, degrees clockwise from North.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The type of unit being used. |
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.11. <Dip>¶
Channel → Dip
type:double range:-90.0 \(\le\) Dip \(\le\) 90.0
Dip of the instrument in degrees, positive down from horizontal Instrument dip in degrees, positive down from horizontal.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The type of unit being used. |
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.12. <WaterLevel>¶
Channel → WaterLevel
type: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=0, then you should set WaterLevel=0. Representation of floating-point numbers used as measurements.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The unit of measurement. Use SI unit names and symbols whenever possible (e.g., ‘m’ instead of ‘METERS’). |
unit=”m” |
|
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
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.
Example: <Type>CONTINUOUS</Type>
2.4.14. <SampleRate>¶
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The type of unit being used. |
unit=”SAMPLES/S” |
|
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
Example:
<SampleRate>3.859999367e-07</SampleRate>
<SampleRateRatio>
<NumberSamples>1</NumberSamples>
<NumberSeconds>2590674</NumberSeconds>
</SampleRateRatio>
2.4.16. <ClockDrift>¶
Channel → ClockDrift
type:double range:ClockDrift \(\ge\) 0.0
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 |
The unit of drift value. |
unit=”SECONDS/SAMPLE” |
|
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
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>
2.4.18. <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.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
resourceId |
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/be derived from the same base instruments. |
<InstallationDate>¶
2.4.19. <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.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
resourceId |
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/be derived from the same base instruments. |
<InstallationDate>¶
2.4.20. <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.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
resourceId |
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/be derived from the same base instruments. |
<InstallationDate>¶
2.4.21. <Equipment>¶
Channel → Equipment
If the Equipment is entered at the Station level, it is not necessary to do it for each Channel, unless you have differences in equipment. If using a preamplifier, sensor, or datalogger, use their appropriate fields instead. A type for equipment related to data acquisition or processing.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
resourceId |
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/be derived from the same base instruments. |
<InstallationDate>¶
2.5. <Response>¶
The complete instrument response for this channel that expresses the effect of the geophysical instrumentation used to record the input ground motion. The information can be used to convert raw data to Earth unit measurement at a specified frequency or within a range of frequencies. It is strongly suggested that either InstrumentSensitivity or InstrumentPolynomial should be present.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
resourceId |
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/be derived from the same base instruments. |
2.5.1. <InstrumentSensitivity>¶
Response → InstrumentSensitivity
The total sensitivity for a channel, representing the complete acquisition system expressed as a scalar. All instrument responses except polynomial response should have an InstrumentSensitivity. Type for sensitivity, input/output units and relevant frequency range.
<Value> required¶
Response → InstrumentSensitivity → Value
type:double
A scalar value representing the amount of amplification or diminuition, if any, the current stage applies to the input signal.
<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. A type to document units; use SI whenever possible.
<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. A type to document units; use SI whenever possible.
<FrequencyStart>¶
Response → InstrumentSensitivity → FrequencyStart
type:double
The lowest frequency for which the InstrumentSensitivity is valid. <FrequencyStart>, <FrequencyEnd> and <FrequencyDBVariation> are not required, however, if one of these is present, then all must be present.
2.5.2. <InstrumentPolynomial>¶
Response → InstrumentPolynomial
For non-linear sensors (e.g., \(N\ge 2\)), such as some thermistors, pressure transducers, extensometers, etc.), it is required to express the sensor input (e.g., Temp) as a Maclaurin series expansion of powers of the output units (e.g., Volts):
\begin{eqnarray}Temp(V)=\sum_{k=0}^{N} a_k V^{k}\end{eqnarray}For such responses, two StationXML components are required to specify the response: 1. A Polynomial stage, which contains the values of the Maclaurin coefficients, \(a_k\), and 2. An InstrumentPolynomial element that contains the same coefficients, but scaled by powers of the overall gain representing the combined effect of all the stages in the complete acquisition system. Response type for a reponse represented as a polynomial expansion, which allows non-linear sensors to be described. Used at either a stage of acquisition response or a complete system.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
name |
no |
A name given to this filter. |
||
resourceId |
no |
A resource identifier that serves to unique identify this filter or response. 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/be derived from the same base instruments. |
<Description>¶
Response → InstrumentPolynomial → Description
type:string
The description of the filter/stage/response.
<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. A type to document units; use SI whenever possible.
<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. A type to document units; use SI whenever possible.
<ApproximationType> required¶
Response → InstrumentPolynomial → ApproximationType
type:string
The series type for the polynomial approximation.
<FrequencyLowerBound> required¶
Response → InstrumentPolynomial → FrequencyLowerBound
type:double
The lower bound of the frequency range.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The type of unit being used. |
unit=”HERTZ” |
|
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
The upper bound of the frequency range.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The type of unit being used. |
unit=”HERTZ” |
|
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
The lower bound of the approximation range.
<ApproximationUpperBound> required¶
Response → InstrumentPolynomial → ApproximationUpperBound
type:double
The upper bound of the approximation range.
<MaximumError> required¶
<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
Type for channel response entry or stage. A full response is represented as an ordered sequence of these stages.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
number |
yes |
Stage sequence number. This is used in all the response blockettes. Start from name=’1’ and iterate sequentially. |
||
resourceId |
no |
A resource identifier that serves to uniquely identify this response stage. 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/be derived from the same base instruments. |
<PolesZeros>¶
Response → Stage → PolesZeros
Response stage described by the complex poles and zeros of the Laplace Transform (or z-transform) of the transfer function for this stage.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
name |
no |
A name given to this filter. |
||
resourceId |
no |
A resource identifier that serves to unique identify this filter or response. 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/be derived from the same base instruments. |
<Description>¶
Response → Stage → PolesZeros → Description
type:string
The description of the filter/stage/response.
<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. A type to document units; use SI whenever possible.
<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. A type to document units; use SI whenever possible.
<PzTransferFunctionType> required¶
Response → Stage → PolesZeros → PzTransferFunctionType
type:string
Allowable values are:”LAPLACE (RADIANS/SECOND)”, “LAPLACE (HERTZ)”, “DIGITAL (Z-TRANSFORM)”. For an analog stage this should be the units of the poles and zeros of the Laplace Transform, either: “LAPLACE (RADIANS/SECOND)” or “LAPLACE (HERTZ)”. For a digial z-transform (e.g., for an IIR filter), this should be “DIGITAL (Z-TRANSFORM)”.
Example: <PzTransferFunctionType>LAPLACE (RADIANS/SECOND)</PzTransferFunctionType>
<NormalizationFactor> required¶
<NormalizationFrequency> required¶
Response → Stage → PolesZeros → NormalizationFrequency
type:double
Frequency at which the NormalizationFactor is valid. This should be the same for all stages and within the passband, if any.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The type of unit being used. |
unit=”HERTZ” |
|
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 zero of the polezero stage.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
number |
no |
The position index of the pole (or zero) in the array of poles[] (or zeros[]) |
number=”None” |
<Real> required¶
Response → Stage → PolesZeros → Zero → Real
type:double
Real part of the pole or zero. Representation of floating-point numbers without unit.
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 |
<Imaginary> required¶
Response → Stage → PolesZeros → Zero → Imaginary
type:double
Imaginary part of the pole or zero. Representation of floating-point numbers without unit.
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 pole of the polezero stage.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
number |
no |
The position index of the pole (or zero) in the array of poles[] (or zeros[]) |
number=”None” |
<Real> required¶
Response → Stage → PolesZeros → Pole → Real
type:double
Real part of the pole or zero. Representation of floating-point numbers without unit.
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 |
<Imaginary> required¶
Response → Stage → PolesZeros → Pole → Imaginary
type:double
Imaginary part of the pole or zero. Representation of floating-point numbers without unit.
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 type for FIR coefficients. Laplace transforms or IIR filters can both be expressed using type as well but the PolesAndZerosType should be used instead.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
name |
no |
A name given to this filter. |
||
resourceId |
no |
A resource identifier that serves to unique identify this filter or response. 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/be derived from the same base instruments. |
<Description>¶
Response → Stage → Coefficients → Description
type:string
The description of the filter/stage/response.
<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. A type to document units; use SI whenever possible.
<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. A type to document units; use SI whenever possible.
<CfTransferFunctionType> required¶
Response → Stage → Coefficients → CfTransferFunctionType
type:string
Almost always a digital response, but can be an analog response in rad/sec or Hertz.
<Numerator>¶
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 |
<Denominator>¶
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 type for a list of frequency, amplitude, and phase values.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
name |
no |
A name given to this filter. |
||
resourceId |
no |
A resource identifier that serves to unique identify this filter or response. 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/be derived from the same base instruments. |
<Description>¶
Response → Stage → ResponseList → Description
type:string
The description of the filter/stage/response.
<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. A type to document units; use SI whenever possible.
<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. A type to document units; use SI whenever possible.
<ResponseListElement>¶
Response → Stage → ResponseList → ResponseListElement
<Frequency> required¶
Response → Stage → ResponseList → ResponseListElement → Frequency
type:double
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The type of unit being used. |
unit=”HERTZ” |
|
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. Use SI unit names and symbols whenever possible (e.g., ‘m’ instead of ‘METERS’). |
unit=”m” |
|
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 \(\le\) 360.0
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The type of unit being used. |
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 |
<FIR>¶
Response → Stage → FIR
Response type for FIR filter. FIR filters are also commonly documented using the Coefficients element, with this newer type allowing representation of symmetric FIR coefficients without repeating them.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
name |
no |
A name given to this filter. |
||
resourceId |
no |
A resource identifier that serves to unique identify this filter or response. 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/be derived from the same base instruments. |
<Description>¶
<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. A type to document units; use SI whenever possible.
<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. A type to document units; use SI whenever possible.
<Decimation>¶
Response → Stage → Decimation
Representation of decimation stage.
<InputSampleRate> required¶
Response → Stage → Decimation → InputSampleRate
type:double
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The type of unit being used. |
unit=”HERTZ” |
|
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 |
<Factor> required¶
Response → Stage → Decimation → Factor
type:integer
The factor of the input sample rate by which the rate is reduced.
<Offset> required¶
Response → Stage → Decimation → Offset
type:integer
Sample offset chosen for use. The value should be greater than or equal to zero, but less than the decimation factor. If the first sample is used, set this field to zero. If the second sample, set it to 1, and so forth.
<Delay> required¶
Response → Stage → Decimation → Delay
type:double
The estimated pure delay for the stage. This value will almost always be 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 the Decimation Section in the StationXML documentation for a schematic description of delay sign convention. Representation of floating-point numbers used as measurements.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The unit of measurement. Use SI unit names and symbols whenever possible (e.g., ‘m’ instead of ‘METERS’). |
unit=”SECONDS” |
|
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> value; 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 value of zero indicates no correction was applied. See the Decimation Section in the StationXML documentation for a schematic description of delay sign convention. Representation of floating-point numbers used as measurements.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The unit of measurement. Use SI unit names and symbols whenever possible (e.g., ‘m’ instead of ‘METERS’). |
unit=”SECONDS” |
|
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 frequency. Total channel sensitivity should be specified in the InstrumentSensitivity element. Type used for representing sensitivity at a given frequency. This complex type can be used to represent both total sensitivities and individual stage gains.
<Polynomial> required¶
Response → Stage → Polynomial
When a response is given in terms of a polynomial expansion of powers of the sensor output signal (e.g., Volts), a Polynomial Stage is required to specify the Maclaurin coefficients of the expansion. In addition, an InstrumentPolynomial element must be present at Response level to represent the whole acquisition process, which contains the same Maclaurin coefficients, but scaled by powers of the overall gain for all stages. Response type for a reponse represented as a polynomial expansion, which allows non-linear sensors to be described. Used at either a stage of acquisition response or a complete system.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
name |
no |
A name given to this filter. |
||
resourceId |
no |
A resource identifier that serves to unique identify this filter or response. 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/be derived from the same base instruments. |
<Description>¶
Response → Stage → Polynomial → Description
type:string
The description of the filter/stage/response.
<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. A type to document units; use SI whenever possible.
<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. A type to document units; use SI whenever possible.
<ApproximationType> required¶
Response → Stage → Polynomial → ApproximationType
type:string
The series type for the polynomial approximation.
<FrequencyLowerBound> required¶
Response → Stage → Polynomial → FrequencyLowerBound
type:double
The lower bound of the frequency range.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The type of unit being used. |
unit=”HERTZ” |
|
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
The upper bound of the frequency range.
attribute |
type |
required |
description |
example |
|---|---|---|---|---|
unit |
no |
The type of unit being used. |
unit=”HERTZ” |
|
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
The lower bound of the approximation range.
<ApproximationUpperBound> required¶
Response → Stage → Polynomial → ApproximationUpperBound
type:double
The upper bound of the approximation range.
<MaximumError> required¶
<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 |