Skip to content

feat: create nwb acquisition module#9

Open
arjunsridhar12345 wants to merge 23 commits into
devfrom
7-create-nwb-acquisition-processing-module
Open

feat: create nwb acquisition module#9
arjunsridhar12345 wants to merge 23 commits into
devfrom
7-create-nwb-acquisition-processing-module

Conversation

@arjunsridhar12345

@arjunsridhar12345 arjunsridhar12345 commented Jun 1, 2026

Copy link
Copy Markdown
Collaborator

This PR attempts to address #7. Uses information from this issue which has which raw streams to use: #5. The acquisition module currently in the NWB has these 4 streams associated with behavior:

  • left_reward_delivery_time
  • right_reward_delivery_time
  • left_lick_time
  • right_lick_time.

It sets up an acquisition builder module that can then be mapped directly to NWB without the need to take on dependencies from pynwb.

An initial example notebook can be found here on how to access the object:

https://github.com/AllenNeuralDynamics/dynamic-foraging-processing/blob/7-create-nwb-acquisition-processing-module/examples/acquisition_builder_example.ipynb

UPDATE: Removed example notebook because it's redundant to the raw data loader. Renamed to go under an nwb module since this is will be primarily used for nwb packaging

Added the reward annotation and licks. For now, licks are only using ports from the Janelia board. Can update it later I think if the lickety split ones are also used.

The hardware times are used for the timestamps. For the reward annotation, need trial information which comes from the software events. Thus, the closest software time is found for a given hardware time, and then that is used to annotate the reward

@micahwoodard

Copy link
Copy Markdown

for right/left_reward_delivery_time, value will be earned, manual, or automatic. Earned will be if the trial_outcome.data.trial.is_auto_response_right is null. automatic will be if auto_response is true or false. Manual is a bit trickier bc its not aligned with a go cue. There will be a GiveManualWaterRight software event that has the software timestamps of when manual water was given. These software event timestamps will need to be correlated with the harp timestamps

@arjunsridhar12345 arjunsridhar12345 marked this pull request as ready for review June 24, 2026 01:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants