pymodaq 5.1.6__py3-none-any.whl

pymodaq/utils/managers/overshoot_manager.py

@@ -0,0 +1,242 @@
+from qtpy import QtWidgets
+from qtpy.QtWidgets import QMessageBox, QDialogButtonBox, QDialog
+import sys
+import os
+
+from pymodaq_gui.parameter import ioxml, Parameter, ParameterTree
+from pymodaq_gui.parameter.pymodaq_ptypes import registerParameterType, GroupParameter
+from pymodaq_gui.utils import select_file
+
+# check if overshoot_configurations directory exists on the drive
+from pymodaq.utils.config import get_set_overshoot_path
+
+overshoot_path = get_set_overshoot_path()
+
+
+class PresetScalableGroupMove(GroupParameter):
+    """
+        |
+
+        ================ =============
+        **Attributes**    **Type**
+        *opts*            dictionnary
+        ================ =============
+
+        See Also
+        --------
+        hardware.DAQ_Move_Stage_type
+    """
+
+    def __init__(self, **opts):
+        opts['type'] = 'groupmoveover'
+        opts['addText'] = "Add"
+        opts['addList'] = opts['movelist']
+        super().__init__(**opts)
+
+    def addNew(self, name):
+        """
+            Add a child.
+
+            =============== ===========
+            **Parameters**   **Type**
+            *typ*            string
+            =============== ===========
+        """
+        name_prefix = 'move'
+        child_indexes = [int(par.name()[len(name_prefix) + 1:]) for par in self.children()]
+        if not child_indexes:
+            newindex = 0
+        else:
+            newindex = max(child_indexes) + 1
+
+        child = {'title': name, 'name': f'{name_prefix}{newindex:02.0f}', 'type': 'group', 'removable': True,
+                 'children': [
+                     {'title': 'Move if overshoot?:', 'name': 'move_overshoot', 'type': 'bool', 'value': True},
+                     {'title': 'Position:', 'name': 'position', 'type': 'float', 'value': 0}], 'removable': True,
+                 'renamable': False}
+
+        self.addChild(child)
+
+
+registerParameterType('groupmoveover', PresetScalableGroupMove, override=True)
+
+
+class PresetScalableGroupDet(GroupParameter):
+    """
+        =============== ==============
+        **Attributes**    **Type**
+        *opts*            dictionnary
+        *options*         string list
+        =============== ==============
+
+        See Also
+        --------
+    """
+
+    def __init__(self, **opts):
+        opts['type'] = 'groupdetover'
+        opts['addText'] = "Add"
+        opts['addList'] = opts['detlist']
+        opts['movelist'] = opts['movelist']
+
+        super().__init__(**opts)
+
+    def addNew(self, name):
+        """
+            Add a child.
+
+            =============== ===========  ================
+            **Parameters**    **Type**   **Description*
+            *typ*             string     the viewer name
+            =============== ===========  ================
+        """
+        try:
+            name_prefix = 'det'
+            child_indexes = [int(par.name()[len(name_prefix) + 1:]) for par in self.children()]
+            if not child_indexes:
+                newindex = 0
+            else:
+                newindex = max(child_indexes) + 1
+
+            child = {'title': name, 'name': f'{name_prefix}{newindex:02.0f}', 'type': 'group', 'children': [
+                {'title': 'Trig overshoot?:', 'name': 'trig_overshoot', 'type': 'bool', 'value': True},
+                {'title': 'Overshoot value:', 'name': 'overshoot_value', 'type': 'float', 'value': 20},
+                {'title': 'Triggered Moves:', 'name': 'params', 'type': 'groupmoveover',
+                 'movelist': self.opts['movelist']}], 'removable': True, 'renamable': False}
+
+            self.addChild(child)
+        except Exception as e:
+            print(str(e))
+
+
+registerParameterType('groupdetover', PresetScalableGroupDet, override=True)
+
+
+class OvershootManager:
+    def __init__(self, msgbox=False, det_modules=[], actuators_modules=[]):
+
+        self.overshoot_params = None
+        self.det_modules = det_modules
+        self.actuators_modules = actuators_modules
+
+        self._activated = False
+
+        if msgbox:
+            msgBox = QMessageBox()
+            msgBox.setText("Overshoot Manager?")
+            msgBox.setInformativeText("What do you want to do?")
+            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_overshoot()
+
+            elif msgBox.clickedButton() == modify_button:
+                path = select_file(start_path=overshoot_path, save=False, ext='xml')
+                if path != '':
+                    self.set_file_overshoot(str(path))
+            else:  # cancel
+                pass
+
+    @property
+    def activated(self) -> bool:
+        return self._activated
+
+    @activated.setter
+    def activated(self, status: bool):
+        self._activated = status
+
+    def set_file_overshoot(self, filename, show=True):
+        """
+
+        """
+        children = ioxml.XML_file_to_parameter(filename)
+        self.overshoot_params = Parameter.create(title='Overshoot', name='Overshoot', type='group',
+                                                 children=children)
+        if show:
+            self.show_overshoot()
+
+    def set_new_overshoot(self, file=None):
+        if file is None:
+            file = 'overshoot_default'
+        param = [{'title': 'Filename:', 'name': 'filename', 'type': 'str', 'value': file}]
+        params_det = [{'title': 'Detectors:', 'name': 'Detectors', 'type': 'groupdetover', 'detlist': self.det_modules,
+                       'movelist': self.actuators_modules}]  # [PresetScalableGroupDet(name="Detectors")]
+        self.overshoot_params = Parameter.create(title='Preset', name='Preset', type='group',
+                                                 children=param + params_det)
+
+        self.show_overshoot()
+
+    def show_overshoot(self):
+        """
+
+        """
+        dialog = QDialog()
+        vlayout = QtWidgets.QVBoxLayout()
+        tree = ParameterTree()
+        tree.setMinimumWidth(400)
+        tree.setMinimumHeight(500)
+        tree.setParameters(self.overshoot_params, showTop=False)
+
+        vlayout.addWidget(tree)
+        dialog.setLayout(vlayout)
+        buttonBox = QDialogButtonBox(parent=dialog)
+
+        buttonBox.addButton("Save", QDialogButtonBox.ButtonRole.AcceptRole)
+        buttonBox.accepted.connect(dialog.accept)
+        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 == 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')
+            ioxml.parameter_to_xml_file(
+                self.overshoot_params, os.path.join(overshoot_path, self.overshoot_params.child('filename').value()))
+
+    def activate_overshoot(self, det_modules, act_modules, status: bool):
+        det_titles = [det.title for det in det_modules]
+        move_titles = [move.title for move in act_modules]
+
+        if self.overshoot_params is not None:
+            for det_param in self.overshoot_params.child(
+                    'Detectors').children():
+                if det_param['trig_overshoot']:
+                    det_index = det_titles.index(det_param.opts['title'])
+                    det_module = det_modules[det_index]
+                    det_module.settings.child(
+                        'main_settings', 'overshoot', 'stop_overshoot').setValue(status)
+                    det_module.settings.child(
+                        'main_settings', 'overshoot', 'overshoot_value').setValue(
+                        det_param['overshoot_value'])
+                    for move_param in det_param.child('params').children():
+                        if move_param['move_overshoot']:
+                            move_index = move_titles.index(move_param.opts['title'])
+                            move_module = act_modules[move_index]
+                            if status:
+                                det_module.overshoot_signal.connect(
+                                    self.create_overshoot_fun(
+                                        move_module, move_param['position']))
+                            else:
+                                try:
+                                    det_module.overshoot_signal.disconnect()
+                                except Exception as e:
+                                    pass
+
+    @staticmethod
+    def create_overshoot_fun(move_module, position):
+        return lambda: move_module.move_abs(position)
+
+
+if __name__ == '__main__':
+    app = QtWidgets.QApplication(sys.argv)
+    prog = OvershootManager(True, ['det camera', 'det current'], ['Move X', 'Move Y'])
+
+    sys.exit(app.exec_())

