live_axis_range: Add params to set min range width and range limit (#45)

Author: linuswck

pglive/examples_pyqt5/__init__.py

@@ -18,6 +18,18 @@ def stop():
     running = False
     app.exit(0)
 
+def sin_wave_add_square_wave_generator(*data_connectors, flip=False):
+    """Sine wave + Square Wave generator"""
+    x = 0
+    while running:
+        x += 1
+        square_wave_amplitude = 0 if x // 750 % 2 == 0 else 5
+        for data_connector in data_connectors:
+            if flip:
+                data_connector.cb_append_data_point(x, sin(x * 0.025) + square_wave_amplitude)
+            else:
+                data_connector.cb_append_data_point(sin(x * 0.025) + square_wave_amplitude, x)
+        sleep(0.01)
 
 def sin_wave_generator(*data_connectors, flip=False):
     """Sine wave generator"""

pglive/examples_pyqt5/live_plot_range.py

@@ -18,6 +18,7 @@
 layout.layout.setSpacing(0)
 args = []
 args2 = []
+args3 = []
 
 '''
 Move view to the right on every 300 ticks (data update).
@@ -146,9 +147,45 @@
 layout.addWidget(time_axis_plot_widget, row=2, col=2)
 
 # ---
+'''
+Move view to the right on every 300 ticks (data update).
+Y range is automatically adjudicating every tick according to y_min_range_width set.
+'''
+widget = LivePlotWidget(title=f"Rolling X view range, auto Y range @ 100Hz @ Min Range Width 3.0",
+                        y_range_controller=LiveAxisRange(y_min_range_width=3.0))
+plot = LiveLinePlot(pen="green")
+widget.addItem(plot)
+layout.addWidget(widget, row=3, col=0)
+args3.append(DataConnector(plot, max_points=300, update_rate=100))
+
+# ---
+'''
+Move view to the right on every 300 ticks (data update).
+Y range is automatically adjudicating every tick according to y_range_limit set.
+'''
+widget = LivePlotWidget(title=f"Rolling X view range, auto Y range @ 100Hz @ Range Limit -1.0, 1.0",
+                        y_range_controller=LiveAxisRange(y_range_limit=[-1.0, 1.0]))
+plot = LiveLinePlot(pen="green")
+widget.addItem(plot)
+layout.addWidget(widget, row=3, col=1)
+args3.append(DataConnector(plot, max_points=300, update_rate=100))
+
+# ---
+'''
+Move view to the right on every 300 ticks (data update).
+Y range is automatically adjudicating every tick according to y_min_range_width and y_range_limit set.
+
+'''
+widget = LivePlotWidget(title=f"Rolling X view range, auto Y range @ 100Hz @ Min Range Width 3.0 @ Range Limit -1.0, 3.0",
+                        y_range_controller=LiveAxisRange(y_min_range_width=3.0, y_range_limit=[-1.0, 3.0]))
+plot = LiveLinePlot(pen="green")
+widget.addItem(plot)
+layout.addWidget(widget, row=3, col=2)
+args3.append(DataConnector(plot, max_points=300, update_rate=100))
 
 layout.show()
 Thread(target=examples.sin_wave_generator, args=args).start()
 Thread(target=examples.sin_wave_generator, args=args2, kwargs={"flip": True}).start()
+Thread(target=examples.sin_wave_add_square_wave_generator, args=args3).start()
 examples.app.exec()
 examples.stop()

pglive/examples_pyqt6/__init__.py

@@ -18,6 +18,18 @@ def stop():
     running = False
     app.exit(0)
 
+def sin_wave_add_square_wave_generator(*data_connectors, flip=False):
+    """Sine wave + Square Wave generator"""
+    x = 0
+    while running:
+        x += 1
+        square_wave_amplitude = 0 if x // 750 % 2 == 0 else 5
+        for data_connector in data_connectors:
+            if flip:
+                data_connector.cb_append_data_point(x, sin(x * 0.025) + square_wave_amplitude)
+            else:
+                data_connector.cb_append_data_point(sin(x * 0.025) + square_wave_amplitude, x)
+        sleep(0.01)
 
 def sin_wave_generator(*data_connectors, flip=False):
     """Sine wave generator"""

pglive/examples_pyqt6/live_plot_range.py

@@ -18,6 +18,7 @@
 layout.layout.setSpacing(0)
 args = []
 args2 = []
+args3 = []
 
 '''
 Move view to the right on every 300 ticks (data update).
@@ -146,9 +147,45 @@
 layout.addWidget(time_axis_plot_widget, row=2, col=2)
 
 # ---
+'''
+Move view to the right on every 300 ticks (data update).
+Y range is automatically adjudicating every tick according to y_min_range_width set.
+'''
+widget = LivePlotWidget(title=f"Rolling X view range, auto Y range @ 100Hz @ Min Range Width 3.0",
+                        y_range_controller=LiveAxisRange(y_min_range_width=3.0))
+plot = LiveLinePlot(pen="green")
+widget.addItem(plot)
+layout.addWidget(widget, row=3, col=0)
+args3.append(DataConnector(plot, max_points=300, update_rate=100))
+
+# ---
+'''
+Move view to the right on every 300 ticks (data update).
+Y range is automatically adjudicating every tick according to y_range_limit set.
+'''
+widget = LivePlotWidget(title=f"Rolling X view range, auto Y range @ 100Hz @ Range Limit -1.0, 1.0",
+                        y_range_controller=LiveAxisRange(y_range_limit=[-1.0, 1.0]))
+plot = LiveLinePlot(pen="green")
+widget.addItem(plot)
+layout.addWidget(widget, row=3, col=1)
+args3.append(DataConnector(plot, max_points=300, update_rate=100))
+
+# ---
+'''
+Move view to the right on every 300 ticks (data update).
+Y range is automatically adjudicating every tick according to y_min_range_width and y_range_limit set.
+
+'''
+widget = LivePlotWidget(title=f"Rolling X view range, auto Y range @ 100Hz @ Min Range Width 3.0 @ Range Limit -1.0, 3.0",
+                        y_range_controller=LiveAxisRange(y_min_range_width=3.0, y_range_limit=[-1.0, 3.0]))
+plot = LiveLinePlot(pen="green")
+widget.addItem(plot)
+layout.addWidget(widget, row=3, col=2)
+args3.append(DataConnector(plot, max_points=300, update_rate=100))
 
 layout.show()
 Thread(target=examples.sin_wave_generator, args=args).start()
 Thread(target=examples.sin_wave_generator, args=args2, kwargs={"flip": True}).start()
+Thread(target=examples.sin_wave_add_square_wave_generator, args=args3).start()
 examples.app.exec()
 examples.stop()

pglive/examples_pyside6/__init__.py

@@ -18,6 +18,18 @@ def stop():
     running = False
     app.exit(0)
 
+def sin_wave_add_square_wave_generator(*data_connectors, flip=False):
+    """Sine wave + Square Wave generator"""
+    x = 0
+    while running:
+        x += 1
+        square_wave_amplitude = 0 if x // 750 % 2 == 0 else 5
+        for data_connector in data_connectors:
+            if flip:
+                data_connector.cb_append_data_point(x, sin(x * 0.025) + square_wave_amplitude)
+            else:
+                data_connector.cb_append_data_point(sin(x * 0.025) + square_wave_amplitude, x)
+        sleep(0.01)
 
 def sin_wave_generator(*data_connectors, flip=False):
     """Sine wave generator"""

pglive/examples_pyside6/live_plot_range.py

@@ -18,6 +18,7 @@
 layout.layout.setSpacing(0)
 args = []
 args2 = []
+args3 = []
 
 '''
 Move view to the right on every 300 ticks (data update).
@@ -146,10 +147,46 @@
 layout.addWidget(time_axis_plot_widget, row=2, col=2)
 
 # ---
+'''
+Move view to the right on every 300 ticks (data update).
+Y range is automatically adjudicating every tick according to y_min_range_width set.
+'''
+widget = LivePlotWidget(title=f"Rolling X view range, auto Y range @ 100Hz @ Min Range Width 3.0",
+                        y_range_controller=LiveAxisRange(y_min_range_width=3.0))
+plot = LiveLinePlot(pen="green")
+widget.addItem(plot)
+layout.addWidget(widget, row=3, col=0)
+args3.append(DataConnector(plot, max_points=300, update_rate=100))
+
+# ---
+'''
+Move view to the right on every 300 ticks (data update).
+Y range is automatically adjudicating every tick according to y_range_limit set.
+'''
+widget = LivePlotWidget(title=f"Rolling X view range, auto Y range @ 100Hz @ Range Limit -1.0, 1.0",
+                        y_range_controller=LiveAxisRange(y_range_limit=[-1.0, 1.0]))
+plot = LiveLinePlot(pen="green")
+widget.addItem(plot)
+layout.addWidget(widget, row=3, col=1)
+args3.append(DataConnector(plot, max_points=300, update_rate=100))
+
+# ---
+'''
+Move view to the right on every 300 ticks (data update).
+Y range is automatically adjudicating every tick according to y_min_range_width and y_range_limit set.
+
+'''
+widget = LivePlotWidget(title=f"Rolling X view range, auto Y range @ 100Hz @ Min Range Width 3.0 @ Range Limit -1.0, 3.0",
+                        y_range_controller=LiveAxisRange(y_min_range_width=3.0, y_range_limit=[-1.0, 3.0]))
+plot = LiveLinePlot(pen="green")
+widget.addItem(plot)
+layout.addWidget(widget, row=3, col=2)
+args3.append(DataConnector(plot, max_points=300, update_rate=100))
 
 layout.show()
 Thread(target=examples.sin_wave_generator, args=args).start()
 Thread(target=examples.sin_wave_generator, args=args2, kwargs={"flip": True}).start()
+Thread(target=examples.sin_wave_add_square_wave_generator, args=args3).start()
 
 signal.signal(signal.SIGINT, lambda sig, frame: examples.stop())
 examples.app.exec()

pglive/sources/live_axis_range.py

@@ -13,6 +13,10 @@ def __init__(
         offset_top: float = 0.0,
         offset_bottom: float = 0.0,
         fixed_range: Optional[List[float]] = None,
+        x_min_range_width: Optional[float] = None,
+        x_range_limit: Optional[List[float]] = None,
+        y_min_range_width: Optional[float] = None,
+        y_range_limit: Optional[List[float]] = None,
     ) -> None:
         self.roll_on_tick = roll_on_tick
         self.offset_left = offset_left
@@ -24,6 +28,10 @@ def __init__(
         self.crop_top_offset_to_data = False
         self.crop_bottom_offset_to_data = False
         self.fixed_range = fixed_range
+        self.x_min_range_width = x_min_range_width
+        self.x_range_limit = x_range_limit
+        self.y_min_range_width = y_min_range_width
+        self.y_range_limit = y_range_limit
         self.x_range: Dict[str, List[float]] = {}
         self.y_range: Dict[str, List[float]] = {}
         self.final_x_range = [0.0, 0.0]
@@ -65,11 +73,12 @@ def get_x_range(self, data_connector, tick: int) -> List[float]:
                 final_range[0] = x_range[0]
             if final_range[1] < x_range[1]:
                 final_range[1] = x_range[1]
-        if final_range[0] == final_range[1]:
+        if final_range[0] == final_range[1] and self.x_min_range_width is not None:
             # Pyqtgraph ViewBox.setRange doesn't like same value for min and max,
             # therefore in that case we must set some range
             final_range[0] -= 0.4
             final_range[1] += 0.4
+        final_range = self._update_range_width(self.x_range_limit, self.x_min_range_width, final_range)
         if self.final_x_range != final_range:
             self.final_x_range = final_range
         return self.final_x_range
@@ -88,11 +97,12 @@ def recalculate_x_range(self):
                 final_range[1] = x_range[1]
         if final_range is None:
             final_range = [0, 0]
-        if final_range[0] == final_range[1]:
+        if final_range[0] == final_range[1] and self.x_min_range_width is not None:
             # Pyqtgraph ViewBox.setRange doesn't like same value for min and max,
             # therefore in that case we must set some range
             final_range[0] -= 0.4
             final_range[1] += 0.4
+        final_range = self._update_range_width(self.x_range_limit, self.x_min_range_width, final_range)
         if self.final_x_range != final_range:
             self.final_x_range = final_range
         return self.final_x_range
@@ -132,11 +142,12 @@ def get_y_range(self, data_connector, tick: int) -> List[float]:
                 final_range[0] = y_range[0]
             if final_range[1] < y_range[1]:
                 final_range[1] = y_range[1]
-        if final_range[0] == final_range[1]:
+        if final_range[0] == final_range[1] and self.y_min_range_width is None:
             # Pyqtgraph ViewBox.setRange doesn't like same value for min and max,
             # therefore in that case we must set some range
             final_range[0] -= 0.4
             final_range[1] += 0.4
+        final_range = self._update_range_width(self.y_range_limit, self.y_min_range_width, final_range)
         if self.final_y_range != final_range:
             self.final_y_range = final_range
         return self.final_y_range
@@ -155,11 +166,12 @@ def recalculate_y_range(self):
                 final_range[1] = y_range[1]
         if final_range is None:
             final_range = [0, 0]
-        if final_range[0] == final_range[1]:
+        if final_range[0] == final_range[1] and self.y_min_range_width is None:
             # Pyqtgraph ViewBox.setRange doesn't like same value for min and max,
             # therefore in that case we must set some range
             final_range[0] -= 0.4
             final_range[1] += 0.4
+        final_range = self._update_range_width(self.y_range_limit, self.y_min_range_width, final_range)
         if self.final_y_range != final_range:
             self.final_y_range = final_range
         return self.final_y_range
@@ -199,6 +211,25 @@ def _get_range(
         else:
             return None
 
+    def _update_range_width(self, bound, range_width, final_range):
+        if range_width is not None:
+            if abs(final_range[0] - final_range[1]) < range_width:
+                center_pt = (final_range[0] + final_range[1]) / 2
+                final_range[0] = center_pt - range_width / 2
+                final_range[1] = center_pt + range_width / 2
+
+        if bound is not None:
+            final_range_width = abs(final_range[0] - final_range[1])
+            if (bound[0] > final_range[1] and bound[0] > final_range[0]) or \
+                (bound[1] < final_range[1] and bound[0] < final_range[0]) or \
+                (bound[0] > final_range[0] and bound[1] < final_range[1]):
+                final_range = bound
+            elif bound[1] > final_range[0] and final_range[0] > bound[0]:
+                final_range = [max(bound[1] - final_range_width, bound[0]), bound[1]]
+            elif bound[0] < final_range[1] and final_range[1] < bound[1]:
+                final_range = [bound[0], min(bound[0] + final_range_width, bound[1])]
+        return final_range
+
     def ignore_connector(self, data_connector, flag: bool) -> None:
         if not flag:
             self.ignored_data_connectors.append(data_connector.__hash__())