Page History

----
{center}
!CycleControls.bmp!
*CYCLE CONTROLS Panel*
{center}
-----
{toc:type=flat}

h3. Cycle Mode Overview

Cycle mode allows control and timing of acquisition sequences. Cycle acquisitions are started when {blue:Cycle Mode On} is enabled and a [LOOP acquisition|SI3.8_AcqModes] is started.

Cycle acquisitions consist of _Iterations_ each of which is a Loop of 1 or more acquisitions (Loop _Repeats_) -- i.e. a Cycle is effectively a meta-loop, or loop of loops. 

At the start of each Cycle Iteration, one or more of the following actions can be specified:

* Wait a specified _Iteration Delay_ before starting Iteration acquisition 
* Load a specified [Configuration (CFG) file|SI3.8_Config], updating configuration parameters to use for that iteration's acquisition(s)
* Move or /step motor to specified coordinates, or to coordinates storedassociated forwith identifiedspecified Position or [ROI ID|ROI number, as shown/managed in the Controls (r3.8)] or [Position ControlsID|Position Controls (r3.8)] and
* Update _ROI Scan Parameters_ to those associated with specified [ROI ControlsID|ROI Controls (r3.8)], respectively
* Override configuration[Configuration parameters|SI3.8_Config] (e.g. # Repeats, # Frames, # Slices, etc) with _Iteration_-specific values


h3. Left Side Controls

* {blue:Cycle Mode On}: Enables Cycle mode -- subsequently started [LOOP acquisitions|SI3.8_AcqModes] will follow the Cycle parameters configured in this panel.

* {blue:Cycle Name}: Name of Cycle file (.CYC), if any, that has last been loaded or saved
* {blue:Load}: Load a Cycle file (.CYC), updating current Cycle parameters. 
* {blue:Save}: Save current Cycle parameters to a Cycle file (.CYC). Dialog is launched to select the folder/file to save to.

(i) The current Cycle parameters are exactly those displayed in the {blue:Cycle Iteration Data} table

* {blue:Cycles Done}: On right, sets the number of Cycles to complete before automatically terminating the [LOOP acquisition|SI3.8_AcqModes]. On left, displays the number of Cycles which have been completed so far. In case of {blue:Auto-reset Iteration/Count} disabled, value at left can be edited to specify which Cycle count value to start with for next started [LOOP acquisition|SI3.8_AcqModes].
** For value > 1, Cycle wraps around to Iteration 1 following the final Iteration N. 
** For value Inf, Cycle wraps around indefinitely and never completes until user hits {blue:Abort} on the [Main Controls|Main Controls (r3.8)] panel. 

* {blue:Cycle Iteration}: On right, shows the number of _Iterations_ to be executed per-Cycle, i.e. the number defined in the {blue:Cycle Iteration Data} table. On left, displays the number of _Iterations_ which have been completed for the current Cycle count value so far. In case of {blue:Auto-reset Iteration/Count} disabled, value at left can be edited to specify which _Iteration_ to start with for next started [LOOP acquisition|SI3.8_AcqModes].

* {blue:Go Home at Cycle End}: If enabled, the motor position is recorded at start of each Cycle-enabled [LOOP acquisition|SI3.8_AcqModes]. Upon completion or abort of the acquisition, the motor is moved to restore the starting position.

* {blue:Restore Original CFG}: If enabled, the prevailing [Configuration|SI3.8_Config] is cached at start of each Cycle-enabled [LOOP acquisition|SI3.8_AcqModes] -- the active settings, not just the settings in the last-loaded [Configuration file|SI3.8_Config]. Upon completion or abort of the acquisition, the cached [Configuration|SI3.8_Config] settings are restored.

* {blue:Auto-reset Iteration/Count}: If enabled, the {blue:Cycles Done} and {blue:Cycle Iteration} values are reset to 0 and 1, respectively, upon completion or abort of each Cycle-enabled [LOOP acquisition|SI3.8_AcqModes]. If disabled, 

(/) Disabling {blue:Auto-reset Iteration/Count} allows user to handle cases where an ongoing Cycle may need to be aborted/restarted, e.g. for motion or other interruption, perhaps redoing particular iteration(s). 

If {blue:Auto-reset Iteration/Count} is disabled, the following controls are available:

* {blue:Reset}: Manually reset the {blue:Cycles Done} and {blue:Cycle Iteration} values to 0 and 1, respectively.

* {blue:Iterations per LOOP}: Specifies the number of Cycle iterations to execute before automatically terminating for each started [LOOP acquisition|SI3.8_AcqModes]. Value of Inf implies to execute all iterations until specified number of Cycles (see {blue:Cycles Done}) have completed, if ever. 

(/) Setting {blue:Iterations per LOOP} to finite value allows one to use {blue:Cycle Iteration Data} as a 'to-do' list of acquisitions to obtain, one or more at a time.

h3. Right Side Controls

* {blue:Cycle Iteration Data}: Table specifying number of Cycle _Iterations_ and the actions to implement for each one. Each column is a possible action -- leaving a column blank implies that particular action is not taken for that particular _Iteration_.

** {blue:Config Name}: Specify a [Configuration (CFG) file|SI3.8_Config] to load for that _Iteration_
** {blue:Iteration Delay}: Time, in seconds, to wait before start of this _Iteration_ -- the first _Repeat_, if multiple Repeats are 

{blue