pymodaq 3.6.13__py3-none-any.whl → 4.0.1__py3-none-any.whl

pymodaq/{daq_utils → utils}/tcp_server_client.py

@@ -4,21 +4,20 @@ Created on Fri Aug 30 12:21:56 2019
 
 @author: Weber
 """
-from abc import ABCMeta, abstractmethod
-
-
 from qtpy.QtCore import QObject, Signal, Slot, QThread
 from qtpy import QtWidgets
 import socket
 import select
 import numpy as np
 
-import pymodaq.daq_utils.parameter.ioxml
-import pymodaq.daq_utils.parameter.utils
-import pymodaq.daq_utils.parameter.pymodaq_ptypes
-from pymodaq.daq_utils.daq_utils import getLineInfo, ThreadCommand, DataFromPlugins
-from pymodaq.daq_utils import math_utils as mutils
-from pymodaq.daq_utils.config import Config
+from pymodaq.utils.parameter import ioxml
+from  pymodaq.utils.parameter import utils as putils
+import pymodaq.utils.parameter.pymodaq_ptypes
+from pymodaq.utils.parameter.ioxml import parameter_to_xml_string
+from pymodaq.utils.daq_utils import getLineInfo, ThreadCommand
+from pymodaq.utils.data import DataFromPlugins
+from pymodaq.utils import math_utils as mutils
+from pymodaq.utils.config import Config
 from pyqtgraph.parametertree import Parameter
 from collections import OrderedDict
 from typing import List
@@ -228,7 +227,7 @@ class Socket:
         data_bytes = self.check_received_length(data_len)
         data = np.frombuffer(data_bytes, dtype=data_type)
         data = data.reshape(tuple(shape))
-        data = np.squeeze(data)
+        data = np.squeeze(data)  # remove singleton dimensions
         return data
 
     def send_array(self, data_array):
@@ -314,6 +313,7 @@ class Socket:
                 data.append(self.get_array())
         return data
 
+
 class TCPClientTemplate:
     params = []
 
@@ -411,7 +411,6 @@ class TCPClientTemplate:
         """Error in the socket communication"""
         raise NotImplementedError
 
-
     def process_error_in_polling(self, e: Exception):
         raise NotImplementedError
 
@@ -472,7 +471,7 @@ class TCPClient(TCPClientTemplate, QObject):
             self.socket.send_string(value_as_string)
 
     @Slot(ThreadCommand)
-    def queue_command(self, command=ThreadCommand()):
+    def queue_command(self, command=ThreadCommand):
         """
         when this TCPClient object is within a thread, the corresponding module communicate with it with signal and slots
         from module to client: module_signal to queue_command slot
@@ -490,42 +489,42 @@ class TCPClient(TCPClientTemplate, QObject):
                 self.cmd_signal.emit(ThreadCommand('disconnected'))
 
         elif command.command == 'update_connection':
-            self.ipaddress = command.attributes['ipaddress']
-            self.port = command.attributes['port']
+            self.ipaddress = command.attribute['ipaddress']
+            self.port = command.attribute['port']
 
         elif command.command == 'data_ready':
-            self.data_ready(command.attributes)
+            self.data_ready(command.attribute)
 
         elif command.command == 'send_info':
             if self.socket is not None:
-                path = command.attributes['path']
-                param = command.attributes['param']
+                path = command.attribute['path']
+                param = command.attribute['param']
 
                 self.socket.send_string('Info_xml')
                 self.socket.send_list(path)
 
                 # send value
-                data = pymodaq.daq_utils.parameter.ioxml.parameter_to_xml_string(param)
+                data = parameter_to_xml_string(param)
                 self.socket.send_string(data)
 
         elif command.command == 'position_is':
             if self.socket is not None:
                 self.socket.send_string('position_is')
-                self.socket.send_scalar(command.attributes[0])
+                self.socket.send_scalar(command.attribute[0])
 
         elif command.command == 'move_done':
             if self.socket is not None:
                 self.socket.send_string('move_done')
-                self.socket.send_scalar(command.attributes[0])
+                self.socket.send_scalar(command.attribute[0])
 
         elif command.command == 'x_axis':
             if self.socket is not None:
                 self.socket.send_string('x_axis')
                 x_axis = dict(label='', units='')