pymodaq/utils/managers/preset_manager.py

@@ -0,0 +1,229 @@
+import os
+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
+
+from pymodaq_gui.utils.file_io import select_file
+from pymodaq_gui.parameter import ParameterTree, Parameter
+from pymodaq_gui.parameter import ioxml
+from pymodaq_gui.messenger import dialog as dialogbox
+from pymodaq.utils import config as config_mod_pymodaq
+from pymodaq.extensions import get_models
+
+import pymodaq.utils.managers.preset_manager_utils  # to register move and det types
+
+logger = set_logger(get_module_name(__file__))
+
+# check if preset_mode directory exists on the drive
+preset_path = config_mod_pymodaq.get_set_preset_path()
+overshoot_path = config_mod_pymodaq.get_set_overshoot_path()
+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:
+            assert isinstance(path, Path)
+
+        self.extra_params = extra_params
+        self.param_options = param_options
+        self.preset_path = path
+        self.preset_params: Parameter = None
+
+        if msgbox:
+            msgBox = QMessageBox()
+            msgBox.setText("Preset Manager?")
+            msgBox.setInformativeText("What do you want to do?")
+            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 != "":
+                    self.set_file_preset(str(path))
+            else:  # cancel
+                pass
+
+    @property
+    def filename(self) -> str:
+        try:
+            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
+        )
+        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": [],
+            },
+        ]
+        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,
+        )
+        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"]
+                    )
+        except Exception as e:
+            logger.exception(str(e))
+
+        self.preset_params.sigTreeStateChanged.connect(self.parameter_tree_changed)
+
+        status = self.show_preset()
+        return status
+
+    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
+        =============== ============================================ ==============================
+        """
+        for param, change, data in changes:
+            path = self.preset_params.childPath(param)
+            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":
+                pass
+
+    def show_preset(self):
+        """ """
+        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 = QDialogButtonBox(parent=dialog)
+
+        buttonBox.addButton("Save", QDialogButtonBox.ButtonRole.AcceptRole)
+        buttonBox.accepted.connect(dialog.accept)
+        buttonBox.addButton("Cancel", QDialogButtonBox.ButtonRole.RejectRole)
+        buttonBox.rejected.connect(dialog.reject)
+
+        vlayout.addWidget(buttonBox)
+        dialog.setWindowTitle("Fill in information about this manager")
+        res = dialog.exec()
+
+        path = self.preset_path
+        file = None
+
+        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,
+                )
+            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 ?",
+                )
+                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"
+                    )
+                else:
+                    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.unlink(missing_ok=True)
+
+            layout_file = layout_path.joinpath(self.filename + ".dock")
+            layout_file.unlink(missing_ok=True)
+
+        return res == QDialog.DialogCode.Accepted
+
+
+if __name__ == "__main__":
+    app = QtWidgets.QApplication(sys.argv)
+    # prog = PresetManager(True)
+    prog = PresetManager(True)
+
+    sys.exit(app.exec_())