We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 6cf607d commit 1d2cf21Copy full SHA for 1d2cf21
1 file changed
doc/develop/backend-api.rst
@@ -619,6 +619,14 @@ in a different order. It is possible to override the default dimension order by
619
using the ``MD_DIMS`` metadata. For instance, RGB data is often stored with the
620
channel as last dimension for display. Such case can be indicated with "YXC".
621
622
+.. note::
623
+
624
+ As a DataArray number of dimension can vary, and by default the MD_DIMS is undefined, to
625
+ indicate the "default order", it is not directly easy to read this metadata.
626
+ It is recommended to access it this way:
627
628
+ ``dims = data.metadata.get(model.MD_DIMS, "CTZYX"[-data.ndim::])``
629
630
Convention about measurement units
631
==================================
632
0 commit comments