SpikeInterface / SpikeInterface/probeinterface

Rec group set to shank_id in NP 2.0 multishank, but to probe_id for NP 1.0

Open
#449 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
Python
Stars
85
Forks
49
Avg merge
13h 47m
Merged PRs (30d)
3

Description

Hello!

SpikeInterface version 0.104.3

As I understand the recording group gets automatically assigned "probe" as group for NP 1.0 and "shanks" for NP 2.0 multi-shank.
This is not necessarily an issue, but created some confusion when sorting began and the single NP 2.0 4 shank probe got split into 4 separate probes folders.
My question is: is there a particular reason for this choice? Can I safely change grouping for NP 2.0 multi-shank probes to "by_probe" rather than "by_shank"? Will that lead to some issues downstream? Because I don't know if any other processing relies on these groups to be shanks and not probes.

Here is a recording with two NP 1.0 probes and property > group of this recording assigns IDs 0 or 1 for each probe:

Image

And here is a recording with single NP 2.0 multi-shank probe and property > group of this recording assigns IDs 0, 1, 2, 3 for each shank:

Image

Let me know if this info was specified somewhere and I missed it.

I'm also wondering what would happen if I were to have two NP 2.0 multi-shank probes in a single recording. What would group property assign and where would shank id information go?

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

No files or tests are named in the report. Start from the recording's group property and the NP 1.0 and NP 2.0 multishank behavior described here; determine how by_probe and by_shank behave with multiple probes, where shank IDs are retained, and document the rationale and downstream implications.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Documentation
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.