Fix for optimization sequence in scanning toolchain

docs/changelog.md

@@ -7,6 +7,7 @@
   implementing this interface.
 - Add back scan data and back scan settings getter and setter methods
   to `qudi.interface.scanning_probe_interface`.
+- Moved ConfigOption ScannerGui.optimizer_plot_dimensions to qudi.logic.scanning_optimize_logic and optimizer sequence creation is solely handled by logic
 
 ### Bugfixes
 - Fix failure of saving plots in `QDPlotLogic` when fiting is used.
@@ -19,6 +20,7 @@
 - Fixed `QDPlotterGui` example config
 - Fixed psu-dependent bugs for laser_quantum_laser
 - Laser logic does not automatically start query loop, gui will still start it on startup
+- Optimization sequences other than [2D, 1D] are now working
 
 ### New Features
 - New `qudi.interface.scanning_probe_interface.ScanSettings` dataclass added.
@@ -30,7 +32,7 @@
   Implementation of configurable backward scans.
 - Add widgets to configure back scan resolution and frequency from scanning GUI.
 - Add config option to save backward scan data to scanning data logic.
-- Get current sweeps and runtime of fastcomtec fastcounter MCS6 when pulling the data trace. 
+- Get current sweeps and runtime of fastcomtec fastcounter MCS6 when pulling the data trace.
 - Re-introduced tilt correction (from old core) to the scanning probe toolchain.
 - Improved support for Stanford Research Systems signal generators
 - Expanded documentation of the microwave interface
@@ -51,10 +53,10 @@ into the scanning probe toolchain, you will be required to adapt to the new inte
 
 
 ### Breaking Changes
-- Major rework of `qudi.interface.data_instream_interface.DataInStreamInterface`. Time series 
-toolchain and NI x-series hardware module have been adapted but custom modules relying on this 
-interface will break.  
-Configuration for time series toolchain needs changes as well. See `default.cfg` or module 
+- Major rework of `qudi.interface.data_instream_interface.DataInStreamInterface`. Time series
+toolchain and NI x-series hardware module have been adapted but custom modules relying on this
+interface will break.
+Configuration for time series toolchain needs changes as well. See `default.cfg` or module
 docstrings.
 
 ### Bugfixes
@@ -64,11 +66,11 @@ docstrings.
 - Fix wrong asset name, non-invokable settings for AWG Tek 70k in sequence mode.
 - Fix disfunctional `mw_source_smbv`
 - Fix Keysight AWG sample rate only set-able with too coarse 10 MHz precision
-- Fix various Poimanager crashes 
+- Fix various Poimanager crashes
 
 ### New Features
 - Added remote streamer support to `TimeSeriesReaderLogic`.
-- New `qudi.interface.data_instream_interface.SampleTiming` Enum added to `DataInStreamInterface` 
+- New `qudi.interface.data_instream_interface.SampleTiming` Enum added to `DataInStreamInterface`
 constraints to allow non-uniform sampling mode.
 - Pulsed and odmr now add fit parameters to saved meta data.
 - New hardware module added that implements the HighFinesse wavemeter as a data instream device, replacing the old (non-functional) wavemeter toolchain.
@@ -79,11 +81,11 @@ constraints to allow non-uniform sampling mode.
 - Bumped `qudi-core` package minimum version requirement to v1.5.0
 - Got rid of deprecated `qudi.core.interface` module usage
 - Support for Python 3.10
-- This version 0.5.1 fixes a requirement issue found while pushing release 0.5.0 to test-pypi 
+- This version 0.5.1 fixes a requirement issue found while pushing release 0.5.0 to test-pypi
 
 ## Version 0.4.0
 ### Breaking Changes
-- `QDPlotLogic` has changed its public method signatures 
+- `QDPlotLogic` has changed its public method signatures
 - `OkFpgaPulser` now has a mandatory config option pointing towards a directory with the bitfiles necessary.
 
 ### Bugfixes
@@ -93,14 +95,14 @@ constraints to allow non-uniform sampling mode.
 ### New Features
 - First stable version of new scanning toolchain (aka omniscan):
     - New `blocking` argument for scanner moves executed via `ScanningProbeInterface`
-    - Multiple bugfixes for the new scanning toolchain with NICard. 
+    - Multiple bugfixes for the new scanning toolchain with NICard.
     - The NiScanningProbeInterfuse now polls data in chunks and independent of logic calls, as it should be.
     - More meta data of scans in saved data
 - Support for Zaber (linear) motorized stages (in `qudi.hardware.motor.zaber_motion`)
-- Overhaul of QDPlot toolchain (GUI and logic) to improve stability and consistency as well as 
+- Overhaul of QDPlot toolchain (GUI and logic) to improve stability and consistency as well as
 adding minor GUI features.
