pymodaq 5.0.17__py3-none-any.whl → 5.1.0__py3-none-any.whl

pymodaq/utils/managers/modules_manager.py

@@ -1,4 +1,4 @@
-from typing import List, Union, TYPE_CHECKING
+from typing import List, Union, TYPE_CHECKING, Optional, Sequence
 
 from collections import OrderedDict
 from qtpy.QtCore import QObject, Signal, Slot, QThread
@@ -15,14 +15,16 @@ from pymodaq_gui.managers.parameter_manager import ParameterManager
 from pymodaq_gui.utils import Dock
 
 from pymodaq.utils.data import DataActuator
-
+from pymodaq.utils.config import Config as ControlModulesConfig
 
 if TYPE_CHECKING:
     from pymodaq.control_modules.daq_viewer import DAQ_Viewer
     from pymodaq.control_modules.daq_move import DAQ_Move
 
 logger = set_logger(get_module_name(__file__))
-config = Config()
+
+config_utils = Config()
+config = ControlModulesConfig()
 
 
 class ModulesManager(QObject, ParameterManager):
@@ -68,9 +70,26 @@ class ModulesManager(QObject, ParameterManager):
         ]},
     ]
 
-    def __init__(self, detectors=[], actuators=[], selected_detectors=[], selected_actuators=[], **kwargs):
+    def __init__(self,
+                 detectors: Optional[Sequence['DAQ_Viewer']] = None,
+                 actuators: Optional[Sequence['DAQ_Move']] = None,
+                 selected_detectors: Optional[Sequence['DAQ_Viewer']] = None,
+                 selected_actuators: Optional[Sequence['DAQ_Move']] = None,
+                 parent_name='',
+                 **kwargs):
+
         QObject.__init__(self)
         ParameterManager.__init__(self)
+        if detectors is None:
+            detectors = []
+        if actuators is None:
+            actuators = []
+        if selected_detectors is None:
+            selected_detectors = []
+        if selected_actuators is None:
+            selected_actuators = []
+
+        self.parent_name = parent_name
 
         for mod in selected_actuators:
             assert mod in actuators
@@ -100,6 +119,9 @@ class ModulesManager(QObject, ParameterManager):
         self.set_actuators(actuators, selected_actuators)
         self.set_detectors(detectors, selected_detectors)
 
+    def __repr__(self):
+        return f'ModulesManager of "{self.parent_name}" with control modules: {self.get_names(self.modules_all)}'
+
     def show_only_control_modules(self, show: True):
         self.settings.child('move_done').show(not show)
         self.settings.child('det_done').show(not show)
@@ -197,7 +219,7 @@ class ModulesManager(QObject, ParameterManager):
 
     @property
     def modules(self):
-        """Get the list of all detectors and actuators"""
+        """Get the list of detectors and actuators"""
         return self.detectors + self.actuators
 
     @property
@@ -257,25 +279,28 @@ class ModulesManager(QObject, ParameterManager):
     def get_det_data_list(self) -> DataToExport:
         """Do a snap of selected detectors, to get the list of all the data and processed data"""
 
-        self.connect_detectors()
-        datas: DataToExport = self.grab_data()
-
-        data_list0D = datas.get_full_names('data0D')
-        data_list1D = datas.get_full_names('data1D')
-        data_list2D = datas.get_full_names('data2D')
-        data_listND = datas.get_full_names('dataND')
-
-        self.settings.child('data_dimensions', 'det_data_list0D').setValue(
-            dict(all_items=data_list0D, selected=[]))
-        self.settings.child('data_dimensions', 'det_data_list1D').setValue(
-            dict(all_items=data_list1D, selected=[]))
-        self.settings.child('data_dimensions', 'det_data_list2D').setValue(
-            dict(all_items=data_list2D, selected=[]))
-        self.settings.child('data_dimensions', 'det_data_listND').setValue(
-            dict(all_items=data_listND, selected=[]))
-
-        self.connect_detectors(False)
-        return datas
+        if len(self.detectors) == 0:
+            return DataToExport(name=__class__.__name__, control_module='DAQ_Viewer')
+        else:
+            self.connect_detectors()
+            datas: DataToExport = self.grab_data()
+
+            data_list0D = datas.get_full_names('data0D')
+            data_list1D = datas.get_full_names('data1D')
+            data_list2D = datas.get_full_names('data2D')
+            data_listND = datas.get_full_names('dataND')
+
+            self.settings.child('data_dimensions', 'det_data_list0D').setValue(
+                dict(all_items=data_list0D, selected=[]))
+            self.settings.child('data_dimensions', 'det_data_list1D').setValue(
+                dict(all_items=data_list1D, selected=[]))
+            self.settings.child('data_dimensions', 'det_data_list2D').setValue(
+                dict(all_items=data_list2D, selected=[]))
+            self.settings.child('data_dimensions', 'det_data_listND').setValue(
+                dict(all_items=data_listND, selected=[]))
+
+            self.connect_detectors(False)
+            return datas
 
     def get_selected_probed_data(self, dim='0D'):
         """Get the name of selected data names of a given dimensionality
@@ -287,26 +312,42 @@ class ModulesManager(QObject, ParameterManager):
         """
         return self.settings.child('data_dimensions', f'det_data_list{dim.upper()}').value()['selected']
 
