Logo

General

  • About
    • Downloading ScanImage®
      • Citing ScanImage®
      • Software Level
      • Free ScanImage®?
    • Publications
    • Support
    • ScanImage® Changes
      • 2026.0.0
        • New Universal Features
        • Device Support
        • New Premium Features
        • General Improvements
        • Compatibility
      • 2023.1.0
        • New Universal Features
        • New Premium Features
        • Device Support
        • GUI Tweaks
        • Bug fixes
      • 2023.0.0
        • New Universal Features
        • New Premium Features
        • Device Support
        • GUI Tweaks
        • Bug Fixes
      • 2022.1.0
      • 2022.0.1
      • 2022.0.0
      • 2021.1.0
      • 2021.0.0
      • 2020.1.4
      • 2020.1.3
      • 2020.1.2
      • 2020.1.1
      • 2020.1.0
      • 2020.0.0
      • 2019bR1
      • 2019bR0
      • 2019aR1
      • 2019aR0
      • 2018bR1
      • 2018b
      • 2018a
      • 2017b
      • 2016b
  • Configuration
    • PC Configuration
      • PC Requirements
      • Install Matlab
      • DAQ Installation
        • vDAQ Installation
        • NI DAQ and driver Installation
      • Install ScanImage
      • Run ScanImage
    • Licensing
      • License Management (SI2022+)
        • Online Activation
        • Offline Activation
      • Legacy License Manager (SI2020-SI2021)
        • License File
      • Data Collection
    • Machine Data File
    • Devices
      • DAQ
        • vDAQ Configuration
        • Resonant Scanning NI DAQ Configuration
        • Linear Scanning NI DAQ Configuration
      • Scanners
        • Analog Galvo
        • Resonant Scanner
        • Generic Polygonal Scanner
        • Vidrio RMR
        • Mirrorcle Resonant Scanner
        • Thorlabs ECU 1 - Scanners
        • Thorlabs ECU 2 - Scanners
      • PhotoMultiplier Tube
        • Analog PMT Controller
        • Thorlabs PMT2000/2100
        • Thorlabs PMT2100 v2
        • Thorlabs ECU1 - PMT
        • Thorlabs ECU 2 - PMT
      • Beam Modulators
      • Motor Controller
      • Fast Focus
      • Shutter
        • Digital Shutter
      • Camera
      • Spatial Light Modulators
        • Generic Monitor SLM
        • Meadowlark SLM 1920x1152
        • Meadowlark SLM ODP 512x512
        • Simulated SLM
        • Thorlabs Exulus SLM
      • Picoquant Remote Interface
        • Setup
        • FAQ
      • Miscellaneous Devices
    • SI Coordinate Systems
      • Configuration
      • Files
    • SI Motors
      • Basic tab
      • Advanced tab
    • Imaging Systems
      • vDAQ Scan System
      • NI Resonant Scan System
      • NI Linear Scan System
      • SLM Scan System
    • Layout and Configuration Settings
      • Loading & Saving Layout & CFG Files
      • Layout Files
      • Configuration (CFG) Files
  • Concepts
    • Scanner Configurations
    • ScanImage® Coordinate Systems
      • Scanner Coordinates
      • Reference Coordinates
      • Sample Relative Coordinate System
      • Scanfields, ROIs, ROI Groups
        • Scanfields
        • ROIs
        • ROI Group
    • Sample Coordinate System
      • Motor Controls
      • Sample Coordinates: Lateral
      • Sample Coordinates: Axial
      • API
    • Volume Imaging
      • Slow Volumes/Stacks
      • Fast Volumes/Stacks
      • Waveform and Buffer
        • Waveform Types
    • Beams
      • Control and Timing
      • GUI
      • Calibration
        • Data Collection
        • Data Processing
        • More considerations
    • Triggers

Tutorials

  • Configuration Tutorial
  • Basic Features
  • Premium Feature Tutorials
  • Advanced Features
    • ScanImage® API
      • Introduction
        • vDAQ® API
        • RoiGroup and Roi API
        • RotatedRectangle API
        • Stimulus Field
        • IntegrationField API
    • User Functions
      • Controls
      • User Function Definition
        • Example
      • Events
        • General Events
        • Photostimulation-module Events
    • Custom Stimulus Functions
      • Example