-- Added mixin `qudi.interface.mixins.process_control_switch.ProcessControlSwitchMixin` to provide 
-optional default implementation satisfying the `SwitchInterface` for process control hardware 
+- Added mixin `qudi.interface.mixins.process_control_switch.ProcessControlSwitchMixin` to provide
+optional default implementation satisfying the `SwitchInterface` for process control hardware
 modules implementing any of the interfaces contained in `qudi.interface.process_control_interface`
 - Overhaul of PID toolchain: added units support, normalization option, gui reset feature,
 dependency option for `process_control_dummy` to simulate PID control

src/qudi/default.cfg

@@ -47,6 +47,7 @@ gui:
         options:
             image_axes_padding: 0.02
             default_position_unit_prefix: null  # optional, use unit prefix characters, e.g. 'u' or 'n'
+            min_crosshair_size_fraction: 0.02   # minimum crosshair size as fraction of the displayed scan range
         connect:
             scanning_logic: scanning_probe_logic
             data_logic: scanning_data_logic
@@ -134,6 +135,8 @@ logic:
         module.Class: 'scanning_optimize_logic.ScanningOptimizeLogic'
         connect:
             scan_logic: scanning_probe_logic
+        options:
+            optimizer_sequence_dimensions: [2, 1] # Optional
 
     poi_manager_logic:
         module.Class: 'poi_manager_logic.PoiManagerLogic'

src/qudi/gui/scanning/scannergui.py

@@ -103,7 +103,6 @@ class ScannerGui(GuiBase):
         options:
             image_axes_padding: 0.02
             default_position_unit_prefix: null  # optional, use unit prefix characters, e.g. 'u' or 'n'
-            optimizer_plot_dimensions: [2, 1]   # optimization sequence dim. order, here for 2D, 1D, e.g. XY, Z
             min_crosshair_size_fraction: 0.02   # minimum crosshair size as fraction of the displayed scan range
         connect:
             scanning_logic: scanning_probe_logic
@@ -119,12 +118,6 @@ class ScannerGui(GuiBase):
 
     # config options for gui
     _default_position_unit_prefix = ConfigOption(name='default_position_unit_prefix', default=None)
-    # for all optimizer sub widgets, (2= xy, 1=z)
-    _optimizer_plot_dims: List[int] = ConfigOption(
-        name='optimizer_plot_dimensions',
-        default=[2, 1],
-        checker=lambda x: set(x) == {1, 2},  # only 1D and 2D optimizations are supported
-    )
     # minimum crosshair size as fraction of the displayed scan range
     _min_crosshair_size_fraction = ConfigOption(name='min_crosshair_size_fraction', default=1/50, missing='nothing')
 
@@ -340,21 +333,10 @@ def _init_optimizer_settings(self):
         """ Configuration and initialisation of the optimizer settings dialog.
         """
         scan_logic: ScanningProbeLogic = self._scanning_logic()
-        axes_obj = tuple(scan_logic.scanner_axes.values())
-        axes_names = [ax.name for ax in axes_obj]
-
-        # figure out sensible optimization sequences for user selection
-        possible_optimizations_per_plot = [itertools.combinations(axes_names, n) for n in self._optimizer_plot_dims]
-        optimization_sequences = list(itertools.product(*possible_optimizations_per_plot))
-        sequences_no_axis_twice = []
-        for sequence in optimization_sequences:
-            occurring_axes = [axis for step in sequence for axis in step]
-            if len(occurring_axes) <= len(set(occurring_axes)):
-                sequences_no_axis_twice.append(sequence)
-
+        optimize_logic : ScanningOptimizeLogic = self._optimize_logic()
         self._osd = OptimizerSettingsDialog(scan_logic.scanner_axes.values(),
                                             scan_logic.scanner_channels.values(),
-                                            sequences_no_axis_twice,
+                                            optimize_logic.allowed_scan_sequences,
                                             scan_logic.scanner_constraints.back_scan_capability)
 
         # Connect MainWindow actions
@@ -421,7 +403,7 @@ def _init_static_dockwidgets(self):
         )
 
         self.optimizer_dockwidget = OptimizerDockWidget(axes=self._scanning_logic().scanner_axes,
-                                                        plot_dims=self._optimizer_plot_dims,
+                                                        plot_dims=self._optimize_logic().optimizer_sequence_dimensions,
                                                         sequence=self._optimize_logic().scan_sequence)
         self.optimizer_dockwidget.setAllowedAreas(QtCore.Qt.TopDockWidgetArea)
         self._mw.addDockWidget(QtCore.Qt.TopDockWidgetArea, self.optimizer_dockwidget)

src/qudi/logic/scanning_optimize_logic.py

@@ -33,6 +33,10 @@
 from qudi.core.connector import Connector
 from qudi.core.statusvariable import StatusVar
 from qudi.util.fit_models.gaussian import Gaussian2D, Gaussian
+from qudi.core.configoption import ConfigOption
+import itertools
+
+
 
 
 class ScanningOptimizeLogic(LogicBase):
@@ -46,12 +50,22 @@ class ScanningOptimizeLogic(LogicBase):
         module.Class: 'scanning_optimize_logic.ScanningOptimizeLogic'
         connect:
             scan_logic: scanning_probe_logic
