ScanImage organizes Rois and Scanfields in a hierarchy. The root of this hiearchy is a RoiGroup object. Each RoiGroup object can contain multiple Rois, and each Roi can contain multiple scanfields.
A RoiGroup is a container that holds multiple Rois. There are multiple accessor methods to manipulate the Rois within a RoiGroup. The order of the Rois within the RoiGroup determines the order the Rois are scanned on one slice.
Each Roi can contain one or more Scanfields. A Scanfield is a 2D cross-section of the 3D Roi at a particular z level. ScanImage currently supports multiple types of scanfields.
- RotatedRectangle - defines an imaging area
- StimulusField - defines a stimulus path
- IntegrationField - defines a region, where image data is integrated for online analysis
All fields are defined in the ScanImage Coordinate Systems coordinate system.