Add SortedSpikeGLXConverter
and improve linking_sorted_data
documentation
#1449
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding data from SpikeGLX with multiple probes is a popular use case that currently lacks comprehensive documentation and tooling support. The existing documentation fo linking electrode metadata to sorted units has significant gaps (see
NeurodataWithoutBorders/helpdesk#97 (comment) plus personal discussions with @tabedzki), so I'm taking this opportunity to address both issues simultaneously by introducing the
SortedSpikeGLXConverter
and improving the overall documentation for this.This PR introduces a new
SortedSpikeGLXConverter
that extendsSpikeGLXConverterPipe
to handle sorting data from multiple probes while maintaining proper unit-to-electrode linkage. Additionally, I've restructured and expanded the electrode linking documentation into a proper "how-to" guide which hopefully should be more clear.This is a draft for discussion and I'm hoping to get feedback from the community.
@alejoe91, could you take a brief look at the kilosort section? I am not as familiar with the sorte as you are
@EthanKato, mentioned in the dandi-desk that he was converting data like this so your input would be valuable.
@simon-ball, this should address the use case you described in #1112.
I believe @yarikoptic and @manimoh may have encountered similar multi-probe scenarios as well and could benefit from this enhancement.
A link to the live documentation can be found here:
https://neuroconv--1449.org.readthedocs.build/en/1449/how_to/linking_sorted_data.html