PlaneSegmentation

See also:

Format Specification or Source Specification for PlaneSegmentation.

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

Bases: types.hdmf_common.DynamicTable, types.untyped.GroupClass

PLANESEGMENTATION - Results from image segmentation of a specific imaging plane. At least one of image_mask, pixel_mask, or voxel_mask is required.

Required Properties*:

colnames, description, id, imaging_plane

Constructor Summary
PlaneSegmentation(varargin)

PLANESEGMENTATION - Constructor for PlaneSegmentation

Syntax:

planeSegmentation = types.core.PLANESEGMENTATION() creates a PlaneSegmentation object with unset property values.

planeSegmentation = types.core.PLANESEGMENTATION(Name, Value) creates a PlaneSegmentation object where one or more property values are specified using name-value pairs.

Input Arguments (Name-Value Arguments):

  • colnames (char) - The names of the columns in this table. This should be used to specify an order to the columns.

  • description (char) - Description of what is in this dynamic table.

  • id (ElementIdentifiers) - Array of unique identifiers for the rows of this dynamic table.

  • image_mask (VectorData) - ROI masks for each ROI. Each image mask is the size of the original imaging plane (or volume) and members of the ROI are finite non-zero. At least one of image_mask, pixel_mask, or voxel_mask is required.

  • imaging_plane (ImagingPlane) - Link to ImagingPlane object from which this data was generated.

  • meanings_tables (MeaningsTable) - MeaningsTable objects that provide meanings for values in VectorData columns within this DynamicTable. Tables should be named according to the column they provide meanings for with a “_meanings” suffix. e.g., if a VectorData column is named “stimulus_type”, the corresponding MeaningsTable should be named “stimulus_type_meanings”.

  • pixel_mask (VectorData) - Pixel masks for each ROI: a list of indices and weights for the ROI. Pixel masks are concatenated and parsing of this dataset is maintained by the PlaneSegmentation. At least one of image_mask, pixel_mask, or voxel_mask is required.

  • pixel_mask_index (VectorIndex) - Index into pixel_mask.

  • reference_images (ImageSeries) - One or more image stacks that the masks apply to (can be one-element stack).

  • vectordata (VectorData) - Vector columns, including index columns, of this dynamic table.

  • voxel_mask (VectorData) - Voxel masks for each ROI: a list of indices and weights for the ROI. Voxel masks are concatenated and parsing of this dataset is maintained by the PlaneSegmentation. At least one of image_mask, pixel_mask, or voxel_mask is required.

  • voxel_mask_index (VectorIndex) - Index into voxel_mask.

Output Arguments:
Property Summary
image_mask

(VectorData) ROI masks for each ROI. Each image mask is the size of the original imaging plane (or volume) and members of the ROI are finite non-zero. At least one of image_mask, pixel_mask, or voxel_mask is required.

imaging_plane

REQUIRED (ImagingPlane) Link to ImagingPlane object from which this data was generated.

pixel_mask

(VectorData) Pixel masks for each ROI: a list of indices and weights for the ROI. Pixel masks are concatenated and parsing of this dataset is maintained by the PlaneSegmentation. At least one of image_mask, pixel_mask, or voxel_mask is required.

pixel_mask_index

(VectorIndex) Index into pixel_mask.

reference_images

(ImageSeries) One or more image stacks that the masks apply to (can be one-element stack).

voxel_mask

(VectorData) Voxel masks for each ROI: a list of indices and weights for the ROI. Voxel masks are concatenated and parsing of this dataset is maintained by the PlaneSegmentation. At least one of image_mask, pixel_mask, or voxel_mask is required.

voxel_mask_index

(VectorIndex) Index into voxel_mask.

Tip

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