-                if isinstance(command.attributes[0], np.ndarray):
-                    x_axis['data'] = command.attributes[0]
-                elif isinstance(command.attributes[0], dict):
-                    x_axis.update(command.attributes[0].copy())
+                if isinstance(command.attribute[0], np.ndarray):
+                    x_axis['data'] = command.attribute[0]
+                elif isinstance(command.attribute[0], dict):
+                    x_axis.update(command.attribute[0].copy())
 
                 self.socket.send_array(x_axis['data'])
                 self.socket.send_string(x_axis['label'])
@@ -535,10 +534,10 @@ class TCPClient(TCPClientTemplate, QObject):
             if self.socket is not None:
                 self.socket.send_string('y_axis')
                 y_axis = dict(label='', units='')
-                if isinstance(command.attributes[0], np.ndarray):
-                    y_axis['data'] = command.attributes[0]
-                elif isinstance(command.attributes[0], dict):
-                    y_axis.update(command.attributes[0].copy())
+                if isinstance(command.attribute[0], np.ndarray):
+                    y_axis['data'] = command.attribute[0]
+                elif isinstance(command.attribute[0], dict):
+                    y_axis.update(command.attribute[0].copy())
 
                 self.socket.send_array(y_axis['data'])
                 self.socket.send_string(y_axis['label'])
@@ -576,7 +575,7 @@ class TCPClient(TCPClientTemplate, QObject):
         self.cmd_signal.emit(ThreadCommand('connected'))
         self.socket.send_string(self.client_type)
 
-        self.send_infos_xml(pymodaq.daq_utils.parameter.ioxml.parameter_to_xml_string(self.settings))
+        self.send_infos_xml(parameter_to_xml_string(self.settings))
         for command in extra_commands:
             if isinstance(command, ThreadCommand):
                 self.cmd_signal.emit(command)
@@ -598,15 +597,15 @@ class TCPClient(TCPClientTemplate, QObject):
             if message == 'set_info':
                 path = self.socket.get_list()
                 param_xml = self.socket.get_string()
-                messg.attributes = [path, param_xml]
+                messg.attribute = [path, param_xml]
 
             elif message == 'move_abs':
                 position = self.socket.get_scalar()
-                messg.attributes = [position]
+                messg.attribute = [position]
 
             elif message == 'move_rel':
                 position = self.socket.get_scalar()
-                messg.attributes = [position]
+                messg.attribute = [position]
 
             self.cmd_signal.emit(messg)
 
@@ -925,7 +924,7 @@ class TCPServer(QObject):
     def read_infos(self, sock=None, infos=''):
         if sock is not None:
             infos = sock.get_string()
-        params = pymodaq.daq_utils.parameter.ioxml.XML_string_to_parameter(infos)
+        params = ioxml.XML_string_to_parameter(infos)
 
         param_state = {'title': 'Infos Client:', 'name': 'settings_client', 'type': 'group', 'children': params}
         self.settings.child(('settings_client')).restoreState(param_state)
@@ -935,7 +934,7 @@ class TCPServer(QObject):
             path = sock.get_list()
             param_xml = sock.get_string()
         try:
-            param_dict = pymodaq.daq_utils.parameter.ioxml.XML_string_to_parameter(param_xml)[0]
+            param_dict = ioxml.XML_string_to_parameter(param_xml)[0]
         except Exception as e:
             raise Exception(f'Invalid xml structure for TCP server settings: {str(e)}')
         try:
@@ -956,7 +955,7 @@ class TCPServer(QObject):
             info = sock.get_string()
             data = sock.get_string()
 
-        if info not in pymodaq.daq_utils.parameter.utils.iter_children(self.settings.child(('infos')), []):
+        if info not in putils.iter_children(self.settings.child(('infos')), []):
             self.settings.child('infos').addChild({'name': info, 'type': 'str', 'value': data})
             pass
         else:
@@ -1016,7 +1015,7 @@ class Grabber(QObject):
         self.command_tcpip[ThreadCommand].connect(tcpclient.queue_command)
 
         self.tcpclient_thread.start()
-        tcpclient.init_connection(extra_commands=[ThreadCommand('get_axis')])
+        tcpclient.init_connection(extra_commands=[ThreadCommand('get_axis', )])
         self.send_to_tcpip = True
 
     def snapshot(self, info='', send_to_tcpip=True):
@@ -1056,7 +1055,7 @@ class Grabber(QObject):
 
 if __name__ == '__main__':  # pragma: no cover
     import sys
