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

pymodaq/control_modules/utils.py

@@ -15,7 +15,7 @@ from qtpy.QtCore import Signal, QObject, Qt, Slot, QThread
 from pymodaq_utils.utils import ThreadCommand, find_dict_in_list_from_key_val
 from pymodaq_utils.config import Config
 from pymodaq_utils.enums import BaseEnum, enum_checker
-from pymodaq_utils.logger import get_base_logger
+from pymodaq_utils.logger import get_base_logger, set_logger, get_module_name
 
 from pymodaq_gui.utils.custom_app import CustomApp
 from pymodaq_gui.parameter import Parameter, ioxml
@@ -76,7 +76,9 @@ DET_TYPES = {'DAQ0D': get_plugins('daq_0Dviewer'),
 if len(DET_TYPES['DAQ0D']) == 0:
     raise DetectorError('No installed Detector')
 
+
 config = Config()
+logger = set_logger(get_module_name(__file__))
 
 
 class ViewerError(Exception):
@@ -134,6 +136,9 @@ class ControlModule(QObject):
     def __repr__(self):
         return f'{self.__class__.__name__}: {self.title}'
 
+    def custom_command(self, command: str, **kwargs):
+        self.command_hardware.emit(ThreadCommand(command, kwargs))
+
     def thread_status(self, status: ThreadCommand, control_module_type='detector'):
         """Get back info (using the ThreadCommand object) from the hardware
 
@@ -144,7 +149,8 @@ class ControlModule(QObject):
         ----------
         status: ThreadCommand
             The info returned from the hardware, the command (str) can be either:
-                * Update_Status: display messages and log info
+                * Update_Status: display messages and log info (deprecated)
+                * update_status: display info on the UI status bar
                 * close: close the current thread and delete corresponding attribute on cascade.
                 * update_settings: Update the "detector setting" node in the settings tree.
                 * update_main_settings: update the "main setting" node in the settings tree
@@ -160,6 +166,9 @@ class ControlModule(QObject):
             else:
                 self.update_status(status.attribute[0])
 
+        elif status.command == 'update_status':
+            self.update_status(status.attribute)
+
         elif status.command == "close":
             try:
                 self.update_status(status.attribute[0])
@@ -173,7 +182,7 @@ class ControlModule(QObject):
                     self._hardware_thread.terminate()
                     self.update_status('thread is locked?!', 'log')
             except Exception as e:
-                self.logger.exception(str(e))
+                logger.exception(f'Wrong call to the "close" command: \n{str(e)}')
 
             self._initialized_state = False
             self.init_signal.emit(self._initialized_state)
@@ -188,7 +197,7 @@ class ControlModule(QObject):
                 elif status.attribute[2] == 'options':
                     self.settings.child('main_settings', *status.attribute[0]).setOpts(**status.attribute[1])
             except Exception as e:
-                self.logger.exception(str(e))
+                logger.exception(f'Wrong call to the "update_main_settings" command: \n{str(e)}')
 
         elif status.command == 'update_settings':
             # using this the settings shown in the UI for the plugin reflects the real plugin settings
@@ -196,7 +205,7 @@ class ControlModule(QObject):
                 self.settings.sigTreeStateChanged.disconnect(
                     self.parameter_tree_changed)  # any changes on the detcetor settings will update accordingly the gui
             except Exception as e:
-                self.logger.exception(str(e))
+                logger.exception(str(e))
             try:
                 if status.attribute[2] == 'value':
                     self.settings.child(f'{control_module_type}_settings',
@@ -215,9 +224,18 @@ class ControlModule(QObject):
                                         *status.attribute[0]).addChild(status.attribute[1][0])
 
             except Exception as e:
-                self.logger.exception(str(e))
+                logger.exception(f'Wrong call to the "update_settings" command: \n{str(e)}')
             self.settings.sigTreeStateChanged.connect(self.parameter_tree_changed)
 
+        elif status.command == 'update_ui':
+            try:
+                if self.ui is not None:
+                    if hasattr(self.ui, status.attribute):
+                        getattr(self.ui, status.attribute)(*status.args,
+                                                           **status.kwargs)
+            except Exception as e:
+                logger.info(f'Wrong call to the "update_ui" command: \n{str(e)}')
+
         elif status.command == 'raise_timeout':
             self.raise_timeout()
 
@@ -301,7 +319,7 @@ class ControlModule(QObject):
     def show_log(self):
         """Open the log file in the default text editor"""
         import webbrowser
-        webbrowser.open(get_base_logger(self.logger).handlers[0].baseFilename)
+        webbrowser.open(get_base_logger(logger).handlers[0].baseFilename)
 
     def show_config(self, config: Config) -> Config:
         """ Display in a tree the current configuration"""
@@ -326,7 +344,7 @@ class ControlModule(QObject):
             self.ui.display_status(txt)
         self.status_sig.emit(txt)
         if log:
-            self.logger.info(txt)
+            logger.info(txt)
 
     def manage_ui_actions(self, action_name: str, attribute: str, value):
         """Method to manage actions for the UI (if any).
@@ -364,7 +382,6 @@ class ParameterControlModule(ParameterManager, ControlModule):
     listener_class: Type[ActorListener] = ActorListener
 
     def __init__(self, **kwargs):
-        QObject.__init__(self)
         ParameterManager.__init__(self, action_list=('save', 'update'))
         ControlModule.__init__(self)
 

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
 
@@ -15,11 +15,18 @@ from pymodaq_utils.config import Config, get_set_local_dir
 from pymodaq.utils.tcp_ip.tcp_server_client import TCPServer, tcp_parameters
 from pymodaq_data.data import DataToExport, DataRaw
 from pymodaq_utils.warnings import deprecation_msg
-from pymodaq.utils.tcp_ip.mysocket import Socket
-from pymodaq.utils.tcp_ip.serializer import DeSerializer, Serializer
+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
 
-comon_parameters = [{'title': 'Controller Status:', 'name': 'controller_status', 'type': 'list', 'value': 'Master',
-                     'limits': ['Master', 'Slave']}, ]
+from pymodaq_gui.utils.utils import mkQApp
+
+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
@@ -39,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},
@@ -92,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
@@ -104,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()
@@ -120,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
@@ -228,7 +232,8 @@ class DAQ_Viewer_base(QObject):
         """
         pass
 
-    def ini_detector_init(self, old_controller=None, new_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
@@ -239,13 +244,18 @@ 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
             The particular object that allow the communication with the hardware, in general a python wrapper around the
             hardware library. In case of Master it is the new instance of your plugin controller
         """
+        if old_controller is None and slave_controller is not None:
+            old_controller = slave_controller
         self.status.update(edict(info="", controller=None, initialized=False))
         if self.settings['controller_status'] == "Slave":
             if old_controller is None:
@@ -291,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')