AllenSDK icon indicating copy to clipboard operation
AllenSDK copied to clipboard

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

Open Ahad-Allen opened this issue 3 years ago • 0 comments

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.

Ahad-Allen avatar Apr 26 '23 16:04 Ahad-Allen