Skip to content

Commit

Permalink
express length(axes) == rank(data) in NXDL
Browse files Browse the repository at this point in the history
  • Loading branch information
woutdenolf committed Aug 15, 2024
1 parent 27cfde3 commit 37306ef
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions base_classes/NXdata.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -375,15 +375,18 @@
<attribute name="axes">
<doc>
.. index:: plotting

The ``axes`` attribute is a list of strings which are the names of the :ref:`AXISNAME &lt;/NXdata/AXISNAME-field&gt;` fields
to be used as the default axis along all :ref:`DATA &lt;/NXdata/DATA-field&gt;` dimensions. As a result the length must
to be used as the default axis along every :ref:`DATA &lt;/NXdata/DATA-field&gt;` dimension. As a result the length must
be equal to the rank of the :ref:`DATA &lt;/NXdata/DATA-field&gt;` fields. The string "." can be used for
dimensions without a default axis.

.. note:: When ``axes`` contains multiple strings, it must be saved as an actual array
of strings and not a single comma separated string.
</doc>
<dimensions rank="1">
<dim index="1" value="dataRank"/>
</dimensions>
</attribute>

<!-- Data and coordinate fields -->
Expand Down

0 comments on commit 37306ef

Please sign in to comment.