Skip to content

Commit 9b53f09

Browse files
authored
Merge pull request #3496 from zm711/curation-docs
Fix a few typos in the curation docs
2 parents f4dd922 + 61ce000 commit 9b53f09

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

doc/modules/curation.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ The ``censored_period_ms`` parameter is the time window in milliseconds to consi
8888
The :py:func:`~spikeinterface.curation.remove_redundand_units` function removes
8989
redundant units from the sorting output. Redundant units are units that share over
9090
a certain percentage of spikes, by default 80%.
91-
The function can acto both on a ``BaseSorting`` or a ``SortingAnalyzer`` object.
91+
The function can act both on a ``BaseSorting`` or a ``SortingAnalyzer`` object.
9292

9393
.. code-block:: python
9494
@@ -102,13 +102,18 @@ The function can acto both on a ``BaseSorting`` or a ``SortingAnalyzer`` object.
102102
)
103103
104104
# remove redundant units from SortingAnalyzer object
105-
clean_sorting_analyzer = remove_redundant_units(
105+
# note this returns a cleaned sorting
106+
clean_sorting = remove_redundant_units(
106107
sorting_analyzer,
107108
duplicate_threshold=0.9,
108109
remove_strategy="min_shift"
109110
)
111+
# in order to have a SortingAnalyer with only the non-redundant units one must
112+
# select the designed units remembering to give format and folder if one wants
113+
# a persistent SortingAnalyzer.
114+
clean_sorting_analyzer = sorting_analyzer.select_units(clean_sorting.unit_ids)
110115
111-
We recommend usinf the ``SortingAnalyzer`` approach, since the ``min_shift`` strategy keeps
116+
We recommend using the ``SortingAnalyzer`` approach, since the ``min_shift`` strategy keeps
112117
the unit (among the redundant ones), with a better template alignment.
113118

114119

0 commit comments

Comments
 (0)