-    def grab_data(self, **kwargs):
-        """Do a single grab of connected and selected detectors"""
+    def grab_data(self, check_do_override=True, **kwargs):
+        """Do a single grab of connected and selected detectors
+
+        Parameter
+        ---------
+        check_do_override: bool
+            If this is True the signal emission to the DAQ_Viewers will be conditionned to the status of their internal
+            override_grab_from_extension attribute
+        """
         self.det_done_datas = DataToExport(name=__class__.__name__, control_module='DAQ_Viewer')
         self._received_data = 0
         self.det_done_flag = False
         self.settings.child('det_done').setValue(self.det_done_flag)
         tzero = time.perf_counter()
+        
+        if 'DataMixer' in self.selected_detectors_name:
+            overridden_detectors = self.get_mod_from_name(
+                'DataMixer', 'det').settings.child(
+                'detector_settings', 'overridden_detectors').opts['limits']
+        else:
+            overridden_detectors = []
 
         for mod in self.detectors:
-            kwargs.update(dict(Naverage=mod.Naverage))
-            mod.command_hardware.emit(utils.ThreadCommand("single", kwargs))
+            #if not (check_do_override and mod.override_grab_from_extension):
+            if mod.title not in overridden_detectors:    
+                kwargs.update(dict(Naverage=mod.Naverage))
+                mod.command_hardware.emit(utils.ThreadCommand("single", kwargs))
 
         while not self.det_done_flag:
             # wait for grab done signals to end
-
-            QtWidgets.QApplication.processEvents()
-            if time.perf_counter() - tzero > self.detector_timeout:
+            QtWidgets.QApplication.processEvents()  # mandatory for the det_done_flag boolean to be modified in the corresponding method
+            if time.perf_counter() - tzero > self.detector_timeout / 1000:
                 self.timeout_signal.emit(True)
                 logger.error('Timeout Fired during waiting for data to be acquired')
                 break
+            QThread.msleep(10)
 
         self.det_done_signal.emit(self.det_done_datas)
         return self.det_done_datas
@@ -453,12 +494,12 @@ class ModulesManager(QObject, ParameterManager):
         if polling:
             while not self.move_done_flag:  # polling move done
 
-                QtWidgets.QApplication.processEvents()
+                QtWidgets.QApplication.processEvents()  # mandatory for the det_done_flag boolean to be modified in the corresponding method
                 if time.perf_counter() - tzero > self.actuator_timeout / 1000:  # timeout in seconds
                     self.timeout_signal.emit(True)
                     logger.error('Timeout Fired during waiting for actuators to be moved')
                     break
-                QThread.msleep(20)
+                QThread.msleep(10)
 
         self.move_done_signal.emit(self.move_done_positions)
         return self.move_done_positions

pymodaq/utils/managers/overshoot_manager.py

@@ -1,4 +1,5 @@
 from qtpy import QtWidgets
+from qtpy.QtWidgets import QMessageBox, QDialogButtonBox, QDialog
 import sys
 import os
 
@@ -121,13 +122,13 @@ class OvershootManager:
         self._activated = False
 
         if msgbox:
-            msgBox = QtWidgets.QMessageBox()
+            msgBox = QMessageBox()
             msgBox.setText("Overshoot Manager?")
             msgBox.setInformativeText("What do you want to do?")
