pymodaq_data 5.0.2__tar.gz → 5.0.4__tar.gz

{pymodaq_data-5.0.2 → pymodaq_data-5.0.4}/.gitignore

@@ -1,6 +1,8 @@
 # Compiled python modules.
 *.pyc
 
+_version.py
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 

{pymodaq_data-5.0.2 → pymodaq_data-5.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pymodaq_data
-Version: 5.0.2
+Version: 5.0.4
 Summary: Modular Data Acquisition with Python
 Project-URL: Homepage, http://pymodaq.cnrs.fr
 Project-URL: Source, https://github.com/PyMoDAQ/PyMoDAQ

{pymodaq_data-5.0.2 → pymodaq_data-5.0.4}/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '5.0.2'
-__version_tuple__ = version_tuple = (5, 0, 2)
+__version__ = version = '5.0.4'
+__version_tuple__ = version_tuple = (5, 0, 4)

{pymodaq_data-5.0.2 → pymodaq_data-5.0.4}/src/pymodaq_data/data.py

@@ -585,7 +585,7 @@ class DataBase(DataLowLevel, NDArrayOperatorsMixin):
     >>> import numpy as np
     >>> from pymodaq.utils.data import DataBase, DataSource, DataDim, DataDistribution
     >>> data = DataBase('mydata', source=DataSource['raw'], dim=DataDim['Data1D'], \
-    distribution=DataDistribution['uniform'], data=[np.array([1.,2.,3.]), np.array([4.,5.,6.])],\
+    distribution=DataDistribution.uniform, data=[np.array([1.,2.,3.]), np.array([4.,5.,6.])],\
     labels=['channel1', 'channel2'], origin='docutils code')
     >>> data.dim
     <DataDim.Data1D: 1>
@@ -603,7 +603,7 @@ class DataBase(DataLowLevel, NDArrayOperatorsMixin):
 
     def __init__(self, name: str,
                  source: DataSource = None, dim: DataDim = None,
-                 distribution: DataDistribution = DataDistribution['uniform'],
+                 distribution: DataDistribution = DataDistribution.uniform,
                  data: List[np.ndarray] = None,
                  labels: List[str] = None, origin: str = '',
                  units: str = '',
@@ -678,6 +678,49 @@ class DataBase(DataLowLevel, NDArrayOperatorsMixin):
         """ Change immediately the units to whatever else. Use this with care!"""
         self._units = units
 
+    def value(self, units: str = None) -> float:
+        """Returns the underlying float value (of the first elt in the data list) if this data
+        holds only a float otherwise returns a mean of the underlying data
+
+        Parameters
+        ----------
+
+        units: str
+            if unit is compatible with self.units, convert the data to these new units before
+            getting the value
+
+
+        """
+        if self.length == 1 and self.size == 1:
+            if units is not None:
+                data = Q_(float(self.data[0][0]), self.units)
+                return data.m_as(units)
+            else:
+                return float(self.data[0][0])
+        else:
+            if units is not None:
+                data = Q_(float(np.mean(self.data[0])), self.units)
+                return data.m_as(units)
+            else:
+                return float(np.mean(self.data[0]))
+
+    def values(self, units: str = None) -> List[float]:
+        """Returns the underlying float value (for each data array in the data list) if this data
+        holds only a float otherwise returns a mean of the underlying data"""
+        if self.length == 1 and self.size == 1:
+            if units is not None:
+                return [float(Q_(data_array[0], self.units).m_as(units))
+                        for data_array in self.data]
+            else:
+                return [float(data_array[0])
+                        for data_array in self.data]
+        else:
+            if units is not None:
+                return [float(Q_(np.mean(data_array), self.units).m_as(units))
+                        for data_array in self.data]
+            else:
+                return [float(np.mean(data_array)) for data_array in self.data]
+
     def as_dte(self, name: str = 'mydte') -> DataToExport:
         """Convenience method to wrap the DataWithAxes object into a DataToExport"""
         return DataToExport(name, data=[self])
@@ -1668,6 +1711,19 @@ class DataWithAxes(DataBase):
         #then use get_dim_from axes
         self._check_errors(errors)
 
+    def check_axes_linear(self, axes: List[Axis] = None) -> bool:
+        """ Check if any axis may be non linear
+
+        Should trigger a spread like distribution except id dim is Data1D, in which cas, it doesn't
+        matter
+        """
+        if axes is None:
+            axes = self._axes
+        are_axes_linear = True
+        for axis in axes:
+            are_axes_linear = are_axes_linear and axis.is_axis_linear()
+        return are_axes_linear
+
     def _check_errors(self, errors: Iterable[np.ndarray]):
         """ Make sure the errors object is adapted to the len/shape of the dwa object
 
@@ -1734,12 +1790,12 @@ class DataWithAxes(DataBase):
         return plotter_factory.get(plotter_backend).plot(self, *args, viewer=viewer, **kwargs)
 
     def set_axes_manager(self, data_shape, axes, nav_indexes, **kwargs):
-        if self.distribution.name == 'uniform' or len(nav_indexes) == 0:
-            self._distribution = DataDistribution['uniform']
+        if self.distribution.name == DataDistribution.uniform.name or len(nav_indexes) == 0:
+            self._distribution = DataDistribution.uniform
             self.axes_manager = AxesManagerUniform(data_shape=data_shape, axes=axes,
                                                    nav_indexes=nav_indexes,
                                                    **kwargs)
-        elif self.distribution.name == 'spread':
+        elif self.distribution.name == DataDistribution.spread.name:
             self.axes_manager = AxesManagerSpread(data_shape=data_shape, axes=axes,
                                                   nav_indexes=nav_indexes,
                                                   **kwargs)
@@ -2050,6 +2106,7 @@ class DataWithAxes(DataBase):
             self._dim = DataDim['DataND']
         return self._dim
 
+
     @property
     def n_axes(self):
         """Get the number of axes (even if not specified)"""
@@ -2064,6 +2121,7 @@ class DataWithAxes(DataBase):
     def axes(self, axes: List[Axis]):
         """convenience property to set attribute from axis_manager"""
         self.set_axes_manager(self.shape, axes=axes, nav_indexes=self.nav_indexes)
+        self._axes = axes
 
     def axes_limits(self, axes_indexes: List[int] = None) -> List[Tuple[float, float]]:
         """Get the limits of specified axes (all if axes_indexes is None)"""
@@ -2243,7 +2301,7 @@ class DataWithAxes(DataBase):
         if len(nav_indexes) != 0:
             distribution = self.distribution
         else:
-            distribution = DataDistribution['uniform']
+            distribution = DataDistribution.uniform
 
         data = DataWithAxes(self.name, data=new_arrays_data, nav_indexes=tuple(nav_indexes),
                             axes=axes,

{pymodaq_data-5.0.2 → pymodaq_data-5.0.4}/src/pymodaq_data/h5modules/data_saving.py

@@ -1001,7 +1001,7 @@ class DataLoader:
 
         if isinstance(h5saver, Path) or isinstance(h5saver, str):
             h5saver_tmp = H5SaverLowLevel()
-            h5saver_tmp.init_file(addhoc_file_path=Path(h5saver))
+            h5saver_tmp.init_file(file_name=Path(h5saver))
             h5saver = h5saver_tmp
 
         self.h5saver = h5saver

{pymodaq_data-5.0.2 → pymodaq_data-5.0.4}/src/pymodaq_data/h5modules/saving.py

@@ -89,7 +89,8 @@ class H5SaverLowLevel(H5Backend):
     def h5_file(self):
         return self._h5file
 
-    def init_file(self, file_name: Path, raw_group_name='RawData', new_file=False, metadata: dict = None):
+    def init_file(self, file_name: Path, raw_group_name='RawData', new_file=False,
+                  metadata: dict = None):
         """Initializes a new h5 file.
 
         Parameters
@@ -100,6 +101,8 @@ class H5SaverLowLevel(H5Backend):
             Base node name
         new_file: bool
             If True create a new file, otherwise append to a potential existing one
+        metadata: dict
+            A dictionary to be saved as attributes
 
         Returns
         -------

{pymodaq_data-5.0.2 → pymodaq_data-5.0.4}/src/pymodaq_data/plotting/plotter/plotter.py

@@ -18,7 +18,7 @@ from pymodaq_utils.factory import ObjectFactory
 logger = set_logger(get_module_name(__file__))
 
 
-def register_plotter(parent_module_name: str = 'pymodaq.utils.plotting.plotter'):
+def register_plotter(parent_module_name: str = 'pymodaq_data.plotting.plotter'):
     plotters = []
     try:
         plotter_module = import_module(f'{parent_module_name}.plotters')