Allow aggregate_channels to accept a dict of recordings
#3767
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
chrishalcrow
added
enhancement
for more information, see https://pre-commit.ci
alejoe91
reviewed
Mar 13, 2025
…chrishalcrow/spikeinterface into add-dicts-to-aggregate-channels
alejoe91
reviewed
Mar 13, 2025
Comment on lines
23
to
34
| # Check if the recordings were previously split using `split_by` | ||
| if recording_list[0].get_annotation("split_by_property") is None: | ||
| # If default 'group'ing (all equal 0), we label the recordings using the 'group' property | ||
| recording_groups = [] | ||
| for recording in recording_list: | ||
| if (group_property := recording.get_property("group")) is not None: | ||
| recording_groups.extend(group_property) | ||
| else: | ||
| recording_groups.extend([0]) | ||
| if np.all(np.unique(recording_groups) == np.array([0])): | ||
| for group_id, recording in enumerate(recording_list): | ||
| recording.set_property("group", group_id * np.ones(recording.get_num_channels())) |
Member
There was a problem hiding this comment.
This should be done after the else, because it applies to both dicts and lists inputs. Right?
Member
There was a problem hiding this comment.
No you're right. In case of dicts properties are correctly handled later
Member
Author
There was a problem hiding this comment.
I think we're both right: we should use the dictionary keys for group if we don't know how the recording was split up (ie if there's no split_by_property and groups are all 0). I've added this
Member
Author
There was a problem hiding this comment.
I also refactored a bit so this gross bit of code is contained
alejoe91
reviewed
Mar 13, 2025
alejoe91
reviewed
Mar 13, 2025
src/spikeinterface/core/tests/test_channelsaggregationrecording.py
Outdated
Show resolved
Hide resolved
alejoe91
reviewed
Mar 13, 2025
Comment on lines
135
to
157
| # If we don't label at all, aggregation will add a 'group' label | ||
| recording1.set_property("group", [0, 0, 0, 0]) | ||
| recording2.set_property("group", [0, 0]) | ||
| aggregated_recording = aggregate_channels([recording1, recording2]) | ||
| group_property = aggregated_recording.get_property("group") | ||
| assert np.all(group_property == [0, 0, 0, 0, 1, 1]) | ||
|
|
||
| # If we have different group labels, these should be respected | ||
| recording1.set_property("group", [2, 2, 2, 2]) | ||
| recording2.set_property("group", [6, 6]) | ||
| aggregated_recording = aggregate_channels([recording1, recording2]) | ||
| group_property = aggregated_recording.get_property("group") | ||
| assert np.all(group_property == [2, 2, 2, 2, 6, 6]) | ||
|
|
||
| # If we use `split_by`, aggregation should retain the split_by property, even if we only pass the list | ||
| recording1.set_property("user_group", [6, 7, 6, 7]) | ||
| recording_list = list(recording1.split_by("user_group").values()) | ||
| aggregated_recording = aggregate_channels(recording_list) | ||
| group_property = aggregated_recording.get_property("group") | ||
| assert np.all(group_property == [2, 2, 2, 2]) | ||
| user_group_property = aggregated_recording.get_property("user_group") | ||
| # Note, aggregation reorders the channel_ids into the order of the ids of each individual recording | ||
| assert np.all(user_group_property == [6, 6, 7, 7]) |
…g.py Co-authored-by: Alessio Buccino <alejoe9187@gmail.com>
alejoe91
approved these changes
Mar 13, 2025
…chrishalcrow/spikeinterface into add-dicts-to-aggregate-channels
Member
|
Thanks @chrishalcrow LGTM! Ready to merge? |
Member
|
Parfait. |
This was referenced Apr 1, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Related to #3711
Allows
aggregate_channelsto accept a dict of recordings. This allows for the workflow (once #3711 is merged) of the kind:or the truly horrifying
edit: PR is mostly new tests