-    from pymodaq.daq_utils.parameter import ioxml
+    from pymodaq.utils.parameter import ioxml
 
     app = QtWidgets.QApplication(sys.argv)
     mockdata_grabber = MockDataGrabber('2D')

pymodaq/{daq_utils → utils}/tree_layout/tree_layout_main.py

@@ -3,17 +3,19 @@ from qtpy.QtCore import QObject, Signal, QLocale
 import sys
 
 
-class Tree_layout(QObject):
+class TreeLayout(QObject):
     """
     qtpy class object based on QtreeWidget
-    The function populate_Tree has to be used in order to populate the tree with structure as nested lists of dicts
+    The function populate_tree has to be used in order to populate the tree with structure as nested lists of dicts
 
     """
     status_sig = Signal(str)
-
+    item_clicked_sig = Signal(object)
+    item_double_clicked_sig = Signal(object)
+    
     def __init__(self, parent=None, col_counts=1, labels=None):
         
-        super(Tree_layout, self).__init__()
+        super().__init__()
 
         if parent is None:
             parent = QtWidgets.QWidget()
@@ -21,66 +23,79 @@ class Tree_layout(QObject):
 
         self.setupUi()
 
-        self.ui.Tree.setColumnCount(col_counts)
+        self.tree.setColumnCount(col_counts)
         if labels is not None:
-            self.ui.Tree.setHeaderLabels(labels)
+            self.tree.setHeaderLabels(labels)
+
+        self.open_tree_pb.clicked.connect(self.expand_all)
+        self.close_tree_pb.clicked.connect(self.collapse_all)
+        self.open_tree_selected_pb.clicked.connect(self.open_tree_selection)
+        
+        self.tree.itemClicked.connect(self.item_clicked_sig.emit)
+        self.tree.itemDoubleClicked.connect(self.item_double_clicked_sig.emit)
+
+    def _current_text(self, col_index: int = 2):
+        return self.tree.currentItem().text(col_index)
 
-        self.ui.Open_Tree.clicked.connect(self.ui.Tree.expandAll)
-        self.ui.Close_Tree.clicked.connect(self.ui.Tree.collapseAll)
-        self.ui.Open_Tree_Selected.clicked.connect(self.open_Tree_selection)
+    def current_node_path(self):
+        return self._current_text(2)
+
+    def expand_all(self):
+        self.tree.expandAll()
+
+    def collapse_all(self):
+        self.tree.collapseAll()
 
     @property
     def treewidget(self):
-        return self.ui.Tree
+        return self.tree
 
     def setupUi(self):
-        self.ui = QObject()
-
         vlayout = QtWidgets.QVBoxLayout()
         hlayout = QtWidgets.QHBoxLayout()
 
-        self.ui.Tree = CustomTree()
-        vlayout.addWidget(self.ui.Tree)
+        self.tree = CustomTree()
+        vlayout.addWidget(self.tree)
 
         iconopen = QtGui.QIcon()
         iconopen.addPixmap(QtGui.QPixmap(":/icons/Icon_Library/tree.png"), QtGui.QIcon.Normal,
                            QtGui.QIcon.Off)
-        self.ui.Open_Tree = QtWidgets.QPushButton('Open Tree')
-        self.ui.Open_Tree.setIcon(iconopen)
+        self.open_tree_pb = QtWidgets.QPushButton('Open Tree')
+        self.open_tree_pb.setIcon(iconopen)
 
         iconopensel = QtGui.QIcon()
         iconopensel.addPixmap(QtGui.QPixmap(":/icons/Icon_Library/tree.png"), QtGui.QIcon.Normal,
                               QtGui.QIcon.Off)
-        self.ui.Open_Tree_Selected = QtWidgets.QPushButton('Open Selected')
-        self.ui.Open_Tree_Selected.setIcon(iconopensel)
+        self.open_tree_selected_pb = QtWidgets.QPushButton('Open Selected')
+        self.open_tree_selected_pb.setIcon(iconopensel)
 
         iconclose = QtGui.QIcon()
         iconclose.addPixmap(QtGui.QPixmap(":/icons/Icon_Library/CollapseAll.png"), QtGui.QIcon.Normal,
                             QtGui.QIcon.Off)
-        self.ui.Close_Tree = QtWidgets.QPushButton('Close Tree')
-        self.ui.Close_Tree.setIcon(iconclose)
+        self.close_tree_pb = QtWidgets.QPushButton('Close Tree')
+        self.close_tree_pb.setIcon(iconclose)
 
