SpikeInterface / SpikeInterface/spikeinterface

Add `discard_spikes`/`clean_spikes` step in a curation v3

Open
#4,261 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

curation enhancement
Dominant language
Python
Stars
847
Forks
280
Avg merge
3d 9h
Merged PRs (30d)
29

Description

Right now, the curation has:

  • removed: units to remove
  • merges: unit groups to merge
  • splits: unit to split into 2 or multiple sub-units

One another very common use case is to "clean" units. For example, if you have a nice and clean unit with a very nasty noisy event it's easy to remove (most) of those noisy spikes. Currently, to achieve this, one would need a 2 step curation: the first one to perform the split, the second to remove the "noisy" splitted unit.

This is to propose another "step" in the curation model (and make a version 3) which does both of the steps in one go!
It should be very easy on the implementation side: the "discard_spikes" could be run as the first step, and internally perform splits whose units to remove would just be added to the removed units.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the curation v2 model and the existing split and removed-unit handling, since the issue names no files or tests. Trace how a split is represented and how removed units are collected. Done means curation v3 supports a discard_spikes or clean_spikes step that combines those operations while preserving the existing removed, merges, and splits behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.