Images

See also:: Format Specification or Source Specification for Images.

class types.core.Images(varargin)[source]

Bases: types.core.NWBDataInterface, types.untyped.GroupClass, matnwb.mixin.HasUnnamedGroups

IMAGES - A collection of images with an optional way to specify the order of the images using the “order_of_images” dataset. An order must be specified if the images are referenced by index, e.g., from an IndexSeries.

Required Properties*:: baseimage, description

Constructor Summary

Images(varargin)

IMAGES - Constructor for Images

Syntax:

images = types.core.IMAGES() creates an Images object with unset property values.

images = types.core.IMAGES(Name, Value) creates an Images object where one or more property values are specified using name-value pairs.

Input Arguments (Name-Value Arguments):

baseimage (BaseImage) - Images stored in this collection.
description (char) - Description of this collection of images.
order_of_images (ImageReferences) - Ordered dataset of references to BaseImage objects stored in the parent group. Each object in the Images group should be stored once and only once, so the dataset should have the same length as the number of images.

Output Arguments:

images (types.core.Images) - An Images object

Property Summary

baseimage: REQUIRED (BaseImage) Images stored in this collection.

description: REQUIRED (char) Description of this collection of images.

order_of_images: (ImageReferences) Ordered dataset of references to BaseImage objects stored in the parent group. Each object in the Images group should be stored once and only once, so the dataset should have the same length as the number of images.

Tip

* If a required property link is not functional, the property may be defined in a superclass. Please refer to the superclass documentation.