+        options:
+            optimizer_sequence_dimensions: [2, 1] # optimization sequence dim. order,
+                                                  # here for first 2D optimization and then 1D optimization, e.g. XY, Z
 
     """
 
     # declare connectors
     _scan_logic = Connector(name='scan_logic', interface='ScanningProbeLogic')
 
+    # declare ConfigOptions
+    # for all optimizer sub widgets, (2= xy, 1=z)
+    _optimizer_sequence_dimensions: List[int] = ConfigOption(
+        name='optimizer_sequence_dimensions',
+        default=[2, 1],
+    )
+
     # status variables
     # not configuring the back scan parameters is represented by empty dictionaries
     _scan_sequence: List[Tuple[str, ...]] = StatusVar(name='scan_sequence', default=None)
@@ -65,6 +79,7 @@ class ScanningOptimizeLogic(LogicBase):
     # signals
     sigOptimizeStateChanged = QtCore.Signal(bool, dict, object)
     sigOptimizeSettingsChanged = QtCore.Signal(dict)
+    sigOptimizeSequenceDimensionsChanged = QtCore.Signal()
 
     _sigNextSequenceStep = QtCore.Signal()
 
@@ -96,16 +111,8 @@ def on_activate(self):
             self._set_default_scan_settings()
 
         self._avail_axes = tuple(axes.values())
-        if self._scan_sequence is None:
-            if len(self._avail_axes) >= 3:
-                self._scan_sequence = [(self._avail_axes[0].name, self._avail_axes[1].name),
-                                       (self._avail_axes[2].name,)]
-            elif len(self._avail_axes) == 2:
-                self._scan_sequence = [(self._avail_axes[0].name, self._avail_axes[1].name)]
-            elif len(self._avail_axes) == 1:
-                self._scan_sequence = [(self._avail_axes[0].name,)]
-            else:
-                self._scan_sequence = list()
+        self._set_scan_sequence()
+
         if self._data_channel is None:
             self._data_channel = tuple(channels.values())[0].name
 
@@ -118,6 +125,7 @@ def on_activate(self):
         self._scan_logic().sigScanStateChanged.connect(
             self._scan_state_changed, QtCore.Qt.QueuedConnection
         )
+        self.sigOptimizeSequenceDimensionsChanged.connect(self._set_scan_sequence, QtCore.Qt.QueuedConnection)
 
     def on_deactivate(self):
         """ Reverse steps of activation
@@ -171,6 +179,33 @@ def scan_sequence(self, sequence: List[Tuple[str, ...]]):
         else:
             self._scan_sequence = sequence
 
+    @property
+    def allowed_scan_sequences(self) -> list:
+        axes_names = [ax.name for ax in self._avail_axes]
+
+        # figure out sensible optimization sequences for user selection
+        possible_optimizations_per_plot = [itertools.combinations(axes_names, n) for n in self._optimizer_sequence_dimensions]
+        optimization_sequences = list(itertools.product(*possible_optimizations_per_plot))
+        sequences_no_axis_twice = []
+        if sum(self._optimizer_sequence_dimensions) > len(axes_names):
+            raise ValueError(f"Requested optimization sequence ({sum(self._optimizer_sequence_dimensions)}) is greater than available scanner axes ({len(axes_names)}). This is currently not supported. Decrease optimizer_sequence_dimensions.")
+
+        for sequence in optimization_sequences:
+            occurring_axes = [axis for step in sequence for axis in step]
+            if len(occurring_axes) <= len(set(occurring_axes)):
+                sequences_no_axis_twice.append(sequence)
+
+        return sequences_no_axis_twice
+
+    @property
+    def optimizer_sequence_dimensions(self) -> list:
+        return self._optimizer_sequence_dimensions
+
+    @optimizer_sequence_dimensions.setter
+    def optimizer_sequence_dimensions(self, dimensions: list) -> None:
+        self._optimizer_sequence_dimensions = sequence_dimension_constructor(dimensions)
+        self.sigOptimizeSequenceDimensionsChanged.emit()
+
     @property
     def optimizer_running(self):
         return self.module_state() != 'idle'
@@ -389,3 +424,16 @@ def _set_default_scan_settings(self):
         self._scan_frequency = {ax.name: max(ax.frequency.minimum, ax.frequency.maximum / 100) for ax in axes.values()}
         self._back_scan_resolution = {}
         self._back_scan_frequency = {}
+
+    def _set_scan_sequence(self):
+        possible_scan_sequences = self.allowed_scan_sequences
+        if self._scan_sequence is None or self._scan_sequence not in possible_scan_sequences:
+            self.log.info(f"No valid scan sequence existing, setting scan sequence to {possible_scan_sequences[0]}.")
+            self._scan_sequence = possible_scan_sequences[0]
+
+    @_optimizer_sequence_dimensions.constructor
+    def sequence_dimension_constructor(self, dimensions: list) -> list:
+        if set(dimensions) <= {1, 2}:
+            return dimensions
+        raise ValueError(f"Dimensions must be in {set([1,2])}, received {dimensions=}.")
+