Component API

ScanImage® is built from components: the objects hanging off hSI that each own one part of the acquisition. This section documents the framework they share and then each component in turn.

hSI                       % scanimage.SI
hSI.hRoiManager           % what is scanned
hSI.hScan2D               % how it is scanned
hSI.hChannels             % which channels are kept
hSI.hMotors               % where the sample is

Start with Component Framework if you are writing anything more involved than a one-line property set - it explains numInstances, the live-update rules, and where each component’s settings are persisted.

• Component Framework
• hSI: Acquisition Control
• RoiManager
• Scan2D: Imaging Systems
• Scan2D Subclasses
• ScannerSet and Scanner Models
• Channels and Display
• Beams, PMTs and Shutters
• Motors
• FastZ and StackManager
• WaveformManager
• Photostim
• IntegrationRoiManager
• MotionManager
• TileManager and CycleManager
• CameraManager
• DataManager, UserFunctions and ConfigurationSaver
• Acquisition Data Structures
• Acquisition Metadata