CorrectedImageStack

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

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

Bases: types.core.NWBDataInterface, types.untyped.GroupClass

CORRECTEDIMAGESTACK - Results from motion correction of an image stack.

Required Properties*:: corrected, original, xy_translation

Constructor Summary

CorrectedImageStack(varargin)

CORRECTEDIMAGESTACK - Constructor for CorrectedImageStack

Syntax:

correctedImageStack = types.core.CORRECTEDIMAGESTACK() creates a CorrectedImageStack object with unset property values.

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

Input Arguments (Name-Value Arguments):

corrected (ImageSeries) - Image stack with frames shifted to the common coordinates.
original (ImageSeries) - Link to ImageSeries object that is being registered.
xy_translation (TimeSeries) - Stores the x,y delta necessary to align each frame to the common coordinates, for example, to align each frame to a reference image.

Output Arguments:

correctedImageStack (types.core.CorrectedImageStack) - A CorrectedImageStack object

Property Summary

corrected: REQUIRED (ImageSeries) Image stack with frames shifted to the common coordinates.

original: REQUIRED (ImageSeries) Link to ImageSeries object that is being registered.

xy_translation: REQUIRED (TimeSeries) Stores the x,y delta necessary to align each frame to the common coordinates, for example, to align each frame to a reference image.

Tip

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