Overview
ScanImage requires an initialization (INI) file, usually named standard.ini, to be selected at startup. This file specifies & initializes all the state variables for ScanImage.
Typically there is only one INI file per ScanImage installation (a 'rig'). ScanImage 3.5 introduces some changes to the way INI files are handled. Please familiarize yourself with Initialization (INI) File Handling.
A subset of the INI file variables – the Rig Configuration variables – are demarcated at the beginning of the INI file. Rig Configuration variables are those which typically require modification for a new ScanImage installation. They are not associated with either CFG or USR files and are not modified 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 standard_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.
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
triggerLineIndex: (Previously below Rig Configuration section) Allows specification of the static digital output line used as the shared trigger source for acquisition, mirror, and Pockels cell board(s). The use of Port 0 on the board specified by triggerBoardIndex is assumed.
triggerInputTerminal, externalTriggerInputTerminal, externalTriggerTimeout: See External Triggering and Trigger Simplification for more details.
outputBoardClockTerminal: See Clock Synchronization for more details.
maxBufferedGrabTime: See [Unlimited and Uninterrupted Acquisition] for more details.
maxFlybackRate: This variable is reserved for ScanImage r3.6.
scanOffsetX/Y: (Previously below Rig Configuration section) Specify offset voltages for mirror command signals. These variables are unique among the Rig Configuration variables in that they can be altered during ScanImage operation. See [Beam and Scan Alignment Tools] for more details.
parkAmplitudeX/Y: (Previously below Rig Configuration section) Specify voltages determining X/Y mirror positions when parked. Beam safety should be considered in setting these values.
maxAmplitudeX/Y: Specify max voltage allowed for X/Y amplitudes. This clamps the sum of the scan amplitude and the scan shift set in ScanImage, for each dimension.
Shutter Variables
The separate values for 'open' and 'closed' have been removed. Variables open and epiShutterOpen are sufficient to specify the 'polarity' of shutter TTL control signal.
The variable shutterBoardIndex is new in r3.5. See Shutter output line(s) can be on any board.
Motor Variables
The number of variables in the rig-specific motor section has been greatly reduced.
Two variables, firmware and posnResolution, are new in r3.5. See MP-285 Interface Improvements for more details.