From c2f980c6bb40df45d411904dd5f58288fa7b8ad3 Mon Sep 17 00:00:00 2001 From: zm711 <92116279+zm711@users.noreply.github.com> Date: Mon, 21 Oct 2024 14:28:20 -0400 Subject: [PATCH 1/2] typos --- doc/modules/curation.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/modules/curation.rst b/doc/modules/curation.rst index d115b33e4a..d24fc810b0 100644 --- a/doc/modules/curation.rst +++ b/doc/modules/curation.rst @@ -88,7 +88,7 @@ The ``censored_period_ms`` parameter is the time window in milliseconds to consi The :py:func:`~spikeinterface.curation.remove_redundand_units` function removes redundant units from the sorting output. Redundant units are units that share over a certain percentage of spikes, by default 80%. -The function can acto both on a ``BaseSorting`` or a ``SortingAnalyzer`` object. +The function can act both on a ``BaseSorting`` or a ``SortingAnalyzer`` object. .. code-block:: python @@ -102,13 +102,16 @@ The function can acto both on a ``BaseSorting`` or a ``SortingAnalyzer`` object. ) # remove redundant units from SortingAnalyzer object - clean_sorting_analyzer = remove_redundant_units( + # note this returns a cleaned sorting + clean_sorting = remove_redundant_units( sorting_analyzer, duplicate_threshold=0.9, remove_strategy="min_shift" ) + # in order to have a sorter with only the non-redundant units do: + clean_sorting_analyzer = sorting_analyzer.select_units(clean_sorting.unit_ids) -We recommend usinf the ``SortingAnalyzer`` approach, since the ``min_shift`` strategy keeps +We recommend using the ``SortingAnalyzer`` approach, since the ``min_shift`` strategy keeps the unit (among the redundant ones), with a better template alignment. From 61ce0007476b9a1e80d69bdbbc42e70d8bcce626 Mon Sep 17 00:00:00 2001 From: zm711 <92116279+zm711@users.noreply.github.com> Date: Mon, 21 Oct 2024 14:32:37 -0400 Subject: [PATCH 2/2] better comment --- doc/modules/curation.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/modules/curation.rst b/doc/modules/curation.rst index d24fc810b0..37de992806 100644 --- a/doc/modules/curation.rst +++ b/doc/modules/curation.rst @@ -108,7 +108,9 @@ The function can act both on a ``BaseSorting`` or a ``SortingAnalyzer`` object. duplicate_threshold=0.9, remove_strategy="min_shift" ) - # in order to have a sorter with only the non-redundant units do: + # in order to have a SortingAnalyer with only the non-redundant units one must + # select the designed units remembering to give format and folder if one wants + # a persistent SortingAnalyzer. clean_sorting_analyzer = sorting_analyzer.select_units(clean_sorting.unit_ids) We recommend using the ``SortingAnalyzer`` approach, since the ``min_shift`` strategy keeps