-            cancel_button = msgBox.addButton(QtWidgets.QMessageBox.Cancel)
-            new_button = msgBox.addButton("New", QtWidgets.QMessageBox.ActionRole)
-            modify_button = msgBox.addButton('Modify', QtWidgets.QMessageBox.AcceptRole)
-            msgBox.setDefaultButton(QtWidgets.QMessageBox.Cancel)
+            cancel_button = msgBox.addButton(QMessageBox.StandardButton.Cancel)
+            new_button = msgBox.addButton("New", QMessageBox.ButtonRole.ActionRole)
+            modify_button = msgBox.addButton("Modify", QMessageBox.ButtonRole.AcceptRole)
+            msgBox.setDefaultButton(QMessageBox.StandardButton.Cancel)
             ret = msgBox.exec()
 
             if msgBox.clickedButton() == new_button:
@@ -173,7 +174,7 @@ class OvershootManager:
         """
 
         """
-        dialog = QtWidgets.QDialog()
+        dialog = QDialog()
         vlayout = QtWidgets.QVBoxLayout()
         tree = ParameterTree()
         tree.setMinimumWidth(400)
@@ -182,18 +183,18 @@ class OvershootManager:
 
         vlayout.addWidget(tree)
         dialog.setLayout(vlayout)
-        buttonBox = QtWidgets.QDialogButtonBox(parent=dialog)
+        buttonBox = QDialogButtonBox(parent=dialog)
 
-        buttonBox.addButton('Save', buttonBox.AcceptRole)
+        buttonBox.addButton("Save", QDialogButtonBox.ButtonRole.AcceptRole)
         buttonBox.accepted.connect(dialog.accept)
-        buttonBox.addButton('Cancel', buttonBox.RejectRole)
+        buttonBox.addButton("Cancel", QDialogButtonBox.ButtonRole.RejectRole)
         buttonBox.rejected.connect(dialog.reject)
 
         vlayout.addWidget(buttonBox)
         dialog.setWindowTitle('Fill in information about this managers')
         res = dialog.exec()
 
-        if res == dialog.Accepted:
+        if res == QDialog.DialogCode.Accepted:
             # save managers parameters in a xml file
             # start = os.path.split(os.path.split(os.path.realpath(__file__))[0])[0]
             # start = os.path.join("..",'daq_scan')

pymodaq/utils/managers/preset_manager.py

@@ -3,6 +3,7 @@ from pathlib import Path
 import sys
 
 from qtpy import QtWidgets
+from qtpy.QtWidgets import QMessageBox, QDialogButtonBox, QDialog
 
 import pymodaq_utils.config as config_mod
 from pymodaq_utils.logger import set_logger, get_module_name
@@ -26,7 +27,6 @@ layout_path = config_mod_pymodaq.get_set_layout_path()
 
 class PresetManager:
     def __init__(self, msgbox=False, path=None, extra_params=[], param_options=[]):
-
         if path is None:
             path = preset_path
         else:
@@ -38,21 +38,25 @@ class PresetManager:
         self.preset_params: Parameter = None
 
         if msgbox:
-            msgBox = QtWidgets.QMessageBox()
+            msgBox = QMessageBox()
             msgBox.setText("Preset Manager?")
             msgBox.setInformativeText("What do you want to do?")
-            cancel_button = msgBox.addButton(QtWidgets.QMessageBox.Cancel)
-            new_button = msgBox.addButton("New", QtWidgets.QMessageBox.ActionRole)
-            modify_button = msgBox.addButton('Modify', QtWidgets.QMessageBox.AcceptRole)
-            msgBox.setDefaultButton(QtWidgets.QMessageBox.Cancel)
+            cancel_button = msgBox.addButton(QMessageBox.StandardButton.Cancel)
+            new_button = msgBox.addButton(
+                "New", QMessageBox.ButtonRole.ActionRole
+            )
+            modify_button = msgBox.addButton(
+                "Modify", QMessageBox.ButtonRole.AcceptRole
+            )
+            msgBox.setDefaultButton(QMessageBox.StandardButton.Cancel)
             ret = msgBox.exec()
 
             if msgBox.clickedButton() == new_button:
                 self.set_new_preset()
 
             elif msgBox.clickedButton() == modify_button:
