Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SpikeGLX: Add inter-sample shift description and fix ElectrodeGroup naming #1177

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

h-mayorquin
Copy link
Collaborator

@h-mayorquin h-mayorquin commented Jan 14, 2025

From the IBL project. The inspector run reveals that the description of inter-sample-shift is missing. As we always have this for SpikeGLX it is a good idea to add it.

Plus, the current ElectrodeGroup naming is confusing when some of the probes have shanks. Here, the diff is illustrative:

Version on main:
image

Note that the shank number is confusing as they are concatenated with the device number of the probe making it hard to read and identify.

Version on this branch:

image

In this case, the second and third probes have shanks and the ElectrodeGroups indicate the situation more clearly.

@h-mayorquin h-mayorquin marked this pull request as ready for review January 14, 2025 18:36
assert device_metadata == expected_device_metadata

assert test_ecephys_metadata["ElectrodeGroup"] == expected_ecephys_metadata["ElectrodeGroup"]
Copy link
Collaborator Author

@h-mayorquin h-mayorquin Jan 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is to make errors easier to track in the testing suite.

@alejoe91
Copy link
Contributor

@h-mayorquin this looks great! One comment: I think the name should be Neuropixels instead of Neuropixel, since that's the correct probe name (https://www.neuropixels.org/)

@h-mayorquin
Copy link
Collaborator Author

Ah thanks for the naming thing. It was inconsistent between devices and ElectrodeGroups and I opted for the singular. Thanks for the correction.

@h-mayorquin
Copy link
Collaborator Author

h-mayorquin commented Jan 14, 2025

@alejoe91 did the name changing: Neuropixel -> Neuropixels.

Copy link

codecov bot commented Jan 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.12%. Comparing base (96dfdff) to head (c960880).
Report is 17 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1177      +/-   ##
==========================================
- Coverage   90.69%   90.12%   -0.58%     
==========================================
  Files         129      129              
  Lines        8189     8300     +111     
==========================================
+ Hits         7427     7480      +53     
- Misses        762      820      +58     
Flag Coverage Δ
unittests 90.12% <100.00%> (-0.58%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
.../datainterfaces/ecephys/spikeglx/spikeglx_utils.py 97.95% <100.00%> (ø)
...terfaces/ecephys/spikeglx/spikeglxdatainterface.py 95.71% <100.00%> (+0.71%) ⬆️

... and 18 files with indirect coverage changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants