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

pymodaq/utils/plotting/widgets.py

@@ -1,76 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
-Created the 04/11/2022
-
-@author: Sebastien Weber
-"""
-
-import pyqtgraph as pg
-from qtpy import QtWidgets
-
-from pymodaq.utils.plotting.utils.plot_utils import View_cust
-from pymodaq.utils.plotting.items.axis_scaled import AXIS_POSITIONS, AxisItem_Scaled
-
-
-class ImageWidget(pg.GraphicsLayoutWidget):
-    """this gives a layout to add imageitems.
-    """
-
-    def __init__(self, parent=None, *args_plotitem, **kwargs_plotitem):
-
-        super().__init__(parent)
-        self.setupUI(*args_plotitem, **kwargs_plotitem)
-
-    def setAspectLocked(self, lock=True, ratio=1):
-        """
-        Defines the aspect ratio of the view
-        Parameters
-        ----------
-        lock: (bool) if True aspect ratio is set to ratio, else the aspect ratio is varying when scaling the view
-        ratio: (int) aspect ratio between horizontal and vertical axis
-        """
-        self.plotitem.vb.setAspectLocked(lock=True, ratio=1)
-
-    def getAxis(self, position):
-        return self.plotitem.getAxis(position)
-
-    def setupUI(self, *args_plotitem, **kwargs_plotitem):
-        layout = QtWidgets.QGridLayout()
-        # set viewer area
-        self.scene_obj = self.scene()
-        self.view = View_cust()
-        self.plotitem = pg.PlotItem(viewBox=self.view, *args_plotitem, **kwargs_plotitem)
-        self.plotItem = self.plotitem  # for backcompatibility
-        self.setAspectLocked(lock=True, ratio=1)
-        self.setCentralItem(self.plotitem)
-
-    def add_scaled_axis(self, position):
-        """
-        Add a AxisItem_Scaled to the given position with respect with the plotitem
-        Parameters
-        ----------
-        position: (str) either 'top', 'bottom', 'right' or 'left'
-
-        Returns
-        -------
-
-        """
-        if position not in AXIS_POSITIONS:
-            raise ValueError(f'The Axis position {position} should be in {AXIS_POSITIONS}')
-        axis = AxisItem_Scaled(position)
-        self.plotitem.setAxisItems({position: axis})
-        return axis
-
-
-class PlotWidget(pg.PlotWidget):
-    def __init__(self, *args, **kwargs):
-        plot_item = pg.PlotItem(viewBox=View_cust())
-        super().__init__(*args, plotItem=plot_item, **kwargs)
-
-    @property
-    def view(self):
-        return self.getViewBox()
-
-    @property
-    def legend(self):
-        return self.plotItem.legend

pymodaq/utils/qvariant.py

@@ -1,12 +0,0 @@
-from qtpy import API_NAME
-
-if API_NAME.lower() == 'pyqt5':
-    from qtpy.QtCore import QVariant
-else:
-    def QVariant(*args):
-        if len(args) > 1:
-            raise TypeError('Argument of QVariant in a singlet')
-        elif len(args) == 1:
-            return args[0]
-        else:
-            return None

pymodaq/utils/slicing.py

@@ -1,63 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
-Created the 07/11/2022
-
-@author: Sebastien Weber
-"""
-from typing import Union, List, TYPE_CHECKING
-import numpy as np
-
-if TYPE_CHECKING:
-    from pymodaq.utils.data import DataWithAxes, Axis
-
-
-class SpecialSlicers(object):
-    """make it elegant to apply a slice to navigation or signal dimensions"""
-    def __init__(self, obj: Union['DataWithAxes', 'Axis'], is_navigation):
-        self.is_navigation = is_navigation
-        self.obj = obj
-
-    def __getitem__(self, slices) -> Union['DataWithAxes', 'Axis']:
-        return self.obj._slicer(slices, self.is_navigation)
-
-
-class SpecialSlicersData(SpecialSlicers):
-
-    def __setitem__(self, slices, data: Union[np.ndarray, 'DataWithAxes', 'Axis']):
-        """x.__setitem__(slices, data) <==> x[slices]=data
-        """
-        slices = self.obj._compute_slices(slices, self.is_navigation)
-
-        if hasattr(self.obj, 'base_type') and self.obj.base_type == 'Axis':
-            if isinstance(data, np.ndarray):
-                data_to_replace = data
-            else:
-                data_to_replace = data.get_data()
-            if hasattr(self.obj, 'units') and self.obj.data is None:
-                self.obj.create_linear_data(len(self.obj))
-            self.obj.data[slices] = data_to_replace
-        else:
-            for ind in range(len(self.obj)):
-                if isinstance(data, np.ndarray):
-                    data_to_replace = data
-                else:  # means it's a DataWithAxes
-                    data_to_replace = data[ind]
-                self.obj[ind][slices] = data_to_replace
-
-    def __len__(self):
-        return self.obj.axes_manager.sig_shape[0]
-
-
-if __name__ == '__main__':
-    from pymodaq.utils.data import DataWithAxes, DataRaw, Axis
-    shape = (4, 10, 5, 7)
-    dat = np.arange(np.prod(shape))
-    dat = dat.reshape(shape)
-    data = DataRaw('mydata', data=[dat], nav_indexes=(0, 1, 2),
-                   axes=[Axis(f'axis_{ind:02d}',
-                              data=np.linspace(0, shape[ind]-1, shape[ind]),
-                              index=ind) for ind in range(len(shape))])
-    subdata_sig = data.inav[2, 2, 3].data
-    subdata_nav = data.isig[3].data
-    data.isig[:]
-    pass

