Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NXdata errors on an axis, signal or auxiliary signal #1047

Merged
merged 6 commits into from
Sep 15, 2022
Merged

NXdata errors on an axis, signal or auxiliary signal #1047

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bb5d07f
NXdata errors on an axis, signal or auxiliary signal
woutdenolf Apr 26, 2022
68778c5
remove the usage of VARIABLE
woutdenolf Sep 15, 2022
85aa5f7
Update NXdata.nxdl.xml
benajamin Sep 15, 2022
711c7bd
Update NXdata.nxdl.xml
benajamin Sep 15, 2022
2d6bde4
Update NXdata.nxdl.xml
benajamin Sep 15, 2022
b5365eb
Update NXdata.nxdl.xml
benajamin Sep 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 12 additions & 27 deletions base_classes/NXdata.nxdl.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
<symbols>
<doc>These symbols will be used below to coordinate fields with the same shape.</doc>
<symbol name="dataRank"><doc>rank of the ``DATA`` field</doc></symbol>
<symbol name="n"><doc>length of the ``VARIABLE`` field</doc></symbol>
<symbol name="n"><doc>length of the ``AXISNAME`` field</doc></symbol>
<symbol name="nx"><doc>length of the ``x`` field</doc></symbol>
<symbol name="ny"><doc>length of the ``y`` field</doc></symbol>
<symbol name="nz"><doc>length of the ``z`` field</doc></symbol>
Expand Down Expand Up @@ -166,7 +166,7 @@

It is strongly recommended that there is at least one :ref:`NXdata`
group in each :ref:`NXentry` group.
Note that the fields named ``VARIABLE`` and ``DATA``
Note that the fields named ``AXISNAME`` and ``DATA``
can be defined with different names.
(Upper case is used to indicate that the actual name is left to the user.)
The ``signal`` and ``axes`` attributes of the
Expand Down Expand Up @@ -270,7 +270,7 @@
but not to describe how the data is to be plotted.
(https://www.nexusformat.org/NIAC2018Minutes.html#nxdata-plottype--attribute)
</doc>
<field name="VARIABLE" type="NX_NUMBER" nameType="any">
<field name="AXISNAME" type="NX_NUMBER" nameType="any">
<doc>
Dimension scale defining an axis of the data.
Client is responsible for defining the dimensions of the data.
Expand Down Expand Up @@ -304,26 +304,15 @@
</doc>
</attribute>
</field>
<field name="VARIABLE_errors" type="NX_NUMBER" nameType="any">
<field name="FIELDNAME_errors" type="NX_NUMBER" nameType="any">
<doc>
"Errors" (actually *uncertainties*) associated with axis ``VARIABLE``.
Client is responsible for defining the dimensions of the data.
The name of this field may be changed to fit the circumstances
but is matched with the *VARIABLE* field with ``_errors`` appended.

This pattern of using ``VARIABLE_errors`` can be used
throughout a NeXus data file to associate uncertainties
with a field named ``VARIABLE``. This pattern also
applies to other relationships such as ``VARIABLE_resolutions``
to connect additional data with a certain field.
"Errors" (meaning *uncertainties* or *standard deviations*)
associated with any field named ``FIELDNAME`` in this ``NXdata``
group (e.g. an axis, signal or auxiliary signal).

The dimensions of the ``FIELDNAME_errors`` field must match
the dimensions of the ``FIELDNAME`` field.
</doc>
<dimensions rank="1">
<doc>
A dimension scale must have a rank of 1 and has length ``n``,
same as ``VARIABLE``.
</doc>
<dim index="1" value="n"/>
</dimensions>
</field>
<field name="DATA" type="NX_NUMBER" nameType="any">
<doc>
Expand Down Expand Up @@ -366,19 +355,15 @@
Do not use the ``axes`` attribute with the ``axis`` attribute.
</doc>
</attribute>
<!--
NIAC2018 voted to use VARIABLE_errors, not @uncertainties
https://github.com/nexusformat/definitions/issues/634
-->
<attribute name="long_name">
<doc>data label</doc>
</attribute>
</field>
<field name="errors" type="NX_NUMBER">
<field name="errors" type="NX_NUMBER" deprecated="Use ``DATA_errors`` instead (NIAC2018)">
<doc>
Standard deviations of data values -
the data array is identified by the group attribute ``signal``.
The ``errors`` array must have the same dimensions as ``data``.
The ``errors`` array must have the same dimensions as ``DATA``.
Client is responsible for defining the dimensions of the data.
</doc>
<dimensions rank="dataRank">
Expand Down