Fix sparse template handling in kilosort reader for SI-exported Phy data#20
Merged
Merged
Conversation
SpikeInterface's export_to_phy exports sparse templates by default (since v0.101.0), with templates.npy shape (n_templates, n_samples, max_sparse_channels) instead of the full (n_templates, n_samples, n_channels) format from native Kilosort. The companion file templates_ind.npy maps (template_idx, sparse_channel_idx) to actual channel indices, with -1 indicating padding. This fix updates get_best_channel() and extract_spike_depths() to: - Check if templates_ind exists (indicates SI-exported sparse format) - Use templates_ind to map sparse indices to actual channel indices - Fall back to original behavior for native Kilosort (dense) format Without this fix, spike_sites and best_channel values are incorrect when reading SI-exported Phy curations, as argmax returns indices into the sparse representation rather than actual channel indices. Related: dj-sciops/nei_nienborg#111 (Issue #2) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
kushalbakshi
approved these changes
Feb 9, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
spike_sitesandbest_channelvalues when reading SpikeInterface-exported Phy curationsexport_to_phyexports sparse templates by default (since v0.101.0)Problem
SpikeInterface exports
templates.npywith shape(n_templates, n_samples, max_sparse_channels)where:max_sparse_channelsis the maximum number of sparse channels across all units (not all channels)templates_ind.npymaps(template_idx, sparse_channel_idx) -> actual_channel_idxThe existing code used
argmaxto find the channel with max amplitude, but this returns an index into the sparse representation (0, 1, 2...), not the actual channel index.Solution
Updated
get_best_channel()andextract_spike_depths()to:templates_ind.npyexists (indicates SI-exported sparse format)templates_indto map sparse indices to actual channel indicesTest plan
spike_sitesvalues match expected channel indicesRelated
🤖 Generated with Claude Code