Page History

{alias:SI3.7_UserSettingsGUI}

{center}
!UserSettings.bmp!
*USER SETTINGS Dialog*
{center}
-----
{toc:maxLevel=4}
----
(/) All settings in the *USER SETTINGS...* dialog are (unsurprisingly!) [User Settings|User Settings & USR Files (r3.6)], i.e. saved to *USR* files.

{blue:External Trigger Timeout (sec)}: When external start triggering is enabled, via {blue:EXT} button on {report-info:data:MainControls|render=wiki|source=SI3.7 Data}, this specifies length of time to wait for external trigger to arrive following start of [*GRAB* acquisition or *LOOP* _Repeat_|SI3.6_AcqModes] before generating a timeout error.

h3. Saving/Memory

h5. Root Save Path Settings
{multi-excerpt:name=RootSavePath}
ScanImage typically requires that user specify a save path, via *File >> Set Save Path...* on the {report-info:data:MainControls|render=wiki|source=SI3.7 Data} menu, before the first [*GRAB*/*LOOP*|SI3.6_AcqModes] acquisition in a ScanImage session.

{blue:Root Save Path}: Specifies root folder to display when selecting *File >> Set Save Path...* to specify path for file-saving. By selecting a folder at _root_ of hierarchy where user stores data files, the selection of the save path is made much faster.
(/) For example, the folder C:\Data or C:\Data\MyName  might be specified, so one can readily select/create subfolder identifying date or other grouping folder immediately below this _root_ in the system folder hierarchy

{blue:Root Path is Default Path}: Specifies that {blue:Root Save Path} is the default save path if none other has been specified. Selecting this option allows user to avoid requirement of specifying a save path (*File >> Set Save Path...*) for each ScanImage session.
(i) This option works best when user employs a flat file hierarchy, e.g. if the {blue:Basename} values specified in {report-info:data:MainControls|render=wiki|source=SI3.7 Data} will contain date information and/or other prefix information to allow files and file groups to be identified. 
{multi-excerpt}
h5. Running Frame Buffer Settings

{multi-excerpt:name=MaxBufferedFrames}
Although ScanImage normally saves each frame to disk as it is acquired, it is often useful to maintain recently acquired frames in RAM, e.g. for online processing by [_User Functions_|User Functions (r3.7)].

ScanImage therefore maintains a circular running buffer of the most recently acquired frames in the {vi-statevar:state.acq.acquiredData} state variable (in the Matlab global workspace). 

This variable is a nested cell array of 2-D images (frames), indexed as follows:
{panel:borderStyle=dashed}>> state.acq.acquiredData\{<_FrameIndex_>\}\{<_ChannelIndex_>\}(<_lineIndex_>,<_pixelIndex_>)
&nbsp;&nbsp;where <_FrameIndex_> counts from the most recent frame.{panel}
(i) In previous ScanImage versions, this variable was structured as a cell array of 3D arrays

{blue:Max Buffered Frames (AutoSave ON/OFF)}: 
These values specify the number of the most recent frames to store in RAM, in the {vi-statevar:state.acq.acquiredData} state variable, when {blue:AutoSave} is *ON*/*OFF* on the {report-info:data:MainControls|render=wiki|source=SI3.7 Data} panel. 
(i) Value of _Inf_ indicates to buffer the entire acquisition. This is default value when {blue:AutoSave} is *OFF*, so that entire acquisition can be saved after it completes, manually using *File >> Save Last Acquisition As...*
{multi-excerpt}
(i) When {blue:AutoSave} is *ON* panel, ScanImage saves each frame of data to open filestream _during_ acquisition

h5. Other Settings
* {blue:# Frames/File:} Some users may prefer to separate ('chunk') data from very long acquisitions into several smaller files. This value specifies the number of _Frames_ to log to each file during the acquisition. As further data is collected, a new data file is automatically created. 
(/) To disable such 'chunking', this value should be set to _Inf_ (infinite), causing all data to be logged to a single file.
(/) File chunking can be used to avoid the 2GB file size limit in 32-bit Windows 
(i)  When chunking is enabled, a three-digit number (e.g. 001, 002, etc) is appended to the filename, following an underscore. The number is auto-incremented as each new file ('chunk') is added. For example, if 3000 frames are collected with 500 frames/file, with {blue:Basename}='BehaviorExpt' and {blue:Acquisition #}=1, specified in the {report-info:data:MainControls|render=wiki|source=SI3.7Doc} panel, there will be six files named 'BehaviorExpt1_001' through 'BehaviorExpt1_006.


h3. Focus Options



h3. Snapshot Options

h3. ROI Options

h3. Power Control

* {blue:Verify Power:} This option causes the actual power level to be measured using the photodiode (or other power detector), as configured in the [*INI* File|SI_INIFile] for each _Beam_, following any change to the ScanImage [_Configuration_|SI3.6_Config]. The measured value is referenced to the current [Pockels Calibration|SI3.6_PockelsCalibration] for each _Beam_, and the {blue:Power} level value is _updated_ to match the measured level.
(/) A change in the user-specified {blue:Power} level is a change to the [_Configuration_|SI3.6_Config], so a measurement will occur.

h3. Hot Keys

{comment}
{report-info:data:UnderConstructionNote|render=wiki|source=SI3.6 Data}
{comment}