SpikeInterface / SpikeInterface/spikeinterface

Register additional data to `SortingAnalyzer`

Open
#3,968 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

In the context of curation/visualization or for downstream analysis, it would be great to "register" som additional data ot the analyzer.

Here a couple of useful things:

  • motion: motion might have been estimated but not applied (and even if applied, it would be good to have it to check for residuals)
  • events: for some experiments, it would be good for checking if units/spikes are correlated to events (eg. opto-stimulation?)

We could add an additional folder/group/dict called registered_data and a very thin BaseRegisteredData wrapper to save and load, so that this could be easily customized as needed.

What do y'all think about it?

@samuelgarcia @zm711 @h-mayorquin @yger @JoeZiminski

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 SortingAnalyzer implementation and its existing save/load mechanisms. Review how motion and event data are currently represented, then determine how registered data should be stored and restored. Done means the analyzer can register, save, and load custom data such as motion or events without disrupting existing analysis workflows.

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
Quiet
Clarity
Needs clarification
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.