FDSN StationXML schema. A metadata
standard for seismological and related data.
Root-level for StationXML documents.
Originator of the information contained in the document.
It is recommended that archives or services providing StationXML that are not
the original creator of the metadata set this to be
the empty element, especially because a StationXML document may
contain information from many unrelated networks.
This element is likely to be a choice with Sender.
Name of the institution sending this document,
for example the institution hosting an FDSN Station web service.
It is recommended that authoritative StationXML
created by the originator of the metadata not use Sender and
use Source instead. For example metadata created by a network
operator for submission to other data archives would only use Source,
The data archive in response to a request would use Sender.
This element is likely to be a choice with Source.
Name of the software module that generated this document.
SeisComp3
Resource identifier of the query that generated the document,
or, if applicable, the resource identifier of the software that generated this document.
Date that this document was generated.
The StationXML schema version of this document.
1.2
This attribute may change to be a string to allow micro versions,
and potential dash, '-', separators starting in version 2. Users
should not assume 'xs:decimal'.
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.
An active Network should not use the endDate attribute.
Unlike SEED, do not use an endDate in the distant future to mean active.
Agency and contact persons who manage this network.
The total number of stations in this
network, including inactive or terminated stations.
24
This element is likely to be removed.
The number of stations selected in the request that resulted
in this document.
12
This element is likely to be removed.
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.
An active Station should not use the endDate attribute.
Unlike SEED, do not use an endDate in the distant future to mean active.
Station latitude, in degrees. Where the bulk of the equipment is located (or another appropriate site location).
The unit is fixed to be degrees, and datum defaults to WGS84.
34.9459
Station longitude, in degrees. Where the bulk of the equipment is located (or another appropriate site location).
The unit is fixed to be degrees, and datum defaults to WGS84.
-106.4572
Elevation of local ground surface level at station, in meters.
1850.0
Elevation of the water surface in meters for underwater sites, where 0 is mean sea level.
If you put an OBS on a lake bottom, where the lake surface is at elevation=1200 meters,
then you should set WaterLevel=1200. An OBS in the ocean would
have WaterLevel=0.
1200
Type of vault, e.g. World-Wide Standardized Seismograph Network (WWSSN), tunnel,
USArray Transportable Array Generation 2, etc.
Type of rock and/or geologic formation at the station.
Equipment used by all channels at a station,
Equipment that contributes to or affects the response of a channel should be documented on the channel.
Agency who manage this station.
Only use if this differs from the Operator of the Network.
Date and time (UTC) when the station was first installed.
This element is likely to be removed.
Date and time (UTC) when the station was terminated or
will be terminated. Do not include this element if a termination date is not available or is not relevant.
This element is likely to be removed.
Total number of channels recorded at this station.
This element is likely to be removed.
The number of channels selected in the request that resulted in this document.
This element is likely to be removed.
URI of any type of external report
The Channel container.
A Description element may be included with other information.
An Identifier element may be included to designate a persistent identifier (e.g. DOI) to use for citation or reference.
A Comment element may be included for arbitrary comments.
An active Channel should not use the endDate attribute.
Unlike SEED, do not use an endDate in the distant future to mean active.
URI of any type of external report, such as data quality reports.
Latitude of this channel's sensor, in degrees.
Often the same as the station latitude, but
when different the channel latitude is the true location of the sensor.
34.9459
Longitude of this channel's sensor, in degrees.
Often the same as the station longitude, but
when different the channel longitude is the true location of the sensor.
-106.4572
Elevation of the sensor, in meters. To find the local ground surface level,
add the Depth value to this elevation.
The depth of the sensor relative to the local ground surface level, in meters.
Elevation of the water surface in meters for underwater sites, where 0 is mean sea level.
If you put an OBS on a lake bottom, where the lake surface is at elevation=1200 meters,
then you should set WaterLevel=1200. An OBS in the ocean would
have WaterLevel=0.
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.
CONTINUOUS
This element existed primarily to hold the corresponding
value from SEED, but should not be used for new StationXML.
This element is likely to be removed.
Tolerance value, measured in seconds per sample,
used as a threshold for time error detection in data from the channel.
The unit of drift value.
This value is fixed to be SECONDS/SAMPLE, setting it is redundant.
Units of calibration (e.g., V (for Volts) or A (for amps))
Use *SI* units when possible
V
Volts
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.
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.
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.
Any equipment that does not have type-specific fields.
Equipment such as sensor, data logger and preamplifier that has type-specific fields should be documented in those structures.
If the same Equipment is entered at the Station level, it is not necessary to include it for each Channel.
If using a preamplifier, sensor, or datalogger, use their appropriate fields instead.
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.
30
Type used for representing sensitivity at a given frequency. This complex type
can be used to represent both total sensitivities and individual stage gains.
A scalar value representing the amount of amplification or diminution, if any,
the current stage applies to the input signal.
The frequency (in Hertz) at which the Value is valid.
While any frequency in the passband is acceptable, it is preferred that:
#. For low pass FIR filters, use gain at zero frequency (sum of coefficients)
#. If given, use manufacturer frequency/gain without recomputing
#. For anything else, frequency should be in the "good" part of the passband
#. All stage frequencies should be below the final Nyquist, as long as 2,3 are satisfied
#. All stages, except lowpass FIR filters, should use the same frequencies, as long as 2,3 are satisfied
#. Overall gain should also use the same frequency as 5, as long as it is below the final Nyquist and in the good part of the final passband
Type for defining a pass band (in Hertz) from FrequencyStart to FrequencyEnd
in which a sensitivity value is valid within the number of decibels (dB) specified in FrequencyDBVariation.
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.
The highest 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.
Variation in decibels within the specified frequency range.
<FrequencyStart>, <FrequencyEnd> and <FrequencyDBVariation> are not
required, however, if one of these is present, then all must be present.
Type for sensitivity, input/output units and relevant frequency range.
The units of the data as input to the sensor. For example
if stage 1 represented a seismometer, InputUnits would be 'm/s'
and OutputUnits would be 'V'.
The units of the data as output from data
acquisition system. For most channels recorded by
systems that use an AtoD, the OutputUnits will be 'count'.
The frequency range for which the sensitivity value is
valid within the dB variation specified.
A type for equipment related to data acquisition or processing.
Type of equipment
Description of equipment
Manufacturer of equipment
Vendor of equipment
Model of equipment
Serial number of equipment
Date this equipment was installed
Date this equipment was removed
Date this equipment was calibrated
An identifier that serves to uniquely identify this resource.
This identifier can be interpreted differently depending on the datacenter/software
that generated the document. Also, we recommend using a prefix, e.g., GENERATOR:Meaningful ID.
It should be expected that equipment with the same ID should indicate the same information or be
derived from the same base instruments.
Type for channel response entry or stage. A full response is
represented as an ordered sequence of these stages.
A filter, (PolesZeros, Coefficients, FIR, etc) is not required, but is
recommended to provide a place to store the input and output units
even in the case of "gain-only" stages.
For an analog gain-only stage, use a PolesZeros filter with no poles
or zeros, PzTransferFunctionType=LAPLACE (RADIANS/SECOND)",
NormalizationFactor=1 and NormalizationFrequency=0.
For a digital gain-only stage, use a FIR filter with one
numerator with value 1.0, and symmetry=NONE. While a digital Coefficients
filter can serve the same purpose and is common, the FIR filter is more concise.
A filter, (PolesZeros, Coefficients, FIR, etc) may be required.
A choice of polynomial versus all other response types,
to enforce one response per stage.
Response stage described by the complex poles and zeros of the Laplace Transform (or z-transform)
of the transfer function for this stage.
The gain at the stage of the encapsulating
response element at a specific frequency.
Total channel sensitivity should be specified in the InstrumentSensitivity
element.
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.
Stage sequence number. This is used in all the response
blockettes. Start from name='1' and iterate sequentially.
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.
Container for a comment or log entry.
Comment text.
Temporary network deployment
GPS Clock is unlocked
Large number of spikes
Start time for when comment applies.
2008-09-15T00:00:00Z
End time for when comment applies.
2008-09-16T12:00:00Z
Author of Comment.
An ID for this comment
12345
A subject for this comment. Multiple comments with the same
subject should be considered related.
Scheduled maintenance
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 digital z-transform (e.g., for an IIR filter), this should be
"DIGITAL (Z-TRANSFORM)"
LAPLACE (RADIANS/SECOND)
Normalization scale factor
Frequency at which the NormalizationFactor is valid.
This should be the same for all stages and within the passband, if any.
Complex zero of the polezero stage.
Complex pole of the polezero stage.
Response type for FIR filter. FIR filters
are also commonly documented using a digital Coefficients element with no
denominators, but it is preferred to use this type
allowing representation of symmetric FIR coefficients without repeating them.
The NumeratorCoefficient field is likely to be changed to require at least one numerator in future versions of StationXML.
The NumeratorCoefficient field is likely to be renamed to Numerator in future versions of StationXML.
The symmetry code. Designates how the factors will be specified.
* NONE: No Symmetry - all Coefficients are specified, corresponds to A in SEED.
* ODD: Odd number Coefficients with symmetry, B in SEED.
* EVEN: Even number Coefficients with symmetry, C in SEED.
The coefficients of the FIR filter. Should include at least one.
At least one Numerator may be required.
May be renamed to Numerator.
Response type for filter giving coefficients. Laplace transforms or analog
filters can both be expressed using this type as well but the PolesZeros should be used
instead. Digital filters with no denominator should use FIR instead.
The Numerator element is likely to be changed to require at least one numerator.
Almost always a digital response, but can be an
analog response in rad/sec or Hertz.
Numerator for the coefficient. Should include at least one.
At least one Numerator may be required.
Denominator for the coefficient
Response type for a list of frequency, amplitude, and phase values.
Because it is less flexible, the other filter types, PolesZeros,
Coefficients, FIR, etc, are preferred.
Response type for a response 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.
The series type for the polynomial approximation
The lower bound of the frequency range.
The upper bound of the frequency range.
The lower bound of the approximation range.
The upper bound of the approximation range.
The maximum error of the approximation.
Representation of decimation stage
The factor of the input sample rate by which the rate is reduced.
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.
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.
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.
Attributes for expressing uncertainties or errors with positive and negative
components. Both values should be given as positive integers, but the minusError is
understood to be negative.
plus uncertainty or error in measured value.
0.1
minus uncertainty or error in measured value.
0.1
Representation of floating-point numbers without unit.
The unit of measurement. Use *SI* unit names and symbols whenever possible
(e.g., 'm' instead of 'METERS').
s
m
m
A time duration value in seconds.
The type of unit being used.
This value is fixed to be SECONDS, setting it is redundant.
The type of unit being used.
This value is fixed to be VOLTS, setting it is redundant.
The type of unit being used.
This value is fixed to be DEGREES, setting it is redundant.
Base latitude type.
The type of unit being used.
This value is fixed to be DEGREES, setting it is redundant.
Latitude type extending the base type to add datum as an attribute with default.
Base longitude type.
The type of unit being used.
This value is fixed to be DEGREES, setting it is redundant.
Longitude type extending the base type to add datum as an attribute with default.
Azimuth of the component in degrees clockwise from geographic (true) north.
The type of unit being used.
This value is fixed to be DEGREES, setting it is redundant.
Dip of the component in degrees, positive is down from horizontal.
For horizontal dip=0, for vertical upwards
dip=-90 and for vertical downwards dip=+90.
The type of unit being used.
This value is fixed to be DEGREES, setting it is redundant.
The type of unit being used.
This value is fixed to be METERS, setting it is redundant.
The type of unit being used.
This value is fixed to be HERTZ, setting it is redundant.
This is a group of elements that represent sample rate. If this group
is included, then SampleRate, which is the sample rate in samples per second, is
required. SampleRateRatio, which is expressed as a ratio of number of samples in a
number of seconds, is optional. If both are included, SampleRate should be
considered more definitive.
Sample rate in samples per second.
SampleRate is optional unless SampleRateRatio is present, in which case
SampleRate is required.
40.0
Sample rate expressed as number of samples in a number of seconds.
If present, then <SampleRate> must also be present.
It can be useful for very slow data (e.g., less than a few samples per day),
since it allows for greater precision in the stored value.
0.000023148
2
86400
The type of unit being used.
This value is fixed to be SAMPLES/S, setting it is redundant.
Integer number of samples that span a number of seconds.
Integer number of seconds that span a number of samples.
Real part of the complex number.
Imaginary part of the complex number.
The position index of the pole (or zero) in the array of poles[] (or zeros[])
Integers greater than or equal to 0.
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 included in the Operator tag.
The operating agency.
USGS
Website of operating agency
http://usgs.gov
Person's contact information. A person can belong
to multiple agencies and have multiple email addresses and phone numbers.
Name of contact or author
Dr. Jane Doe
Agency of contact or author
USGS
Email of contact or author
jane_doe@example.com
Phone of contact or author
Description of a location using name and optional geopolitical boundaries (country, city, etc.).
Name of the site
Albuquerque, New Mexico
A longer description of the location of this station
NW corner of Yellowstone National Park
The town or city closest to the station.
Albuquerque
The county where the station is located
Bernalillo
The state, province, or region of this site.
Southwest U.S.
The country of this site.
U.S.A.
This type contains a Uniform Resource Identifier (URI) and description
for external information that users may want to reference.
URI of the external reference.
Description of the external reference.
Telephone country code
64
Telephone area code
408
Telephone number
5551212
A type to document units; use SI whenever possible.
Symbol or name of units, e.g. "m/s", "V", "Pa", "C".
Use SI whenever possible, along with singular lowercase
"count" for digital counts.
Description of units, e.g. "Velocity in meters per second",
"Volts", "Pascals", "Degrees Celsius".
Description is only needed when the unit name is not a well know
SI unit or there is need for clarification. Prefer not to use a
Description for common units like `m/s`, `m/s**2`, `count`, etc.
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.
10.1000/140
10.7914/SN/XX
10.5555/12345678ABCD
10.5555/12345678BHZ
Identifier type
DOI
The BaseFilterType is derived by all filters.
The description of the filter/stage/response
The units of the data as input from the previous stage. For example
if stage 1 represented a seismometer, InputUnits would be 'm/s'
and OutputUnits would be 'V'.
The units of the data as output to the following stage. For example
if stage 2 represented the AtoD stage of a data logger,
InputUnits would be 'V'
and OutputUnits would be 'count'.
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 elements with the same resourceId should indicate the same information.
A name given to this filter.
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.
In cases where the response is unknown, for example really old channels,
or where a response is not applicable, like textual log channels,
it is preferred that an empty
response element be used, <response></response>,
to positively indicate that no response exists.
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 units at a specified
frequency or within a range of frequencies.
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.
For non-linear sensors (e.g., :math:`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):
.. math::
Temp(V)=\sum_{k=0}^{N} a_k V^{k}
For such responses, two StationXML components are required to specify the response:
1. A Polynomial stage, which contains the values of the Maclaurin coefficients,
:math:`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.
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 elements with the same ID should indicate the same information.
A base node type use in Network, Station, and Channel types.
Description of the Network, Station, or Channel
Description of the Network
Description of the Station
Description of the Channel
This is a description
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.
Name of Network
Name of Station
Name of Channel
XX
ABCD
BHZ
Start date of network/station/channel epoch
Start date of network
Start date of station epoch
Start date of channel epoch
2016-07-01T00:00:00Z
This attribute is likely to require timezone of Z.
End date of network/station/channel epoch
End date of network. Do not use if still active, endDate should not be in the future.
End date of station epoch. Do not use if still active, endDate should not be in the future.
End date of channel epoch. Do not use if still active, endDate should not be in the future.
2018-01-27T00:00:00Z
This attribute should not be used if it is in the future.
This attribute is likely to require timezone of Z.
A data source identifier in URI form.
It is recommended that this follow the FDSN Source Identifiers
specification, http://docs.fdsn.org/projects/source-identifiers
FDSN:XX
FDSN:XX_ABCD
FDSN:XX_ABCD_00_B_H_Z
One of: \"open\", \"closed\", \"partial\"
open
A code used for display or association
GSN
ALQ
Z
A previously used code if different from the current code
XX
albq
bhz
Data availability extents, the earliest and
latest data available. No information about the continuity of the data
is included or implied.
start date of extent
1988-01-01T00:00:00Z
end date of extent
1988-12-31T00:00:00Z
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.
start date of span
1988-01-01T00:00:00Z
end date of span
1988-12-31T00:00:00Z
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.
2
The maximum time tear (gap or overlap) in seconds between time
series segments in the specified range.
0.01
A type for describing data availability.