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

Optogenetic information in NWB files could be using a more specific data type #2680

Open
Ahad-Allen opened this issue Apr 26, 2023 · 0 comments

Comments

@Ahad-Allen
Copy link
Contributor

Currently, the optotagging information generated by the write_nwb module of the SDK is a timeseries. There exists an optogenetic series data type that would be able to store more specific metadata about our optogenetic tagging.

Describe the solution you'd like
I suggest we change the write_nwb module to instead write the opto_ts as an optogenetic series (https://pynwb.readthedocs.io/en/stable/_modules/pynwb/ogen.html#OptogeneticSeries). The main challenge to this approach will be needing to create an input field for the 'device' information, as this may change depending on the rigs/projects.

Describe alternatives you've considered
This isn't a strictly needed change, just one that would help with metadata and potential future pynwb modules. If there are reasons to stick to the current timeseries datatype, we can certainly continue doing so.

Additional context
I was advised by the pynwb team that this change would help our files follow best practices better and that the optogeneticSeries datatype may be required for future pynwb modules

Do you want to work on this issue?
I am able to work on this issue. I am using a modified version of the SDK to test generation of files with this type of information in place of timeseries.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant