-
Notifications
You must be signed in to change notification settings - Fork 17
Expand file tree
/
Copy pathfdsn-station.xsd
More file actions
1915 lines (1887 loc) · 84.1 KB
/
fdsn-station.xsd
File metadata and controls
1915 lines (1887 loc) · 84.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<!--
FDSN StationXML (www.fdsn.org/xml/station)
The purpose of this schema is to define a metadata standard for seismological and related data.
As a successor to the metadata headers of the SEED 2.4 standard (http://www.fdsn.org/publications.htm)
this format contains similar constructs and a superset of information.
Versioning for FDSN StationXML:
The 'version' attribute of the schema definition identifies the version of the schema. This
version is not enforced when validating documents.
The required 'schemaVersion' attribute of the root element identifies the version of the schema
that the document is compatible with. Validation only requires that a value is present but
not that it matches the schema used for validation.
The targetNamespace of the document identifies the major version of the schema and document,
version 1.x of the schema uses a target namespace of "http://www.fdsn.org/xml/station/1".
All minor versions of the schema will be backwards compatible with previous minor releases. For
example, all 1.x schemas are backwards compatible with and will validate documents for 1.0.
Major changes to the schema that would break backwards compabibility will increment the major
version number, e.g. 2.0, and the namespace, e.g. "http://www.fdsn.org/xml/station/2".
This combination of attributes and targetNamespaces allows the schema and documents to be
versioned and allows the schema to be updated with backward compatible changes (e.g. 1.2)
and still validate documents created for previous major versions of the schema (e.g. 1.0).
Regarding embedded documentation keywords:
StationXML reference documentation details are auto-generated from <documentation> tags
in this this schema document.
To allow additional granularity and clarity in the generated documentation, special embedded
elements and attributes are parsed from the content of the <documentation> tags. These embedded
items are as follows:
1. <example> - An XML element that contains an example of the relevent element
in the StationXML documentation. May have a LevelChoice attribute.
2. <warning> - Text appears included in an admonition wrapper.
It is typically used to indicate features that may be removed in the future.
3. <levelDesc> - An XML element that contains a description of the relevant element
in the StationXML documentation at a given level. Must have a LevelChoice attribute.
4. LevelChoice="X" - Where X is one of "N" (network), "S" (station) or "C" (channel).
This attribute is used so that documentation can be specific to level X for shared XML elements.
5. ElementChoice="TAG_NAME" - Similar to LevelChoice, but allows elements built off a
common basetype to have specific documentation.
For example: <xs:documentation><example ElementChoice="WaterLevel">m</example></xs:documentation>
The text in the example will only be used for the WaterLevel element.
-->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:fsx="http://www.fdsn.org/xml/station/1"
targetNamespace="http://www.fdsn.org/xml/station/1" elementFormDefault="qualified"
attributeFormDefault="unqualified" version="1.2">
<xs:annotation>
<xs:documentation>FDSN StationXML schema. A metadata
standard for seismological and related data.
</xs:documentation>
</xs:annotation>
<!-- Root element -->
<xs:element name="FDSNStationXML" type="fsx:RootType"/>
<!-- Type definitions -->
<xs:complexType name="RootType">
<xs:annotation>
<xs:documentation>Root-level for StationXML documents.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="Source" type="xs:string">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
<xs:documentation><warning>This element is likely to be a choice with Sender.</warning></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Sender" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
<xs:documentation><warning>This element is likely to be a choice with Source.</warning></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Module" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Name of the software module that generated this document.
</xs:documentation>
<xs:documentation><example><Module>SeisComp3</Module></example></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ModuleURI" type="xs:anyURI" minOccurs="0">
<xs:annotation>
<xs:documentation>Resource identifier of the query that generated the document,
or, if applicable, the resource identifier of the software that generated this document.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Created" type="xs:dateTime">
<xs:annotation>
<xs:documentation>Date that this document was generated.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Network" type="fsx:NetworkType" maxOccurs="unbounded"/>
<xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="schemaVersion" type="xs:decimal" use="required">
<xs:annotation>
<xs:documentation>The StationXML schema version of this document.</xs:documentation>
<xs:documentation><example>1.2</example></xs:documentation>
<xs:documentation>
<warning>
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'.
</warning>
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:anyAttribute namespace="##other" processContents="lax"/>
</xs:complexType>
<xs:complexType name="NetworkType">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
<xs:documentation>
An active Network should not use the endDate attribute.
Unlike SEED, do not use an endDate in the distant future to mean active.
</xs:documentation>
<xs:documentation><example><Network code="XX" startDate="2016-01-27T13:00:00Z" /></example></xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="fsx:BaseNodeType">
<xs:sequence>
<xs:element name="Operator" type="fsx:OperatorType" minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Agency and contact persons who manage this network.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="TotalNumberStations" type="fsx:CounterType" minOccurs="0">
<xs:annotation>
<xs:documentation>The total number of stations in this
network, including inactive or terminated stations.
</xs:documentation>
<xs:documentation><example><TotalNumberStations>24</TotalNumberStations></example></xs:documentation>
<xs:documentation><warning>This element is likely to be removed.</warning></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="SelectedNumberStations" type="fsx:CounterType" minOccurs="0">
<xs:annotation>
<xs:documentation>The number of stations selected in the request that resulted
in this document.
</xs:documentation>
<xs:documentation><example><SelectedNumberStations>12</SelectedNumberStations></example></xs:documentation>
<xs:documentation><warning>This element is likely to be removed.</warning></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Station" type="fsx:StationType" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="StationType">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
<xs:documentation>
An active Station should not use the endDate attribute.
Unlike SEED, do not use an endDate in the distant future to mean active.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="fsx:BaseNodeType">
<xs:sequence>
<xs:element name="Latitude" type="fsx:LatitudeType">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
<xs:documentation><example><Latitude>34.9459</Latitude></example></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Longitude" type="fsx:LongitudeType">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
<xs:documentation><example><Longitude>-106.4572</Longitude></example></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Elevation" type="fsx:DistanceType">
<xs:annotation>
<xs:documentation>Elevation of local ground surface level at station, in meters.</xs:documentation>
<xs:documentation><example><Elevation>1850.0</Elevation></example></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Site" type="fsx:SiteType">
</xs:element>
<xs:element name="WaterLevel" type="fsx:FloatType" minOccurs="0">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
<xs:documentation><example><WaterLevel>1200</WaterLevel></example></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Vault" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Type of vault, e.g. World-Wide Standardized Seismograph Network (WWSSN), tunnel,
USArray Transportable Array Generation 2, etc.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Geology" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Type of rock and/or geologic formation at the station.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Equipment" type="fsx:EquipmentType" minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>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.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Operator" type="fsx:OperatorType" minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Agency who manage this station.
Only use if this differs from the Operator of the Network.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="CreationDate" type="xs:dateTime" minOccurs="0">
<xs:annotation>
<xs:documentation>Date and time (UTC) when the station was first installed.</xs:documentation>
<xs:documentation><warning>This element is likely to be removed.</warning></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="TerminationDate" type="xs:dateTime" minOccurs="0">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
<xs:documentation><warning>This element is likely to be removed.</warning></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="TotalNumberChannels" type="fsx:CounterType" minOccurs="0">
<xs:annotation>
<xs:documentation>Total number of channels recorded at this station.</xs:documentation>
<xs:documentation><warning>This element is likely to be removed.</warning></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="SelectedNumberChannels" type="fsx:CounterType" minOccurs="0">
<xs:annotation>
<xs:documentation>The number of channels selected in the request that resulted in this document.</xs:documentation>
<xs:documentation><warning>This element is likely to be removed.</warning></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ExternalReference" type="fsx:ExternalReferenceType"
minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>URI of any type of external report</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Channel" type="fsx:ChannelType" minOccurs="0"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- End StationType-->
<xs:complexType name="ChannelType">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
<xs:documentation>
An active Channel should not use the endDate attribute.
Unlike SEED, do not use an endDate in the distant future to mean active.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="fsx:BaseNodeType">
<xs:sequence>
<xs:element name="ExternalReference" type="fsx:ExternalReferenceType"
minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>URI of any type of external report, such as data quality reports.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Latitude" type="fsx:LatitudeType">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
<xs:documentation><example><Latitude>34.9459</Latitude></example></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Longitude" type="fsx:LongitudeType">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
<xs:documentation><example><Longitude>-106.4572</Longitude></example></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Elevation" type="fsx:DistanceType">
<xs:annotation>
<xs:documentation>Elevation of the sensor, in meters. To find the local ground surface level,
add the Depth value to this elevation. </xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Depth" type="fsx:DistanceType">
<xs:annotation>
<xs:documentation>The depth of the sensor relative to the local ground surface level, in meters.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Azimuth" type="fsx:AzimuthType" minOccurs="0">
</xs:element>
<xs:element name="Dip" type="fsx:DipType" minOccurs="0">
</xs:element>
<xs:element name="WaterLevel" type="fsx:FloatType" minOccurs="0">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Type" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
<xs:documentation><example><Type>CONTINUOUS</Type></example></xs:documentation>
<xs:documentation>
This element existed primarily to hold the corresponding
value from SEED, but should not be used for new StationXML.
</xs:documentation>
<xs:documentation><warning>This element is likely to be removed.</warning></xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:NMTOKEN">
<xs:enumeration value="TRIGGERED"/>
<xs:enumeration value="CONTINUOUS"/>
<xs:enumeration value="HEALTH"/>
<xs:enumeration value="GEOPHYSICAL"/>
<xs:enumeration value="WEATHER"/>
<xs:enumeration value="FLAG"/>
<xs:enumeration value="SYNTHESIZED"/>
<xs:enumeration value="INPUT"/>
<xs:enumeration value="EXPERIMENTAL"/>
<xs:enumeration value="MAINTENANCE"/>
<xs:enumeration value="BEAM"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:group ref="fsx:SampleRateGroup" minOccurs="0"/>
<xs:element name="ClockDrift" minOccurs="0">
<xs:annotation>
<xs:documentation>Tolerance value, measured in seconds per sample,
used as a threshold for time error detection in data from the channel.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:restriction base="fsx:FloatType">
<xs:minInclusive value="0"/>
<xs:attribute name="unit" type="xs:string" use="optional" fixed="SECONDS/SAMPLE">
<xs:annotation>
<xs:documentation>The unit of drift value.
This value is fixed to be SECONDS/SAMPLE, setting it is redundant.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:restriction>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="CalibrationUnits" type="fsx:UnitsType" minOccurs="0">
<xs:annotation>
<xs:documentation>Units of calibration (e.g., V (for Volts) or A (for amps))</xs:documentation>
<xs:documentation>Use *SI* units when possible</xs:documentation>
<xs:documentation>
<example>
<CalibrationUnits>
<Name>V</Name>
<Description>Volts</Description>
</CalibrationUnits>
</example>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Sensor" type="fsx:EquipmentType" minOccurs="0">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PreAmplifier" type="fsx:EquipmentType" minOccurs="0">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="DataLogger" type="fsx:EquipmentType" minOccurs="0">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Equipment" type="fsx:EquipmentType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Response" type="fsx:ResponseType" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="locationCode" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
<xs:documentation><example>30</example></xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- End ChannelType -->
<xs:complexType name="GainType">
<xs:annotation>
<xs:documentation>Type used for representing sensitivity at a given frequency. This complex type
can be used to represent both total sensitivities and individual stage gains.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="Value" type="xs:double">
<xs:annotation>
<xs:documentation>
A scalar value representing the amount of amplification or diminution, if any,
the current stage applies to the input signal.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Frequency" type="xs:double">
<xs:annotation>
<xs:documentation>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
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:group name="FrequencyRangeGroup">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="FrequencyStart" type="xs:double">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="FrequencyEnd" type="xs:double">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="FrequencyDBVariation" type="xs:double">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:group>
<xs:complexType name="SensitivityType">
<xs:annotation>
<xs:documentation>Type for sensitivity, input/output units and relevant frequency range.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="fsx:GainType">
<xs:sequence>
<xs:element name="InputUnits" type="fsx:UnitsType">
<xs:annotation>
<xs:documentation>
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'.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="OutputUnits" type="fsx:UnitsType">
<xs:annotation>
<xs:documentation> 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'.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:group ref="fsx:FrequencyRangeGroup" minOccurs="0">
<xs:annotation>
<xs:documentation>The frequency range for which the sensitivity value is
valid within the dB variation specified.
</xs:documentation>
</xs:annotation>
</xs:group>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="EquipmentType">
<xs:annotation>
<xs:documentation>A type for equipment related to data acquisition or processing.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="Type" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Type of equipment</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Description" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Description of equipment</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Manufacturer" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Manufacturer of equipment</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Vendor" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Vendor of equipment</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Model" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Model of equipment</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="SerialNumber" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Serial number of equipment</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="InstallationDate" type="xs:dateTime" minOccurs="0">
<xs:annotation>
<xs:documentation>Date this equipment was installed</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="RemovalDate" type="xs:dateTime" minOccurs="0">
<xs:annotation>
<xs:documentation>Date this equipment was removed</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="CalibrationDate" type="xs:dateTime" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Date this equipment was calibrated</xs:documentation>
</xs:annotation>
</xs:element>
<xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="resourceId" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation> 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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:anyAttribute namespace="##other" processContents="lax"/>
</xs:complexType>
<xs:complexType name="ResponseStageType">
<xs:annotation>
<xs:documentation>Type for channel response entry or stage. A full response is
represented as an ordered sequence of these stages.
</xs:documentation>
<xs:documentation>
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.
</xs:documentation>
<xs:documentation>
<warning>
A filter, (PolesZeros, Coefficients, FIR, etc) may be required.
</warning>
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:choice>
<xs:annotation>
<xs:documentation>A choice of polynomial versus all other response types,
to enforce one response per stage.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:choice>
<xs:element name="PolesZeros" type="fsx:PolesZerosType" minOccurs="0">
<xs:annotation>
<xs:documentation>
Response stage described by the complex poles and zeros of the Laplace Transform (or z-transform)
of the transfer function for this stage.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Coefficients" type="fsx:CoefficientsType" minOccurs="0"/>
<xs:element name="ResponseList" type="fsx:ResponseListType" minOccurs="0"/>
<xs:element name="FIR" type="fsx:FIRType" minOccurs="0">
</xs:element>
</xs:choice>
<xs:element name="Decimation" type="fsx:DecimationType" minOccurs="0"/>
<xs:element name="StageGain" type="fsx:GainType">
<xs:annotation>
<xs:documentation>The gain at the stage of the encapsulating
response element at a specific frequency.
Total channel sensitivity should be specified in the InstrumentSensitivity
element.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:element name="Polynomial" type="fsx:PolynomialType">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="number" type="fsx:CounterType" use="required">
<xs:annotation>
<xs:documentation>Stage sequence number. This is used in all the response
blockettes. Start from name='1' and iterate sequentially.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="resourceId" type="xs:string">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:anyAttribute namespace="##other" processContents="lax"/>
</xs:complexType>
<xs:complexType name="CommentType">
<xs:annotation>
<xs:documentation>Container for a comment or log entry.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="Value" type="xs:string">
<xs:annotation>
<xs:documentation>Comment text.</xs:documentation>
<xs:documentation>
<example LevelChoice="N"><Value>Temporary network deployment</Value></example>
<example LevelChoice="S"><Value>GPS Clock is unlocked</Value></example>
<example LevelChoice="C"><Value>Large number of spikes</Value></example>
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="BeginEffectiveTime" type="xs:dateTime" minOccurs="0">
<xs:annotation>
<xs:documentation>Start time for when comment applies.</xs:documentation>
<xs:documentation><example><BeginEffectiveTime>2008-09-15T00:00:00Z</BeginEffectiveTime></example></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="EndEffectiveTime" type="xs:dateTime" minOccurs="0">
<xs:annotation>
<xs:documentation>End time for when comment applies.</xs:documentation>
<xs:documentation><example><EndEffectiveTime>2008-09-16T12:00:00Z</EndEffectiveTime></example></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Author" type="fsx:PersonType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Author of Comment.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="id" type="fsx:CounterType" use="optional">
<xs:annotation>
<xs:documentation>An ID for this comment</xs:documentation>
<xs:documentation><example>12345</example></xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="subject" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>A subject for this comment. Multiple comments with the same
subject should be considered related.
</xs:documentation>
<xs:documentation><example>Scheduled maintenance</example></xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="PolesZerosType">
<xs:complexContent>
<xs:extension base="fsx:BaseFilterType">
<xs:sequence>
<xs:element name="PzTransferFunctionType">
<xs:annotation>
<xs:documentation>
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)"
</xs:documentation>
<xs:documentation><example><PzTransferFunctionType>LAPLACE (RADIANS/SECOND)</PzTransferFunctionType></example>
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="LAPLACE (RADIANS/SECOND)"/>
<xs:enumeration value="LAPLACE (HERTZ)"/>
<xs:enumeration value="DIGITAL (Z-TRANSFORM)"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="NormalizationFactor" type="xs:double" default="1.0">
<xs:annotation>
<xs:documentation>Normalization scale factor</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="NormalizationFrequency" type="fsx:FrequencyType">
<xs:annotation>
<xs:documentation>Frequency at which the NormalizationFactor is valid.
This should be the same for all stages and within the passband, if any.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Zero" type="fsx:PoleZeroType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Complex zero of the polezero stage.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Pole" type="fsx:PoleZeroType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Complex pole of the polezero stage.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="FIRType">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
<xs:documentation>
<warning>The NumeratorCoefficient field is likely to be changed to require at least one numerator in future versions of StationXML.</warning>
</xs:documentation>
<xs:documentation>
<warning>The NumeratorCoefficient field is likely to be renamed to Numerator in future versions of StationXML.</warning>
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="fsx:BaseFilterType">
<xs:sequence>
<xs:element name="Symmetry">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:NMTOKEN">
<xs:enumeration value="NONE"/>
<xs:enumeration value="EVEN"/>
<xs:enumeration value="ODD"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="NumeratorCoefficient" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
The coefficients of the FIR filter. Should include at least one.
</xs:documentation>
<xs:documentation>
<warning>At least one Numerator may be required.</warning>
<warning>May be renamed to Numerator.</warning>
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:double">
<xs:attribute name="i" type="xs:integer"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="CoefficientsType">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
<xs:documentation>
<warning>The Numerator element is likely to be changed to require at least one numerator.</warning>
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="fsx:BaseFilterType">
<xs:sequence>
<xs:element name="CfTransferFunctionType">
<xs:annotation>
<xs:documentation> Almost always a digital response, but can be an
analog response in rad/sec or Hertz.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="ANALOG (RADIANS/SECOND)"/>
<xs:enumeration value="ANALOG (HERTZ)"/>
<xs:enumeration value="DIGITAL"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="Numerator" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Numerator for the coefficient. Should include at least one.
</xs:documentation>
<xs:documentation>
<warning>At least one Numerator may be required.</warning>
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="fsx:FloatNoUnitType">
<xs:attribute name="number" type="fsx:CounterType"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="Denominator" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Denominator for the coefficient
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="fsx:FloatNoUnitType">
<xs:attribute name="number" type="fsx:CounterType"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="ResponseListElementType">
<xs:sequence>
<xs:element name="Frequency" type="fsx:FrequencyType"/>
<xs:element name="Amplitude" type="fsx:FloatType"/>
<xs:element name="Phase" type="fsx:AngleType"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ResponseListType">
<xs:annotation>
<xs:documentation>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.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="fsx:BaseFilterType">
<xs:sequence>
<xs:element name="ResponseListElement" type="fsx:ResponseListElementType"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="PolynomialType">
<xs:annotation>
<xs:documentation>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. </xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="fsx:BaseFilterType">
<xs:sequence>
<xs:element name="ApproximationType" default="MACLAURIN">
<xs:annotation>
<xs:documentation>The series type for the polynomial approximation</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="MACLAURIN"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="FrequencyLowerBound" type="fsx:FrequencyType">
<xs:annotation>
<xs:documentation>The lower bound of the frequency range.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="FrequencyUpperBound" type="fsx:FrequencyType">
<xs:annotation>