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 ScanImage. Typically there is only one INI file per ScanImage installation (a 'rig').

{info}ScanImage 3.5 introduces some changes tosomewhat the way the INI file is filesloaded areat handledstartup. PleaseThis familiarizeis yourselfdescribed within the section about [Initialization (INI) File Handling].{info}

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. 

h5. Rig Configuration Variable Reference
 This section serves as a reference to the new and notable _Rig Configuration_ variables in ScanImage 3.5. {link-window:ScanImage Files^r3_5_standardINI_rigConfig.txt|target="_blank"}View _Rig Configuration_ Section of Model INI File{link-window}{center}

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

{panel:title=New/Notable Variables in _standard_model.INI_}
*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 the sections on [Triggering Simplification] and [External Triggering] for more details.

*outputBoardClockTerminal*: See [Clock Synchronization] for more details.

*maxBufferedGrabTime*: See [Unlimited and Uninterrupted Acquisition] for more details.

*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 (i.e. when no acquisition is occurring). 
(!) Beam safety should be considered in setting these values. 
(/) When the beam is parked, the shutter is closed and the Pockels Cell set to minimum transmission.

h6. Shutter Variables
* Variable _shutterBoardIndex_ is new in ScanImage 3.5.
* Several variables (e.g. _closed_, _epiShutterOpen_, and _epiShutterClosed_) have been removed.

(/) See [Enhanced Shutter Configuration] for more details.

h6. Motor (MP-285) Variables
* Variables _umPerStepX/Y/Z_ have been added, replacing _calibrationX/Y/Z_ values in ScanImage 3.0.
* Variable _posnResolution_ is also new in ScanImage 3.5.
 
(/) See [MP-285 Interface Improvements] for more details.
{panel}