Configuration (r3.7)

• Unknown macro: {blue}
  : (Read-Only) Displays the name of the active Configuration (CFG) file – i.e., the most recently loaded CFG file, if any.

• Unknown macro: {blue}
  : Launches dialog to select a ScanImage Configuration (CFG) file to load. Identical to selecting File >> Load Configuration... from the
  Unknown macro: {report-info}
  panel menubar.

• Unknown macro: {blue}
  : Launches dialog to save the current ScanImage Configuration to a specified CFG file. Identical to selecting File >> Save Configuration As... from the
  Unknown macro: {report-info}
  } panel menubar.

• Unknown macro: {blue}
  : 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
  Unknown macro: {blue}
  button becomes active and changes are applied only when pressed.
  Note that the controls in the [
  Unknown macro: {blue}
  section|#Sec C] DO take immediate effect IF the changes occur during FOCUS mode operation

• Unknown macro: {blue}
  : Saves the current ScanImage Configuration to the active Configuration (CFG) file. Identical to selecting File >> Save Configuration... from the
  Unknown macro: {report-info}
  } 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
  Unknown macro: {report-info}
  } panel menubar in order to save the changes (if desired).

The controls in this section pertain to the concepts described in Scan Configuration Basics.

• Unknown macro: {blue}
  : 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].

• Unknown macro: {blue}
  : Specifies the number of lines to scan with the fast (X) dimension scanner during each Frame of acquisition, while simultaneously adjusting the slow (Y) dimension position (except during a Line Scan). This value becomes the number of vertical pixels in the displayed image and the [stored image].

• Unknown macro: {blue}
  : Specifies the time (in ms) to spend during each line scanned by the fast (X) dimension scanner, including both the Acquisition Period as well as non-acquiring time for flyback and/or turnaround.
  The
  Unknown macro: {blue}
  value can differ somewhat from the
  Unknown macro: {blue}
  value, based on the
  Unknown macro: {blue}
  setting (as described in Fast (X) Dimension Optimization)
  The Acquisition Period = 0.8192 *
  Unknown macro: {blue}
  (as described in Fast (X) Dimension Optimization)
  At this time, ScanImage supports values down to 0.5 ms/line with
  Unknown macro: {blue}
  enabled and 1ms/line otherwise

• Unknown macro: {blue}
  : Enables, when selected, Bidirectional scanning. When not selected, Sawtooth scanning is used.

• Unknown macro: {blue}
  : ScanImage generates X and Y command signals on the 2 output channels of the board specified by mirrorOutputBoardIndex in the INI File. This value specifies on which channel the X command signal is generated; the Y command signal is generated on the other.
  At this time, all the [DAQ boards] supported by ScanImage for generating mirror output signals only have 2 output channels.

• Unknown macro: {blue}
  : Specifies in optical degrees the half-angle 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
  Unknown macro: {vi-statevar}
  value in the INI File.
  ScanImage allows scanning of non-square aspect ratio regions, via the appropriate adjustment of the
  Unknown macro: {blue}
  values
  The command signal generated for the Fast (X) dimension has a larger half-amplitude than
  Unknown macro: {blue}
  , as described in Fast (X) Dimension Optimization.
  When Line Scanning is active (via
  Unknown macro: {blue}
  in the
  Unknown macro: {report-info}
  } panel), the
  Unknown macro: {blue}
  value used internally by ScanImage becomes 0, but the value stored/displayed by the Configuration remains as previously set.

The parameters in this section relate to the Fast (X) 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 (X) 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.

• Unknown macro: {blue}
  : 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 (X) 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.

• Unknown macro: {blue}
  : Selecting this enables adjustment of the
  Unknown macro: {blue}
  in fine increments
  The fine increment for the
  Unknown macro: {blue}
  is the sampling period determined by the
  Unknown macro: {blue}
  value

• Unknown macro: {blue}
  : Value represents time (in microseconds) by which to extend the linear ramp at the beginning of each Acquisition Period in the Fast (X) command signal.
  This value is read-only when Bidirectional (
  Unknown macro: {blue}
  ) scanning is enabled, as the ramp extension is determined (implied) by the
  Unknown macro: {blue}
  value.

• Unknown macro: {blue}
  : (Read-only) Value displays the duration of each period of the Fast (X) command signal, each of which corresponds to the scan of a single Line. This value may differ somewhat from the user-specified
  Unknown macro: {blue}
  ) value, according to the currently specified
  Unknown macro: {blue}
  .

• Unknown macro: {blue}
  : Value represents the fraction of the
  Unknown macro: {blue}
  occupied by the Acquisition Period – the portion of each period of the Fast (X) command signal during which the input signal data is processed. Adjusting this value actually sets the
  Unknown macro: {blue}
  value (because the Acquisition Period is fixed for a given
  Unknown macro: {blue}
  ).
  The value of 0.8192 corresponds to case where the
  Unknown macro: {blue}
  matches the
  Unknown macro: {blue}
  value
  (Reducing/increasing) the
  Unknown macro: {blue}
  (below/above) 0.8192 (increases/decreases) the
  Unknown macro: {blue}
  value

