ScanImage requires an initialization (INI) file, usually named standard.ini, to be specified at startup. This file initializes state variables for ScanImage that are considered to be invariant with respect to experiment or user employing the ScanImage installation (a 'rig'). Typically there is only one INI file per 'rig'.
The INI file should generally be stored in the same directory with one or more user (USR) files. (See [ScanImage CFG/USR/INI Files] for more information about USR files.) On startup, ScanImage prompts for a USR file to be selected. If one is chosen, then ScanImage loads the standard.ini file located in the same directory, if found.
ScanImage only prompts to directly select an INI file if 1) no USR file is specified or 2) no file named standard.ini is found in the selected USR file's directory.
The first time running ScanImage, one will not have a USR file configured yet. When prompted to select a USR file, 'Cancel' should thus be selected. Then ScanImage will prompt that an INI file be selected. The configured standard.ini file should then be selected. It is highly recommended that users save a USR file, to avoid this double prompting.
Configuring the INI File
Each release of ScanImage (beginning with ScanImage r3.5) contains a file standard_model.ini located in the directory 'ScanImage
init_files'. This file should be copied to the desired INI (and USR) file directory (e.g. C:\Data\Config\ScanImage) and then renamed to standard.ini. Then the file should be edited as appropriate for the rig.
The standard_model.ini file contains comments which document the meaning of each of the variables.
The INI file parser is whitespace sensitive. The format <VARNAME>=<VARVALUE> must be strictly followed, i.e. no space to left or right of the equal sign
Find below the standard_model.ini file for each ScanImage release and further explanation of each of the variables therein:
ScanImage Version |
Model INI File |
Variable Descriptions |
|---|---|---|
| Unknown macro: {text-data} |
Unknown macro: {attachment-data} |
Unknown macro: {text-data} |
In rare circumstances, a rig might require more than one INI file, if one of the variables contained in the INI file must differ from session to session. In such cases, either the INI file should be named something other than standard.ini and then in
ScanImage 3.5 changes somewhat the way the INI file is loaded at startup. This is described in the section about Initialization (INI) File Handling.
A subset of the INI file variables – termed the Rig Configuration variables – are demarcated at the beginning of the INI file. Rig Configuration variables are those which may require modification for a new ScanImage installation. These variables are rig-specific, and are not associated with either configuration (CFG) or user (USR) files. The values for these variables are not modified/modifiable during ScanImage program operation.
Rig Configuration Variable Reference
This section serves as a reference to the new and notable Rig Configuration variables in ScanImage 3.5.
View Rig Configuration Section of Model INI File
Users should adjust the Rig Configuration values to match the hardware and experimental requirements for their rig, creating their own standard.ini file.