Rename threshold_metrics_label_units

Author: alejoe91

doc/api.rst

@@ -373,6 +373,7 @@ spikeinterface.curation
     .. autofunction:: remove_redundant_units
     .. autofunction:: remove_duplicated_spikes
     .. autofunction:: remove_excess_spikes
+    .. autofunction:: threshold_metrics_label_units
     .. autofunction:: model_based_label_units
     .. autofunction:: load_model
     .. autofunction:: train_model

src/spikeinterface/curation/__init__.py

@@ -20,7 +20,7 @@
 from .sortingview_curation import apply_sortingview_curation
 
 # automated curation
-from .qualitymetrics_curation import qualitymetrics_label_units
+from .qualitymetrics_curation import threshold_metrics_label_units
 from .model_based_curation import model_based_label_units, load_model, auto_label_units
 from .train_manual_curation import train_model, get_default_classifier_search_spaces
 from .unitrefine_curation import unitrefine_label_units

src/spikeinterface/curation/qualitymetrics_curation.py

@@ -8,7 +8,7 @@
 from .curation_tools import is_threshold_disabled
 
 
-def qualitymetrics_label_units(
+def threshold_metrics_label_units(
     analyzer: SortingAnalyzer,
     thresholds: dict | str | Path,
 ):

src/spikeinterface/curation/tests/test_qualitymetrics_curation.py

@@ -2,19 +2,19 @@
 import json
 
 from spikeinterface.curation.tests.common import sorting_analyzer_for_curation
-from spikeinterface.curation import qualitymetrics_label_units
+from spikeinterface.curation import threshold_metrics_label_units
 
 
-def test_qualitymetrics_label_units(sorting_analyzer_for_curation):
-    """Test the `qualitymetrics_label_units` function."""
+def test_threshold_metrics_label_units(sorting_analyzer_for_curation):
+    """Test the `threshold_metrics_label_units` function."""
     sorting_analyzer_for_curation.compute("quality_metrics")
 
     thresholds = {
         "snr": {"min": 5.0},
         "firing_rate": {"min": 0.1, "max": 20.0},
     }
 
-    labels = qualitymetrics_label_units(
+    labels = threshold_metrics_label_units(
         sorting_analyzer_for_curation,
         thresholds,
     )
@@ -36,8 +36,8 @@ def test_qualitymetrics_label_units(sorting_analyzer_for_curation):
             assert labels.loc[unit_id, "label"] == "noise"
 
 
-def test_qualitymetrics_label_units_with_file(sorting_analyzer_for_curation, tmp_path):
-    """Test the `qualitymetrics_label_units` function with thresholds from a JSON file."""
+def test_threshold_metrics_label_units_with_file(sorting_analyzer_for_curation, tmp_path):
+    """Test the `threshold_metrics_label_units` function with thresholds from a JSON file."""
     sorting_analyzer_for_curation.compute("quality_metrics")
 
     thresholds = {
@@ -49,7 +49,7 @@ def test_qualitymetrics_label_units_with_file(sorting_analyzer_for_curation, tmp
     with open(thresholds_file, "w") as f:
         json.dump(thresholds, f)
 
-    labels = qualitymetrics_label_units(
+    labels = threshold_metrics_label_units(
         sorting_analyzer_for_curation,
         thresholds_file,
     )