-
Notifications
You must be signed in to change notification settings - Fork 56
/
nxdl.xsd
executable file
·1420 lines (1295 loc) · 51.7 KB
/
nxdl.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"?>
<!-- Here's a procedure to validate this XSD Schema file:
https://stackoverflow.com/a/48980995/1046449 -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://definition.nexusformat.org/nxdl/3.1"
xmlns:nx="http://definition.nexusformat.org/nxdl/3.1"
elementFormDefault="qualified">
<xs:annotation>
<xs:documentation>
..
NeXus - Neutron and X-ray Common Data Format
Copyright (C) 2008-2024 NeXus International Advisory Committee (NIAC)
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 3 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
For further information, see http://www.nexusformat.org
</xs:documentation>
</xs:annotation>
<!-- +++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<xs:include schemaLocation="nxdlTypes.xsd">
<xs:annotation>
<xs:documentation>
Definitions of the basic data types and unit types
allowed in NXDL instance files.
</xs:documentation>
</xs:annotation>
</xs:include>
<!-- +++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<!-- define the document root element -->
<xs:element name="definition" type="nx:definitionType">
<xs:annotation>
<xs:documentation>
A ``definition`` element
is the ``group`` at the
root of every NXDL specification.
It may *only* appear
at the root of an NXDL file and must only appear
**once** for the NXDL to be *well-formed*.
</xs:documentation>
</xs:annotation>
</xs:element>
<!-- +++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<xs:simpleType name="validItemName">
<xs:annotation>
<xs:documentation>
Used for allowed names of elements and attributes.
Note: No ``-`` characters (among others) are allowed
and you cannot start or end with a period (``.``).
HDF4 had a 64 character limit on names
(possibly including NULL) and the NAPI enforces this
via the ``NX_MAXNAMELEN`` variable with
a **64** character limit (which
may be 63 on a practical basis if one considers a NULL
terminating byte).
(This data type is used internally in the NXDL schema
to define a data type.)
NOTE: In some languages, it may be necessary to add a
``^`` at the start and a ``$`` at the end of the regular
expression to constrain the match to an entire line.
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:pattern value="[a-zA-Z0-9_]([a-zA-Z0-9_.]*[a-zA-Z0-9_])?" />
<xs:maxLength value="63" /> <!-- enforce via NX_MAXNAMELEN -->
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="validNXClassName">
<xs:annotation>
<xs:documentation>
Used for allowed names of NX class types (e.g. NXdetector).
Note this is *not* the instance name (e.g. ``bank1``)
which is covered by ``validItemName``.
(This data type is used internally in the NXDL schema
to define a data type.)
</xs:documentation>
</xs:annotation>
<xs:restriction base="nx:validItemName">
<xs:pattern value="NX.+"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="validTargetName">
<xs:annotation>
<xs:documentation>
This is a valid link target - currently it must be an absolute path
made up of valid names with the ``/`` character delimiter. But we may
want to consider allowing "``..``" (parent of directory) at some point.
If the ``name`` attribute is helpful, then use it in the path
with the syntax of *name:type* as in these examples::
/NXentry/NXinstrument/analyzer:NXcrystal/ef
/NXentry/NXinstrument/monochromator:NXcrystal/ei
/NX_other
Must also consider use of ``name`` attribute in resolving ``link`` targets.
(This data type is used internally in the NXDL schema
to define a data type.)
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:token">
<xs:annotation>
<xs:documentation>
From the HDF5 documentation:
*Note that relative path names in HDF5 do not employ the ``../`` notation,
the UNIX notation indicating a parent directory, to indicate a parent group.*
Thus, if we only consider the case of
``[name:]type``, the matching regular expression syntax
is written: ``/[a-zA-Z_][\w_]*(:[a-zA-Z_][\w_]*)?)+``.
Note that HDF5 also permits relative path names, such as:
``GroupA/GroupB/Dataset1``
but this is not permitted in the matching regular expression and not supported in NAPI.
</xs:documentation>
</xs:annotation>
<xs:pattern value="(/[a-zA-Z_][\w_]*(:[a-zA-Z_][\w_]*)?)+" />
</xs:restriction>
</xs:simpleType>
<!-- +++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<xs:attributeGroup name="deprecatedAttributeGroup">
<xs:attribute name="deprecated" use="optional">
<xs:annotation>
<xs:documentation>
The presence of the ``deprecated`` attribute
indicates to the data file validation process that
an advisory message (specified as the content of the
``deprecated`` attribute) will be reported.
Future versions of the NXDL file might
not define (or even re-use) the component marked with this attribute.
The value of the attribute will be printed in the documentation.
Make it descriptive (limited to no line breaks).
For example::
deprecated="as of release MAJOR.MINOR"
Note: because ``deprecated`` is an attribute,
the XML rules do not permit it to have any
element content.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:pattern value=".*(\w+).*" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:attributeGroup>
<xs:attributeGroup name="nameTypeAttributeGroup">
<xs:attribute name="nameType" use="optional" default="specified">
<xs:annotation>
<xs:documentation>
This interprets the ``name`` attribute as:
* ``"specified"`` = Exactly this name.
Note that if no ``name`` and ``nameType`` are provided
for a group, ``nameType="any"`` becomes the default.
* ``"any"`` = Any name not already used in group.
* ``"partial"`` = The capital letters are substitutable
(empty string allowed) and the lower case letters
(and other allowed symbols, such as ``_``) are not.
In each case, all names in a NeXus data file must
follow the naming :ref:`rules<Design-Naming>`.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="nx:NX_CHAR">
<xs:enumeration value="specified" />
<xs:enumeration value="any" />
<xs:enumeration value="partial" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:attributeGroup>
<xs:complexType name="definitionType">
<xs:annotation>
<xs:documentation>
A ``definition`` is the root element of every NXDL definition.
It may *only* appear at the root of an NXDL file and must only
appear **once** for the NXDL to be *well-formed*.
The ``definitionType`` defines the documentation,
attributes, fields, and groups that will be used
as children of the ``definition`` element.
Could contain these elements:
* ``attribute``
* ``doc``
* ``field``
* ``group``
* ``link``
Note that a ``definition`` element also includes the definitions of the
``basicComponent`` data type.
(The ``definitionType`` data type is used internally in the NXDL schema
to define elements and attributes to be used by users in NXDL specifications.)
Note that the first line of text in a ``doc`` element in a ``definition``
is used as a summary in the manual. Follow the pattern as shown
in the base class NXDL files.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="symbols" type="nx:symbolsType" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>
Use a ``symbols`` list
to define each of the mnemonics that
represent the length of each dimension in a vector or array.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:group ref="nx:groupGroup" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
In addition to an optional ``symbols`` list,
a ``definition`` may contain any of the items
allowed in a ``group``.
</xs:documentation>
</xs:annotation>
</xs:group>
</xs:sequence>
<xs:attribute name="name" use="required" type="nx:validItemName">
<xs:annotation>
<xs:documentation>
The ``name`` of this NXDL file (case sensitive without the file extension).
The name must be unique amongst all the NeXus base class, application,
and contributed definitions. For the class to be adopted by the NIAC,
the first two letters must be "``NX``" (in uppercase). Any other use
must *not* begin with "``NX``" in any combination
of upper or lower case.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="type" use="required" type="nx:definitionTypeAttr">
<xs:annotation>
<xs:documentation>Must be ``type="group"``</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="extends" use="optional">
<xs:annotation>
<xs:documentation>
The ``extends`` attribute allows this definition
to *subclass* from another NXDL,
otherwise ``extends="NXobject"`` should be used.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="restricts" use="optional">
<xs:annotation>
<xs:documentation>
The ``restricts`` attribute is a flag to the data validation.
When ``restricts="1"``, any non-standard component found
(and checked for validity against this NXDL specification)
in a NeXus data file will be flagged as an error. If the
``restricts`` attribute is not present, any such situations
will produce a warning.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="svnid" use="optional">
<xs:annotation>
<xs:documentation>
(2014-08-19: deprecated since switch to GitHub version control)
The identifier string from the subversion revision control system.
This reports the time stamp and the revision number of this file.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="category" use="required">
<xs:annotation>
<xs:documentation>
NXDL ``base`` definitions define the dictionary
of terms to use for these components.
All terms in a ``base`` definition are optional.
NXDL ``application`` definitions define what is
required for a scientific interest.
All terms in an ``application`` definition
are required.
NXDL ``contributed`` definitions may be
considered either base or applications.
Contributed definitions <emphasis>must</emphasis> indicate
their intended use, either as a base class or
as an application definition.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="base"/>
<xs:enumeration value="application"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="ignoreExtraGroups" use="optional" type="nx:NX_BOOLEAN" default="false">
<xs:annotation>
<xs:documentation>
Only validate known groups; do not not warn about unknowns.
The ``ignoreExtraGroups`` attribute is a flag to the process of
validating NeXus data files. By setting ``ignoreExtraGroups="true"``,
presence of any undefined groups in this class will not generate warnings
during validation. Normally, validation will check all the groups against
their definition in the NeXus base classes and
application definitions. Any items found that do not match the definition
in the NXDL will generate a warning message.
The ``ignoreExtraGroups`` attribute should be used sparingly!
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ignoreExtraFields" use="optional" type="nx:NX_BOOLEAN" default="false">
<xs:annotation>
<xs:documentation>
Only validate known fields; do not not warn about unknowns.
The ``ignoreExtraFields`` attribute is a flag to the process of
validating NeXus data files. By setting ``ignoreExtraFields="true"``,
presence of any undefined fields in this class will not generate warnings
during validation. Normally, validation will check all the fields against
their definition in the NeXus base classes and
application definitions. Any items found that do not match the definition
in the NXDL will generate a warning message.
The ``ignoreExtraFields`` attribute should be used sparingly!
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ignoreExtraAttributes" use="optional" type="nx:NX_BOOLEAN" default="false">
<xs:annotation>
<xs:documentation>
Only validate known attributes; do not not warn about unknowns.
The ``ignoreExtraAttributes`` attribute is a flag to the process of
validating NeXus data files. By setting ``ignoreExtraAttributes="true"``,
presence of any undefined attributes in this class will not generate warnings
during validation. Normally, validation will check all the attributes
against their definition in the NeXus base classes and
application definitions. Any items found that do not match the definition
in the NXDL will generate a warning message.
The ``ignoreExtraAttributes`` attribute should be used sparingly!
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attributeGroup ref="nx:deprecatedAttributeGroup"/>
</xs:complexType>
<xs:simpleType name="definitionTypeAttr">
<xs:annotation>
<xs:documentation>
Prescribes the allowed values for ``definition`` ``type`` attribute.
(This data type is used internally in the NXDL schema
to define a data type.)
</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:enumeration value="group" />
<xs:enumeration value="definition" />
</xs:restriction>
</xs:simpleType>
<!-- +++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<xs:complexType name="choiceType">
<xs:annotation>
<xs:documentation>
A ``choice`` element is used when a named group might take one
of several possible NeXus base classes. Logically, it must
have at least two group children.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="group" type="nx:groupType" minOccurs="2" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
NeXus base class that could be used here.
The group will take the ``@name`` attribute
defined by the parent ``choice`` element
so do not specify the ``@name`` attribute of
the group here.
</xs:documentation>
<!-- TODO: How to enforce the name rule in the schema? -->
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="name" use="required" type="nx:validItemName">
<xs:annotation>
<xs:documentation>
The name to be applied to the selected child group.
None of the child groups should define a
``@name`` attribute.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<!-- +++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<xs:complexType name="groupType">
<xs:annotation>
<xs:documentation>
A group element refers to the definition of
an existing NX object or a locally-defined component.
Could contain these elements:
* ``attribute``
* ``doc``
* ``field``
* ``group``
* ``link``
Note that a ``group`` element also includes the definitions of the
``basicComponent`` data type.
(The ``groupType`` data type is used internally in the NXDL schema
to define elements and attributes to be used by users in NXDL specifications.)
</xs:documentation>
</xs:annotation>
<xs:group ref="nx:groupGroup" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
A ``group`` may be contained within another ``group``.
</xs:documentation>
</xs:annotation>
</xs:group>
<xs:attribute name="type" use="required" type="nx:validNXClassName">
<xs:annotation>
<xs:documentation>
The ``type`` attribute *must*
contain the name of a
NeXus base class, application definition, or contributed definition.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="name" use="optional" type="nx:validItemName">
<xs:annotation>
<xs:documentation>
A particular scientific application may expect
a name of a ``group`` element. It is helpful but not
required to specify the ``name``
attribute in the NXDL file.
It is suggested to always specify a ``name``
to avoid ambiguity. It is also suggested to
derive the ``name`` from the
type, using an additional number suffix as necessary.
For example, consider a data file with only one
``NXentry``. The suggested default
``name`` would
be ``entry``. For a data file with two or more
``NXentry`` groups, the suggested names would be
``entry1``, ``entry2``, ...
Alternatively, a scientific application such as small-angle
scattering might require
a different naming procedure; two different ``NXaperture`` groups
might be given the names ``beam_defining_slit``
and ``scatter_slit``.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="minOccurs" use="optional" default="0" type="nx:nonNegativeUnbounded">
<xs:annotation>
<xs:documentation>
Minimum number of times this ``group`` is allowed to be present within its
parent group. Note each ``group`` must have a ``name`` attribute
that is unique among all ``group`` and ``field``
declarations within a common parent group.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="recommended" use="optional" type="nx:NX_BOOLEAN" default="false" >
<xs:annotation>
<xs:documentation>
A synonym for optional, but with the recommendation that this
``group`` be specified.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="optional" use="optional" type="nx:NX_BOOLEAN" default="false" >
<xs:annotation>
<xs:documentation>
A synonym for minOccurs=0.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxOccurs" use="optional" type="nx:nonNegativeUnbounded">
<xs:annotation>
<xs:documentation>
Maximum number of times this ``group`` is allowed to be present within its
parent ``group``. Note each ``group`` must have a ``name`` attribute
that is unique among all ``group`` and ``field``
declarations within a common parent ``group``.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attributeGroup ref="nx:deprecatedAttributeGroup"/>
<xs:attributeGroup ref="nx:nameTypeAttributeGroup"/>
</xs:complexType>
<xs:group name="groupGroup">
<xs:annotation>
<xs:documentation>
A ``groupGroup`` defines the allowed children of a
``group`` specification.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="doc" type="nx:docType" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>
Describe the purpose of this ``group``.
This documentation will go into the manual.
The first line should summarize as a complete
sentence with no line break. (The automatic
documentation will pick just the first line as a
summary.) Then a blank line should be added
before any further
documentation. Indentation should be consistent
with rules for reStructured text.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="attribute" type="nx:attributeType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
Use an ``attribute`` if additional information
needs to be associated with a ``group``.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="choice" type="nx:choiceType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
Use a ``choice`` if a named group could be either
of a defined list of base classes.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="group" type="nx:groupType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
A ``group`` may contain ``group``s.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="field" type="nx:fieldType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
A ``group`` may contain ``field`` elements (datasets).
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="link" type="nx:linkType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
Use a ``link`` to refer locally to
information placed elsewhere else in the data storage hierarchy.
The ``name`` attribute uniquely identifies
the element in this ``group``.
The ``target`` attribute
(added automatically in a data file by the NAPI)
identifies the original location of this data in the
data storage hierarchy.
In an NXDL specification, the ``target`` attribute
indicates a link to be made by the software that writes the data file.
The value, as written in the NXDL file, will be a suggestion of
the path to the source of the link.
For example::
<link name="data" target="/NXentry/NXinstrument/NXdetector/data"/>
The value of ``target`` is written using
the NeXus class names since this is a suggestion and does not actually use
the element names from a particular data file.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:group>
<!-- +++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<xs:complexType name="basicComponent">
<xs:annotation>
<xs:documentation>
A ``basicComponent`` defines the allowed name
format and attributes common to all ``field``
and ``group`` specifications.
(This data type is used internally in the NXDL schema
to define elements and attributes to be used by users in NXDL specifications.)
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="doc" type="nx:docType" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>
Describe this ``basicComponent`` and its use.
This documentation will go into the manual.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="name" use="required" type="nx:validItemName">
<xs:annotation>
<xs:documentation>
The ``name`` attribute is the
identifier string for this entity.
It is required that ``name`` must be unique
within the enclosing ``group``.
The name must match the regular expression
defined by ``validItemName``.
(Historical note:
Originally, the rule (``validItemName``) was defined to allow
only names that can be represented as valid variable names
in most computer languages.
)
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attributeGroup ref="nx:deprecatedAttributeGroup"/>
</xs:complexType>
<!-- +++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
<xs:complexType name="fieldType">
<xs:annotation>
<xs:documentation>
A ``field`` declares a new element in the component being defined.
A ``field`` is synonymous with the HDF4 SDS (Scientific Data Set) and
the HDF5 *dataset* terms. Could contain these elements:
* ``attribute``
* ``dimensions``
* ``doc``
* ``enumeration``
Note that a ``field`` element also includes the definitions of the
``basicComponent`` data type.
(The ``fieldType`` data type is used internally in the NXDL schema
to define elements and attributes to be used by users in NXDL specifications.)
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="nx:basicComponent">
<xs:sequence>
<xs:element name="dimensions" type="nx:dimensionsType" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>
dimensions of a data element in a NeXus file
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="attribute" type="nx:attributeType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>
attributes to be used with this field
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="enumeration" type="nx:enumerationType" minOccurs="0">
<xs:annotation>
<xs:documentation>
A field can specify which values are to be used
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="units" type="nx:anyUnitsAttr">
<xs:annotation>
<xs:documentation>
String describing the engineering units.
The string should be appropriate for the value.
* If a unit is not provided by the list of NeXus
unit categories, instead of providing a category,
a field element can include an example of the
units directly.
* The example does not constrain the scale of the
units. For example, if the unit is ``eV/mm``, the
user could specify in a data file ``eV/cm``, or any
other unit that is convertible to the example given.
It is recommended that users and application developers
check if their units and their unit examples adhere to
the UDUNITS standard. [#]_
Conformance is not validated at this time.
.. [#] https://www.unidata.ucar.edu/software/udunits/
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="long_name" type="nx:NX_CHAR">
<xs:annotation>
<xs:documentation>
Descriptive name for this field (may include whitespace and engineering units).
Often, the long_name (when defined) will be used as the axis label on a plot.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="signal" type="nx:NX_POSINT">
<xs:annotation>
<xs:documentation>
Presence of the ``signal`` attribute means this field is an ordinate.
Integer marking this field as plottable data (ordinates).
The value indicates the priority of selection or interest.
Some facilities only use ``signal=1``
while others use ``signal=2`` to indicate
plottable data of secondary interest.
Higher numbers are possible but not common
and interpretation is not standard.
A field with a ``signal`` attribute should not have an ``axis`` attribute.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="axes" type="nx:NX_CHAR">
<xs:annotation>
<xs:documentation>
NOTE: Use of the ``axes`` attribute for a
*field* is discouraged. It is for legacy
support. You should use the ``axes`` group
attribute (such as in NXdata) instead.
This attribute contains a string array that
defines the independent data fields used in
the default plot for all of the dimensions
of the *signal* field (the *signal* field is
the field in this group that is named by the
``signal`` attribute of this group).
When there is only one item in the string array,
it is acceptable to set the value to the one string.
In such case, it is not necessary to make it
an array of one string.
Presence of the ``axes`` attribute means
this field is an ordinate.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="axis" type="nx:NX_POSINT">
<xs:annotation>
<xs:documentation>
NOTE: Use of this attribute is discouraged. It is for legacy support.
You should use the ``axes`` group
attribute (such as in NXdata) instead.
Presence of the ``axis`` attribute means this field is an abscissa.
The attribute value is an integer indicating this
field as an axis that is part of the data set.
The data set is a field with the attribute
``signal=1`` in the same group.
The value can range from 1 up to the number of
independent axes (abscissae) in the data set.
A value of ``axis=1``" indicates that this field
contains the data for the first independent axis.
For example, the X axis in an XY data set.
A value of ``axis=2`` indicates that this field
contains the data for the second independent axis.
For example, the Y axis in a 2-D data set.
A value of ``axis=3`` indicates that this field
contains the data for the third independent axis.
For example, the Z axis in a 3-D data set.
A field with an ``axis`` attribute should
not have a ``signal`` attribute.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="primary" type="nx:NX_POSINT">
<xs:annotation>
<xs:documentation>
Integer indicating the priority of selection
of this field for plotting (or visualization) as an axis.
Presence of the ``primary`` attribute means this
field is an abscissa.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="type" type="nx:primitiveType" default="NX_CHAR">
<xs:annotation>
<xs:documentation>
Defines the type of the element as allowed by NeXus.
See :ref:`here<Design-DataTypes>` and :ref:`elsewhere<nxdl-types>` for the complete list of allowed types.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="minOccurs" use="optional" default="0" type="nx:nonNegativeUnbounded">
<xs:annotation>
<xs:documentation>
Defines the minimum number of times this ``field`` may be used. Its
value is confined to zero or greater. Must be less than or equal to
the value for the "maxOccurs" attribute.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="recommended" use="optional" type="nx:NX_BOOLEAN" default="false" >
<xs:annotation>
<xs:documentation>
A synonym for optional, but with the recommendation that this
``field`` be specified.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="optional" use="optional" type="nx:NX_BOOLEAN" default="false" >
<xs:annotation>
<xs:documentation>
A synonym for minOccurs=0.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="maxOccurs" use="optional" default="1" type="nx:nonNegativeUnbounded">
<xs:annotation>
<xs:documentation>
Defines the maximum number of times this element may be used. Its
value is confined to zero or greater. Must be greater than or equal to
the value for the "minOccurs" attribute.
A value of "unbounded" is allowed.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="stride" use="optional" default="1" type="nx:NX_INT">
<xs:annotation>
<xs:documentation>
The ``stride`` and ``data_offset`` attributes
are used together to index the array of data items in a
multi-dimensional array. They may be used as an alternative
method to address a data array that is not stored in the standard NeXus
method of "C" order.
The ``stride`` list chooses array locations from the
data array with each value in the ``stride`` list
determining how many elements to move in each dimension.
Setting a value in the ``stride`` array to 1 moves
to each element in that dimension of the data array, while
setting a value of 2 in a location in the ``stride``
array moves to every other element in that dimension of the
data array. A value in the ``stride`` list may be
positive to move forward or negative to step backward.
A value of zero will not step (and is of no particular use).
See https://support.hdfgroup.org/HDF5/Tutor/phypereg.html
or *4. Dataspace Selection Operations* in
https://portal.hdfgroup.org/display/HDF5/Dataspaces
The ``stride`` attribute contains a
comma-separated list of integers.
(In addition to the required comma delimiter,
whitespace is also allowed to improve readability.)
The number of items in the list
is equal to the rank of the data being stored. The value of each
item is the spacing of the data items in that subscript of the array.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="data_offset" use="optional" default="1" type="nx:nonNegativeUnbounded">
<xs:annotation>
<!--
note: renamed from "offset" due to conflict with CIF usage.
see: https://github.com/nexusformat/definitions/issues/330#issuecomment-232074420
-->
<xs:documentation>
The ``stride`` and ``data_offset`` attributes
are used together to index the array of data items in a
multi-dimensional array. They may be used as an alternative
method to address a data array that is not stored in the standard NeXus
method of "C" order.
The ``data_offset`` attribute
determines the starting coordinates of the data array
for each dimension.
See https://support.hdfgroup.org/HDF5/Tutor/phypereg.html
or *4. Dataspace Selection Operations* in
https://portal.hdfgroup.org/display/HDF5/Dataspaces
The ``data_offset`` attribute contains a
comma-separated list of integers.
(In addition to the required comma delimiter,
whitespace is also allowed to improve readability.)
The number of items in the list
is equal to the rank of the data being stored. The value of each
item is the offset in the array of the first data item of that
subscript of the array.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="interpretation" use="optional">
<xs:annotation>
<xs:documentation>
This instructs the consumer of the data what the last dimensions
of the data are. It allows plotting software to work
out the natural way of displaying the data.
For example a single-element, energy-resolving, fluorescence detector
with 512 bins should have ``interpretation="spectrum"``. If the
detector is scanned over a 512 x 512 spatial grid, the data reported
will be of dimensions: 512 x 512 x 512.
In this example, the initial plotting representation should default to
data of the same dimensions of a 512 x 512 pixel ``image``
detector where the images where taken at 512 different pressure values.
In simple terms, the allowed values mean:
* ``scalar`` = 0-D data to be plotted
* ``scaler`` = DEPRECATED, use ``scalar``
* ``spectrum`` = 1-D data to be plotted
* ``image`` = 2-D data to be plotted
* ``rgb-image`` = 3-D data to be plotted
* ``rgba-image`` = 3-D data to be plotted
* ``hsl-image`` = 3-D data to be plotted
* ``hsla-image`` = 3-D data to be plotted
* ``cmyk-image`` = 3-D data to be plotted
* ``vertex`` = 3-D data to be plotted
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="nx:NX_CHAR">
<xs:enumeration value="scalar"/>
<xs:enumeration value="spectrum"/>
<xs:enumeration value="image"/>
<xs:enumeration value="rgb-image"/>
<xs:enumeration value="rgba-image"/>
<xs:enumeration value="hsl-image"/>
<xs:enumeration value="hsla-image"/>
<xs:enumeration value="cmyk-image"/>
<xs:enumeration value="vertex"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attributeGroup ref="nx:nameTypeAttributeGroup"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="attributeType">
<xs:annotation>
<xs:documentation>
Any new group or field may expect or require some common attributes.
..
Could contain these elements:
* ``doc``
* ``enumeration``
(This data type is used internally in the NXDL schema
to define elements and attributes to be used by users in NXDL specifications.)
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="doc" type="nx:docType" minOccurs="0">
<xs:annotation>
<xs:documentation>
Description of this ``attribute``.
This documentation will go into the manual.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="enumeration" type="nx:enumerationType"
minOccurs="0">
<xs:annotation>
<xs:documentation>
An enumeration specifies the values to be used.
</xs:documentation>
</xs:annotation>
</xs:element>