rename mnemonics to fields

src/toolbox_scs/load.py

@@ -498,7 +498,7 @@ def concatenateRuns(runs):
     return result
 
 
-def check_data_rate(run, mnemonics=None):
+def check_data_rate(run, fields=None):
     """
     Calculates the fraction of train ids that contain data in a run.
 
@@ -506,7 +506,7 @@ def check_data_rate(run, mnemonics=None):
     ----------
     run: extra_data DataCollection
         the DataCollection associated to the data.
-    mnemonics: str, list of str or dict
+    fields: str, list of str or dict
         mnemonics to check. If None, all mnemonics in the run are checked.
         A custom mnemonic can be defined with a dictionnary: {'extra':
         {'source': 'SCS_CDIFFT_MAG/SUPPLY/CURRENT', 'key':
@@ -518,20 +518,20 @@ def check_data_rate(run, mnemonics=None):
         that contain data as values.
     """
     run_mnemonics = mnemonics_for_run(run)
-    if mnemonics is None:
-        mnemonics = run_mnemonics
-    mnemonics = [mnemonics] if isinstance(mnemonics, str) else mnemonics
+    if fields is None:
+        fields = run_mnemonics
+    fields = [fields] if isinstance(fields, str) else fields
     ret = {}
-    for m in mnemonics:
-        if isinstance(m, dict):
-            name = list(m.keys())[0]
-            val = m[name]
-            m = name
-        elif m not in run_mnemonics:
-            log.warning(f'mnemonic {m} not found. Skipping!')
+    for f in fields:
+        if isinstance(f, dict):
+            name = list(f.keys())[0]
+            val = f[name]
+            f = name
+        elif f not in run_mnemonics:
+            log.warning(f'mnemonic {f} not found. Skipping!')
             continue
         else:
-            val = run_mnemonics[m]
+            val = run_mnemonics[f]
         counts = run[val['source']][val['key']].data_counts(False)
         npulses = counts.max()
         if npulses == 0:  # (only missing data)
@@ -539,5 +539,5 @@ def check_data_rate(run, mnemonics=None):
         else:
             counts = counts / npulses  # to only count trains and not pulses
             rate = counts.sum() / len(run.train_ids)
-        ret[m] = rate
+        ret[f] = rate
     return ret