Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Upgrading ScanImage

At least for more recent releases of SI Basic, the procedure for manually updating ScanImage is very straightforward. These instructions use the manual installer: perhaps the automatic installer is more straightforward but we have not tested this. Across some earlier releases of ScanImage there were large changes in settings files, which made the process a bit more awkward.

Starting the new version

  • Quit ScanImage

  • Download the manual installer and unpack ScanImage into a new directory. For example, your current install may be at C:\MATLAB\SI_R50 and you unpack the new version in C:\MATLAB\SI_R51

  • Copy your machine data file into the new directory. Usually you can just use the same file.

  • Rename your old install directory to something else (e.g. C:\MATLAB\SI_R50_OLD).

  • Make a backup copy of this old install somewhere else (e.g. a remote server) in case you need to revert to it.

  • Add the new ScanImage directory to your MATLAB path. Remove the old one. Start ScanImage.

  • When requested, point ScanImage to the location of the copied machine data file.

Copy the settings

If you are using USR and CFG files to store customisations, you will add these now. I assume you are keeping these in your ScanImage directories.

  • Copy all of the config files from your last install to the new directory.

  • Load your .usr file (ignore any errors) then press save.

  • Load the .cfg you normally use then press save (ignore any errors). Then save the .usr file so the .cfg will be loaded along with it.

  • Repeat loading and saving for any other files or file combinations you have.

  • Close ScanImage and re-open it, selecting a .usr file to load at startup if applicable. ScanImage should now parse the config files without errors

Copy the resonant/galvo calibration curve

If you are using a resonant scanner you likely have used the hSI.hScan2D.plotFov2VoltageCurve tool to ensure you are getting square images. This information will not have been ported over by the above steps. To port it over, do the following:

  • Close ScanImage

  • Copy the ConfigData\YourScannerName_ResScanner_classData.mat file from the old install to the new install.

  • Re-start ScanImage. There should be no errors, if there are please file a BakingTray support issue.

  • Run hSI.hScan2D.plotFov2VoltageCurve and you should see your old voltage curve.

Check the laser power calibration

Verify that the laser power calibrations are still correct and redo them if necessary.

Last updated