Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Wiki Markup
{alias:SI3.8_UserSettingsGUI}

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

* {blue:External Trigger Timeout (sec)}: When external start triggering is enabled, via {blue:EXT} button on [*Main Controls*|Main Controls (r3.8)], this specifies length of time to wait for external trigger to arrive following start of a [GRAB acquisition or LOOP _Repeat_|SI3.8_AcqModes] before generating a timeout error.

h4. Saving/Memory

h5. Root Save Path Settings
{multi-excerpt:name=RootSavePath}
ScanImage typically requires that user specify a save path, via {blue:File >> Set Save Path...} or the {blue:DIR...} button on the [*Main Controls*|Main Controls (r3.8)], before the first [*GRAB*/*LOOP*|SI3.8_AcqModes] acquisition in a ScanImage session.

* {blue:Root Save Path}: Specifies root folder to display when selecting {blue: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 ({blue: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 [*Main Controls*|Main Controls (r3.8)] 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.8)].

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:Save} is *ON*/*OFF* on the [*Main Controls*|Main Controls (r3.8)] panel. 
(i) Value of _Inf_ indicates to buffer the entire acquisition. This is default value when {blue:Save} is *OFF*, so that entire acquisition can be saved after it completes, manually using {blue:File >> Save Last Acquisition As...}{multi-excerpt}
(i) When {blue:Save} is *ON* panel, ScanImage saves each frame of data to open filestream _during_ acquisition
(/) The {blue:Save} control on the [*Main Controls*|Main Controls (r3.8)] and {blue:AutoSave} control on the [*Configuration*|Configuration (r3.8)] panel are linked/equivalent


h4. Focus Options

* {blue:Infinite Focus}: If enabled, [FOCUS acquisitions|SI3.8_AcqModes] continue indefinitely until {blue:ABORT} is pressed

h4. 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.8_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.8_Config], so a measurement will occur.

h4. Hot Keys

h4. Other Settings
* {blue:Allow zoom factors < 1}: If enabled, {blue:Zoom} can be set to sub-unity values on the [*Main Controls*|Main Controls (r3.8)] panel. This allows the [scan angular range|Scan Command Amplitude Determination (r3.8)] to exceed the {vi-statevar:state.init.scanAngularRangeReferenceFast/Slow} values specified in the [INI File|SI_INIFile].


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