Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions doc/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -404,9 +404,6 @@ Deprecated
:noindex:

.. autofunction:: apply_sortingview_curation
.. autoclass:: CurationSorting
.. autoclass:: MergeUnitsSorting
.. autoclass:: SplitUnitSorting


spikeinterface.generation
Expand Down
38 changes: 0 additions & 38 deletions doc/modules/curation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -487,41 +487,3 @@ We have other tools for cleaning spike sorting outputs:
* :py:func:`~spikeinterface.curation.find_duplicated_spikes` : find duplicated spikes in the spike trains
* | :py:func:`~spikeinterface.curation.remove_excess_spikes` : remove spikes whose times are greater than the
| recording's number of samples (by segment)


The `CurationSorting` class (deprecated)
----------------------------------------

SpikeInterface offers machinery to manually curate a sorting output and keep track of the curation history.
The curation has several "steps" that can be repeated and chained:

* remove/select units
* split units
* merge units

This functionality is done with :py:class:`~spikeinterface.curation.CurationSorting` class.
Internally, this class keeps the history of curation as a graph.
The merging and splitting operations are handled by the :py:class:`~spikeinterface.curation.MergeUnitsSorting` and
:py:class:`~spikeinterface.curation.SplitUnitSorting`. These two classes can also be used independently.


.. code-block:: python

from spikeinterface.curation import CurationSorting

sorting = run_sorter(sorter_name='kilosort2', recording=recording)

cs = CurationSorting(parent_sorting=sorting)

# make a first merge
cs.merge(units_to_merge=['#1', '#5', '#15'])

# make a second merge
cs.merge(units_to_merge=['#11', '#21'])

# make a split
split_index = ... # some criteria on spikes
cs.split(split_unit_id='#20', indices_list=split_index)

# here is the final clean sorting
clean_sorting = cs.sorting
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
import numpy as np


from spikeinterface.core.sorting_tools import apply_merges_to_sorting
from spikeinterface.sorters import run_sorter

from spikeinterface.comparison import GroundTruthComparison
from spikeinterface.sortingcomponents.motion.motion_interpolation import InterpolateMotionRecording
from spikeinterface.curation import MergeUnitsSorting


from .benchmark_base import Benchmark, BenchmarkStudy


Expand Down Expand Up @@ -77,7 +74,7 @@ def compute_result(self, exhaustive_gt=True, merging_score=0.2):
if merge_ids.size > 1:
to_merge.append(list(merge_ids))

merged_sporting = MergeUnitsSorting(sorting, to_merge)
merged_sporting = apply_merges_to_sorting(sorting, to_merge)
comparison_merged = GroundTruthComparison(self.gt_sorting, merged_sporting, exhaustive_gt=True)

self.result["comparison_merged"] = comparison_merged
Expand Down
5 changes: 0 additions & 5 deletions src/spikeinterface/curation/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,6 @@
auto_merge_units,
)

# manual sorting,
from .curationsorting import CurationSorting, curation_sorting
from .mergeunitssorting import MergeUnitsSorting, merge_units_sorting
from .splitunitsorting import SplitUnitSorting, split_unit_sorting

# curation format
from .curation_format import validate_curation_dict, curation_label_to_dataframe, apply_curation, load_curation

Expand Down
6 changes: 3 additions & 3 deletions src/spikeinterface/curation/auto_merge.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@
HAVE_NUMBA = False

from spikeinterface.core import SortingAnalyzer
from spikeinterface.core.sorting_tools import apply_merges_to_sorting
from spikeinterface.metrics.quality.misc_metrics import compute_refrac_period_violations
from spikeinterface.metrics.spiketrain.metrics import compute_firing_rates

from .mergeunitssorting import MergeUnitsSorting
from .curation_tools import resolve_merging_graph

_compute_merge_presets = {
Expand Down Expand Up @@ -956,8 +956,8 @@ def check_improve_contaminations_score(

# make a merged sorting and tale one unit (unit_id1 is used)
unit_id1, unit_id2 = sorting.unit_ids[ind1], sorting.unit_ids[ind2]
sorting_merged = MergeUnitsSorting(
sorting, [[unit_id1, unit_id2]], new_unit_ids=[unit_id1], delta_time_ms=censored_period_ms
sorting_merged = apply_merges_to_sorting(
sorting, [[unit_id1, unit_id2]], new_unit_ids=[unit_id1], censor_ms=censored_period_ms
).select_units([unit_id1])

# create recordingless analyzer
Expand Down
Loading
Loading