ImageSegmentation

See also:

Format Specification or Source Specification for ImageSegmentation.

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

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

IMAGESEGMENTATION - Stores pixels in an image that represent different regions of interest (ROIs) or masks. All segmentation for a given imaging plane is stored together, with storage for multiple imaging planes (masks) supported. Each ROI is stored in its own subgroup, with the ROI group containing both a 2D mask and a list of pixels that make up this mask. Segments can also be used for masking neuropil. If segmentation is allowed to change with time, a new imaging plane (or module) is required and ROI names should remain consistent between them.

Required Properties*:

planesegmentation

Constructor Summary
ImageSegmentation(varargin)

IMAGESEGMENTATION - Constructor for ImageSegmentation

Syntax:

imageSegmentation = types.core.IMAGESEGMENTATION() creates an ImageSegmentation object with unset property values.

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

Input Arguments (Name-Value Arguments):

  • planesegmentation (PlaneSegmentation) - Results from image segmentation of a specific imaging plane.

Output Arguments:
Property Summary
planesegmentation

REQUIRED (PlaneSegmentation) Results from image segmentation of a specific imaging plane.

Tip

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