added 'save' param to 'phase_synchrony_metrics'

Author: AlvaroDeleglise

pyleida/_data_loader.py

@@ -601,7 +601,7 @@ def overlap_withyeo(self,parcellation=None,n_areas=None,k=2,state=None,darkstyle
 
         return overlap
 
-    def phase_synchrony_metrics(self,k=2):
+    def phase_synchrony_metrics(self,k=2,save=True):
         """
         For each subject, compute the Kuramoto order 
         parameter for each community at each time t.
@@ -622,6 +622,10 @@ def phase_synchrony_metrics(self,k=2):
         k : int.
             Select the K partition of interest.
 
+        save : bool. Default = True.
+            Whether to save the results in
+            .csv files in 'dynamics_metrics/'.
+
         Returns:
         --------
         kuramoto : pd.DataFrame.
@@ -648,6 +652,7 @@ def phase_synchrony_metrics(self,k=2):
 
         kura_lst = []
 
+        print('-Computing the Kuramoto order parameter.')
         for sub_id in subject_ids: #for each subject
             #get current subject signals
             tseries = time_series[sub_id]
@@ -676,6 +681,7 @@ def phase_synchrony_metrics(self,k=2):
 
         # Compute synchronization of each
         # community as their time-average
+        print('\n-Computing synchronization')
         synchronization = kuramoto.groupby(['subject_id','condition']).mean().reset_index()
 
         # Compute global synchronization
@@ -688,6 +694,7 @@ def phase_synchrony_metrics(self,k=2):
 
         # Compute metastability of each community
         # as their std across time.
+        print('-Computing metastability.')
         metastability = kuramoto.groupby(['subject_id','condition']).std().reset_index()
 
         # Compute global metastability
@@ -698,6 +705,16 @@ def phase_synchrony_metrics(self,k=2):
 
         metastability['global'] = global_meta
 
+        if save:
+            try:
+                res_pth = f'{self._results_path_}/dynamics_metrics/k_{k}'
+                print(f'Saving results to {res_pth}')
+                kuramoto.to_csv(f'{res_pth}/kuramoto.csv',index=False)
+                synchronization.to_csv(f'{res_pth}/synchronization.csv',index=False)
+                metastability.to_csv(f'{res_pth}/metastability.csv',index=False)
+            except:
+                print(f'An error occured when saving the results to {res_pth}')
+
         return kuramoto,synchronization,metastability
 
     def phase_locking_metastability(self,k):

pyleida/_leida.py

@@ -1042,7 +1042,7 @@ def _pool_stats(self,metric="occupancies"):
         data = pd.concat((data),ignore_index=True)
         return data
 
-    def phase_synchrony_metrics(self,k=2):
+    def phase_synchrony_metrics(self,k=2,save=True):
         """
         For each subject, compute the Kuramoto order 
         parameter for each community at each time t.
@@ -1063,6 +1063,10 @@ def phase_synchrony_metrics(self,k=2):
         k : int.
             Select the K partition of interest.
 
+        save : bool. Default = True.
+            Whether to save the results in
+            .csv files in 'dynamics_metrics/'.
+
         Returns:
         --------
         kuramoto : pd.DataFrame.
@@ -1088,6 +1092,7 @@ def phase_synchrony_metrics(self,k=2):
 
         kura_lst = []
 
+        print('-Computing the Kuramoto order parameter.')
         for sub_id in subject_ids: #for each subject
             #get current subject signals
             tseries = self.time_series[sub_id]
@@ -1116,6 +1121,7 @@ def phase_synchrony_metrics(self,k=2):
 
         # Compute synchronization of each
         # community as their time-average
+        print('\n-Computing synchronization')
         synchronization = kuramoto.groupby(['subject_id','condition']).mean().reset_index()
 
         # Compute global synchronization
@@ -1128,6 +1134,7 @@ def phase_synchrony_metrics(self,k=2):
 
         # Compute metastability of each community
         # as their std across time.
+        print('-Computing metastability.')
         metastability = kuramoto.groupby(['subject_id','condition']).std().reset_index()
 
         # Compute global metastability
@@ -1138,6 +1145,16 @@ def phase_synchrony_metrics(self,k=2):
 
         metastability['global'] = global_meta
 
+        if save:
+            try:
+                res_pth = f'{self._results_path_}/dynamics_metrics/k_{k}'
+                print(f'Saving results to {res_pth}')
+                kuramoto.to_csv(f'{res_pth}/kuramoto.csv',index=False)
+                synchronization.to_csv(f'{res_pth}/synchronization.csv',index=False)
+                metastability.to_csv(f'{res_pth}/metastability.csv',index=False)
+            except:
+                print(f'An error occured when saving the results to {res_pth}')
+
         return kuramoto,synchronization,metastability
 
     def phase_locking_metastability(self,k):