CONFIGURATION Panel
- Overview
- Section A
- Section B: Basic Scan Parameters
- Section C: Live Adjustable Scan Parameters
- Section D: Scan Parameter Array
- Section E: Pockels Control Parameters
- Section F: DAQ Sample Rates
- Section G: Slow Dimension Scan Settings
- Section H: Dependent Parameter Display
- Section I: Miscellaneous Parameters
Section A
_Current_ vs _Active_ Configuration
It is important to distinguish between the current ScanImage Configuration and the active Configuration (CFG) file. The former represents the current state of all ScanImage controls (both on the CONFIGURATION panel and otherwise) which comprise the ScanImage Configuration, while the latter represents the most recently loaded ScanImage Configuration (CFG) file (whose settings may no longer all be in effect)
: (Read-Only) Displays the name of the active Configuration (CFG) file – i.e., the most recently loaded CFG file, if any.
: Launches dialog to select a ScanImage Configuration (CFG) file to load. Identical to selecting File >> Load Configuration... from the
panel menubar.
: Launches dialog to save the current ScanImage Configuration to a specified CFG file. Identical to selecting File >> Save Configuration As... from the
panel menubar.
: Changes made to controls throughout the CONFIGURATION panel do not immediately update the current ScanImage Configuration, i.e. the current ScanImage state. When a change is made, the
button becomes active and changes are applied only when pressed.
Note that the controls in the
section Sec C DO take immediate effect IF the changes occur during FOCUS mode operation
: Saves the current ScanImage Configuration to the active Configuration (CFG) file. Identical to selecting File >> Save Configuration... from the
panel menubar.
This control only appears active if a change to one of the controls in the CONFIGURATION panel has occurred (and been applied) since the active Configuration (CFG) file was last loaded.
If a change to the current ScanImage Configuration is made outside of the CONFIGURATION panel, then File >> Save Configuration... should be selected from the
panel menubar in order to save the changes (if desired).
Section B: Basic Scan Parameters
The controls in this section pertain to the concepts described in Scan Configuration Basics.
: Specifies the number of input sample bins to use during the Acquisition Period of each scanned line. This value becomes the number of horizontal pixels in the displayed image and the stored image.
: Specifies the number of lines to scan with the FAST dimension scanner during each Frame of acquisition, while simultaneously adjusting the SLOW dimension position (except during a Line Scan). This value becomes the number of vertical pixels in the displayed image and the stored image.
: Specifies the time (in ms) to spend during each line scanned by the FAST dimension scanner, including both the Acquisition Period as well as non-acquiring time for flyback and/or turnaround.
The
value can differ somewhat from the
value, based on the
setting (as described in Fast Dimension Optimization)
The Acquisition Period = 0.8192 *
(as described in Fast Dimension Optimization)
At this time, ScanImage supports values down to 0.5 ms/line with
enabled and 1ms/line otherwise
: Enables, when selected, Bidirectional scanning. When not selected, Sawtooth scanning is used.
: ScanImage generates FAST and SLOW command signals on the 2 analog output channels of the DAQ board specified by
in the INI File. This value specifies for which scanner, X or Y, the FAST command signal is generated; the SLOW command signal is generated for the other scanner.
The
INI variables specify the mapping of the X and Y physical scanners to the 2 DAQ output channels.
Adjusting
allows one to rotate the image by 90 degrees.
: Specifies in optical degrees the full angular range that the physical scanner associated with each dimension should cover during the Acquisition Period.
The conversion between optical degrees and command signal units (e.g. volts) is specified by the
value in the INI File.
ScanImage allows scanning of non-square aspect ratio regions, via the appropriate adjustment of the
values
The command signal generated for the FAST dimension has a larger half-amplitude than
, as described in Fast Dimension Optimization.
When Line Scanning is active (via
in the
panel), the
value used internally by ScanImage becomes 0, but the value stored/displayed by the Configuration remains as previously set.
Adjust Infrequently
In general, the values are not intended to be varied frequently. Adjusting the scan range is usually accomplished by the
value instead. The primary reasons known to adjust the
values are:
- Support for non-square aspect ratios
- Matching laser scanned area precisely to some reference image area (e.g. video camera)
Section C: Live Adjustable Scan Parameters
The parameters in this section relate to the FAST Dimension command signal. The full meanings/effects of the parameters in this section, as well as procedures to set their values optimally, are described in Fast Dimension Optimization.
Unlike other parameters on the CONFIGURATION panel, changes to these parameters are immediately applied during a live acquisition (only in FOCUS mode), allowing their effect on the acquired image to be readily visualized. When these parameters are varied while not live imaging, then must be pressed for the changes to update the current ScanImage Configuration.
The parameters set in this section apply to the currently configured value (in the
panel). When changes are applied, the
values are updated accordingly.
: Adjusts the Acquisition Delay value required by ScanImage during processing the input data. To produce the optimal/correct image from the scanned data, this value must match the actual delay between the Acquisition Period of the FAST command signal and the corresponding period in the physical scanner's position response.
Adjusting this value while Sawtooth scanning will shift the displayed image; adjusting it while Bidirectional scanning will adjust the alignment of every-other-line in the image.
Fast Acq Delay Adjustment
To rapidly visualize the results of adjusting the during live FOCUS mode imaging, the options
and
should be temporarily disabled (if they were enabled), to prevent the Pockels and SLOW scan command signals from needing to be recomputed as the value is adjusted.
This is particularly useful when optimizing Bidirectional scans
: Selecting this enables adjustment of the
in fine increments
The fine increment for the
is the sampling period determined by the
value
: Value represents time (in microseconds) by which to extend the linear ramp at the beginning of each Acquisition Period in the FAST command signal.
This value is read-only when Bidirectional (
) scanning is enabled, as the ramp extension is determined (implied) by the
value.
: (Read-only) Value displays the duration of each period of the FAST command signal, each of which corresponds to the scan of a single Line. This value may differ somewhat from the user-specified
) value, according to the currently specified
.
: Value represents the fraction of the
occupied by the Acquisition Period – the portion of each period of the FAST command signal during which the input signal data is processed. Adjusting this value actually sets the
value (because the Acquisition Period is fixed for a given
).
The value of 0.8192 corresponds to case where the
matches the
value
(Reducing/increasing) the
(below/above) 0.8192 (increases/decreases) the
value
Section D: Scan Parameter Array
As described in Fast Dimension Optimization, optimal settings for the FAST command signal can be amplitude-dependent and therefore vary with the value. To address this, ScanImage allows distinct sets of the
discussed in the last section to be stored for different
levels as part of the ScanImage Configuration. These sets of variables correspond to the entries in the Scan Parameter Array – which is 'indexed' by the
level.
: This value stores the minimum zoom level to allow for the current ScanImage Configuration. This value constrains the
value set in the
panel.
This is useful when preparing a ScanImage CFG File which employs a fast (small)
value that may stretch the physical scanner limits (e.g. current drive, servo control, or thermal limits)
- Constant @ Zoom >=: This value determines the length of the Scan Parameter Array.
levels above this level use the same
values as those configured at this
level.
: This determines the zoom level to set and/or display in the Fill Fraction, Acq Delay, and Scan Delay text controls within the
section.
This value can range from 1 to Constant @ Zoom >= (values can be stored for zoom levels below the
value, although they have no effect).
Scrolling through the
values allows one to scroll through the Fill Fraction, Acq Delay, and Scan Delay values stored for each
level
: These correspond to the parameters described in the
section, specifying the parameters to use at each
level.
Section E: Pockels Control Parameters
Further background on these parameters can be found in Pockels Flyback Blanking.
: Enabling this option implies –
- The Pockels Cell command signal(s) generated by ScanImage for the (active) Beams are 'blanked' outside of the Acquisition Period of the FAST command signal
- If
is selected, the Pockels Cell command signal(s) generated by ScanImage for the (active) Beams are 'blanked' during the the final line of each Frame to allow for flyback of the SLOW dimension scan
: Specifies a time (in microseconds) by which the Acquisition Period value used to determine the Pockels Cell command signal(s) is extended (increased) relative to the actual value for the FAST command signal.
This parameter specifies extra 'cushion' to use in the Pockels command signal(s), ensuring the signal is not 'blanked' during the actual Acquisition Period.
This cushion 1) accounts for light modulator response time and 2) provides tolerance for errors in the
.
Section F: DAQ Sample Rates
This section determines the sample rates used by the Analog Input and Analog Output channels used by ScanImage.
: Specifies the sample rate (in MHz) of the Analog Input channels used by ScanImage to digitize the PMT (or other photodetector) input signals
: Specifies the sample rate (in kHz) of the Analog Output channels used by ScanImage to generate the FAST and SLOW scanner command signals, as well as the Pockels (or other light modulator) command signal(s) generated for each Beam
Increasing this value can improve the positioning accuracy of scan regions selected for the Power Box feature and with the
tool (in the
panel).
At this time, the Analog Output sample rate for the channels used for the scanner and Pockels cell command signals are required to be equal
: This option (available for both the
and
controls) causes the sample rate to be automatically determined by the current
value
For the
, selecting
causes the
to remain constant for common values of
– this allows the ScanImage image displays to appear consistent as the scan speed is varied, with fixed
levels (set in the
Section G: Slow Dimension Scan Settings
The full meaning/effects of the parameters in this section are described in Slow Scan Dimension Settings.
: Specifies that the SLOW command signal should be a staircase – i.e. should step to a discrete level for each line in the Frame – rather than a continuous ramp.
: Specifies that beginning of flyback for SLOW command signal will coincide with start of final line in the Frame; also, if
is selected, then the Pockels (or other light modulator) command signal will be 'blanked' during this (entire) final line
If this option is disabled, then the SLOW command signal flyback begins at the end of the Frame meaning, practically, that it occurs during the first line of the succeeding frame
This option is valuable for fast scan speeds (low
values) as the flyback may take nearly as long as a single line scan; hence the Pockels 'blanking' is appropriate
: Specifies that the final line of acquired data during the Frame is discarded and does not appear in the image display figures and is not recorded to the stored image files.
This option is disabled and inactive if
is disabled
This option is often used with an odd value for
specified, so that the stored/displayed number of lines is even (e.g. 257 can be specified to store/display a 256 line image)
Section H: Dependent Parameter Display
This section displays read-only parameters determined by the other values specified in the CONFIGURATION panel.
: Specifies the number of samples acquired on the Analog Input channels used for the PMT (or other photodetector) input signal during the Acquisition Period occurr ing during each Line Period (
) of the FAST dimension scan. This value depends on:
: Specifies the number of Analog Input samples from the input signal(s) which are generally summed together to compute the value for each horizontal pixel that is computed by ScanImage to assemble an image for each Frame of acquisition to display|SI3.6_ImageDisplay] and/or store) . This value depends on:
(
and
)
The samples can be averaged, rather than summed, if
is selected in the
panel.
: Specifies the total time spent during the acquisition of
samples for each horizontal pixel computed by ScanImage.
This value is computed simply as:
=
/
: Specifies the total time spent for each Frame of acquisition.
This value is computed simply as:
= 1 */ (
*
)
The total time for a ScanImage acquisition is determined exactly by the number of frames acquired times the Frame Period (= 1 /
*)*) – i.e. there are no gaps between Frames
Section I: Miscellaneous Parameters
: Specifies the time (in ms) following the start (trigger) of a GRAB acquisition or LOOP Repeat, or an Image Stack Slice, that the optional shutter signal generated by ScanImage should switch to Open state.
See Shutter Control for more information.
: In many circumstances, ScanImage processes the input data in evenly-subdivided segments of each Frame termed Stripes, allowing the update of image display figures to appear more 'real-time'. Selecting
prevents this from occurring, forcing ScanImage to display images one Frame at a time.
Why Disable Image Striping?
There are two primary reasons to forcibly disable image striping:
- For fast scans (low
) and/or large
values, the Acquisition Period of the physical scanner position response will be delayed sufficiently to overlap the next Line Period of the FAST scan command signal. In such cases, ScanImage must 'wrap' the input data obtained during each segment of acquired data. Forcing data to be acquired in Frame segments avoids the 'wrap' artifact from occurring in the middle of the Frame
- When the
option is enabled (in the
dialog), image striping must be disabled for the crosshair to display correctly in the ScanImage image display figures.