As described in Fast (X) Dimension Optimization, optimal settings for the Fast (X) 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.

• Unknown macro: {blue}
  : This value stores the minimum zoom level to allow for the current ScanImage Configuration. This value constrains the
  Unknown macro: {blue}
  value set in the
  Unknown macro: {report-info}
  } panel.
  This is useful when preparing a ScanImage CFG File which employs a fast (small)
  Unknown macro: {blue}
  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.
  Unknown macro: {blue}
  levels above this level use the same
  Unknown macro: {blue}
  values as those configured at this
  Unknown macro: {blue}
  level.

• Unknown macro: {blue}
  : This determines the zoom level to set and/or display in the Fill Fraction, Acq Delay, and Scan Delay text controls within the
  Unknown macro: {blue}
  section.
  This value can range from 1 to Constant @ Zoom >= (values can be stored for zoom levels below the
  Unknown macro: {blue}
  value, although they have no effect).
  Scrolling through the
  Unknown macro: {blue}
  values allows one to scroll through the Fill Fraction, Acq Delay, and Scan Delay values stored for each
  Unknown macro: {blue}
  level

• Unknown macro: {blue}
  : These correspond to the parameters described in the
  Unknown macro: {blue}
  section, specifying the parameters to use at each
  Unknown macro: {blue}
  level.

Further background on these parameters can be found in Pockels Flyback Blanking.

• Unknown macro: {blue}
  : 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 X command signal
  • If
    Unknown macro: {blue}
    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 (Y) dimension scan

• Unknown macro: {blue}
  : 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 (X) 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
  Unknown macro: {blue}
  .

This section determines the sample rates used by the Analog Input and Analog Output channels used by ScanImage.

• Unknown macro: {blue}
  : Specifies the sample rate (in MHz) of the Analog Input channels used by ScanImage to digitize the PMT (or other photodetector) input signals

• Unknown macro: {blue}
  : Specifies the sample rate (in kHz) of the Analog Output channels used by ScanImage to generate the Fast (X) and Slow (Y) 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
  Unknown macro: {blue}
  tool (in the
  Unknown macro: {report-info}
  } 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

• Unknown macro: {blue}
  : This option (available for both the
  Unknown macro: {blue}
  and
  Unknown macro: {blue}
  controls) causes the sample rate to be automatically determined by the current
  Unknown macro: {blue}
  value
  For the
  Unknown macro: {blue}
  , selecting
  Unknown macro: {blue}
  causes the
  Unknown macro: {blue}
  to remain constant for common values of
  Unknown macro: {blue}
  – this allows the ScanImage image displays to appear consistent as the scan speed is varied, with fixed
  Unknown macro: {blue}
  levels (set in the
  Unknown macro: {report-info}
  }

The full meaning/effects of the parameters in this section are described in Slow (Y) Scan Dimension Settings.

• Unknown macro: {blue}
  : Specifies that the Slow (Y) 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.

• Unknown macro: {blue}
  : Specifies that beginning of flyback for Slow (Y) command signal will coincide with start of final line in the Frame; also, if
  Unknown macro: {blue}
  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 (Y) 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
  Unknown macro: {blue}
  values) as the flyback may take nearly as long as a single line scan; hence the Pockels 'blanking' is appropriate

• Unknown macro: {blue}
  : 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
  Unknown macro: {blue}
  is disabled
  This option is often used with an odd value for
  Unknown macro: {blue}
  specified, so that the stored/displayed number of lines is even (e.g. 257 can be specified to store/display a 256 line image)

This section displays read-only parameters determined by the other values specified in the CONFIGURATION panel.

• Unknown macro: {blue}
  : 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 (
  Unknown macro: {blue}
  ) of the Fast (X) dimension scan. This value depends on:
  • Unknown macro: {blue}
  • Unknown macro: {blue}

• Unknown macro: {blue}
  : 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:
  • Unknown macro: {blue}
    (
    Unknown macro: {blue}
    and
    Unknown macro: {blue}
    )
  • Unknown macro: {blue}
    The samples can be averaged, rather than summed, if
    Unknown macro: {blue}
    is selected in the
    Unknown macro: {report-info}
    } panel.

• Unknown macro: {blue}
  : Specifies the total time spent during the acquisition of
  Unknown macro: {blue}
  samples for each horizontal pixel computed by ScanImage.
  This value is computed simply as:
  Unknown macro: {blue}
  *=
  Unknown macro: {blue}
  /*
  Unknown macro: {blue}

• Unknown macro: {blue}
  : Specifies the total time spent for each Frame of acquisition.
  This value is computed simply as:
  Unknown macro: {blue}
  = 1 */ (
  Unknown macro: {blue}
  *
  Unknown macro: {blue}
  )
  The total time for a ScanImage acquisition is determined exactly by the number of frames acquired times the Frame Period (= 1 /
  Unknown macro: {blue}
  )) – i.e. there are no gaps between Frames

• Unknown macro: {blue}
  : 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.

• Unknown macro: {blue}
  : 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
  Unknown macro: {blue}
  prevents this from occurring, forcing ScanImage to display images one Frame at a time.