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

pymodaq/utils/parameter/pymodaq_ptypes/tableview.py

@@ -1,149 +0,0 @@
-from qtpy import QtWidgets, QtCore
-from collections import OrderedDict
-from pyqtgraph.parametertree.Parameter import ParameterItem
-from pyqtgraph.parametertree.parameterTypes.basetypes import WidgetParameterItem
-from pyqtgraph.parametertree import Parameter
-from pyqtgraph.widgets import ColorButton
-
-
-class TableViewCustom(QtWidgets.QTableView):
-    """
-        ============== ===========================
-        *Attributes**    **Type**
-        *valuechanged*   instance of pyqt Signal
-        *QtWidgets*      instance of QTableWidget
-        ============== ===========================
-    """
-
-    valueChanged = QtCore.Signal(list)
-    add_data_signal = QtCore.Signal(int)
-    remove_row_signal = QtCore.Signal(int)
-    load_data_signal = QtCore.Signal()
-    save_data_signal = QtCore.Signal()
-
-    def __init__(self, menu=False):
-        super().__init__()
-        self.setmenu(menu)
-
-    def setmenu(self, status):
-        if status:
-            self.menu = QtWidgets.QMenu()
-            self.menu.addAction('Add new', self.add)
-            self.menu.addAction('Remove selected row', self.remove)
-            self.menu.addAction('Clear all', self.clear)
-            self.menu.addSeparator()
-            self.menu.addAction('Load as txt', lambda: self.load_data_signal.emit())
-            self.menu.addAction('Save as txt', lambda: self.save_data_signal.emit())
-        else:
-            self.menu = None
-
-    def clear(self):
-        self.model().clear()
-
-    def add(self):
-        self.add_data_signal.emit(self.currentIndex().row())
-
-    def remove(self):
-        self.remove_row_signal.emit(self.currentIndex().row())
-
-    def data_has_changed(self, topleft, bottomright, roles):
-        self.valueChanged.emit([topleft, bottomright, roles])
-
-    def get_table_value(self):
-        """
-
-        """
-        return self.model()
-
-    def set_table_value(self, data_model):
-        """
-
-        """
-        try:
-            self.setModel(data_model)
-            self.model().dataChanged.connect(self.data_has_changed)
-        except Exception as e:
-            pass
-
-    def contextMenuEvent(self, event):
-        if self.menu is not None:
-            self.menu.exec(event.globalPos())
-
-
-class TableViewParameterItem(WidgetParameterItem):
-    def makeWidget(self):
-        """
-            Make and initialize an instance of Table_custom.
-
-            Returns
-            -------
-            table : instance of Table_custom.
-                The initialized table.
-
-            See Also
-            --------
-            Table_custom
-        """
-        self.asSubItem = True
-        self.hideWidget = False
-        menu = False
-        opts = self.param.opts
-        if 'menu' in opts:
-            menu = opts['menu']
-        w = TableViewCustom(menu=menu)
-
-        if 'tip' in opts:
-            w.setToolTip(opts['tip'])
-        w.horizontalHeader().setSectionResizeMode(QtWidgets.QHeaderView.Stretch)
-        #w.setMaximumHeight(200)
-        # self.table.setReadOnly(self.param.opts.get('readonly', False))
-        w.value = w.get_table_value
-        w.setValue = w.set_table_value
-        w.sigChanged = w.valueChanged
-        return w
-
-    def optsChanged(self, param, opts):
-        """
-            | Called when any options are changed that are not name, value, default, or limits.
-            |
-            | If widget is a SpinBox, pass options straight through.
-            | So that only the display label is shown when visible option is toggled.
-
-            =============== ================================== ==============================
-            **Parameters**    **Type**                           **Description**
-            *param*           instance of pyqtgraph parameter    the parameter to check
-            *opts*            string list                        the associated options list
-            =============== ================================== ==============================
-
-            See Also
-            --------
-            optsChanged
-        """
-        # print "opts changed:", opts
-        ParameterItem.optsChanged(self, param, opts)
-
-        if 'delegate' in opts:
-            styledItemDelegate = QtWidgets.QStyledItemDelegate()
-            styledItemDelegate.setItemEditorFactory(opts['delegate']())
-            self.widget.setItemDelegate(styledItemDelegate)
-
-        if 'menu' in opts:
-            self.widget.setmenu(opts['menu'])
-
-
-class TableViewParameter(Parameter):
-    """
-        =============== =================================
-        **Attributes**    **Type**
-        *itemClass*       instance of TableParameterItem
-        *Parameter*       instance of pyqtgraph parameter
-        =============== =================================
-    """
-    itemClass = TableViewParameterItem
-
-    def setValue(self, value):
-        self.opts['value'] = value
-        self.sigValueChanged.emit(self, value)
-
-
-

