Images

Storage of Images

Storing the order of images in an Images object

The order_of_images field of an Images object is designed to contain the order of the images in the images field of the 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 Image objects in the Images object.

Check functions: check_order_of_images_unique() and check_order_of_images_len()

Use of IndexSeries

The use of an IndexSeries object to point to a TimeSeries will be deprecated in a future release of the NWB schema. The IndexSeries object should point to an Images container, which holds a collection of Image objects instead.

Check function: check_index_series_points_to_image()