Skip to content

Commit

Permalink
Add missing images.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
rly authored Nov 27, 2024
1 parent 75ceae1 commit 21a3586
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/best_practices/images.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
Images
======

Storage of Images
-----------------

.. _best_practice_order_of_images_unique:
.. _best_practice_order_of_images_len:

Storing the order of images in an Images object
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The ``order_of_images`` field of an :ref:`nwb-schema:sec-Images` object is designed to contain the order
of the images in the ``images`` field of the :ref:`nwb-schema:sec-Images` object. As such, all of the values
in the ``order_of_images`` field should be unique, and its length should be equal to the number of
:ref:`nwb-schema:sec-Image` objects in the :ref:`nwb-schema:sec-Images` object.

Check functions: :py:meth:`~nwbinspector.checks._images.check_order_of_images_unique` and
:py:meth:`~nwbinspector.checks._images.check_order_of_images_len`


.. _best_practice_index_series_points_to_image:

Use of IndexSeries
~~~~~~~~~~~~~~~~~~

The use of an :ref:`nwb-schema:sec-IndexSeries` object to point to a :ref:`nwb-schema:sec-TimeSeries` will
be deprecated in favor. The :ref:`nwb-schema:sec-IndexSeries` object should point to an
:ref:`nwb-schema:sec-Images` container, which holds a collection of :ref:`nwb-schema:sec-Image` objects instead.

Check function: :py:meth:`~nwbinspector.checks._images.check_index_series_points_to_image`

0 comments on commit 21a3586

Please sign in to comment.