fix: update axes ranges when "Auto XY-range" is selected in plotting

Author: paulmueller

CHANGELOG

@@ -1,7 +1,9 @@
 2.26.2
  - fix: prevent `pipeline.lock` deadlocks via Qt signal cluttering
+ - fix: update axes ranges when "Auto XY-range" is selected in plotting
  - enh: increase default disk store size from 2GB to 9GB
  - enh: reduce delay after selecting axes in the Plot view
+ - ref: incorporate `PipelinePlot` into sender-receiver signal pyramid
  - setup: bump dclab to 0.71.2 (disk-caching of DCOR/HTTP/S3 data)
 2.26.1
  - fix: possibly fix `KeyError` on hover in QuickView by doing a
@@ -57,7 +59,7 @@
  - enh: improved presentation of multiple datasets with identical sample names
  - ref: tentative `set_pipeline`, so widgets have direct access to the pipeline
  - ref: raise ValueError in unreachable case in DataSlot creation
- - ref: restructure pipeline management through signaling
+ - ref: restructure pipeline management with sender-receiver signal pyramid
  - ref: move slot, plot, and filter duplication to `Pipeline` class
  - ref: refer power to Slot/Plot/Filter creation to `Pipeline`
  - setup: bump pyqtgraph to 0.14.0

dcscope/gui/helpers.py

@@ -14,3 +14,21 @@ def connect_pp_mod_signals(parent, child):
     """
     parent.pp_mod_recv.connect(child.pp_mod_recv)
     child.pp_mod_send.connect(parent.pp_mod_send)
+
+
+def disconnect_pp_mod_signals(parent, child):
+    """The sender-receiver signal pyramid
+
+    Each widget that implements the `pp_mod_send` and `pp_mod_recv`
+    may be part of the sender-receiver pipeline modifications pyramid.
+    The tip of the pyramid is the main class.
+    When a widget changes something about the pipeline, it sends a dictionary
+    through the `pp_mod_send` signal up the pyramid. At the top of the
+    pyramid this signal is connected to the `pp_mod_recv` side of the
+    pyramid.
+    Every widget can send and receive any kind of pipeline change.
+    Receiving widgets are responsible for filtering out what they need.
+    This approach makes it easy to synchronize widgets.
+    """
+    parent.pp_mod_recv.disconnect(child.pp_mod_recv)
+    child.pp_mod_send.disconnect(parent.pp_mod_send)

dcscope/gui/main.py

@@ -35,7 +35,7 @@
     update,
     widgets,
 )
-from .helpers import connect_pp_mod_signals
+from .helpers import connect_pp_mod_signals, disconnect_pp_mod_signals
 
 # global plotting configuration parameters
 pg.setConfigOption("background", None)
@@ -57,7 +57,6 @@
 
 
 class DCscope(QtWidgets.QMainWindow):
-    plots_changed = QtCore.pyqtSignal()
     # widgets emit these whenever they changed the pipeline
     pp_mod_send = QtCore.pyqtSignal(dict)
     # widgets receive these so they can reflect the pipeline changes
@@ -384,7 +383,7 @@ def add_plot_window(self, plot_id):
             pw = pipeline_plot.PipelinePlot(parent=sub,
                                             pipeline=self.pipeline,
                                             plot_id=plot_id)
-            self.plots_changed.connect(pw.update_content)
+            connect_pp_mod_signals(self, pw)
             sub.setWidget(pw)
             pw.update_content()
             self.mdiArea.addSubWindow(sub)
@@ -919,7 +918,7 @@ def on_pp_mod_recv(self, data):
                     for child in sub.children():
                         # disconnect signals
                         if isinstance(child, pipeline_plot.PipelinePlot):
-                            self.plots_changed.disconnect(child.update_content)
+                            disconnect_pp_mod_signals(self, child)
                             break
                     sub.deleteLater()
 
@@ -943,11 +942,6 @@ def on_pp_mod_recv(self, data):
         QtWidgets.QApplication.processEvents(
             QtCore.QEventLoop.ProcessEventsFlag.AllEvents, 300)
 
-        if data.get("pipeline"):
-            # Update plots after updating block matrix
-            with widgets.ShowWaitCursor():
-                self.plots_changed.emit()
-
         # redraw
         self.mdiArea.update()
         self.subwindows["analysis_view"].update()

dcscope/gui/matrix/pm_element.py

@@ -55,7 +55,7 @@ def mousePressEvent(self, event):
                     slot_id,
                     plot_id,
                     not self.invalid and not self.active)
-            self.pp_mod_send.emit({"pipeline": {"plot_change": plot_id}})
+            self.pp_mod_send.emit({"pipeline": {"plot_changed": plot_id}})
             event.accept()
 
     @QtCore.pyqtSlot(dict)

dcscope/gui/matrix/pm_plot.py

@@ -66,7 +66,7 @@ def on_active_toggled(self):
                     filt_plot_id=plot_id,
                     active=self.active
                 )
-        self.pp_mod_send.emit({"pipeline": {"plot_toggled": plot_id}})
+        self.pp_mod_send.emit({"pipeline": {"plot_changed": plot_id}})
 
     # Other methods
     def abolish(self):

dcscope/gui/pipeline_plot.py

@@ -38,6 +38,11 @@ class ContourSpacingTooLarge(UserWarning):
 
 class PipelinePlot(QtWidgets.QWidget):
     """Implements the plotting pipeline using pyqtgraph"""
+    # widgets emit these whenever they changed the pipeline
+    pp_mod_send = QtCore.pyqtSignal(dict)
+    # widgets receive these so they can reflect the pipeline changes
+    pp_mod_recv = QtCore.pyqtSignal(dict)
+
     instances = {}
 
     def __init__(self, parent, pipeline, plot_id, *args, **kwargs):
@@ -58,6 +63,20 @@ def __init__(self, parent, pipeline, plot_id, *args, **kwargs):
         self.update_content()
         PipelinePlot.instances[plot_id] = self
 
+        self.pp_mod_recv.connect(self.on_pp_mod_recv)
+
+    @QtCore.pyqtSlot(dict)
+    def on_pp_mod_recv(self, data):
+        pip_data = data.get("pipeline", {})
+        if pip_data.get("plot_changed") == self.identifier:
+            plot = self.pipeline.get_plot(self.identifier)
+            plot_state = plot.__getstate__()
+            self.update_content()
+            if plot.__getstate__() != plot_state:
+                # Updated the range controls
+                self.pp_mod_send.emit(
+                    {"pipeline": {"plot_range_corrected": self.identifier}})
+
     @QtCore.pyqtSlot()
     def update_content(self):
         """Update the current plot"""
@@ -135,6 +154,8 @@ def update_content_plot(self, plot_state, slot_states, dslist):
             gen["range y"] = self.pipeline.get_min_max(feat=gen["axis y"],
                                                        plot_id=self.identifier,
                                                        margin=0.05)
+            plot = self.pipeline.get_plot(self.identifier)
+            plot.__setstate__(plot_state)
 
         # title
         self.setWindowTitle(lay["name"])