pymodaq 4.4.7__py3-none-any.whl → 5.0.1__py3-none-any.whl

pymodaq/control_modules/viewer_utility_classes.py

@@ -1,4 +1,4 @@
-from typing import Union
+from typing import Union, Iterable
 from qtpy import QtWidgets
 from qtpy.QtCore import QObject, Slot, Signal
 
@@ -9,16 +9,24 @@ from easydict import EasyDict as edict
 
 import numpy as np
 from pymodaq.utils.math_utils import gauss1D, gauss2D
-from pymodaq.utils.daq_utils import ThreadCommand, getLineInfo
-from pymodaq.utils.config import Config, get_set_local_dir
+from pymodaq_utils.utils import ThreadCommand, getLineInfo
+
+from pymodaq_utils.config import Config, get_set_local_dir
 from pymodaq.utils.tcp_ip.tcp_server_client import TCPServer, tcp_parameters
-from pymodaq.utils.data import DataToExport, DataRaw
-from pymodaq.utils.messenger import deprecation_msg
-from pymodaq.utils.tcp_ip.mysocket import Socket
-from pymodaq.utils.tcp_ip.serializer import DeSerializer, Serializer
+from pymodaq_data.data import DataToExport, DataRaw
+from pymodaq_utils.warnings import deprecation_msg
+from pymodaq_utils.serialize.mysocket import Socket
+from pymodaq_utils.serialize.serializer_legacy import DeSerializer, Serializer
+from pymodaq_gui.plotting.utils.plot_utils import RoiInfo
+
+from pymodaq_gui.utils.utils import mkQApp
 
-comon_parameters = [{'title': 'Controller Status:', 'name': 'controller_status', 'type': 'list', 'value': 'Master',
-                     'limits': ['Master', 'Slave']}, ]
+comon_parameters = [{'title': 'Controller Status:', 'name': 'controller_status', 'type': 'list',
+                     'value': 'Master',
+                     'limits': ['Master', 'Slave']},
+                    {'title': 'Controller ID:', 'name': 'controller_ID', 'type': 'int', 'value': 0,
+                     'default': 0, 'readonly': False},
+                    ]
 
 local_path = get_set_local_dir()
 # look for eventual calibration files
@@ -38,7 +46,7 @@ params = [
         {'title': 'Detector type:', 'name': 'detector_type', 'type': 'str', 'value': '', 'readonly': True},
         {'title': 'Detector Name:', 'name': 'module_name', 'type': 'str', 'value': '', 'readonly': True},
         {'title': 'Plugin Config:', 'name': 'plugin_config', 'type': 'bool_push', 'label': 'Show Config', },
-        {'title': 'Controller ID:', 'name': 'controller_ID', 'type': 'int', 'value': 0, 'default': 0, 'readonly': False},
+
         {'title': 'Show data and process:', 'name': 'show_data', 'type': 'bool', 'value': True, },
         {'title': 'Refresh time (ms):', 'name': 'refresh_time', 'type': 'float', 'value': 50., 'min': 0.},
         {'title': 'Naverage', 'name': 'Naverage', 'type': 'int', 'default': 1, 'value': 1, 'min': 1},
@@ -91,7 +99,7 @@ params = [
 ]
 
 
-def main(plugin_file=None, init=True):
+def main(plugin_file=None, init=True, title='Testing'):
     """
     this method start a DAQ_Viewer object with this defined plugin as detector
     Returns
@@ -103,10 +111,7 @@ def main(plugin_file=None, init=True):
     from pymodaq.control_modules.daq_viewer import DAQ_Viewer
     from pathlib import Path
 
-    app = QtWidgets.QApplication(sys.argv)
-    if config('style', 'darkstyle'):
-        import qdarkstyle
-        app.setStyleSheet(qdarkstyle.load_stylesheet())
+    app = mkQApp("PyMoDAQ Viewer")
 
     win = QtWidgets.QMainWindow()
     area = DockArea()
@@ -119,7 +124,7 @@ def main(plugin_file=None, init=True):
     else:
         detector = Path(plugin_file).stem[13:]
         det_type = f'DAQ{Path(plugin_file).stem[4:6].upper()}'
-    prog = DAQ_Viewer(area, title="Testing")
+    prog = DAQ_Viewer(area, title=title)
     win.show()
     prog.daq_type = det_type
     prog.detector = detector
@@ -227,7 +232,8 @@ class DAQ_Viewer_base(QObject):
         """
         pass
 
-    def ini_detector_init(self, old_controller=None, new_controller=None, slave_controller=None):
+    def ini_detector_init(self, old_controller=None, new_controller=None,
+                          slave_controller=None):
         """Manage the Master/Slave controller issue
 
         First initialize the status dictionary
@@ -238,7 +244,10 @@ class DAQ_Viewer_base(QObject):
 
         Parameters
         ----------
-        old_controller: object
+        old_controller: object (deprecated)
+            The particular object that allow the communication with the hardware, in general a python wrapper around the
+            hardware library. In case of Slave this one comes from a previously initialized plugin
+        slave_controller: object
             The particular object that allow the communication with the hardware, in general a python wrapper around the
             hardware library. In case of Slave this one comes from a previously initialized plugin
         new_controller: object
@@ -292,6 +301,33 @@ class DAQ_Viewer_base(QObject):
         """
         pass
 
+    def roi_select(self, roi_info: RoiInfo, ind_viewer: int = 0):
+        """ Every time a ROISelect is updated on a 2D Viewer,
+        this method receive the corresponding info
+
+        To be subclassed in a plugin to use the info
+
+        Parameters
+        ----------
+        roi_info: RoiInfo
+        ind_viewer: int
+            The index of the viewer (if multiple) in which the roi is declared
+        """
+        pass
+
+    def crosshair(self, crosshair_info: Iterable[float], ind_viewer: int = 0):
+        """ Every time a crosshair is updated, this method receive the corresponding info
+
+        To be subclassed in a plugin to use the info
+
+        Parameters
+        ----------
+        crosshair_info: list of float
+        ind_viewer: int
+            The index of the viewer (if multiple) in which the crosshair is declared
+        """
+        pass
+
     def get_axis(self):
         """deprecated"""
         raise DeprecationWarning('get_axis is deprecated add the axes within the DataWithAxes, '

pymodaq/daq_utils/daq_utils.py

@@ -0,0 +1,6 @@
+from pymodaq_utils import utils as daq_utils
+
+from pymodaq_utils.warnings import deprecation_msg
+
+deprecation_msg('Importing daq_utils stuff from pymodaq is deprecated in pymodaq>5.0.0,'
+                'please use the pymodaq_utils.utils module')