Looking for up-to-date ScanImage documentation? That has moved here: docs.scanimage.org


This documentation is for a legacy ScanImage version. The current documentation is ScanImage 2019.

Skip to end of metadata
Go to start of metadata


Start by installing required software and hardware.

Install the software 

Scanimage Installation

  1. Download ScanImage.
  2. Create or Select a folder to install ScanImage software.


  3. Check the ScanImage install folder permissions and allow full control.
    1. From Windows explorer, right click on the folder and select 'properties'.
    2. In the Properties dialog box, uncheck 'Read Only', if checked and select 'Apply'.
    3. Select OK.
  4. Extract the contents of the ScanImage ZIP file into your Scanimage folder.
  5. Launch the Matlab application.
  6. Add your ScanImage folder to the Matlab Path.
    1. In the Matlab application, click the 'Home' Tab.
    2. In the environment section, click on 'Set Path'.
    3. The Set Path dialog is displayed.
    4. In the Set Path dialog, select 'Add Folder...'.
    5. When prompted, locate and select your ScanImage folder. You should see your ScanImage folder at the top of the MatLab search path list.
    6. Press 'Save'.
    7. Press 'Close'.

Start scanimage

  1. Launch the Matlab application.
  2. In the Matlab command window, type:

  3. If this is the first time scanimage is run, see Machine Data File (MDF) section, below.
  4. The ScanImage Configuration dialog appears.

  5. Browse to the folder that contains your Machine Data File (MDF).
  6. Press Continue.

    (tick) To run scan image, make sure your Digital IO Device is connected to your system and is turned on before you start your computer.


Machine Data File (MDF)

If the is first time you are running ScanImage, the following ScanImage dialog box will appear:

  1. Press 'Create..'. 
    1. A Machine Data File is created.

  2. Locate and Save the Machine Data File in a location that is backed up.

    (tick) Recommended location for the Machine Data File is a folder named 'config'  at  root of the user's Data directory. In the example above, 'E:\' is backed up, thus, the Machine Data File in the 'config' folder is backed up. 

  3. The following dialog appears:

  4. Press OK.

  5. The Machine Data File will be created in sections.  After each section is created, it will be displayed in the Matlab editor.  Edit the settings for each section and then save the file.  A small pop-up dialog box will await you to confirm you've done this before moving on to the next section.

    (tick) The Machine Data File (MDF) contains information used to describe aspects of the hardware configuration that rarely change.  The contents of the MDF is accessed and applied at the startup of ScanImage. Any change to the MDF during an experiment requires a Matlab restart.

  6. If the machine file is not already open, click on the link displayed in the command window.

USR/CFG Settings

Additional hardware configuration and window position information is stored in the USR file.

On the first startup, you may be prompted to locate the USR File.  Hit Cancel to proceed using default settings.

After starting ScanImage successfully, you should soon thereafter arrange windows as you prefer them and then save a USR file via the File >> Save User Settings As... menu item on the Main Controls. Later, select this USR file to use the saved settings.