Installation

IMPORTANT: The ScanM imaging package requires the 32bit version IgorPro 6. The stand-alone ScanM file reader also works with IgorPro 7, although currently only with the 32bit version.

1. Only the ScanM file reader

Get the latest ScanM package as a ZIP file from GitHub and search for the folder where IgorPro keeps the the user-specific files (workspace). The path is usually something like: C:\User Documents\WaveMetrics\Igor Pro 6 User Files. Note that depending on which version - master or development - was downloaded, ScanM-xxx refers to ``ScanM-masterorScanM-development``` in the following.

Note: The following procedure can also be used for IgorPro 7 (32bit version only) by simple using the respective IgorPro 7 workspace.

1. Under ...\Igor Pro 6 User Files\ create a new folder named ScanM and copy the file ScanDecoder.xop from the ZIP folder ScanM-xxx\ScanM into that folder.

2. In ...\Igor Pro 6 User Files\Igor Extensions make a shortcut to ScanDecoder.xop.

3. Under ...\Igor Pro 6 User Files\User Procedures create a new folder named ScanM and copy all files from the ZIP-folder ScanM-xxx\User Procedures\ScanM into that folder.

4. In ...\Igor Pro 6 User Files\Igor Procedures make a shortcut to ...\Igor Pro 6 User Files\User Procedures\ScanM\ScM_FileIO.ipf.

2. The complete ScanM imaging software

2.1 Preparations

1. Install Wavemetrics Igor v6.x; independent of the Windows version always the 32bit version of Igor.

   IMPORTANT: Start IgorPro, open the "Procedure Window" and turn off "NVAR SVAR WAVE Checking" in the "Procedure" menu.

2. Install the newest NI-DAQmx driver package; version 16.x and higher is recommended.

3. Configure drivers using NI MAX:

   • Make sure that the NI-RTSI cable is defined and the two cards (6110 and 6259 or 6363) are defined to be attached to the cable

   • Rename devices: 6363 for the NI PCIe 6363, 6110 for the NI PCI-6110 and so on.

   • Reboot

   Note: If you do not have NI cards in your computer, you still need to define virtual cards and a virtual NI-RTSI cable and name them as described above.

4. Install the Wavemetrics NIDAQ Tools MX v1.05 or higher.

5. Under Windows 7 and higher:

   • Add "Lock pages in memory" right to the current user (adding this right to the administrator instead does not work). Go to ...

     • Administrative tools
     • "Lokale Sicherheitsrichtlinie" (Local Security Policy)
     • "Lokale Richtlinien" (Local Policies)
     • "Zuweisung von Benutzerrechten" (xxx)
     • "Sperren von Seiten im Speicher" (Lock pages in memory) ...
     • ... and then add current user, then log-out and -in to activate the changes.

   • Allow Igor to run "as administrator" by changing the properties of the Igor start link.

2.2 Actual installation of ScanM

Get the latest ScanM package as a ZIP file from GitHub and search for the folder where IgorPro keeps the the user-specific files. The path is usually something like: C:\User Documents\WaveMetrics\Igor Pro 6 User Files.

1. Copy the ZIP folder ScanM-xxx\ScanM as a separate folder ScanM under ...\Igor Pro 6 User Files\. It contains:

   • the Igor routines (*.ipf),
   • the ScanM core library (ScanM32.dll),
   • the ScanM interface library for Igor (ScnM.xop),
   • the Sutter MP285 driver library (Sutter.dll)
   • the Sutter.dll interface library for Igor (MP285.xop)
   • the scan decoder library (ScanDecoder.xop)
   • a folder with documentation
   • and the ScM_Configs folder with the scan configurations available.

2. Under ...\Igor Pro 6 User Files\ create two new folders:

   • ScanM_Data (for the pixel data) and
   • ScanM_Settings (for the user defined settings such as color maps etc.).

3. Create in the directory ...\Igor Pro 6 User Files\Igor Procedures a shortcut to ...\Igor Pro 6 User Files\ScanM\ScanM Package Loader.ipf.

4. Create in the directory ...\Igor Pro 6 User Files\User Procedures a shortcut to the folder ...\Igor Pro 6 User Files\ScanM.

5. Create in the directory ...\Igor Pro 6 User Files\Igor Extensions shortcuts to

   • ...\Igor Pro 6 User Files\ScanM\ScM.xop,
   • ...\Igor Pro 6 User Files\ScanM\MP285.xop, and
   • ...\Igor Pro 6 User Files\ScanM\ScanDecoder.xop

6. Move ScM_USER_DEFINITIONS.ipf to Igor Pro 6 User Files\User Procedures. It contains setup hardware-specific definitions.

   This file needs to adjusted to the respective setup! Make sure that the file reflects the NI cards (even if virtual cards are used) defined in the NI tools.

7. If not already present, make a folder called ScanM under ...\Igor Pro 6 User Files\User Procedures. Copy the current versions of ScM_FileIO.ipf, ScM_ScanPathFuncs.ipf and all other files found in ScanM-xxx\UserProcedures\ScanM into this folder. In the folder ...\Igor Pro 6 User Files\Igor Procedures create a shortcut to ...\Igor Pro 6 User Files\User Procedures\ScanM\ScM_FileIO.ipf.

8. Make sure that you have shortcuts to the following Igor extensions in the directory ...\Igor Pro 6 User Files\Igor Extensions. You can find these extensions in the folder where the Igor program was installed, typically something like this C:\Programme\WaveMetrics\Igor Pro Folder\:

   • VDT2.xop, VDT2 Help.ihf from ```...\Igor Pro Folder\More Extensions\Data Acquisition"
   • DSXop.xop, DSXop Help.ihf from ...\Igor Pro Folder\More Extensions\Data Acquisition\Frame Grabbers\DSXOP\"

9. Depending on your environment, commentize/de-commentize options in ScanM Package Loader.ipf:

   • De-commentize SetIgorOption poundDefine = isUseScopeSutter if no Sutter MP28x is connected.
   • Generally de-commentize SetIgorOption poundDefine = isUseElectricalLen, even if it is not present.
   • SetIgorOption poundDefine = isNIPresent is to be de-commentized when NI-hardware is physically present. It can also be de-commentized for virtual hardware; ScanM will load but fail to complete scans (errors), because as expected the virtual card do not behave as real ones. When this option is commentized, scans will run but of course data acquisition is simulated and therefore may not behave like real recordings.

10. Start Igor and load ScanM using the ScanM menu entry.