pymodaq 4.2.4__py3-none-any.whl → 5.0.0__py3-none-any.whl

pymodaq/utils/gui_utils/dock.py

@@ -1,107 +0,0 @@
-import warnings
-
-from qtpy.QtCore import Signal, QObject
-from qtpy import QtGui, QtCore, QtWidgets
-from pyqtgraph.dockarea import Dock, DockArea, DockLabel
-from pyqtgraph.dockarea.DockArea import TempAreaWindow
-from pyqtgraph.widgets.VerticalLabel import VerticalLabel
-
-
-class Dock(Dock):
-    dock_focused = Signal(str)
-    def __init__(self, name, *args, fontSize='20px', **kwargs):
-        kwargs['fontSize'] = fontSize
-        super().__init__(name, *args, **kwargs)
-
-    def removeWidgets(self):
-        for widget in self.widgets:
-            self.layout.removeWidget(widget)
-            widget.close()
-        self.widgets = []
-
-    def setOrientation(self, o='auto', force=False):
-        """
-        Sets the orientation of the title bar for this Dock.
-        Must be one of 'auto', 'horizontal', or 'vertical'.
-        By default ('auto'), the orientation is determined
-        based on the aspect ratio of the Dock.
-        """
-        if self.container() is not None:  # patch here for when Dock is closed and when the QApplication
-            # event loop is processed
-            if o == 'auto' and self.autoOrient:
-                if self.container().type() == 'tab':
-                    o = 'horizontal'
-                elif self.width() > self.height() * 1.5:
-                    o = 'vertical'
-                else:
-                    o = 'horizontal'
-            if force or self.orientation != o:
-                self.orientation = o
-                self.label.setOrientation(o)
-                self.updateStyle()
-
-
-class DockArea(DockArea, QObject):
-    """
-    Custom Dockarea class subclassing from the standard DockArea class and QObject so it can emit a signal when docks
-    are moved around (one subclassed method: moveDock)
-    See Also
-    --------
-    pyqtgraph.dockarea
-    """
-    dock_signal = Signal()
-
-    def __init__(self, parent=None, temporary=False, home=None):
-        super(DockArea, self).__init__(parent, temporary, home)
-
-    def moveDock(self, dock, position, neighbor):
-        """
-        Move an existing Dock to a new location.
-        """
-        # Moving to the edge of a tabbed dock causes a drop outside the tab box
-        if position in ['left', 'right', 'top',
-                        'bottom'] and neighbor is not None and neighbor.container() is not None and neighbor.container().type() == 'tab':
-            neighbor = neighbor.container()
-        self.addDock(dock, position, neighbor)
-        self.dock_signal.emit()
-
-    def addTempArea(self):
-        if self.home is None:
-            area = DockArea(temporary=True, home=self)
-            self.tempAreas.append(area)
-            win = TempAreaWindow(area)
-            area.win = win
-            win.show()
-        else:
-            area = self.home.addTempArea()
-        # print "added temp area", area, area.window()
-        return area
-
-
-if __name__ == '__main__':
-    import sys
-    from pymodaq.utils.parameter import ParameterTree
-    app = QtWidgets.QApplication(sys.argv)
-    import qdarkstyle
-    app.setStyleSheet(qdarkstyle.load_stylesheet(qdarkstyle.DarkPalette))
-
-    labelv = DockLabel('mysuperlabel', fontSize='25px')
-    docky = Dock('MysuperDockLogger', fontSize='30px')
-    dockx = Dock('MysuperDockLoggerx', fontSize='30px')
-    area = DockArea()
-    area.addDock(docky)
-    area.addDock(dockx)
-    dockx.addWidget(ParameterTree())
-    labelv.setAlignment(QtCore.Qt.AlignmentFlag.AlignTop | QtCore.Qt.AlignmentFlag.AlignHCenter)
-    f = labelv.font()
-    f.setPixelSize(25)
-    labelv.setFont(f)
-    docky.label.setFont(f)
-    labelv.show()
-    area.show()
-    QtWidgets.QApplication.processEvents()
-    print(f'labelv size hint: {labelv.sizeHint()}')
-    print(f'labelv size: {labelv.size()}')
-    print(f'labelv margins: {labelv.contentsMargins().top()}, {labelv.contentsMargins().bottom()}')
-
-    sys.exit(app.exec())

pymodaq/utils/gui_utils/file_io.py

@@ -1,93 +0,0 @@
-from pathlib import Path
-
-from pymodaq.utils.config import Config
-from qtpy import QtWidgets
-
-config = Config()
-
-
-def select_file_filter(start_path=config('data_saving', 'h5file', 'save_path'), save=True, ext=None, filter=None,
-                force_save_extension=False):
-    """Opens a selection file popup for loading or saving a file
-
-    Parameters
-    ----------
-    start_path: str or Path
-        The strating point in the file/folder system to open the popup from
-    save: bool
-        if True, ask you to enter a filename (with or without extension)
-    ext: str
-        the extension string, e.g. xml, h5, png ...
-    filter: list of string
-        list of possible extensions, mostly valid for loading
-    force_save_extension: bool
-        if True force the extension of the saved file to be set to ext
-
-    Returns
-    -------
-    Path: the Path object of the file to save or load
-    str: the selected filter
-    """
-    if ext is None:
-        ext = '.h5'
-
-    if filter is None:
-        if not save:
-            if not isinstance(ext, list):
-                ext = [ext]
-            filter = "Data files ("
-            for ext_tmp in ext:
-                filter += '*.' + ext_tmp + " "
-            filter += ")"
-
-    if start_path is not None:
-        if not isinstance(start_path, str):
-            start_path = str(start_path)
-    if save:
-        fname, selected_filter = QtWidgets.QFileDialog.getSaveFileName(None, 'Enter a file name', start_path,
-                                                                       filter)
-    else:
-        fname, selected_filter = QtWidgets.QFileDialog.getOpenFileName(None, 'Select a file name', start_path, filter)
-
-    if fname != '':  # execute if the user didn't cancel the file selection
-        fname = Path(fname)
-        if save and force_save_extension:
-            parent = fname.parent
-            filename = fname.stem
-            fname = parent.joinpath(filename + "." + ext)  # forcing the right extension on the filename
-    return fname, selected_filter
-
-
-def select_file(start_path=config('data_saving', 'h5file', 'save_path'), save=True, ext=None, filter=None,
-                force_save_extension=False):
-    """Opens a selection file popup for loading or saving a file
-
-    Parameters
-    ----------
-    start_path: str or Path
-        The strating point in the file/folder system to open the popup from
-    save: bool
-        if True, ask you to enter a filename (with or without extension)
-    ext: str
-        the extension string, e.g. xml, h5, png ...
-    filter: string
-        list of possible extensions, if you need several you can separate them by ;;
-        for example: "Images (*.png *.xpm *.jpg);;Text files (*.txt);;XML files (*.xml)"
-    force_save_extension: bool
-        if True force the extension of the saved file to be set to ext
-
-    Returns
-    -------
-    Path: the Path object of the file to save or load
-    """
-    fname, selected_filter = select_file_filter(start_path, save, ext, filter,
-                                                force_save_extension)
-    return fname  # fname is a Path object
-
-
-if __name__ == '__main__':
-    import sys
-    app = QtWidgets.QApplication(sys.argv)
-    file = select_file(save=True, filter="Images (*.png *.xpm *.jpg);;Text files (*.txt);;XML files (*.xml)")
-    print(file)
-    sys.exit(app.exec_())

pymodaq/utils/gui_utils/layout.py

