Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a "how to" for combining recordings #2713

Merged
merged 6 commits into from
Apr 22, 2024

Conversation

zm711
Copy link
Collaborator

@zm711 zm711 commented Apr 12, 2024

Fixes #2620.

@h-mayorquin just getting the ball rolling. Did we want to include aggregate channels at the bottom of this tutorial?

I need to update the repr I was just trying to get the gist, but I'll try to do this with a real file so I can get the real repr values shortly :)

@zm711 zm711 added the documentation Improvements or additions to documentation label Apr 12, 2024
Copy link
Collaborator

@h-mayorquin h-mayorquin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be nice to add the channels thing. But we should get this to the documentation and then do the channels in another PR just so we don't delay this unecessarily.

How to Combine Recordings in SpikeInterface
===========================================

In this tutorial we will walk through combining multiple recording objects. This can happen when the probe is not
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The structure of the second sentence was a bit confusing to me. You start by saying the conditions for this to make sense (it is the same probe) and then how the recording ended up into pieces. What about doing this the other way around or something else?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll try to fix. Don't want to be confusing.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tried to tweak this. Let me know what you think!

doc/how_to/combine_recordings.rst Show resolved Hide resolved
doc/how_to/combine_recordings.rst Show resolved Hide resolved
doc/how_to/combine_recordings.rst Show resolved Hide resolved
If you wish to keep each recording as a separate segment identity (e.g. if doing baseline, stim, poststim) you can use
:code:`append` instead of :code:`concatenate`.

#TODO Why would we really want to do this @everyone
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder why as well.

@zm711
Copy link
Collaborator Author

zm711 commented Apr 16, 2024

Thanks for the review @h-mayorquin, I penciled in time to work on this tomorrow so I'll update with your feedback then :)

Copy link
Collaborator Author

@zm711 zm711 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to fix these. Always my reflex...

doc/how_to/combine_recordings.rst Outdated Show resolved Hide resolved
doc/how_to/combine_recordings.rst Outdated Show resolved Hide resolved
@zm711 zm711 marked this pull request as ready for review April 17, 2024 12:45
@zm711
Copy link
Collaborator Author

zm711 commented Apr 17, 2024

@h-mayorquin I'm ready for another read-through when you have time :)

Copy link
Collaborator

@h-mayorquin h-mayorquin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me. Let's see if @alejoe91 or @samuelgarcia have something to say.

Thanks a lot @zm711

@alejoe91 alejoe91 merged commit 8e272c9 into SpikeInterface:main Apr 22, 2024
11 checks passed
@zm711 zm711 deleted the how_to_concatenate branch April 22, 2024 17:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Issue with reading intan file
3 participants