pymodaq_data 5.0.3__tar.gz → 5.0.4__tar.gz

{pymodaq_data-5.0.3 → 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.3 → pymodaq_data-5.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pymodaq_data
-Version: 5.0.3
+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.3 → 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.3'
-__version_tuple__ = version_tuple = (5, 0, 3)
+__version__ = version = '5.0.4'
+__version_tuple__ = version_tuple = (5, 0, 4)

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

@@ -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])