-                path = select_file(start_path=self.preset_path, save=False, ext='xml')
-                if path != '':
+                path = select_file(start_path=self.preset_path, save=False, ext="xml")
+                if path != "":
                     self.set_file_preset(str(path))
             else:  # cancel
                 pass
@@ -60,37 +64,55 @@ class PresetManager:
     @property
     def filename(self) -> str:
         try:
-            return self.preset_params['filename']
+            return self.preset_params["filename"]
         except:
             return None
 
     def set_file_preset(self, filename, show=True):
-        """
-
-        """
+        """ """
         status = False
         children = ioxml.XML_file_to_parameter(filename)
-        self.preset_params = Parameter.create(title='Preset', name='Preset', type='group', children=children)
+        self.preset_params = Parameter.create(
+            title="Preset", name="Preset", type="group", children=children
+        )
         if show:
             status = self.show_preset()
         return status
 
-
     def set_new_preset(self):
         param = [
-            {'title': 'Filename:', 'name': 'filename', 'type': 'str', 'value': 'preset_default'},
-            {'title': 'Model Settings:', 'name': 'model_settings', 'type': 'group', 'visible': False, 'children': []},
+            {
+                "title": "Filename:",
+                "name": "filename",
+                "type": "str",
+                "value": "preset_default",
+            },
+            {
+                "title": "Model Settings:",
+                "name": "model_settings",
+                "type": "group",
+                "visible": False,
+                "children": [],
+            },
         ]
         params_move = [
-            {'title': 'Moves:', 'name': 'Moves', 'type': 'groupmove'}]  # PresetScalableGroupMove(name="Moves")]
-        params_det = [{'title': 'Detectors:', 'name': 'Detectors',
-                       'type': 'groupdet'}]  # [PresetScalableGroupDet(name="Detectors")]
-        self.preset_params = Parameter.create(title='Preset', name='Preset', type='group',
-                                              children=param + self.extra_params + params_move + params_det)
+            {"title": "Moves:", "name": "Moves", "type": "groupmove"}
+        ]  # PresetScalableGroupMove(name="Moves")]
+        params_det = [
+            {"title": "Detectors:", "name": "Detectors", "type": "groupdet"}
+        ]  # [PresetScalableGroupDet(name="Detectors")]
+        self.preset_params = Parameter.create(
+            title="Preset",
+            name="Preset",
+            type="group",
+            children=param + self.extra_params + params_move + params_det,
+        )
         try:
             for option in self.param_options:
-                if 'path' in option and 'options_dict' in option:
-                    self.preset_params.child(option['path']).setOpts(**option['options_dict'])
+                if "path" in option and "options_dict" in option:
+                    self.preset_params.child(option["path"]).setOpts(
+                        **option["options_dict"]
+                    )
         except Exception as e:
             logger.exception(str(e))
 
@@ -101,91 +123,105 @@ class PresetManager:
 
     def parameter_tree_changed(self, param, changes):
         """
-            Check for changes in the given (parameter,change,information) tuple list.
-            In case of value changed, update the DAQscan_settings tree consequently.
-
-            =============== ============================================ ==============================
-            **Parameters**    **Type**                                     **Description**
-            *param*           instance of pyqtgraph parameter              the parameter to be checked
-            *changes*         (parameter,change,information) tuple list    the current changes state
-            =============== ============================================ ==============================
+        Check for changes in the given (parameter,change,information) tuple list.
+        In case of value changed, update the DAQscan_settings tree consequently.
+
+        =============== ============================================ ==============================
+        **Parameters**    **Type**                                     **Description**
+        *param*           instance of pyqtgraph parameter              the parameter to be checked
+        *changes*         (parameter,change,information) tuple list    the current changes state
+        =============== ============================================ ==============================
         """
         for param, change, data in changes:
             path = self.preset_params.childPath(param)
-            if change == 'childAdded':
+            if change == "childAdded":
                 if len(data) > 1:
-                    if 'params' in data[0].children():
-                        data[0].child('params', 'main_settings', 'module_name').setValue(data[0].child('name').value())
-
-            elif change == 'value':
-                if param.name() == 'name':
-                    param.parent().child('params', 'main_settings', 'module_name').setValue(param.value())
-
-            elif change == 'parent':
+                    if "params" in data[0].children():
+                        data[0].child(
+                            "params", "main_settings", "module_name"
+                        ).setValue(data[0].child("name").value())
+
+            elif change == "value":
+                if param.name() == "name":
+                    param.parent().child(
+                        "params", "main_settings", "module_name"
+                    ).setValue(param.value())
+
+            elif change == "parent":
                 pass
 
     def show_preset(self):
