📝 docs(AdvancedDataWorker.py): update docstrings to reflect changes in the module

The name of the module has been changed to AdvancedDataWorker.py to better reflect its functionality. The description has been updated to include the extraction of morphological indicators. The parameters and instance variables have been updated to reflect the change in functionality. The run() method has been updated to include a description of the emitted signal and the keys of the dictionary that is emitted.

utils/gui/pyqt/main_window/Workers/AdvancedDataWorker.py

@@ -1,7 +1,7 @@
 """
-Created on Wed Apr 26 2023
-@name:   DiscreteDataWorker.py
-@desc:   A module to process discrete data in a thread
+Created on Thu May 4 2023
+@name:   AdvancedDataWorker.py
+@desc:   A module to process discrete data and extract morphological indicators
 @auth:   Djalim Simaila
 @e-mail: djalim.simaila@inrae.fr
 """
@@ -14,16 +14,10 @@ class AdvancedDataWorker(Worker):
     Worker to calculate the discrete data in a thread
 
     :param name: The name of the worker
-    :param obj: The scanned object
-    :param output_path: The path to save the output file
-    :param output_file_prefix: The prefix of the output file
-    :param delta_z: The delta z
+    :param discrete_data: The discrete data to process
 
-    :ivar obj: The scanned object
-    :ivar delta_z: The delta z
-    :ivar output_path: The path to save the output file
-    :ivar output_file_prefix: The prefix of the output file
-    :ivar processedData: The signal to emit the result
+    :ivar processedData: Signal emitted when the data is processed
+    :ivar discrete_data: The discrete data to process
     """
     processedData = pyqtSignal(dict)
 
@@ -34,7 +28,16 @@ class AdvancedDataWorker(Worker):
 
     def run(self):
         """
-        Run the analyse
+        This function is called when the thread is started.
+        It calculates the advanced data and emits a dict with the following keys:
+            - Tortuosite
+            - Volume
+            - Surface
+            - Moyenne des rayons moyens
+            - Ecart-type des rayons moyens
+            - Sigma r tot
+            - MI_l
+            - MI_p
         """
         self.set_status("Calculating advanced data...")
         advanced_data = get_advanced_data(self.discrete_data,self.update_progress)