Add peak_sign to sd_ratio #4362
Open
+18
−20
Conversation
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
for more information, see https://pre-commit.ci
yger
approved these changes
Feb 3, 2026
Collaborator
yger
left a comment
yger
left a comment
There was a problem hiding this comment.
looks good to me, thanks a lot for the careful review of the metrics!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
sd_ratio uses get_template_extremum_channel to select the "best_channel" for each unit. Similar to other metrics/extensions where this function is used (spike_amplitudes, spike_locations, template_metrics, snr) I think it's worth adding a peak_sign so people can control its behavior.
Effect is rather minimal because few extremum channels change and nearby channels have similar noise levels anyway but if spike_amplitudes were created with peak_sign='both', it is correct to use peak_sign='both' here too to select the same channel for the std(noise) (as was used for spike_amplitudes).
I also refactored some code for legibility but results are unchanged (for peak_sign='neg', the default).