@@ -1,34 +0,0 @@
-import pickle
-
-from pymodaq.utils import config as config_mod
-from pymodaq.utils.gui_utils.file_io import select_file
-
-
-def load_layout_state(dockarea, file=None):
-    """
-        Load and restore a dockarea layout state from the select_file obtained pathname file.
-    """
-    if file is None:
-        file = select_file(start_path=config_mod.get_set_layout_path(), save=False, ext='dock')
-    if file is not None:
-        with open(str(file), 'rb') as f:
-            dockstate = pickle.load(f)
-            dockarea.restoreState(dockstate)
-    file = file.name
-    return file
-
-
-def save_layout_state(dockarea, file=None):
-    """
-        Save the current layout state in the select_file obtained pathname file.
-        Once done dump the pickle.
-    """
-
-    dockstate = dockarea.saveState()
-    if 'float' in dockstate:
-        dockstate['float'] = []
-    if file is None:
-        file = select_file(start_path=config_mod.get_set_layout_path(), save=True, ext='dock')
-    if file is not None:
-        with open(str(file), 'wb') as f:
-            pickle.dump(dockstate, f, pickle.HIGHEST_PROTOCOL)

pymodaq/utils/gui_utils/list_picker.py

@@ -1,38 +0,0 @@
-from qtpy.QtCore import QObject
-from qtpy import QtWidgets
-
-
-class ListPicker(QObject):
-
-    def __init__(self, list_str):
-        super(ListPicker, self).__init__()
-        self.list = list_str
-
-    def pick_dialog(self):
-        self.dialog = QtWidgets.QDialog()
-        self.dialog.setMinimumWidth(500)
-        vlayout = QtWidgets.QVBoxLayout()
-
-        self.list_widget = QtWidgets.QListWidget()
-        self.list_widget.addItems(self.list)
-
-        vlayout.addWidget(self.list_widget, 10)
-        self.dialog.setLayout(vlayout)
-
-        buttonBox = QtWidgets.QDialogButtonBox()
-        buttonBox.addButton('Apply', buttonBox.AcceptRole)
-        buttonBox.accepted.connect(self.dialog.accept)
-        buttonBox.addButton('Cancel', buttonBox.RejectRole)
-        buttonBox.rejected.connect(self.dialog.reject)
-
-        vlayout.addWidget(buttonBox)
-        self.dialog.setWindowTitle('Select an entry in the list')
-
-        res = self.dialog.show()
-
-        pass
-        if res == self.dialog.Accepted:
-            # save managers parameters in a xml file
-            return [self.list_widget.currentIndex(), self.list_widget.currentItem().text()]
-        else:
-            return [-1, ""]

pymodaq/utils/gui_utils/widgets/__init__.py

@@ -1,5 +0,0 @@
-from .qled import QLED
-from .push import PushButtonIcon, EditPush, EditPushRel
-from .spinbox import QSpinBox_ro, SpinBox
-from .table import TableView, TableModel
-from .label import LabelWithFont

pymodaq/utils/gui_utils/widgets/label.py