pymodaq/utils/units.py

@@ -1,216 +0,0 @@
-# -*- 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
-
-
-

pymodaq-4.4.7.dist-info/METADATA

@@ -1,163 +0,0 @@
-Metadata-Version: 2.3
-Name: pymodaq
-Version: 4.4.7
-Summary: Modular Data Acquisition with Python
-Project-URL: Homepage, http://pymodaq.cnrs.fr
-Project-URL: Source, https://github.com/PyMoDAQ/PyMoDAQ
-Project-URL: Tracker, https://github.com/PyMoDAQ/PyMoDAQ/issues
-Author-email: Sébastien Weber <sebastien.weber@cemes.fr>
-License: The MIT License (MIT)
-        
-        Copyright (c) 2021 Sebastien Weber <sebastien.weber@cemes.fr>
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in
-        all copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-        THE SOFTWARE.
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Environment :: Other Environment
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Natural Language :: English
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Topic :: Scientific/Engineering :: Human Machine Interfaces
-Classifier: Topic :: Scientific/Engineering :: Visualization
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Classifier: Topic :: Software Development :: User Interfaces
-Requires-Python: >=3.7
-Requires-Dist: bayesian-optimization<2.0.0
-Requires-Dist: easydict
-Requires-Dist: importlib-metadata; python_version < '3.8'
-Requires-Dist: multipledispatch
-Requires-Dist: numpy<2.0.0
-Requires-Dist: packaging
-Requires-Dist: pint
-Requires-Dist: pyleco>0.3; python_version >= '3.8'
-Requires-Dist: pymodaq-plugin-manager>=0.0.17
-Requires-Dist: pymodaq-plugins-mock<5.0.0
-Requires-Dist: pyqtgraph>=0.12
-Requires-Dist: python-dateutil
-Requires-Dist: qdarkstyle
-Requires-Dist: qtconsole
-Requires-Dist: qtpy
-Requires-Dist: scipy
-Requires-Dist: setuptools>=60
-Requires-Dist: simple-pid
-Requires-Dist: tables<3.9
-Requires-Dist: toml
-Description-Content-Type: text/x-rst
-
-PyMoDAQ
-#######
-
-.. image:: https://img.shields.io/pypi/v/pymodaq.svg
-   :target: https://pypi.org/project/pymodaq/
-   :alt: Latest Version
-
-.. image:: https://readthedocs.org/projects/pymodaq/badge/?version=latest
-   :target: https://pymodaq.readthedocs.io/en/stable/?badge=latest
-   :alt: Documentation Status
-
-.. image:: https://codecov.io/gh/PyMoDAQ/PyMoDAQ/branch/4.4.x/graph/badge.svg?token=IQNJRCQDM2
-    :target: https://codecov.io/gh/PyMoDAQ/PyMoDAQ
-
-====== ========== ======= ======
-Python Qt Backend OS      Passed
-====== ========== ======= ======
-3.8    Qt5        Linux   |38Qt5|
-3.9    Qt5        Linux   |39Qt5|
-3.10   Qt5        Linux   |310Qt5|
-3.11   Qt5        Linux   |311Qt5|
-3.8    Qt5        Windows |38Qt5win|
-3.8    PySide2    Linux   |38pyside|
-3.9    Qt6        Linux   |39Qt6|
-====== ========== ======= ======
-
-
-.. |38Qt5| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyqt5.yml/badge.svg?branch=4.4.x
-    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyqt5.yml
-
-.. |39Qt5| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp39pyqt5.yml/badge.svg?branch=4.4.x
-    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp39pyqt5.yml
-
-.. |310Qt5| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp310pyqt5.yml/badge.svg?branch=4.4.x
-    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp310pyqt5.yml
-
-.. |311Qt5| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp311pyqt5.yml/badge.svg?branch=4.4.x
-    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp311pyqt5.yml
-
-.. |38Qt5win| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyqt5_win.yml/badge.svg?branch=4.4.x
-    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyqt5_win.yml
-
-.. |38pyside| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyside2.yml/badge.svg?branch=4.4.x
-    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp38pyside2.yml
-
-.. |39Qt6| image:: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp39pyqt6.yml/badge.svg?branch=4.4.x
-    :target: https://github.com/PyMoDAQ/PyMoDAQ/actions/workflows/Testp39pyqt6.yml
-
-
-
-.. figure:: http://pymodaq.cnrs.fr/en/latest/_static/splash.png
-   :alt: shortcut
-
-
-PyMoDAQ, Modular Data Acquisition with Python, is a set of **python** modules used to interface any kind of experiments.
-It simplifies the interaction with detector and actuator hardware to go straight to the data acquisition of interest.
-
-It has two purposes:
-
-* First, to provide a complete interface to perform automated measurements or logging data without having to write a user/interface for each
-  new experiment, this is under the *Dashboard_module* environment and its extensions.
-* Second, to provide various tools (modules) to easily build *custom apps*
-
-It is organised a shown below:
-
-.. figure:: http://pymodaq.cnrs.fr/en/latest/_images/pymodaq_diagram.png
-   :alt: overview
-
-   PyMoDAQ's Dashboard and its extensions: DAQ_Scan for automated acquisitions, DAQ_Logger for data logging and many other.
-
-The main component is the **Dashboard** : This is a graphical component that will initialize actuators and detectors given
-the need of your particular experiment. You configure the dashboard using an interface for quick launch of various
-configurations (numbers and types of control modules).
-
-The detectors and the actuators are represented and manipulated using two control modules:
-
-* **DAQ_Move_module** : used to control/drive an actuator (stand alone and/or automated).
-  Any number of these modules can be instantiated in the Dashboard
-* **DAQ_Viewer_module** : used to control/drive a detector (stand alone and/or automated).
-
-Any number of these modules can be instantiated in the Dashboard.
-
-The Dashboard allows you to start dedicated extensions that will make use of the control modules:
-
-* **DAQ_Logger_module** : This module lets you log data from one or many detectors defined in the dashboard. You can log data
-  in a binary hierarchical hdf5 file or towards a sql database
-* **DAQ_Scan_module** : This module lets you configure automated data acquisition from one or many detectors defined
-  in the dashboard as a function or one or more actuators defined also in the dashboard.
-
-and many others to simplify any application development.
-
-Published under the MIT FREE SOFTWARE LICENSE
-
-GitHub repo: https://github.com/PyMoDAQ
-
-Documentation: http://pymodaq.cnrs.fr/