Appendix

  • Safety
  • Glossary
  • Tab Reference Guide
    • Graphical User Interface
      • Features GUI
    • Viewport
      • Basic Controls
      • Basic Elements in XY
        • Scanner FOV
        • Park Position
        • Default Imaging Group ROI
        • Annotations
        • Motor Controls
        • Scalebar
      • Basic Elements in Z
        • Display Slider
        • Actuator Slider
        • Paired FastZ Dropdown
        • Z Range
        • Stack
        • Motor Controls
        • Stage Drag Limits
        • Absolute Stage Limit
      • Groupings of Elements
    • Alignment Tab
      • Keyboard Shortcuts
      • Resonant Scanner Calibration Panel
      • X Offset Scaling Calibration Panel
      • Stage Scanner Alignment Panel
      • FastZ Alignment Panel
      • Precise FastZ Alignment Panel
      • Scanner To Scanner Alignment
      • Session-Session Alignment Panel
    • Arbitrary Line Scanning Tab
      • Keyboard Shortcuts
      • Arbitrary Line Scan Settings Panel
      • Arbitrary Line Scan Rois Panel
      • Arbitrary Line Scan Scanfields Panel
      • Line Scan Display Panel
        • Arbitrary Line Display Style
    • Camera Tab
      • Keyboard Shortcuts
      • Camera Controls Panel
      • Camera Histogram
        • Histogram Controls
      • Camera Alignment
    • Cycle Tab
      • Cycle
      • Time-Lapse
    • Display Tab
      • Scan Phase Controls
      • Histograms
      • Layers
      • Channels
      • Background
        • Image Controls
        • Grid Controls
        • Annotation Controls
    • Edit Stim Groups Tab
      • Stim Scanfields Panel
        • Stimulation Parameters
        • ROI Positioning
        • Optional Parameter
        • Beam Modulator
      • Stim ROIs Panel
    • Field Curvature Tab
      • Example Video
      • Surface Parameters Gui
    • IO Tab
      • Acquisition Triggering GUI
      • User Functions
    • Mosaic Tab
      • Keyboard Shortcuts
      • Mosaic Panel
      • Add Mosaic Panel
    • Motion Tab
      • Motion Estimator Panel
      • Motion Corrector Panel
    • Multiple Regions Of Interest Tab
      • Keyboard Shortcuts
      • Scanfields Panel
      • Rois Panel
        • Buttons
        • Table
        • Add ROI settings buttons
      • Roi Groups Panel
    • Online Analysis Tab
      • Keyboard Shortcuts
      • Integration Scanfields Panel
      • Integration ROIs Panel
      • Integration Output
    • Photostim Tab
      • ROI Groups Panel
      • Settings Panel
        • Scanner and Triggers
        • Monitoring
      • On Demand Settings
        • External Stimulus Selection
      • Sequence Mode Settings
    • Power Box Tab
      • Keyboard Shortcuts
      • Power Boxes Gui
        • Buttons
        • Power Box Table
      • Selected Power Box Gui
        • Basic Settings
        • Mask
    • Quick Analysis Tab
      • Keyboard Shortcuts
      • Quick Analysis ROIs
      • Quick Analysis Scanfields
    • Scan Tab
      • Panel Utility Buttons
      • Scanner Configuration Panel
      • Single Scanfield Settings Panel
      • XY Panel
        • Transitions
        • Sampling
        • Line phase
        • Images
      • Beams Panel
    • Stack Tab
      • Example Video
      • Keyboard Shortcuts
        • Bounded Stacks
        • Arbitrary Stacks
      • Stack Definition Panel
        • Top Panel
      • Stack Actuation Panel
        • Slow Tab
        • Fast Tab
      • Power over Depth Panel
  • Output Files
  • ScanImage® Utility Functions
    • Compute Resonant Scan Mask
    • Daq Task Get Max Sample Rate
    • Generate Multi-ROI Data From Tiff
    • Generate ROI Data From Image
    • Generate a ScanImage® Report
    • Open Tiff
    • Pulse Generator
    • Read Photostim Monitor File
    • Read ROI Group From Appended Tiff Data
    • Reset Class Data Files
    • Reset DAQ Devices
    • Simulate a Resonant Mirror
    • Translate Trigger To Port
    • Calculate AD951X configuration parameters
  • ScanImage® TiffReader

Solutions

  • Solutions
    • FAQ
    • Patches
      • Standard vDAQ MSADC initialization failure
        • Versions Affected
        • Patch Instructions
ScanImage
  • Search

© Copyright 2014-2025, MBF Bioscience.

Built with Sphinx using a theme provided by Read the Docs.