/
nmrML.xsd
1368 lines (1363 loc) · 65 KB
/
nmrML.xsd
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"?>
<xs:schema xmlns:dx="http://nmrml.org/schema" attributeFormDefault="unqualified"
elementFormDefault="qualified" targetNamespace="http://nmrml.org/schema" version="1.0.rc1"
xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://nmrml.org/schema">
<xs:element name="nmrML" type="nmrMLType">
<xs:annotation>
<xs:documentation>This is the root element for the COordination Of Standards In MetabOlomicS
nmrML schema, which is intended to capture the use of a nuclear magnetic resonance
spectrometer, the data generated, and the initial processing of that data (to the level of
the peak list).</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="QuantifiedCompoundType">
<xs:complexContent>
<xs:extension base="ChemicalCompoundType">
<xs:sequence>
<xs:element name="concentration" type="ValueWithUnitType"/>
<xs:element minOccurs="0" name="clusterList" type="ClusterListType">
<xs:annotation>
<xs:documentation>A list of clusters of peaks that are aligned with the spectrum for quantification.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="peakList" type="PeakListType" minOccurs="0">
<xs:annotation>
<xs:documentation>A list of the positions and amplitudes of the peaks that are associated with the compound. This is an alternative to the cluster list for the case where you want to record a fit but discard some of the information about the library you used to fit the spectrum.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="ClusterListType">
<xs:sequence>
<xs:element maxOccurs="unbounded" name="cluster" type="ClusterType"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ClusterType">
<xs:sequence>
<xs:element name="peakList" type="PeakListType">
<xs:annotation>
<xs:documentation>A list of the positions and amplitudes of the peaks in the multiplet. Optional if the peaks are not identified. In which case the 'center' attribute offers a hint for annotation.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="center"/>
<xs:attribute name="shift"/>
</xs:complexType>
<xs:complexType name="ChemicalCompoundType">
<xs:sequence minOccurs="1">
<xs:element name="identifierList" type="CompoundIdentifierListType" minOccurs="0"> </xs:element>
<xs:element name="structure" type="CompoundStructureType" minOccurs="0"> </xs:element>
</xs:sequence>
<xs:attribute name="name"/>
</xs:complexType>
<xs:complexType name="CompoundStructureType">
<xs:annotation>
<xs:documentation/>
</xs:annotation>
<xs:sequence>
<xs:element name="atomList" maxOccurs="1" minOccurs="1" type="AtomListType"/>
<xs:element maxOccurs="1" minOccurs="1" name="bondList" type="BondListType"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="AtomListType">
<xs:sequence>
<xs:element maxOccurs="unbounded" name="atom" type="AtomType"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="AtomType">
<xs:attribute name="id" type="xs:ID" use="required">
<xs:annotation>
<xs:documentation>An identifier unique to the file only, so that it can be referenced by the bond elements as well as by the spectrum annotations. Most people use "a1", "a2", ... , "aN"</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="elementType" use="required">
<xs:annotation>
<xs:documentation>The symbol for the element. For example: "H","C" or "Fe"</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="x" use="required">
<xs:annotation>
<xs:documentation>The x position of the element in cartesian coordinates. The cordinates along with the bond information in the bond list should allow for software to draw a 2D representation of the chemical structure.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="y" use="required">
<xs:annotation>
<xs:documentation>The y position of the element in cartesian coordinates. The cordinates along with the bond information in the bond list should allow for software to draw a 2D representation of the chemical structure.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="BondListType">
<xs:sequence>
<xs:element maxOccurs="unbounded" name="bond" type="BondType"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="BondType">
<xs:attribute name="atomRefs" use="required">
<xs:annotation>
<xs:documentation>Contains a list of atom IDs seperated by a space. The atom ids are the atoms connected by the bond. For example: "a1 a2"</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="order" use="required">
<xs:annotation>
<xs:documentation>The order of the bond connecting two atoms. A single bond should be "1", a double bond should be "2", a triple bond should be "3".</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="AtomAssignmentListType">
<xs:sequence>
<xs:element maxOccurs="unbounded" name="multiplet" type="MultipletType">
<xs:annotation>
<xs:documentation>A cluster of 1 or more peaks that corresponds to specific atoms in a chemical structure.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="MultipletType">
<xs:sequence>
<xs:element name="atoms" type="AtomRefsType">
<xs:annotation>
<xs:documentation>Lists the atomRefs for atoms in the chemical structure that contribute to the multiplet.
If the corresponding atoms are unknown than the list can be blank.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="multiplicity" type="CVTermType">
<xs:annotation>
<xs:documentation>A description of the type of multiplet that is annotated. For exmample a singlet, a doublet, a doublet of doublets, etc.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="peakList" type="PeakListType" minOccurs="0">
<xs:annotation>
<xs:documentation>A list of the positions and amplitudes of the peaks in the multiplet. Optional if the peaks are not identified. In which case the 'center' attribute offers a hint for annotation.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="center" use="required">
<xs:annotation>
<xs:documentation>The center of the multiplet in ppm.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="AtomRefsType">
<xs:attribute name="atomRefs"/>
</xs:complexType>
<xs:complexType name="PeakType">
<xs:attribute name="center" use="required"/>
<xs:attribute name="amplitude"/>
<xs:attribute name="width"/>
</xs:complexType>
<xs:complexType name="PeakListType">
<xs:sequence>
<xs:element maxOccurs="unbounded" name="peak" type="PeakType"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="AtomAssingmentAnnotationType">
<xs:sequence>
<xs:element name="chemicalCompound" type="ChemicalCompoundType"/>
<xs:element name="atomAssignmentList" type="AtomAssignmentListType" minOccurs="0">
<xs:annotation>
<xs:documentation>A list of annotated peak clusters in the spectrum and the atoms that they correspond to. </xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="spectrumRef" type="xs:IDREF" use="required">
<xs:annotation>
<xs:documentation>A reference to the id of the spectrum that this annotation is for.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="InChiStringType">
<xs:annotation>
<xs:documentation>Captures the compound structure as an InChI, which allows for capturing a chemical structure as a string example:
InChI=1S/C7H11N3O2/c1-10-3-5(9-4-10)2-6(8)7(11)12/h3-4,6H,2,8H2,1H3,(H,11,12)/t6-/m0/s1</xs:documentation>
</xs:annotation>
</xs:complexType>
<xs:complexType name="CompoundIdentifierListType">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" name="identifier" type="CVTermType">
<xs:annotation>
<xs:documentation>Captures compound identifiers coming from an ontology. Usually CHEBI.
Example:
<compoundIdentifier accession="CHEBI:16449" cvRef="CHEBI"/></xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" name="databaseIdentifier"
type="CompoundDatabaseIdentifierType"> </xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="CompoundDatabaseIdentifierType">
<xs:annotation>
<xs:documentation>Captures a database identifier and reference via URI.
Example:
<compoundDatabaseIdentifier databaseID="HMDB00067" databaseURI="http://hmdb.ca/metabolites/HMDB00067"/></xs:documentation>
</xs:annotation>
<xs:attribute name="identifier" use="required"/>
<xs:attribute name="URI" use="required"/>
</xs:complexType>
<xs:complexType name="QuantificationAnnotationType">
<xs:sequence>
<xs:element name="quantificationMethod" type="CVTermType"/>
<xs:element name="quantifiedCompoundList" type="QuantifiedCompoundListType">
<xs:annotation>
<xs:documentation>A list of the quantified chemical compounds and the associated information about clusters of peaks in the spectrum.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="spectrumRef" type="xs:IDREF" use="required">
<xs:annotation>
<xs:documentation>A reference to the id of the spectrum that this annotation is for.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="QuantifiedCompoundListType">
<xs:annotation>
<xs:documentation>Caputures information about analytes that have been quantified in a mixture. The infromation is about quantification and identification of the analytes.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element maxOccurs="unbounded" name="quantifiedCompound" type="QuantifiedCompoundType"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="SpectrumAnnotationListType">
<xs:sequence>
<xs:element name="atomAssignment" minOccurs="0" type="AtomAssingmentAnnotationType">
<xs:annotation>
<xs:documentation>An annotation for assigning atoms in a chemical structure to peaks in a spectrum.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="quantification" type="QuantificationAnnotationType">
<xs:annotation>
<xs:documentation>An annotation for capturing the quantification of a complex mixture in an NMR experiment. The annotation captures the alighnment of clusters of peaks to the spectrum, the associated chemical compounds, and the quantification information. </xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="nmrMLType">
<xs:annotation>
<xs:documentation>This is the root element for the COordination Of Standards In MetabOlomicS
nmrML schema, which is intended to capture the use of a nuclear magnetic resonance
spectrometer, the data generated, and the initial processing of that data (to the level of
the peak list).</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="cvList" type="dx:CVListType"/>
<xs:element name="fileDescription" type="FileDescriptionType"/>
<xs:element maxOccurs="1" minOccurs="0" name="contactList" type="ContactListType"/>
<xs:element minOccurs="0" name="referenceableParamGroupList"
type="ReferenceableParamGroupListType"/>
<xs:element minOccurs="0" name="sourceFileList" type="SourceFileListType"/>
<xs:element name="softwareList" type="SoftwareListType" minOccurs="0"/>
<xs:element name="instrumentConfigurationList" type="InstrumentConfigurationListType"/>
<xs:element minOccurs="0" name="sampleList" type="SampleListType"/>
<xs:element name="acquisition" type="AcquisitionType"/>
<xs:element minOccurs="0" name="spectrumList" type="SpectrumListType">
<xs:annotation>
<xs:documentation>A list of frequency domain spectrum data as well as information about how the spectrum was processed. There can be more than one do to different techniques for processing the FID data.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="spectrumAnnotationList" type="SpectrumAnnotationListType"/>
</xs:sequence>
<xs:attribute name="version" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The nmrML version used to create the document.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="accession" type="xs:string">
<xs:annotation>
<xs:documentation>Optional accession number for the nmrML document. Used for storage (for
example MetaboLights) </xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="accession_url" type="xs:anyURI">
<xs:annotation>
<xs:documentation>Optional attribute for retrieva of an nmrML document. Usefull when the
document has been retrieved from a public database.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="id" type="xs:string">
<xs:annotation>
<xs:documentation>An optional ID for the nmrML document.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="CVListType">
<xs:annotation>
<xs:documentation>Container for one or more controlled vocabulary
definitions.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element maxOccurs="unbounded" name="cv" type="dx:CVType"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="CVType">
<xs:annotation>
<xs:documentation>Information about an ontology or CV source and a short 'lookup' tag to refer
to.</xs:documentation>
</xs:annotation>
<xs:attribute name="id" type="xs:ID" use="required">
<xs:annotation>
<xs:documentation>The short label to be used as a reference tag with which to refer to this
particular Controlled Vocabulary source description (e.g., from the cvLabel attribute, in
CVParamType elements).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="fullName" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The usual name for the resource (e.g. The MSI-NMR Controlled
Vocabulary).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="version" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>The version of the CV from which the referred-to terms are
drawn.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="URI" type="xs:anyURI" use="required">
<xs:annotation>
<xs:documentation>The URI for the resource.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="ContactListType">
<xs:sequence minOccurs="1">
<xs:element name="contact" type="dx:ContactType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ContactType">
<xs:annotation>
<xs:documentation>A person's name and information on how to communicate with
them.</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="ParamGroupType">
<xs:attribute name="id" type="xs:ID" use="required">
<xs:annotation>
<xs:documentation>An identifier for this contact .</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="fullname" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Name of the contact person.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="url" type="xs:anyURI">
<xs:annotation>
<xs:documentation>Uniform Resource Locator related to the contact person or
organization.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="address" type="xs:string">
<xs:annotation>
<xs:documentation>Postal address of the contact person or
organization.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="organization" type="xs:string">
<xs:annotation>
<xs:documentation>Home institution of the contact person.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="email" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Email address of the contact person or
organization.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="ContactRefType">
<xs:attribute name="ref" type="xs:IDREF" use="required">
<xs:annotation>
<xs:documentation>This attribute must reference the 'id' of the contact node in the
contactList.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="ContactRefListType">
<xs:sequence>
<xs:element maxOccurs="unbounded" name="contactRef" type="ContactRefType">
<xs:annotation>
<xs:documentation>Reference to a previously defined sourceFile.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="AcquisitionParameterFileRefType">
<xs:attribute name="ref" type="xs:IDREF" use="required">
<xs:annotation>
<xs:documentation>This attribute must reference the 'id' of the sourceFile node in the sourceFileList</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="AcquisitionParameterFileRefListType">
<xs:sequence>
<xs:element maxOccurs="unbounded" name="acquisitionParameterFileRef"
type="AcquisitionParameterFileRefType">
<xs:annotation>
<xs:documentation>Reference to a previously defined sourceFile.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="FileDescriptionType">
<xs:annotation>
<xs:documentation>Information pertaining to the entire nmrML file (i.e. not specific to any
part of the data set) is stored here. The FileDescriptionType element is intended to contain
a summary description of the current nmrML file, for example it could say that the file has
a 1D FID, a processed spectra, and a peak picked spectra. It does not point to source files
or anything like that. It is intended to make it easy to determine what is inside a file
without having to look for different element types etc and build a summary yourself.
RawSpectrumFile would not be a good name. nmrMLInstanceSummary might be a more intuitive
name.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="fileContent" type="ParamGroupType">
<xs:annotation>
<xs:documentation>This summarizes the different types of spectra that can be expected in
the file. This is expected to aid processing software in skipping files that do not
contain appropriate spectrum types for it. It should also describe the nativeID format
used in the file by referring to an appropriate CV term.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="CVTermType">
<xs:annotation>
<xs:documentation>This element holds additional data or annotation as a simple CV term with no
further values (Parameters) associated with it. Only controlled CV terms values are allowed
here.</xs:documentation>
</xs:annotation>
<xs:attribute name="cvRef" type="xs:IDREF" use="required">
<xs:annotation>
<xs:documentation>A reference to the CV 'id' attribute as defined in the cvList in this
nmrML file.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="accession" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The accession number of the referred-to term in the named resource (e.g.:
NMR:000012).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The actual name for the parameter, from the referred-to controlled
vocabulary. This should be the preferred name associated with the specified accession
number.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="CVParamType">
<xs:annotation>
<xs:documentation>This element holds additional data or annotation. In contrast to CVTermType,
here a pair of CV term plus a value (=Parameter) is captured. Only controlled values are
allowed here.</xs:documentation>
</xs:annotation>
<xs:attribute name="cvRef" type="xs:IDREF" use="required">
<xs:annotation>
<xs:documentation>A reference to the CV 'id' attribute as defined in the cvList in this
nmrML file.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="accession" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The accession number of the referred-to term in the named resource (e.g.:
NMR:000012).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The actual name for the parameter, from the referred-to controlled
vocabulary. This should be the preferred name associated with the specified accession
number.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="value" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>The value for the parameter; may be absent if not appropriate, or a
numeric or symbolic value, or may itself be CV (legal values for a parameter should be
enumerated and defined in the ontology).</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="CVParamWithUnitType">
<xs:annotation>
<xs:documentation>This element holds additional data or annotation. Only controlled values are
allowed here.</xs:documentation>
</xs:annotation>
<xs:attribute name="cvRef" type="xs:IDREF" use="required">
<xs:annotation>
<xs:documentation>A reference to the CV 'id' attribute as defined in the cvList in this
nmrML file.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="accession" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The accession number of the referred-to term in the named resource (e.g.:
NMR:000012).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The actual name for the parameter, from the referred-to controlled
vocabulary. This should be the preferred name associated with the specified accession
number.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="value" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>The value for the parameter; may be absent if not appropriate, or a
numeric or symbolic value, or may itself be CV (legal values for a parameter should be
enumerated and defined in the ontology).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="unitCvRef" type="xs:IDREF" use="optional">
<xs:annotation>
<xs:documentation>If a unit term is referenced, this attribute must refer to the CV 'id'
attribute defined in the cvList in this nmrML file.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="unitAccession" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>An optional CV accession number for the unit term associated with the
value, if any (e.g., 'UO:0000266' for 'electron volt').</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="unitName" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>An optional CV name for the unit accession number, if any (e.g., 'electron
volt' for 'UO:0000266' ).</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="ValueWithUnitType">
<xs:annotation>
<xs:documentation>This element holds a value that also has a unit. Only controlled values are allowed for the unit.</xs:documentation>
</xs:annotation>
<xs:attribute name="value" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation/>
</xs:annotation>
</xs:attribute>
<xs:attribute name="unitAccession" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>An optional CV accession number for the unit term associated with the
value, if any (e.g., 'UO:0000266' for 'electron volt').</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="unitName" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>An optional CV name for the unit accession number, if any (e.g., 'electron
volt' for 'UO:0000266' ).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="unitCvRef" type="xs:IDREF" use="optional">
<xs:annotation>
<xs:documentation>If a unit term is referenced, this attribute must refer to the CV 'id'
attribute defined in the cvList in this nmrML file.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="UserParamType">
<xs:annotation>
<xs:documentation>Uncontrolled user parameters (essentially allowing free text). Before using
these, one should verify whether there is an appropriate CV term available, and if so, use
the CV term instead</xs:documentation>
</xs:annotation>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>The name for the parameter.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="valueType" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>The datatype of the parameter, where appropriate (e.g.:
xsd:float).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="value" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>The value for the parameter, where appropriate.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="unitAccession" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>An optional CV accession number for the unit term associated with the
value, if any (e.g., 'UO:0000266' for 'electron volt').</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="unitName" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>An optional CV name for the unit accession number, if any (e.g., 'electron
volt' for 'UO:0000266' ).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="unitCvRef" type="xs:IDREF" use="optional">
<xs:annotation>
<xs:documentation>If a unit term is referenced, this attribute must refer to the CV 'id'
attribute defined in the cvList in this nmrML file.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="ParamGroupType">
<xs:annotation>
<xs:documentation>Structure allowing the use of a controlled (cvParam) or uncontrolled
vocabulary (userParam), or a reference to a predefined set of these in this nmrML file
(paramGroupRef).</xs:documentation>
</xs:annotation>
<xs:sequence minOccurs="0">
<xs:element minOccurs="0" maxOccurs="unbounded" name="referenceableParamGroupRef"
type="ReferenceableParamGroupRefType"/>
<xs:element minOccurs="0" maxOccurs="unbounded" name="cvParam" type="CVParamType"/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="cvParamWithUnit"
type="CVParamWithUnitType"/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="cvTerm" type="CVTermType"/>
<xs:element minOccurs="0" maxOccurs="unbounded" name="userParam" type="UserParamType"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="ReferenceableParamGroupType">
<xs:annotation>
<xs:documentation>A collection of CVParam and UserParam elements that can be referenced from
elsewhere in this nmrML document by using the 'paramGroupRef' element in that location to
reference the 'id' attribute value of this element.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="cvParam" type="CVParamType"/>
<xs:element minOccurs="0" maxOccurs="unbounded" name="userParam" type="UserParamType"/>
</xs:sequence>
<xs:attribute name="id" type="xs:ID" use="required">
<xs:annotation>
<xs:documentation>The identifier with which to reference this
ReferenceableParamGroup.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="ReferenceableParamGroupRefType">
<xs:annotation>
<xs:documentation>A reference to a previously defined ParamGroup, which is a reusable
container of one or more cvParams.</xs:documentation>
</xs:annotation>
<xs:attribute name="ref" type="xs:IDREF" use="required">
<xs:annotation>
<xs:documentation>Reference to the id attribute in a
referenceableParamGroup.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="ReferenceableParamGroupListType">
<xs:annotation>
<xs:documentation>Container for a list of referenceableParamGroups</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element maxOccurs="unbounded" name="referenceableParamGroup"
type="ReferenceableParamGroupType"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="SourceFileListType">
<xs:annotation>
<xs:documentation>List and descriptions of the source files this nmrML document was generated
or derived from</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="unbounded" name="sourceFile" type="dx:SourceFileType"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="SampleListType">
<xs:annotation>
<xs:documentation>List and descriptions of samples.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element maxOccurs="unbounded" name="sample" type="dx:SampleType"/>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="PhType">
<xs:restriction base="xs:double"/>
</xs:simpleType>
<xs:complexType name="SampleType">
<xs:sequence maxOccurs="1" minOccurs="1">
<xs:element maxOccurs="1" minOccurs="0" name="originalBiologicalSamplepH" type="PhType"> </xs:element>
<xs:element maxOccurs="1" minOccurs="0" name="postBufferpH" type="PhType"> </xs:element>
<xs:element maxOccurs="1" minOccurs="0" name="buffer" type="CVTermType"> </xs:element>
<xs:element maxOccurs="1" minOccurs="1" name="fieldFrequencyLock">
<xs:complexType>
<xs:attribute name="fieldFrequencyLockName" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
<xs:element maxOccurs="1" minOccurs="1" name="chemicalShiftStandard" type="CVParamType"> </xs:element>
<xs:element name="solventType" type="CVParamWithUnitType" maxOccurs="unbounded"/>
<xs:element name="additionalSoluteList" type="AdditionalSoluteListType"/>
<xs:element maxOccurs="1" minOccurs="0" name="concentrationStandard">
<xs:complexType>
<xs:sequence>
<xs:element name="type" type="CVTermType"/>
<xs:element name="concentrationInSample" type="ValueWithUnitType"/>
<xs:element name="name" type="CVTermType"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="originalBiologicalSampleReference" type="xs:anyURI" use="required"/>
</xs:complexType>
<xs:complexType name="SoftwareListType">
<xs:annotation>
<xs:documentation>List and descriptions of software used to acquire and/or process the data in
this nmrML file.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element maxOccurs="unbounded" name="software" type="dx:SoftwareType">
<xs:annotation>
<xs:documentation>A software program used during the acquisition of the spectra or
processing of the FID.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="SoftwareType">
<xs:annotation>
<xs:documentation>Software information.</xs:documentation>
</xs:annotation>
<xs:complexContent mixed="false">
<xs:extension base="CVTermType">
<xs:attribute name="id" type="xs:ID" use="required">
<xs:annotation>
<xs:documentation>An identifier for this software that is unique across all
SoftwareTypes.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="version" type="xs:string">
<xs:annotation>
<xs:documentation>The software version.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="SoftwareRefType">
<xs:annotation>
<xs:documentation>Reference to a previously defined software element</xs:documentation>
</xs:annotation>
<xs:attribute name="ref" type="xs:IDREF" use="required">
<xs:annotation>
<xs:documentation>This attribute must be used to reference the 'id' attribute of a software
element.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="SoftwareRefListType">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="softwareRef" type="SoftwareRefType">
<xs:annotation>
<xs:documentation>Reference to a previously defined sourceFile.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="SourceFileType">
<xs:annotation>
<xs:documentation>Description of the source file, including location and type. The
SourceFileType element is intended to be a generic element that points to a file that was
used to produce the spectrum or the nmrML file. It could point to an FID file, a procpar
file, a pulse program file etc. nmrExperimentSourceFile could be a good name but I
personally think that SourceFile is an intuitive name already.</xs:documentation>
</xs:annotation>
<xs:complexContent mixed="false">
<xs:extension base="ParamGroupType">
<xs:attribute name="id" type="xs:ID" use="required">
<xs:annotation>
<xs:documentation>An identifier for this file.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Name of the source file, without reference to location (either URI or
local path).</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="location" type="xs:anyURI" use="required">
<xs:annotation>
<xs:documentation>URI-formatted location where the file was
retrieved.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="sha1" type="xs:string"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="SourceFileRefType">
<xs:attribute name="ref" type="xs:IDREF" use="required">
<xs:annotation>
<xs:documentation>This attribute must reference the 'id' of the appropriate
sourceFile.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="SourceFileRefListType">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="sourceFileRef"
type="dx:SourceFileRefType">
<xs:annotation>
<xs:documentation>Reference to a previously defined sourceFile.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="InstrumentConfigurationType">
<xs:annotation>
<xs:documentation>Description of a particular hardware configuration of a NMR spectrometer.
For software configuration, use a ReferenceableParamGroup element.</xs:documentation>
</xs:annotation>
<xs:complexContent mixed="false">
<xs:extension base="ParamGroupType">
<xs:sequence>
<xs:element minOccurs="0" name="softwareRef" type="SoftwareRefType" maxOccurs="unbounded"
/>
</xs:sequence>
<xs:attribute name="id" type="xs:ID" use="required">
<xs:annotation>
<xs:documentation>An identifier for this instrument configuration.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="InstrumentConfigurationListType">
<xs:annotation>
<xs:documentation>List and descriptions of instrument configurations. At least one instrument
configuration must be specified, even if it is only to specify that the instrument is
unknown. In that case, the "instrument model" term is used to indicate the unknown
instrument in the instrumentConfiguration.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element maxOccurs="unbounded" name="instrumentConfiguration"
type="dx:InstrumentConfigurationType"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="BinaryDataArrayType">
<xs:annotation>
<xs:documentation/>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="xs:base64Binary">
<xs:attribute name="compressed" type="xs:boolean" use="required">
<xs:annotation>
<xs:documentation>True if the binary data was compressed with zlib before encoding as
base64</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="encodedLength" type="xs:nonNegativeInteger" use="required">
<xs:annotation>
<xs:documentation>The number of characters in the base64 string. This is useful for skipping over the string in high throughput applications.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="byteFormat" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>TODO format as little endian 64 bit pairs of floats, or 32 bit pairs of floats. See online documentation for decoding examples. </xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:complexType name="SoluteType">
<xs:sequence>
<xs:element name="concentrationInSample" type="ValueWithUnitType"/>
</xs:sequence>
<xs:attribute name="name" type="xs:string" use="required"/>
</xs:complexType>
<xs:complexType name="TemperatureType">
<xs:annotation>
<xs:documentation>A temperature and references to a unit from the unit
ontology.</xs:documentation>
</xs:annotation>
<xs:attribute name="temperature" type="xs:float" use="required"/>
<xs:attribute name="temperatureUnitName" type="xs:string" use="required"/>
<xs:attribute name="temperatureUnitID" type="xs:ID"/>
</xs:complexType>
<xs:complexType name="AdditionalSoluteListType">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" name="solute" type="SoluteType"> </xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="AcquisitionDimensionParameterSetType">
<xs:annotation>
<xs:documentation>Descriptions of the acquisition parameters set prior to the start of data
acquisition specific to each NMR analysis dimension.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" name="decouplingMethod" type="CVTermType"/>
<xs:element name="acquisitionNucleus" type="CVTermType"/>
<xs:element maxOccurs="1" minOccurs="1" name="effectiveExcitationField"
type="ValueWithUnitType">
<xs:annotation>
<xs:documentation>replacing the hardPulse parameter, would be automatically calculated
from the pulse width in the procs file. If you say the pulse width you also have to specify the excitation angle
so this way is more compact/useful. Should be recorded in Tesla</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="1" minOccurs="1" name="sweepWidth" type="ValueWithUnitType">
<xs:annotation>
<xs:documentation>Should be in ppm and Hz.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="pulseWidth" type="ValueWithUnitType">
<xs:annotation>
<xs:documentation>90° pulse width, measured in µs</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="1" minOccurs="1" name="irradiationFrequency" type="ValueWithUnitType"> </xs:element>
<xs:element maxOccurs="1" minOccurs="1" name="irradiationFrequencyOffset" type="ValueWithUnitType"> </xs:element>
<xs:element name="decouplingNucleus" type="CVTermType" minOccurs="0"/>
<xs:element name="samplingStrategy" type="CVTermType"/>
<xs:element name="samplingTimePoints" type="BinaryDataArrayType" minOccurs="0">
<xs:annotation>
<xs:documentation>The time domain for the samples. Allows for capturing off grid points
and non-uniform sampling.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="decoupled" type="xs:boolean" use="required"/>
<xs:attribute name="numberOfDataPoints" type="xs:integer" use="required"/>
</xs:complexType>
<xs:complexType name="AcquisitionIndirectDimensionParameterSetType">
<xs:annotation>
<xs:documentation>Descriptions of the acquisition parameters set prior to the start of data
acquisition specific to each NMR analysis dimension.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="acquisitionNucleus" type="CVTermType"/>
<xs:element maxOccurs="1" minOccurs="1" name="effectiveExcitationField"
type="ValueWithUnitType">
<xs:annotation>
<xs:documentation>replacing the hardPulse parameter, would be automatically calculated from the procs. If you say the pulse width you also have to specify the excitation angle so this way is more compact/useful
Parsed from Excitation width ?</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="1" minOccurs="1" name="sweepWidth" type="ValueWithUnitType">
<xs:annotation>
<xs:documentation>TODO should be in ppm and Hz.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="timeDomain" type="BinaryDataArrayType">
<xs:annotation>
<xs:documentation>The time domain for the samples. Allows for capturing off grid points
and non-uniform sampling.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="encodingMethod" type="CVTermType">
<xs:annotation>
<xs:documentation>The quadrature method.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="1" minOccurs="1" name="irradiationFrequency" type="ValueWithUnitType">
<xs:annotation>
<xs:documentation>Frequency in ppm or Hz</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="decoupled" type="xs:boolean" use="required"/>
<xs:attribute name="acquisitionParamsFileRef" type="xs:anyURI" use="required"/>
<xs:attribute name="numberOfDataPoints" type="xs:integer" use="required"/>
</xs:complexType>
<xs:complexType name="AcquisitionParameterSetType">
<xs:annotation>
<xs:documentation>Base type for the list with the descriptions of the acquisition settings
applied prior to the start of data acquisition.</xs:documentation>
</xs:annotation>
<xs:sequence maxOccurs="1" minOccurs="1">
<xs:element name="contactRefList" type="ContactRefListType" minOccurs="0"/>
<xs:element minOccurs="0" name="softwareRef" type="SoftwareRefType"/>
<xs:element maxOccurs="1" minOccurs="1" name="sampleContainer" type="CVTermType">
<xs:annotation>
<xs:documentation>The container used to introduc the sample into the autosampler. Example:
tube, flow probe, rotor. Must reference a CV term. </xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="1" minOccurs="1" name="sampleAcquisitionTemperature"
type="ValueWithUnitType">
<xs:annotation>
<xs:documentation>The temperature of the sample during the acquisition.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="solventSuppressionMethod" type="CVParamType">
<xs:annotation>
<xs:documentation>This tag captures the instrument inherent solvent (usually water)
suppression method used during acquisition.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="1" minOccurs="1" name="spinningRate" type="ValueWithUnitType"> </xs:element>
<xs:element maxOccurs="1" minOccurs="1" name="relaxationDelay" type="ValueWithUnitType"> </xs:element>
<xs:element maxOccurs="1" minOccurs="1" name="pulseSequence" type="PulseSequenceType">
<xs:annotation>
<xs:documentation>A description of the pulse sequence using CV params/terms, and reference
to the pulse sequence file if the source is available. </xs:documentation>
</xs:annotation>
</xs:element>