Documentation, Refactoring and new data savinf functions

Author: patfuchs

sciopy/EIT_16_32_64_128.py

@@ -29,7 +29,8 @@
 }
 
 from .sciopy_dataclasses import EitMeasurementSetup
-from sciopydev.sciopy.usb_message_parser import MessageParser, make_eitframes_hex, get_data_as_matrix
+from sciopydev.sciopy.usb_message_parser import (MessageParser, make_eitframes_hex, get_data_as_matrix,
+                                                 make_results_folder)
 
 
 class EIT_16_32_64_128:
@@ -581,7 +582,7 @@ def StartStopMeasurementFast(self, return_as="pot_mat"):
         elif return_as == "pot_mat":
             return self.get_data_as_matrix()
 
-    #todo check
+
     def StartStopMeasurementNew(self, timeout:int=0, return_as="pot_mat", bSaveData:bool=False, bDeleteData:bool=False,
                                 sSavepath:str="C/", bResultsFolder=True):
         """
@@ -599,8 +600,8 @@ def StartStopMeasurementNew(self, timeout:int=0, return_as="pot_mat", bSaveData:
                 - "pot_mat": Returns the processed data as a matrix using `get_data_as_matrix()`.
                 Default is "pot_mat".
                 - else: data is only stored
-            bSaveData (bool): Specifies if a the measured data is saved in NPZ format
-            bDeleteData (bool): Specifies if a the measured data is deleted out of memory after each EITframe, with
+            bSaveData (bool): Specifies if the measured data is saved in NPZ format
+            bDeleteData (bool): Specifies if the measured data is deleted out of memory after each EITframe, with
                 bSaveData=True, measured data is saved and then removed from RAM
             sSavepath (str): Specifies the sPath where the measured data is saved.
 
@@ -610,14 +611,13 @@ def StartStopMeasurementNew(self, timeout:int=0, return_as="pot_mat", bSaveData:
 
         # Start measurement
         self.cMessageParser.clear_out_data()
-        if bResultsFolder:
-            self.cMessageParser.make_results_folder(bResultsFolder, bSaveData, sSavepath)
+        sCurrentPath= make_results_folder(bResultsFolder, bSaveData, sSavepath) # No new path is created  if bResultsFolder=False
 
         self.send_message(bytearray([0xB4, 0x01, 0x01, 0xB4]))
         self.cMessageParser.bPrintMessages = False
         if timeout != 0:
             self.cMessageParser.read_usb_for_seconds(timeout, bSaveData=bSaveData, bDeleteDataFrame=bDeleteData,
-                                                            sSavePath=sSavepath,bResultsFolder=False )
+                                                            sSavePath=sCurrentPath,bResultsFolder=False )
         else:
             if self.setup.burst_count ==0:
                 print("Burst count for this setup needs to be >=1")
@@ -628,7 +628,7 @@ def StartStopMeasurementNew(self, timeout:int=0, return_as="pot_mat", bSaveData:
         self.send_message(bytearray([0xB4, 0x01, 0x00, 0xB4]))
         # All data is returned if wanted
         data = self.cMessageParser.read_usb_till_timeout(bSaveData=bSaveData, bDeleteDataFrame=bDeleteData,
-                                                          sSavePath=sSavepath, bResultsFolder=False)
+                                                          sSavePath=sCurrentPath, bResultsFolder=False)
 
         if bDeleteData:
             return
@@ -639,6 +639,8 @@ def StartStopMeasurementNew(self, timeout:int=0, return_as="pot_mat", bSaveData:
         elif return_as == "eitframe":
             return data
 
+
+
     def get_data_as_matrix(self):
         """
         Converts the raw EIT data into a 3D matrix of potentials.

sciopy/sciopy_dataclasses.py

@@ -2,7 +2,7 @@
 
 from dataclasses import dataclass
 from typing import List, Tuple, Union
-
+import numpy.typing as npt
 
 @dataclass
 class EitMeasurementSetup:
@@ -211,3 +211,33 @@ class PreperationConfig:
     lpath: str
     spath: str
     n_samples: int
+
+
+
+# -------------------------------------------------------------------------------------------------------------------- #
+@dataclass
+class EITFrame:
+    """
+    This class is for parsing the whole EIT excitation stages (and frequency stages).
+    Defined by Sciospec:"EIT -16,32,64,128", Chapter 5.4.1
+
+    Parameters
+    ----------
+    n_el = Number of used electrodes
+    excitation_stgs : np.array [[int1, int2]] , Features the [ESout, ESin] injection electrodes
+    frequency_stgs : List[str] # todo
+    timestamp1 : int Timestamp of the very first measured channel group in this frame, milli seconds?
+    timestamp2 : int Timestamp of the very last measured channel group in this frame, milli seconds?
+    ppcData : np.array [[Complex measured data]]
+              for e in used excitations stages,
+                 for f in used frequency stages:
+                    for c in all used channels: -> insert complex value
+    """
+    n_el: int  # Number of used electrodes
+    excitation_stgs: npt.NDArray[int]  # Num Excitation Settings X 2
+    frequency_stgs: npt.NDArray[int]  # List of Frequency-Sweep Settings,
+    timestamp1: int  # [ms]
+    timestamp2: int
+    ppcData: npt.NDArray[complex]  # Channels 1-(64) all channel groups combined
+
+