Page History

{composition-setup}
h5. 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 the ScanImage configuration and determines which variables are associated with configuration (CFG) and user (USR) files.  

Typically there is only one INI file per ScanImage installation (a 'rig'). ScanImage r3.5 introduces some changes to the way INI files are handled. Please familiarized yourself with [Initialization (INI) File Handling|Important Changes in ScanImage 3.5#Initialization (INI) File Handling]. 

A subset of the INI file variables -- the _Rig Configuration_ variables -- are demarcated at the beginning of the INI file.   {report-link:source=^standardINI_abridged.txt|key=attachment:download path|target="_blank"}*View Rig Configuration section of _standard\_model.ini_ file*{report-link}

They comprise thethose variables thatwhich typically require modification for a new ScanImage installation. Rig Configuration variables are not associated with either CFG or USR files and are not modified during ScanImage program operation. 

{center}
Users should adjust thesethe Rig Configuration values to match the hardware and experimental requirements for their rig, to createcreating their own _standard.ini_ file.
{report-link:source=^standardINI_abridged.txt|key=attachment:download path|target="_blank"}View Rig Configuration section of _standard\_model.ini_ file{report-link}
(/) 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
{center}

h5. Rig Configuration Variable Reference
 This section serves as a reference to the new and notable _Rig Configuration_ variables in ScanImage r3.5.

*triggerLineIndex*: (Previously below Rig Configuration section) Allows specification of the _static digital output line_ used as 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*: See [External Triggering and Trigger Simplification|Important New Features in ScanImage 3.5#External Triggering and Trigger Simplification].
*externalTriggerInputTerminal*: See [External Triggering and Trigger Simplification|Important New Features in ScanImage 3.5#External Triggering and Trigger Simplification].
*externalTriggerTimeout*: See [External Triggering and Trigger Simplification|Important New Features in ScanImage 3.5#External Triggering and Trigger Simplification].

*outputBoardClockTerminal*: See [Clock Synchronization|Important Changes in ScanImage 3.5#Clock Synchronization] for more details.

*maxBufferedGrabTime*: Specifies max duration, in seconds, of an acquisition (effectively limiting the max number of frames) to allow without using 'SaveDuringAcquisition' option. This value should typically not be altered. Longer acquisitions should employ the new [Continuous Disk Logging|Important New Features in ScanImage3.5#Continuous Disk Logging] feature.

*maxFlybackRate*: This value is reserved for r3.6.

*scanOffsetX/Y*: (Previously below Rig Configuration section) Specify offset voltages for mirror command signals. These variables are unique among the Rig Specific variables in that they can be altered during ScanImage operation. See [Beam and Scan Alignment Tools|Important New Features in ScanImage3.5#Beam and Scan Alignment Tools] for more information.

*parkAmplitudeX/Y*: (Previously below Rig Configuration section) Specify voltages for X/Y mirror 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.

h6. 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|Other New Features and Changes in ScanImage 3.5#shutterAnyBoard].

h6. 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|Important New Features in ScanImage 3.5#MP-285 Interface Improvements] for more etails.

{panel}