@@ -1,24 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
-Created the 29/07/2022
-
-@author: Sebastien Weber
-"""
-
-from qtpy import QtWidgets, QtCore, QtGui
-
-
-class LabelWithFont(QtWidgets.QLabel):
-
-    def __init__(self, text: str = '', *args, font_name=None, font_size=None, isbold=False, isitalic=False, **kwargs):
-        super().__init__(text, *args, **kwargs)
-
-        font = QtGui.QFont()
-        if font_name is not None:
-            font.setFamily(font_name)
-        if font_size is not None:
-            font.setPointSize(font_size)
-
-        font.setBold(isbold)
-        font.setItalic(isitalic)
-        self.setFont(font)

pymodaq/utils/gui_utils/widgets/lcd.py

@@ -1,111 +0,0 @@
-from typing import List
-
-import numpy as np
-
-from qtpy import QtWidgets
-from qtpy.QtCore import QObject
-from pymodaq.utils.plotting.data_viewers.viewer0D import Viewer0D
-from pymodaq.utils.data import DataRaw
-import sys
-
-
-class LCD(QObject):
-
-    def __init__(self, parent, **kwargs):
-        super().__init__()
-        self.Nvals = None
-        self.labels = None
-        self.parent = parent
-        self.viewer0D = None
-        self.digits = 3
-        self.setupui(**kwargs)
-
-    def setvalues(self, values: List[np.ndarray]):
-        """
-        display values on lcds
-        Parameters
-        ----------
-        values: list of 0D ndarray
-
-        Returns
-        -------
-
-        """
-        while len(values) < self.Nvals:
-            values.append(np.array([0.]))
-        if len(values) > self.Nvals:
-            values = values[:self.Nvals]
-        vals = []
-        for ind, val in enumerate(values):
-            self.lcds[ind].display(val[0])
-            vals.append(val)
-        self.viewer0D.show_data(DataRaw(name='LCD', data=values))
-
-    def setupui(self, **kwargs):
-        if 'digits' in kwargs:
-            self.digits = kwargs['digits']
-        if 'Nvals' in kwargs:
-            self.Nvals = kwargs['Nvals']
-        else:
-            self.Nvals = 1
-        if 'labels' in kwargs:
-            self.labels = kwargs['labels']
-        else:
-            self.labels = ['CH{:d}'.format(ind) for ind in range(self.Nvals)]
-
-        while len(self.labels) < self.Nvals:
-            self.labels.append('')
-
-        vlayout = QtWidgets.QVBoxLayout()
-        hsplitter = QtWidgets.QSplitter()
-        vlayout.addWidget(hsplitter)
-        self.parent.setLayout(vlayout)
-        form = QtWidgets.QWidget()
-        self.viewer0D = Viewer0D(form)
-        self.viewer0D.labels = self.labels
-
-        vlayout = QtWidgets.QVBoxLayout()
-
-        lcd_layouts = []
-        labels = []
-        self.lcds = []
-
-        for ind in range(self.Nvals):
-            lcd_layouts.append(QtWidgets.QVBoxLayout())
-            labels.append(QtWidgets.QLabel(self.labels[ind]))
-            labels[-1].setSizePolicy(QtWidgets.QSizePolicy.Preferred, QtWidgets.QSizePolicy.Maximum)
-            self.lcds.append(QtWidgets.QLCDNumber())
-            self.lcds[-1].setDigitCount(self.digits)
-            lcd_layouts[-1].addWidget(labels[-1])
-            lcd_layouts[-1].addWidget(self.lcds[-1])
-            vlayout.addLayout(lcd_layouts[-1])
-
-            if ind != self.Nvals - 1:
-                hFrame = QtWidgets.QFrame()
-                hFrame.setFrameShape(QtWidgets.QFrame.HLine)
-                vlayout.addWidget(hFrame)
-
-        lcd_widget = QtWidgets.QWidget()
-        lcd_widget.setLayout(vlayout)
-        hsplitter.addWidget(lcd_widget)
-        hsplitter.addWidget(form)
-        self.parent.resize(800, 500)
-        hsplitter.setSizes([400, 300])
-
-
-if __name__ == '__main__':
-    from pymodaq.utils.math_utils import gauss1D
-    import numpy as np
-
-    x = np.linspace(0, 200, 201)
-    y1 = gauss1D(x, 75, 25)
-    y2 = gauss1D(x, 120, 50, 2)
-    app = QtWidgets.QApplication(sys.argv)
-    Form = QtWidgets.QWidget()
-
-    prog = LCD(Form, Nvals=2)
-    Form.show()
-    for ind, data in enumerate(y1):
-        prog.setvalues([data])
-        QtWidgets.QApplication.processEvents()
-    sys.exit(app.exec_())

pymodaq/utils/gui_utils/widgets/push.py

@@ -1,149 +0,0 @@
-from pathlib import Path
-
-from qtpy import QtWidgets, QtCore, QtGui
-from qtpy.QtWidgets import QWidget
-from pymodaq.utils.gui_utils.widgets.spinbox import SpinBox
-
-
-EDIT_PUSH_TYPES = ['abs', 'rel']
-
-
-class PushButtonIcon(QtWidgets.QPushButton):
-    def __init__(self, icon_name: str, text: str, checkable=False, tip="", menu=None):
-        super().__init__(text)
-        self._menu = menu
-        if icon_name != '':
-            icon = QtGui.QIcon()
-            if Path(icon_name).is_file():
-                icon.addPixmap(QtGui.QPixmap(icon_name), QtGui.QIcon.Normal,
-                               QtGui.QIcon.Off)
-            else:
-                icon.addPixmap(QtGui.QPixmap(f":/icons/Icon_Library/{icon_name}.png"), QtGui.QIcon.Normal,
-                               QtGui.QIcon.Off)
-            self.setIcon(icon)
-        self.setCheckable(checkable)
-        self.setToolTip(tip)
-        
-    def contextMenuEvent(self, event):
-        if self._menu is not None:
-            self._menu.exec(event.globalPos())
-
-
-class EditPushInfo:
-    def __init__(self, type:str, value: float):
-        if type not in EDIT_PUSH_TYPES:
-            raise ValueError(f'Possible types are {EDIT_PUSH_TYPES}')
-        self.type = type
-        self.value = value
-
-
-class EditPush(QtWidgets.QWidget):
-    clicked = QtCore.Signal(EditPushInfo)
-
-    def __init__(self, icon_name: str, ini_value=0.1, text=''):
-        super().__init__()
-        self._edit_push_type = 'abs'
-        self.setLayout(QtWidgets.QHBoxLayout())
-        self._edit = SpinBox(value=ini_value, dec=True, step=0.1, minStep=0.001)
-        self._edit.setMinimumHeight(20)
-        self._edit.setMaximumWidth(60)
-        self._edit.setMinimumWidth(60)
-        self.layout().addWidget(self._edit)
-        self.set_pushs(icon_name, text)
-
-    def set_pushs(self, icon_name, text):
-        self._push = PushButtonIcon(icon_name, text)
-        self._push.setMaximumWidth(40)
-        self._push.clicked.connect(lambda: self.emit_clicked())
-        self.layout().addWidget(self._push)
-
-    def emit_clicked(self, coeff=1):
-        """will emit a signal containing a float value calculated from the product of the coeff and the internal
-        spinbox value.
-
-        See Also
-        --------
-        EditPushRel
-        """
-        self.clicked.emit(EditPushInfo(type=self._edit_push_type, value=coeff * self._edit.value()))
-
-
-class EditPushRel(EditPush):
-
-    def __init__(self, icon_name: str, text='', ini_value=0.15):
-        super().__init__(icon_name, text=text, ini_value=ini_value)
-        self._edit_push_type = 'rel'
-
-    def set_pushs(self, icon_name, text):
-        vlayout = QtWidgets.QVBoxLayout()
-        self.layout().addLayout(vlayout)
-
-        self._push_plus = PushButtonIcon(icon_name, f'+{text}')
-        self._push_plus.setMaximumWidth(40)
-        self._push_minus = PushButtonIcon(icon_name, f'-{text}')
-        self._push_minus.setMaximumWidth(40)
-
-        vlayout.addWidget(self._push_plus)
-        vlayout.addWidget(self._push_minus)
-
-        self._push_plus.clicked.connect(lambda: self.emit_clicked(1))
-        self._push_minus.clicked.connect(lambda: self.emit_clicked(-1))
-
-
-class ActionMenu(QtWidgets.QAction):
-    def __init__(self, *args, menu=None, **kwargs):
-        super().__init__(*args, **kwargs)
-        self._menu = menu
-
-    def contextMenuEvent(self, event):
-        if self._menu is not None:
-            self._menu.exec(event.globalPos())
-
-
-def main(init_qt=True):
-    import sys
-
-    if init_qt:  # used for the test suite
-        app = QtWidgets.QApplication(sys.argv)
-
-    widget = QtWidgets.QWidget()
-    widget.setLayout(QtWidgets.QVBoxLayout())
-    toolbar = QtWidgets.QToolBar()
-    widget.layout().addWidget(toolbar)
-
-    action = QtWidgets.QAction('blabla')
-    toolbar.addAction(action)
-
-    menu1 = QtWidgets.QMenu()
-    menu1.addAction('Add new task')
-    menu1.addAction('Edit current row')
-    menu1.addAction('Remove selected rows')
-    menu1.addSeparator()
-    menu1.addAction('Affect Responsable')
-    menu2 = QtWidgets.QMenu()
-    menu2.addAction('Affect volunteers')
-    menu2.addAction('Remove volunteers')
-    menu2.addSeparator()
-    menu2.addAction('Show localisation')
-
-    icon = QtGui.QIcon()
-    icon.addPixmap(QtGui.QPixmap(f":/icons/Icon_Library/{'run2'}.png"), QtGui.QIcon.Normal,
-                   QtGui.QIcon.Off)
-    action2 = ActionMenu(icon, 'grab', menu=menu1)
-
-    toolbar.addAction(action2)
-    grab_pb = PushButtonIcon('run2', text='', checkable=True, menu=menu2)
-    grab_pb.setFlat(True)
-    toolbar.addWidget(grab_pb)
-
-    otherpb = PushButtonIcon('run2', 'grab me')
-    widget.layout().addWidget(otherpb)
-
-    widget.show()
-    if init_qt:
-        sys.exit(app.exec_())
-
-
-if __name__ == '__main__':
-    main()
-

pymodaq/utils/gui_utils/widgets/qled.py

@@ -1,62 +0,0 @@
-import os
-import numpy as np
-from qtpy import QtCore, QtGui, QtWidgets
-from qtpy.QtWidgets import QLabel
-from qtpy.QtCore import QObject, Signal
-from pymodaq.utils.gui_utils.utils import clickable
-
-
-class QLED(QLabel):
-    value_changed = Signal(bool)
-
-    def __init__(self, parent=None, scale=1, readonly=True):
-        QLabel.__init__(self, parent)
-        # self.setText("")
-        self.red_icon = QtGui.QPixmap(":/icons/Icon_Library/red_light.png")
-        self.green_icon = QtGui.QPixmap(":/icons/Icon_Library/greenLight2.png")
-        self.setPixmap(self.red_icon)
-        self.state = False
-        self.clickable = not readonly
-        # set the possibility to click and control the state of the LED otherwise it behaves as an indicator
-        clickable(self).connect(
-            self.LED_Clicked)
-        # clickable is a function importing a filter class to deal with mouse down event as a signal see GUI_utils
-        self.setText("empty")
-        self.setMaximumWidth(self.height())
-        if scale != 1:
-            self.scale(scale)
-        self.set_as_false()
-
-    def scale(self, scale):
-        self.green_icon = self.green_icon.scaled(scale * self.green_icon.width(),
-                                                 scale * self.green_icon.height())
-        self.red_icon = self.red_icon.scaled(scale * self.red_icon.width(),
-                                             scale * self.red_icon.height())
-
-    def get_state(self):
-        return self.state
-
-    def set_as(self, state=True):
-
-        if state:
-            self.set_as_true()
-        else:
-            self.set_as_false()
-        if state != self.state:
-            self.value_changed.emit(state)
-
-    def set_as_true(self):
-        self.state = True
-        self.setPixmap(self.green_icon)
-
-    def set_as_false(self):
-        self.state = False
-        self.setPixmap(self.red_icon)
-
-    def LED_Clicked(self):
-        if self.clickable:
-            if self.state:
-                self.set_as_false()
-            else:
-                self.set_as_true()
-            self.value_changed.emit(not self.state)

pymodaq/utils/gui_utils/widgets/spinbox.py

@@ -1,24 +0,0 @@
-from qtpy import QtWidgets, QtGui
-from pyqtgraph.widgets.SpinBox import SpinBox
-
-
-class SpinBox(SpinBox):
-    """
-    In case I want to add pyqtgraph spinbox functionalities
-    """
-    def __init__(self, *args, font_size=None, min_height=20, **kwargs):
-        super().__init__(*args, **kwargs)
-
-        if font_size is not None:
-            font = QtGui.QFont()
-            font.setPointSize(font_size)
-            self.setFont(font)
-        self.setMinimumHeight(min_height)
-
-
-class QSpinBox_ro(SpinBox):
-    def __init__(self, *args, readonly=True, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.setMaximum(100000)
-        self.setReadOnly(readonly)
-        self.setButtonSymbols(QtWidgets.QAbstractSpinBox.NoButtons)