Skip to content

Commit

Permalink
fixes #534
Browse files Browse the repository at this point in the history
  • Loading branch information
@prjemian
prjemian committed Jan 18, 2017
1 parent 0135fd2 commit e888dac
Showing 1 changed file with 141 additions and 0 deletions.
141 changes: 141 additions & 0 deletions applications/NXcanSAS.nxdl.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,19 @@
``Q`` data is time-dependent: :math:`\vec{Q}(t)`.
</doc>
</attribute>
<attribute name="mask" type="NX_CHAR" >
<doc>
Name of the data mask field.

.. see: https://github.com/nexusformat/definitions/issues/533

The data *mask* must have the same shape as the *data* field.
Positions in the mask correspond to positions in the *data* field.
The value of the mask field may be either a boolean array
where ``false`` means *no mask* and ``true`` means *mask*
or a more descriptive array as as defined in :ref:`NXdetector`.
</doc>
</attribute>
<attribute name="Mask_indices" optional="true">
<doc>
Integer or integer array that describes which indices
Expand Down Expand Up @@ -289,6 +302,23 @@
:math:`|\vec{Q}|`
or :math:`\vec{Q}`, depending on the context.
</doc>
<attribute name="units" optional="false">
<doc>
Engineering units to use when expressing
:math:`Q` and related terms.

Data expressed in other units will generate
a warning from validation software and may not
be processed by some analysis software packages.
</doc>
<enumeration>
<item value="1/m" />
<item value="1/nm">
<doc>preferred</doc>
</item>
<item value="1/angstrom" />
</enumeration>
</attribute>
<attribute name="uncertainties" optional="true">
<doc>
(optional: for numerical arrays)
Expand Down Expand Up @@ -439,6 +469,29 @@
data may be presented in other units and still be consistent with NeXus.
See the :ref:`design-units` section.
</doc>
<attribute name="units" optional="false">
<doc>
Engineering units to use when expressing
:math:`I` and intensity-related terms.

Data expressed in other units (or missing a ``@units`` attribute)
will be treated as ``arbitrary`` by some software packages.

For software using the UDUNITS-2 library, ``arbitrary`` will be
changed to ``unknown`` for handling with that library.
</doc>
<enumeration>
<item value="1/m">
<doc>includes m2/m3 and 1/m/sr</doc>
</item>
<item value="1/cm">
<doc>includes cm2/cm3 and 1/cm/sr</doc>
</item>
<item value="m2/g" />
<item value="cm2/g" />
<item value="arbitrary" />
</enumeration>
</attribute>
<attribute name="uncertainties" optional="true">
<doc>
(optional: for numerical arrays)
Expand Down Expand Up @@ -500,6 +553,30 @@
I/@uncertainties="Idev"

</doc>
<attribute name="units" optional="false">
<doc>
Engineering units to use when expressing
:math:`I` and intensity-related terms.

Data expressed in other units (or missing a ``@units`` attribute)
will generate a warning from any validation process
and will be treated as ``arbitrary`` by some analysis software packages.

For software using the UDUNITS-2 library, ``arbitrary`` will be
changed to ``unknown`` for handling with that library.
</doc>
<enumeration>
<item value="1/m">
<doc>includes m2/m3 and 1/m/sr</doc>
</item>
<item value="1/cm">
<doc>includes cm2/cm3 and 1/cm/sr</doc>
</item>
<item value="m2/g" />
<item value="cm2/g" />
<item value="arbitrary" />
</enumeration>
</attribute>
</field>

<field name="Qdev" type="NX_NUMBER" units="NX_PER_LENGTH" minOccurs="0">
Expand All @@ -520,6 +597,22 @@
Q/@resolutions="dQw", "dQl"

</doc>
<attribute name="units" optional="false">
<doc>
Engineering units to use when expressing
:math:`Q` and related terms.

Data expressed in other units may not be processed by some
software packages.
</doc>
<enumeration>
<item value="1/m" />
<item value="1/nm">
<doc>preferred</doc>
</item>
<item value="1/angstrom" />
</enumeration>
</attribute>
</field>

<field name="dQw" type="NX_NUMBER" units="NX_PER_LENGTH" minOccurs="0">
Expand All @@ -539,6 +632,22 @@
Q/@resolutions="dQw", "dQl"

</doc>
<attribute name="units" optional="false">
<doc>
Engineering units to use when expressing
:math:`Q` and related terms.

Data expressed in other units may not be processed by some
software packages.
</doc>
<enumeration>
<item value="1/m" />
<item value="1/nm">
<doc>preferred</doc>
</item>
<item value="1/angstrom" />
</enumeration>
</attribute>
</field>

<field name="dQl" type="NX_NUMBER" units="NX_PER_LENGTH" minOccurs="0">
Expand All @@ -558,6 +667,22 @@
Q/@resolutions="dQw", "dQl"

</doc>
<attribute name="units" optional="false">
<doc>
Engineering units to use when expressing
:math:`Q` and related terms.

Data expressed in other units may not be processed by some
software packages.
</doc>
<enumeration>
<item value="1/m" />
<item value="1/nm">
<doc>preferred</doc>
</item>
<item value="1/angstrom" />
</enumeration>
</attribute>
</field>

<field name="Qmean" minOccurs="0" units="NX_PER_LENGTH" type="NX_NUMBER">
Expand All @@ -569,6 +694,22 @@
It is expected that ``Q`` is provided
and that both ``Q`` and ``Qmean`` will have the same units.
</doc>
<attribute name="units" optional="false">
<doc>
Engineering units to use when expressing
:math:`Q` and related terms.

Data expressed in other units may not be processed by some
software packages.
</doc>
<enumeration>
<item value="1/m" />
<item value="1/nm">
<doc>preferred</doc>
</item>
<item value="1/angstrom" />
</enumeration>
</attribute>
</field>
<field name="ShadowFactor" minOccurs="0" units="NX_DIMENSIONLESS">
<doc>
Expand Down

0 comments on commit e888dac

Please sign in to comment.