pymagnetos 0.1.0__py3-none-any.whl

pymagnetos/core/gui/widgets/_graphs.py

@@ -0,0 +1,93 @@
+"""
+The graphs area that holds all the plots.
+
+The plots themselves should be placed on a custom layout by subclass. This Base class
+merely provides plots behavior :
+- mouse coordinates on hover,
+- CRTL+click to zoom in an area.
+"""
+
+from functools import partial
+
+import pyqtgraph as pg
+from PyQt6 import QtWidgets
+from PyQt6.QtCore import QEvent, Qt
+from PyQt6.QtGui import QKeyEvent
+
+
+class BaseGraphsWidget(QtWidgets.QWidget):
+    """Base class for the graphs area with all the plots."""
+
+    _plots_list: set[pg.PlotWidget]
+
+    def __init__(self) -> None:
+        super().__init__()
+
+        # Internal flags
+        self._mouse_pan_mode = True
+
+        # Registered plots
+        self._plots_list = set()
+
+        # Get pens
+        self.init_plot_style()
+
+    def init_plot_style(self) -> None:
+        """Set and store QPen for styling of curves and ROIs."""
+        raise NotImplementedError("Subclass must implement this method.")
+
+    def event(self, ev: QEvent) -> bool:
+        """Handle mouse selection while holding CTRL to make a ROI zoom in plots."""
+        # Switch to rectangular zoom selection on the first Ctrl key press event
+        if ev.type() == QKeyEvent.Type.KeyPress and ev.key() == Qt.Key.Key_Control:
+            if self._mouse_pan_mode:
+                self.switch_mouse_pan_mode(False)
+
+        # Switch back to pan mode on left click when releasing the Ctrl key
+        if ev.type() == QKeyEvent.Type.KeyRelease and ev.key() == Qt.Key.Key_Control:
+            self.switch_mouse_pan_mode(True)
+
+        return super().event(ev)
+
+    def switch_mouse_pan_mode(self, state: bool) -> None:
+        """
+        Switch mouse behavior from panning to ROI-zooming when holding CTRL.
+
+        Parameters
+        ----------
+        state : bool
+            If True, all plots are set to pan mode, otherwise they are set in ROI-zoom
+            mode.
+        """
+        # Get mode
+        mode = pg.ViewBox.PanMode if state else pg.ViewBox.RectMode
+        self._mouse_pan_mode = state
+
+        # Set mode for all registered plots
+        for plot in self._plots_list:
+            plot.getPlotItem().getViewBox().setMouseMode(mode)
+
+    def init_coordinates_on_hover(self) -> None:
+        """Add x, y coordinates on mouse hover for all registered plots."""
+        for plot in self._plots_list:
+            self.coordinates_on_hover(plot)
+
+    def coordinates_on_hover(self, plot) -> None:
+        """Add x, y coordinates on mouse hover."""
+        plot.scene().sigMouseMoved.connect(partial(self.mouse_moved_in_plot, plot))
+        plot.setLabel("top", "x=, y=")
+        plot.getAxis("top").setStyle(showValues=False)
+
+    def mouse_moved_in_plot(self, plot, evt) -> None:
+        """Define what happens when the mouse moves within a plot."""
+        pos = evt
+        if plot.getPlotItem().sceneBoundingRect().contains(pos):
+            vb = plot.getPlotItem().getViewBox()
+            mouse_point = vb.mapSceneToView(pos)
+            label_text = f"x={mouse_point.x():0.6f}, y={mouse_point.y():0.6f}"
+            plot.setLabel("top", label_text)
+
+    def clear_all_plots(self) -> None:
+        """Clear plots."""
+        for plot in self._plots_list:
+            plot.clearPlots()

pymagnetos/core/gui/widgets/_param_content.py

@@ -0,0 +1,20 @@
+"""
+Define various parameters to set in a PyQtGraph Parameter Tree.
+
+To be able to automatically update them from the configuration file, their name should
+match exactly the one in the configuration file.
+Use the "title" kwarg to set the displayed name on the widget.
+
+It is used in the ConfigurationWidget.
+"""
+
+
+class BaseParamContent:
+    PARAMS_TO_PARSE: list[str]
+    children_files: list[dict[str, str | bool]] = [
+        dict(name="file", type="file", value="", title="Configuration file"),
+        dict(name="expid", type="str", value="", readonly=False, title="Experiment ID"),
+        dict(name="autoload", type="bool", value=True, title="Load data automatically"),
+    ]
+    children_parameters: list[dict[str, str | bool | list | float | int | None]]
+    children_settings: list[dict[str, str | bool | list | float | int | None]]

pymagnetos/core/gui/widgets/_popup_progressbar.py

@@ -0,0 +1,29 @@
+"""A standalone progress bar window that emits its progress."""
+
+from PyQt6 import QtWidgets
+from PyQt6.QtCore import pyqtSlot
+
+
+class PopupProgressBar(QtWidgets.QWidget):
+    """Pop-up progress bar."""
+
+    def __init__(self, min: int = 0, max: int = 100, title: str = ""):
+        # Setup window
+        super().__init__()
+        self.pbar = QtWidgets.QProgressBar(self)
+        self.pbar.setGeometry(30, 40, 500, 75)
+        self.pbar.setMinimum(min)
+        self.pbar.setMaximum(max)
+
+        vlayout = QtWidgets.QVBoxLayout(self)
+        vlayout.addWidget(self.pbar)
+        self.setLayout(vlayout)
+        self.setGeometry(300, 300, 550, 100)
+        self.setWindowTitle(title)
+
+    def start_progress(self):
+        self.show()
+
+    @pyqtSlot(int)
+    def update_progress(self, idx: int):
+        self.pbar.setValue(idx + 1)

pymagnetos/core/gui/widgets/_text_logger.py

@@ -0,0 +1,32 @@
+"""A logging handler to print log stream in a text window."""
+
+import logging
+
+from PyQt6 import QtWidgets
+from PyQt6.QtCore import QObject, pyqtSignal
+
+
+class TextLoggerWidget(logging.Handler, QObject):
+    """
+    Logger handler to print log in a QTextEdit widget.
+
+    pyqtSignals
+    -------
+    sig_append_text : internal, emits the log message to be printed in the text box.
+    """
+
+    sig_append_text = pyqtSignal(str)
+    flushOnClose = True
+
+    def __init__(self, parent):
+        super().__init__()
+        QObject.__init__(self)
+
+        self.widget = QtWidgets.QPlainTextEdit(parent)
+        self.widget.setReadOnly(True)
+
+        self.sig_append_text.connect(self.widget.appendPlainText)
+
+    def emit(self, record: logging.LogRecord) -> None:
+        msg = self.format(record)
+        self.sig_append_text.emit(msg)