pymodaq/utils/parameter/pymodaq_ptypes/text.py

@@ -1,142 +0,0 @@
-import os
-from pathlib import Path
-from qtpy import QtWidgets, QtCore, QtGui
-from pyqtgraph.parametertree.Parameter import ParameterItem
-from pyqtgraph.parametertree.parameterTypes.basetypes import WidgetParameterItem
-from pyqtgraph.parametertree import Parameter
-
-
-class PlainTextWidget(QtWidgets.QWidget):
-    """
-        ================ ========================
-        **Attributes**    **Type**
-        *value_changed*   instance of pyqt Signal
-        ================ ========================
-
-        See Also
-        --------
-        initUI, emitsignal
-    """
-    value_changed = QtCore.Signal(str)
-
-    def __init__(self):
-
-        super().__init__()
-
-        self.initUI()
-        self.text_edit.textChanged.connect(self.emitsignal)
-
-    def emitsignal(self):
-        """
-            Emit the value changed signal from the text_edit attribute.
-        """
-        text = self.text_edit.toPlainText()
-        self.value_changed.emit(text)
-
-    def set_value(self, txt):
-        """
-            Set the value of the text_edit attribute.
-
-            =============== =========== ================================
-            **Parameters**    **Type**    **Description**
-            *txt*             string      the string value to be setted
-            =============== =========== ================================
-        """
-        self.text_edit.setPlainText(txt)
-
-    def get_value(self):
-        """
-            Get the value of the text_edit attribute.
-
-            Returns
-            -------
-            string
-                The string value of text_edit.
-        """
-        return self.text_edit.toPlainText()
-
-    def initUI(self):
-        """
-            Init the User Interface.
-        """
-
-        self.hor_layout = QtWidgets.QHBoxLayout()
-        self.text_edit = QtWidgets.QPlainTextEdit()
-        self.text_edit.setReadOnly(True)
-        self.text_edit.setMaximumHeight(50)
-
-        self.add_pb = QtWidgets.QPushButton()
-        self.add_pb.setText("")
-        icon3 = QtGui.QIcon()
-        icon3.addPixmap(QtGui.QPixmap(":/icons/Icon_Library/Add2.png"), QtGui.QIcon.Normal, QtGui.QIcon.Off)
-        self.add_pb.setIcon(icon3)
-        self.hor_layout.addWidget(self.text_edit)
-
-        verlayout = QtWidgets.QVBoxLayout()
-        verlayout.addWidget(self.add_pb)
-        verlayout.addStretch()
-        self.hor_layout.addLayout(verlayout)
-        self.hor_layout.setSpacing(0)
-        self.setLayout(self.hor_layout)
-
-
-class PlainTextParameterItem(WidgetParameterItem):
-
-    def __init__(self, param, depth):
-        super().__init__(param, depth)
-        self.hideWidget = False
-        self.subItem = QtWidgets.QTreeWidgetItem()
-        self.addChild(self.subItem)
-
-    def treeWidgetChanged(self):
-        # # TODO: fix so that superclass method can be called
-        # # (WidgetParameter should just natively support this style)
-        # WidgetParameterItem.treeWidgetChanged(self)
-        if self.treeWidget() is not None:
-            self.treeWidget().setFirstItemColumnSpanned(self.subItem, True)
-            self.treeWidget().setItemWidget(self.subItem, 0, self.w)
-
-            # for now, these are copied from ParameterItem.treeWidgetChanged
-            self.setHidden(not self.param.opts.get('visible', True))
-            self.setExpanded(self.param.opts.get('expanded', True))
-
-    def makeWidget(self):
-        """
-            Make and initialize an instance of Plain_text_pb object from parameter options dictionnary (using 'readonly' key).
-
-            Returns
-            -------
-            Plain_text_pb object
-                The initialized object.
-
-            See Also
-            --------
-            Plain_text_pb, buttonClicked
-        """
-        self.w = PlainTextWidget()
-        self.w.text_edit.setReadOnly(self.param.opts.get('readonly', False))
-        self.w.value = self.w.get_value
-        self.w.setValue = self.w.set_value
-        self.w.sigChanged = self.w.value_changed
-        self.w.add_pb.clicked.connect(self.buttonClicked)
-        return self.w
-
-    def buttonClicked(self):
-        text, ok = QtWidgets.QInputDialog.getText(None, "Enter a value to add to the parameter",
-                                                  "String value:", QtWidgets.QLineEdit.Normal)
-        if ok and not (text == ""):
-            self.param.setValue(self.param.value() + '\n' + text)
-
-
-class PlainTextPbParameter(Parameter):
-    """Editable string; displayed as large text box in the tree."""
-    itemClass = PlainTextParameterItem
-    sigActivated = QtCore.Signal(object)
-
-    def activate(self):
-        """
-            Send the Activated signal.
-        """
-        self.sigActivated.emit(self)
-        self.emitStateChanged('activated', None)
-