-        hlayout.addWidget(self.ui.Open_Tree)
-        hlayout.addWidget(self.ui.Open_Tree_Selected)
-        hlayout.addWidget(self.ui.Close_Tree)
+        hlayout.addWidget(self.open_tree_pb)
+        hlayout.addWidget(self.open_tree_selected_pb)
+        hlayout.addWidget(self.close_tree_pb)
 
         vlayout.addLayout(hlayout)
 
         self.parent.setLayout(vlayout)
 
-    def open_Tree_selection(self):
-        self.Tree_open_children(self.ui.Tree.selectedIndexes()[0])
+    def open_tree_selection(self):
+        self.tree_open_children(self.tree.selectedIndexes()[0])
 
-    def Tree_open_children(self, item_index):
+    def tree_open_children(self, item_index):
         try:
             if not (item_index.isValid()):
                 return
 
-            self.ui.Tree.expand(item_index)
+            self.tree.expand(item_index)
         except Exception as e:
             self.status_sig.emit(str(e))
 
-    def Tree_open_parents(self, item_index):
+    def tree_open_parents(self, item_index):
         try:
             if not (item_index.isValid()):
                 return
@@ -90,14 +105,14 @@ class Tree_layout(QObject):
             while flag:
                 parent = parent.parent()
                 if parent != empty:
-                    self.ui.Tree.expand(parent)
+                    self.tree.expand(parent)
                 else:
                     flag = False
                     break
         except Exception as e:
             self.status_sig.emit(str(e))
 
-    def populate_Tree(self, data_dict):
+    def populate_tree(self, data_dict):
         try:
             parents = []
             for data in data_dict:
@@ -111,7 +126,7 @@ class Tree_layout(QObject):
                 parent.addChildren(Items)
                 parents.append(parent)
 
-            self.ui.Tree.addTopLevelItems(parents)
+            self.tree.addTopLevelItems(parents)
         except Exception as e:
             self.status_sig.emit(str(e))
 
@@ -139,7 +154,7 @@ class Tree_layout(QObject):
 class CustomTree(QtWidgets.QTreeWidget):
 
     def __init__(self, parent=None):
-        super(CustomTree, self).__init__(parent)
+        super().__init__(parent)
         self.setContextMenuPolicy(QtCore.Qt.ActionsContextMenu)
 
 
@@ -148,11 +163,11 @@ if __name__ == '__main__':
 
     app = QtWidgets.QApplication(sys.argv)
     Form = QtWidgets.QWidget()
-    prog = Tree_layout(Form, col_counts=2, labels=["Material", "File"])
+    prog = TreeLayout(Form, col_counts=2, labels=["Material", "File"])
 
     # example of actions to add to the tree widget in order to show a context menu
     detector_action = QtWidgets.QAction("Grab from camera", None)
-    prog.ui.Tree.addAction(detector_action)
+    prog.tree.addAction(detector_action)
     ########################
 
     Form.show()
@@ -161,7 +176,7 @@ if __name__ == '__main__':
         dict(name='fiston1', contents=[dict(name='subfiston', contents='baby', filename='Cest pas malin')]),
         dict(name='fiston2', contents=[dict(name='subfiston', contents='baby', filename='Cest pas normal')])]),
         dict(name='maman', contents=[dict(name='fistone', contents=[dict(name='subfistone', contents='baby')])])]
-    prog.populate_Tree(data)
+    prog.populate_tree(data)
     # filename='C:\\Data\\2019\\20190220\\Dataset_20190220_004\\Dataset_20190220_004.h5'
     # import tables
     # h5_file = tables.open_file(filename, mode = "a")

pymodaq/utils/units.py

