ExternalImage

See also:

Format Specification or Source Specification for ExternalImage.

class types.core.ExternalImage(varargin)[source]

Bases: types.core.BaseImage, types.untyped.DatasetClass

EXTERNALIMAGE - A type for referencing an external image file. The single file path or URI to the external image file should be stored in the dataset. This type should NOT be used if the image is stored in another NWB file and that file is linked to this file.

Required Properties*:

data, image_format

Constructor Summary
ExternalImage(varargin)

EXTERNALIMAGE - Constructor for ExternalImage

Syntax:

externalImage = types.core.EXTERNALIMAGE() creates an ExternalImage object with unset property values.

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

Input Arguments (Name-Value Arguments):

  • data (char) - Data property for dataset class (ExternalImage)

  • description (char) - Description of the image.

  • image_format (char) - Common name of the image file format. Only widely readable, open file formats are allowed. Allowed values are “PNG”, “JPEG”, and “GIF”.

  • image_mode (char) - Image mode (color mode) of the image, e.g., “RGB”, “RGBA”, “grayscale”, and “LA”.

Output Arguments:
Property Summary
image_format

REQUIRED (char) Common name of the image file format. Only widely readable, open file formats are allowed. Allowed values are “PNG”, “JPEG”, and “GIF”.

image_mode

(char) Image mode (color mode) of the image, e.g., “RGB”, “RGBA”, “grayscale”, and “LA”.

Tip

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