pymodaq/utils/plotting/data_viewers/__init__.py

@@ -1,10 +0,0 @@
-from .base import ViewersEnum
-
-from .viewer0D import Viewer0D
-from .viewer1D import Viewer1D
-from .viewer2D import Viewer2D
-from .viewerND import ViewerND
-from .viewer import ViewerDispatcher
-
-
-DATA_TYPES = ['Data0D', 'Data1D', 'Data2D', 'DataND']

pymodaq/utils/plotting/data_viewers/base.py

@@ -1,286 +0,0 @@
-
-from typing import Union, TYPE_CHECKING, Iterable
-
-from pymodaq.utils.enums import BaseEnum
-from pyqtgraph.graphicsItems import InfiniteLine, ROI
-from qtpy import QtWidgets
-from qtpy.QtCore import QObject, Signal, QRectF
-
-from pymodaq.utils.data import DataToExport, DataWithAxes, DataDim, DataDistribution
-from pymodaq.utils.exceptions import ViewerError
-from pymodaq.utils.plotting.utils.plot_utils import RoiInfo
-
-if TYPE_CHECKING:
-    from pymodaq.utils.plotting.data_viewers.viewer0D import Viewer0D
-    from pymodaq.utils.plotting.data_viewers.viewer1D import Viewer1D
-    from pymodaq.utils.plotting.data_viewers.viewer2D import Viewer2D
-    from pymodaq.utils.plotting.data_viewers.viewerND import ViewerND
-
-
-class ViewersEnum(BaseEnum):
-    """enum relating a given viewer with data type"""
-    Viewer0D = 'Data0D'
-    Viewer1D = 'Data1D'
-    Viewer2D = 'Data2D'
-    ViewerND = 'DataND'
-    ViewerSequential = 'DataSequential'
-
-    def get_dim(self):
-        return self.value.split('Data')[1].split('D')[0]
-
-    def increase_dim(self, ndim: int):
-        dim = self.get_dim()
-        if dim != 'N':
-            dim_as_int = int(dim) + ndim
-            if dim_as_int > 2:
-                dim = 'N'
-            else:
-                dim = str(dim_as_int)
-        else:
-            dim = 'N'
-        return ViewersEnum[f'Viewer{dim}D']
-
-    @classmethod
-    def from_n_axes(cls, n_axes: int):
-        if n_axes == 0:
-            return ViewersEnum['Viewer0D']
-        elif n_axes == 1:
-            return ViewersEnum['Viewer1D']
-        elif n_axes == 2:
-            return ViewersEnum['Viewer2D']
-        elif n_axes > 2:
-            return ViewersEnum['ViewerND']
-
-    @staticmethod
-    def get_viewers_enum_from_metadata(dim: DataDim,
-                                       distribution: DataDistribution,
-                                       n_nav_axes: int,
-                                       n_sig_indexes: int,
-                                       shape_len: int,
-                                       size: int) -> 'ViewersEnum':
-        if dim.name == 'Data0D':
-            viewer = 'Viewer0D'
-        elif dim.name == 'Data1D':
-            viewer = 'Viewer1D'
-        elif dim.name == 'Data2D':
-            viewer = 'Viewer2D'
-        else:
-            if distribution.name == 'uniform':
-                if shape_len < 3:
-                    if shape_len == 1 and size == 1:
-                        viewer = 'Viewer0D'
-                    elif shape_len == 1 and size > 1:
-                        viewer = 'Viewer1D'
-                    elif shape_len == 2:
-                        viewer = 'Viewer2D'
-                    else:
-                        viewer = 'ViewerND'
-                else:
-                    viewer = 'ViewerND'
-            else:
-                if n_sig_indexes == 0:
-                    if n_nav_axes == 1:
-                        viewer = 'Viewer1D'
-                    elif n_nav_axes == 2:
-                        viewer = 'Viewer2D'
-                    else:
-                        viewer = 'ViewerND'
-                else:
-                    viewer = 'ViewerND'
-        return ViewersEnum[viewer]
-
-    @staticmethod
-    def get_viewers_enum_from_data(dwa: DataWithAxes) -> 'ViewersEnum':
-        if dwa.dim.name == 'Data0D':
-            viewer = 'Viewer0D'
-        elif dwa.dim.name == 'Data1D':
-            viewer = 'Viewer1D'
-        elif dwa.dim.name == 'Data2D':
-            viewer = 'Viewer2D'
-        else:
-            if dwa.distribution.name == 'uniform':
-                if len(dwa.shape) < 3:
-                    dwa.nav_indexes = ()
-                    if len(dwa.shape) == 1 and dwa.size == 1:
-                        viewer = 'Viewer0D'
-                    elif len(dwa.shape) == 1 and dwa.size > 1:
-                        viewer = 'Viewer1D'
-                    elif len(dwa.shape) == 2:
-                        viewer = 'Viewer2D'
-                    else:
-                        viewer = 'ViewerND'
-                else:
-                    viewer = 'ViewerND'
-            else:
-                if len(dwa.sig_indexes) == 0:
-                    if len(dwa.get_nav_axes()) == 1:
-                        viewer = 'Viewer1D'
-                    elif len(dwa.get_nav_axes()) == 2:
-                        viewer = 'Viewer2D'
-                    else:
-                        viewer = 'ViewerND'
-                else:
-                    viewer = 'ViewerND'
-        return ViewersEnum[viewer]
-
-
-class ViewerBase(QObject):
-    """Base Class for data viewers implementing all common functionalities
-
-    Parameters
-    ----------
-    parent: QtWidgets.QWidget
-    title: str
-
-    Attributes
-    ----------
-    view: QObject
-        Ui interface of the viewer
-
-    data_to_export_signal: Signal[DataToExport]
-    ROI_changed: Signal
-    crosshair_dragged: Signal[float, float]
-    crosshair_clicked: Signal[bool]
-    sig_double_clicked: Signal[float, float]
-    status_signal: Signal[str]
-    """
-    data_to_export_signal = Signal(DataToExport)
-    _data_to_show_signal = Signal(DataWithAxes)
-
-    ROI_changed = Signal()
-    crosshair_dragged = Signal(float, float)  # Crosshair position in units of scaled top/right axes
-    status_signal = Signal(str)
-    crosshair_clicked = Signal(bool)
-    sig_double_clicked = Signal(float, float)
-    ROI_select_signal = Signal(QRectF)  # deprecated: use roi_select_signal
-    roi_select_signal = Signal(RoiInfo)
-
-    def __init__(self, parent: QtWidgets.QWidget = None, title=''):
-        super().__init__()
-        self.title = title if title != '' else self.__class__.__name__
-
-        self._raw_data = None
-        self.data_to_export: DataToExport = DataToExport(name=self.title)
-        self.view: Union[Viewer0D, Viewer1D, Viewer2D, ViewerND] = None
-
-        if parent is None:
-            parent = QtWidgets.QWidget()
-            parent.show()
-        self.parent = parent
-
-        self._display_temporary = False
-
-    @property
-    def has_action(self):
-        """Convenience method"""
-        if hasattr(self.view, 'has_action'):
-            return self.view.has_action
-
-    @property
-    def is_action_checked(self):
-        """Convenience method"""
-        if hasattr(self.view, 'is_action_checked'):
-            return self.view.is_action_checked
-
-    @property
-    def is_action_visible(self):
-        """Convenience method"""
-        if hasattr(self.view, 'is_action_visible'):
-            return self.view.is_action_visible
-
-    @property
-    def set_action_checked(self):
-        """Convenience method"""
-        if hasattr(self.view, 'set_action_checked'):
-            return self.view.set_action_checked
-
-    @property
-    def set_action_visible(self):
-        """Convenience method"""
-        if hasattr(self.view, 'set_action_visible'):
-            return self.view.set_action_visible
-
-    @property
-    def get_action(self):
-        """Convenience method"""
-        if hasattr(self.view, 'get_action'):
-            return self.view.get_action
-
-    @property
-    def toolbar(self):
-        """Convenience property"""
-        if hasattr(self.view, 'toolbar'):
-            return self.view.toolbar
-
-    @property
-    def viewer_type(self):
-        """str: the viewer data type see DATA_TYPES"""
-        return ViewersEnum[self.__class__.__name__].value
-
-    def show_data(self, data: DataWithAxes, **kwargs):
-        """Entrypoint to display data into the viewer
-
-        Parameters
-        ----------
-        data: data_mod.DataFromPlugins
-        """
-        if len(data.shape) > 4:
-            raise ViewerError(f'Ndarray of dim: {len(data.shape)} cannot be plotted using a {self.viewer_type}')
-
-        self.data_to_export = DataToExport(name=self.title)
-        self._raw_data = data
-
-        self._display_temporary = False
-
-        self._show_data(data, **kwargs)
-
-    def show_data_temp(self, data: DataWithAxes, **kwargs):
-        """Entrypoint to display temporary data into the viewer
-
-        No processed data signal is emitted from the viewer
-
-        Parameters
-        ----------
-        data: data_mod.DataFromPlugins
-        """
-        self._display_temporary = True
-        self.show_data(data, **kwargs)
-
-    def _show_data(self, data: DataWithAxes, *args, **kwargs):
-        """Specific viewers should implement it"""
-        raise NotImplementedError
-
-    def add_attributes_from_view(self):
-        """Convenience function to add attributes from the view to self"""
-        for attribute in self.convenience_attributes:
-            if hasattr(self.view, attribute):
-                setattr(self, attribute, getattr(self.view, attribute))
-
-    def trigger_action(self, action_name: str):
-        """Convenience function to trigger programmatically one of the action of the related view"""
-        if self.has_action(action_name):
-            self.get_action(action_name).trigger()
-
-    def activate_roi(self, activate=True):
-        """Activate the Roi manager using the corresponding action"""
-        raise NotImplementedError
-
-    def setVisible(self, show=True):
-        """convenience method to show or hide the paretn widget"""
-        self.parent.setVisible(show)
-
-    @property
-    def roi_target(self) -> Union[InfiniteLine.InfiniteLine, ROI.ROI]:
-        """To be implemented if necessary (Viewer1D and above)"""
-        return None
-
-    def move_roi_target(self, pos: Iterable[float] = None, **kwargs):
-        """move a specific read only ROI at the given position on the viewer"""
-        ...
-
-    def show_roi_target(self, show=True):
-        """Show/Hide a specific read only ROI"""
-        if self.roi_target is not None:
-            self.roi_target.setVisible(show)
-
-