SpikeInterface / SpikeInterface/spikeinterface

Question: Is possible/reasonable to include "select_peaks" to run_node_pipeline?

Open
#4,694 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Hello,

During our preprocessing pipeline, we are plotting the peak locations. We are in the process of updating SpikeInterface to version 0.104.8, and I saw that now there is a new way to improve the speed of this process: detect_peaks -> localize_peaks (https://spikeinterface.readthedocs.io/en/0.104.8/modules/sortingcomponents.html#node-pipelines).

We want to implement this new feature. However, when plotting peak locations, it is always useful to plot a subsample of the peaks (via "select_peaks"); otherwise, it can be difficult to appreciate motion.

I was just wondering if "select_peaks" can also be added to the node_pipeline. If so, how can it be implemented? Or, given the efficiency of using run_node_pipeline, should we do the subsample after we get the peaks and peaks_locations?

Thanks in advance for your help¡
Best
Pepe

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 with the node-pipelines documentation entry point and the mentioned detect_peaks, localize_peaks, select_peaks, and run_node_pipeline APIs. Compare how subsampling is currently handled for peak locations, then establish whether select_peaks belongs in the node pipeline or after its outputs; done means a documented, maintainer-approved recommendation or a clearly scoped implementation plan.

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
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.