-        """
-
-        """
-        dialog = QtWidgets.QDialog()
+        """ """
+        dialog = QDialog()
         vlayout = QtWidgets.QVBoxLayout()
         tree = ParameterTree()
         # tree.setMinimumWidth(400)
         # tree.setMinimumHeight(500)
         tree.setParameters(self.preset_params, showTop=False)
+        tree.header().setSectionResizeMode(QtWidgets.QHeaderView.ResizeToContents)
 
         vlayout.addWidget(tree)
         dialog.setLayout(vlayout)
-        buttonBox = QtWidgets.QDialogButtonBox(parent=dialog)
+        buttonBox = QDialogButtonBox(parent=dialog)
 
-        buttonBox.addButton('Save', buttonBox.AcceptRole)
+        buttonBox.addButton("Save", QDialogButtonBox.ButtonRole.AcceptRole)
         buttonBox.accepted.connect(dialog.accept)
-        buttonBox.addButton('Cancel', buttonBox.RejectRole)
+        buttonBox.addButton("Cancel", QDialogButtonBox.ButtonRole.RejectRole)
         buttonBox.rejected.connect(dialog.reject)
 
         vlayout.addWidget(buttonBox)
-        dialog.setWindowTitle('Fill in information about this manager')
+        dialog.setWindowTitle("Fill in information about this manager")
         res = dialog.exec()
 
         path = self.preset_path
-        file= None
+        file = None
 
-        if res == dialog.Accepted:
+        if res == QDialog.DialogCode.Accepted:
             # save managers parameters in a xml file
             # start = os.path.split(os.path.split(os.path.realpath(__file__))[0])[0]
             # start = os.path.join("..",'daq_scan')
             filename_without_extension = self.filename
 
             try:
-                ioxml.parameter_to_xml_file(self.preset_params,
-                                            path.joinpath(filename_without_extension),
-                                            overwrite=False)
+                ioxml.parameter_to_xml_file(
+                    self.preset_params,
+                    path.joinpath(filename_without_extension),
+                    overwrite=False,
+                )
             except FileExistsError as currenterror:
                 # logger.warning(str(currenterror)+"File " + filename_without_extension + ".xml exists")
-                logger.warning(f"{currenterror} File {filename_without_extension}.xml exists")
-                user_agreed = dialogbox(title='Overwrite confirmation',
-                                        message="File exist do you want to overwrite it ?")
+                logger.warning(
+                    f"{currenterror} File {filename_without_extension}.xml exists"
+                )
+                user_agreed = dialogbox(
+                    title="Overwrite confirmation",
+                    message="File exist do you want to overwrite it ?",
+                )
                 if user_agreed:
-                    ioxml.parameter_to_xml_file(self.preset_params,
-                                                path.joinpath(filename_without_extension))
-                    logger.warning(f"File {filename_without_extension}.xml overwriten at user request")
+                    ioxml.parameter_to_xml_file(
+                        self.preset_params, path.joinpath(filename_without_extension)
+                    )
+                    logger.warning(
+                        f"File {filename_without_extension}.xml overwriten at user request"
+                    )
                 else:
-                    logger.warning(f"File {filename_without_extension}.xml wasn't saved at user request")
+                    logger.warning(
+                        f"File {filename_without_extension}.xml wasn't saved at user request"
+                    )
                     # emit status signal to dashboard to write : did not save ?
                 pass
 
             # check if overshoot configuration and layout configuration with same name exists => delete them if yes
-            over_shoot_file = overshoot_path.joinpath(self.filename + '.xml')
+            over_shoot_file = overshoot_path.joinpath(self.filename + ".xml")
             over_shoot_file.unlink(missing_ok=True)
 
-            layout_file = layout_path.joinpath(self.filename + '.dock')
+            layout_file = layout_path.joinpath(self.filename + ".dock")
             layout_file.unlink(missing_ok=True)
 
-        return res == dialog.Accepted
+        return res == QDialog.DialogCode.Accepted
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     app = QtWidgets.QApplication(sys.argv)
     # prog = PresetManager(True)
     prog = PresetManager(True)