Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
prjemian committed Jan 23, 2020
2 parents eafd1af + 53f79d6 commit 8d6d5b9
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 7 deletions.
6 changes: 3 additions & 3 deletions applications/NXmx.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@
dataset with indices (np, i, j, k) will be an array with indices
(i, j, k).

The order of indices (i, j or i, j, k) is slow to fast.
The :ref:`order <Design-ArrayStorageOrder>` of indices (i, j or i, j, k) is slow to fast.
</doc>
</field>
<field name="data_size" type="NX_INT">
Expand Down Expand Up @@ -261,7 +261,7 @@
</field>
<field name="fast_pixel_direction" units="NX_LENGTH" type="NX_NUMBER">
<doc>
Values along the direction of fastest varying pixel direction.
Values along the direction of :ref:`fastest varying &lt;Design-ArrayStorageOrder&gt;` pixel direction.
The direction itself is given through the vector attribute
</doc>
<attribute name="transformation_type">
Expand All @@ -278,7 +278,7 @@
</field>
<field name="slow_pixel_direction" type="NX_NUMBER" units="NX_LENGTH">
<doc>
Values along the direction of slow varying pixel direction. The
Values along the direction of :ref:`slowest varying &lt;Design-ArrayStorageOrder&gt;` pixel direction. The
direction itself is given through the vector attribute
</doc>
<attribute name="transformation_type">
Expand Down
6 changes: 3 additions & 3 deletions base_classes/NXdetector_module.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
dataset with indices (np, i, j, k) will be an array with indices
(i, j, k).

The order of indices (i, j or i, j, k) is slow to fast.
The :ref:`order &lt;Design-ArrayStorageOrder&gt;` of indices (i, j or i, j, k) is slow to fast.
</doc>
</field>
<field name="data_size" type="NX_INT">
Expand Down Expand Up @@ -95,7 +95,7 @@
</field>
<field name="fast_pixel_direction" units="NX_LENGTH" type="NX_NUMBER">
<doc>
Values along the direction of fastest varying pixel direction. Each value in this
Values along the direction of :ref:`fastest varying &lt;Design-ArrayStorageOrder&gt;` :index:`pixel direction&lt;dimension; fastest varying&gt;`. Each value in this
array is the size of a pixel in the units specified. Alternatively, if only one
value is given, all pixels in this direction have the same value. The direction
itself is given through the vector attribute.
Expand Down Expand Up @@ -128,7 +128,7 @@
</field>
<field name="slow_pixel_direction" type="NX_NUMBER" units="NX_LENGTH">
<doc>
Values along the direction of fastest varying pixel direction. Each value in this
Values along the direction of :ref:`slowest varying&lt;Design-ArrayStorageOrder&gt;` :index:`pixel direction&lt;dimension; slowest varying&gt;`. Each value in this
array is the size of a pixel in the units specified. Alternatively, if only one
value is given, all pixels in this direction have the same value. The direction
itself is given through the vector attribute.
Expand Down
5 changes: 4 additions & 1 deletion manual/source/datarules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -160,9 +160,12 @@ NeXus Array Storage Order

NeXus stores :index:`multi-dimensional <dimension; storage order>`
arrays of physical values in C language storage order,
where the last dimension is the fastest varying. This is the rule.
where the first dimension has the :index:`slowest varying <dimension; slowest varying>` index when iterating through the array in storage order,
and the last dimension is the :index:`fastest varying <dimension; fastest varying>`. This is the rule.
*Good reasons are required to deviate from this rule.*

Where the array contains data from a detector, the array dimensions may correspond to physical directions or axes. The slowest, slow, fast, fastest qualifiers can then apply to these axes too.

It is possible to store data in storage orders other than C language order.

.. TODO: see note with "Design-DataValueTransformations" section below
Expand Down

0 comments on commit 8d6d5b9

Please sign in to comment.