Hard code synchony_sizes
#3559
Merged
Hard code synchony_sizes
#3559
Conversation
This file contains 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
alejoe91
reviewed
Dec 2, 2024
zm711
reviewed
Dec 2, 2024
| @@ -520,18 +520,18 @@ def compute_sliding_rp_violations( | |||
| ) | |||
|
|
|||
|
|
|||
| def get_synchrony_counts(spikes, synchrony_sizes, all_unit_ids): | |||
There was a problem hiding this comment.
This does change the order in order to have the default. I guess I don't see a way around this, so it's okay.
There was a problem hiding this comment.
Or do we event need the auto default if the user api already feeds this. We could have this be the same, but private no? Something to think about @alejoe91 @chrishalcrow
There was a problem hiding this comment.
Yeah, I think you're right. The function is only used in compute_synchrony_metrics, and this allows people to use get_synchrony_counts with the synchrony_sizes in another context and keeps the order in tact. Nice.
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.
Fix #3549
Currently there is one metric,
synchony, whose column names depends on a kwarg:synchony_sizes. If the user inputssynchony_sizes = [3,5,7]the columns in thequality_metricsdataframe aresync_spikes_3,sync_spikes_5andsync_spikes_7. This is a bit awkward to deal with in a few places. Computing these customsynchrony_sizesare a bit of an edge case, so me @alejoe91 and @zm711 decided to just hard code the default values ofsynchony_sizes = [2,4,8].To help users who really want to compute custom synchony sizes, I've left the
_compute_synchonry_countsfunction (which is called by the user-facingcompute_synchrony_metricsfunction) with the ability to do this, but made it private.No backwards compatibility issues spring to mind: using this PR you can still load an old
sorting_analyzerwithsync_spikes_3columns. Also, it shouldn't be breaking: if you pass thesynchony_sizeskwarg tocompute_synchrony_metricsit still computes, just with a warning.