@@ -0,0 +1,216 @@
+# -*- coding: utf-8 -*-
+"""
+Created the 27/10/2022
+
+@author: Sebastien Weber
+"""
+import numpy as np
+
+Cb = 1.602176e-19  # coulomb
+h = 6.626068e-34  # J.s
+c = 2.997924586e8  # m.s-1
+
+
+def Enm2cmrel(E_nm, ref_wavelength=515):
+    """Converts energy in nm to cm-1 relative to a ref wavelength
+
+    Parameters
+    ----------
+    E_nm: float
+          photon energy in wavelength (nm)
+    ref_wavelength: float
+                    reference wavelength in nm from which calculate the photon relative energy
+
+    Returns
+    -------
+    float
+         photon energy in cm-1 relative to the ref wavelength
+
+    Examples
+    --------
+    >>> Enm2cmrel(530, 515)
+    549.551199853453
+    """
+    return 1 / (ref_wavelength * 1e-7) - 1 / (E_nm * 1e-7)
+
+
+def Ecmrel2Enm(Ecmrel, ref_wavelength=515):
+    """Converts energy from cm-1 relative to a ref wavelength to an energy in wavelength (nm)
+
+    Parameters
+    ----------
+    Ecmrel: float
+            photon energy in cm-1
+    ref_wavelength: float
+                    reference wavelength in nm from which calculate the photon relative energy
+
+    Returns
+    -------
+    float
+         photon energy in nm
+
+    Examples
+    --------
+    >>> Ecmrel2Enm(500, 515)
+    528.6117526302285
+    """
+    Ecm = 1 / (ref_wavelength * 1e-7) - Ecmrel
+    return 1 / (Ecm * 1e-7)
+
+
+def eV2nm(E_eV):
+    """Converts photon energy from electronvolt to wavelength in nm
+
+    Parameters
+    ----------
+    E_eV: float
+          Photon energy in eV
+
+    Returns
+    -------
+    float
+         photon energy in nm
+
+    Examples
+    --------
+    >>> eV2nm(1.55)
+    799.898112990037
+    """
+    E_J = E_eV * Cb
+    E_freq = E_J / h
+    E_nm = c / E_freq * 1e9
+    return E_nm
+
+
+def nm2eV(E_nm):
+    """Converts photon energy from wavelength in nm to electronvolt
+
+    Parameters
+    ----------
+    E_nm: float
+          Photon energy in nm
+
+    Returns
+    -------
+    float
+         photon energy in eV
+
+    Examples
+    --------
+    >>> nm2eV(800)
+    1.549802593918197
+    """
+    E_freq = c / E_nm * 1e9
+    E_J = E_freq * h
+    E_eV = E_J / Cb
+    return E_eV
+
+
+def E_J2eV(E_J):
+    E_eV = E_J / Cb
+    return E_eV
+
+
+def eV2cm(E_eV):
+    """Converts photon energy from electronvolt to absolute cm-1
+
+    Parameters
+    ----------
+    E_eV: float
+          Photon energy in eV
+
+    Returns
+    -------
+    float
+         photon energy in cm-1
+
+    Examples
+    --------
+    >>> eV2cm(0.07)
+    564.5880342655984
+    """
+    E_nm = eV2nm(E_eV)
+    E_cm = 1 / (E_nm * 1e-7)
+    return E_cm
+
+
+def nm2cm(E_nm):
+    """Converts photon energy from wavelength to absolute cm-1
+
+        Parameters
+        ----------
+        E_nm: float
+              Photon energy in nm
+
+        Returns
+        -------
+        float
+             photon energy in cm-1
+
+        Examples
+        --------
+        >>> nm2cm(0.04)
+        0.000025
+        """
+    return 1 / (E_nm * 1e7)
+
+
+def cm2nm(E_cm):
+    """Converts photon energy from absolute cm-1 to wavelength
+
+            Parameters
+            ----------
+            E_cm: float
+                  photon energy in cm-1
+
+            Returns
+            -------
+            float
+                 Photon energy in nm
+
+            Examples
+            --------
+            >>> cm2nm(1e5)
+            100
+            """
+    return 1 / (E_cm * 1e-7)
+
+
+def eV2E_J(E_eV):
+    E_J = E_eV * Cb
+    return E_J
+
+
+def eV2radfs(E_eV):
+    E_J = E_eV * Cb
+    E_freq = E_J / h
+    E_radfs = E_freq * 2 * np.pi / 1e15
+    return E_radfs
+
+
+def l2w(x, speedlight=300):
+    """Converts photon energy in rad/fs to nm (and vice-versa)
+
+    Parameters
+    ----------
+    x: float
+       photon energy in wavelength or rad/fs
+    speedlight: float, optional
+                the speed of light, by default 300 nm/fs
+
+    Returns
+    -------
+    float
+
+    Examples
+    --------
+    >>> l2w(800)
+    2.356194490192345
+    >>> l2w(800,3e8)
+    2356194.490192345
+    """
+    y = 2 * np.pi * speedlight / x
+    return y
+
+
+