probe plotting feature request
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 68/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- python
- Domain
- data-visualization
Research direction
Start at the plot_probe and plot_probegroup entry points and inspect how shanks and dual-sided probe faces are rendered. Add optional shank-ID annotations and a back-face orientation caption without changing default behavior, then verify plots for multi-shank and dual-sided probes.
Written by the indexing model from the issue text.
Description
Two small plotting additions would close a usability gap we keep hitting when people cross-check our figures against Cambridge NeuroTech's hard-copy datasheets:
-
Shank-ID labels.
When a probe has multiple shanks, it would help to optionally annotate each shank with its shank ID (e.g. "A", "B" / 0, 1, ...) on the plot_probe / plot_probegroup output. Today the shanks are drawn but unlabelled, so a reader has to infer which shank is which - and people's assumptions about where "Shank A" sits differ, which causes real confusion. -
Front/back orientation label for dual-sided probes.
both faces are rendered from a front-facing viewpoint (the back face mirrored into the front view). But it is not explicit.
A short built-in label / title addition such as "back - viewed from front" on the back sides's panel would make the orientation unambiguous against Cambridge's printed documentation, where the back is sometimes drawn viewed from the back.
A simple optional kwarg on plot_probe for each (e.g. with_shank_ids=True and an orientation caption for side="back") would be enough - no change to default behaviour.
- Dominant language
- Python
- Stars
- 85
- Forks
- 49
- Avg merge
- 13h 47m
- Merged PRs (30d)
- 3
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from SpikeInterface/probeinterface
-
Difficulty 4/5 3-5 days Newbie friendliness 58/100
SpikeInterface/probeinterface#469 · 2 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 48/100
SpikeInterface/probeinterface#452 · 1 comment ·
-
question
Difficulty 4/5 3-5 days Newbie friendliness 45/100
SpikeInterface/probeinterface#449 · 7 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
SpikeInterface/probeinterface#447 · 2 comments · 1 reaction ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
SpikeInterface/probeinterface#444 ·
All issues in SpikeInterface/probeinterface
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
anthropics/skills#1811 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
speaches-ai/speaches#678 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
datalayer/mcp-compose#42 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
conda-forge/spacy-feedstock#177 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
UKGovernmentBEIS/inspect_evals#2523 ·