📂 VrForagingDataset [Dataset]Type: Dataset
Description: A VrForaging dataset
├── 📂 Behavior [DataStreamCollection]Type: DataStreamCollection
Description: Data from the Behavior modality
├── 📂 HarpBehavior [HarpDevice]Type: HarpDevice
Description: No description available
├── 📂 HarpManipulator [HarpDevice]Type: HarpDevice
Description: No description available
├── 📂 HarpTreadmill [HarpDevice]Type: HarpDevice
Description: No description available
├── 📂 HarpOlfactometer [HarpDevice]Type: HarpDevice
Description: No description available
├── 📂 HarpSniffDetector [HarpDevice]Type: HarpDevice
Description: No description available
├── 📂 HarpLickometer [HarpDevice]Type: HarpDevice
Description: No description available
├── 📂 HarpClockGenerator [HarpDevice]Type: HarpDevice
Description: No description available
├── 📂 HarpEnvironmentSensor [HarpDevice]Type: HarpDevice
Description: No description available
├── 📂 HarpCommands [DataStreamCollection]Type: DataStreamCollection
Description: Commands sent to Harp devices
│ ├── 📂 HarpBehavior [HarpDevice]Type: HarpDevice
Description: No description available
│ ├── 📂 HarpManipulator [HarpDevice]Type: HarpDevice
Description: No description available
│ ├── 📂 HarpTreadmill [HarpDevice]Type: HarpDevice
Description: No description available
│ ├── 📂 HarpOlfactometer [HarpDevice]Type: HarpDevice
Description: No description available
│ ├── 📂 HarpSniffDetector [HarpDevice]Type: HarpDevice
Description: No description available
│ ├── 📂 HarpLickometer [HarpDevice]Type: HarpDevice
Description: No description available
│ ├── 📂 HarpClockGenerator [HarpDevice]Type: HarpDevice
Description: No description available
│ └── 📂 HarpEnvironmentSensor [HarpDevice]Type: HarpDevice
Description: No description available
├── 📂 SoftwareEvents [DataStreamCollection]Type: DataStreamCollection
Description: Software events generated by the workflow. The timestamps of these events are low precision and should not be used to align to physiology data.
│ ├── 📄 ActivePatch [SoftwareEvents]Type: SoftwareEvents
Description: An event emitted when a patch threshold is crossed.
│ ├── 📄 ActiveSite [SoftwareEvents]Type: SoftwareEvents
Description: An event emitted when a site becomes active.
│ ├── 📄 ArmOdor [SoftwareEvents]Type: SoftwareEvents
Description: An event sent each time an Odor mixture messaged is sent to arm at the olfactometer.
│ ├── 📄 Block [SoftwareEvents]Type: SoftwareEvents
Description: An event signaling block transitions.
│ ├── 📄 ChoiceFeedback [SoftwareEvents]Type: SoftwareEvents
Description: A unit event that is emitted when the subject receives feedback about their choice.
│ ├── 📄 ForceGiveReward [SoftwareEvents]Type: SoftwareEvents
Description: An event that is emitted when the experimenter manually delivers a reward to the subject, overriding the task logic.
│ ├── 📄 GiveReward [SoftwareEvents]Type: SoftwareEvents
Description: The amount of reward given to a subject. The value can be null if no reward was given (P=0) or 0.0 if the reward was delivered but calculated to be 0.
│ ├── 📄 PatchRewardAmount [SoftwareEvents]Type: SoftwareEvents
Description: Amount of reward available to be collected in the upcoming site.
│ ├── 📄 PatchRewardAvailable [SoftwareEvents]Type: SoftwareEvents
Description: Amount of reward left in the patch.
│ ├── 📄 PatchRewardProbability [SoftwareEvents]Type: SoftwareEvents
Description: Probability of reward being available to be collected in the upcoming site.
│ ├── 📄 RngSeed [SoftwareEvents]Type: SoftwareEvents
Description: The value of the random number generator seed.
│ ├── 📄 StopVelocityThreshold [SoftwareEvents]Type: SoftwareEvents
Description: The velocity threshold used to determine if the subject is stopped or not. In cm/s.
│ ├── 📄 VisualCorridorSpecs [SoftwareEvents]Type: SoftwareEvents
Description: Specification of the visual corridor instantiated to be rendered.
│ ├── 📄 WaitRewardOutcome [SoftwareEvents]Type: SoftwareEvents
Description: The outcome of the period between choice and reward delivery.
│ ├── 📄 WaitLickOutcome [SoftwareEvents]Type: SoftwareEvents
Description: The outcome of the period between reward availability and lick detection.
│ ├── 📄 UpdaterStopDurationOffset [SoftwareEvents]Type: SoftwareEvents
Description: Metadata for the updater of the StopDurationOffset parameter.
│ ├── 📄 UpdaterStopVelocityThreshold [SoftwareEvents]Type: SoftwareEvents
Description: Metadata for the updater of the StopVelocityThreshold parameter.
│ ├── 📄 UpdaterRewardDelayOffset [SoftwareEvents]Type: SoftwareEvents
Description: Metadata for the updater of the RewardDelayOffset parameter.
│ ├── 📄 HabituationRewardAvailable [SoftwareEvents]Type: SoftwareEvents
Description: In the habituation task mode, this event will be emitted whenever a reward is available to be collected.
│ ├── 📄 PatchState [SoftwareEvents]Type: SoftwareEvents
Description: An event emitted whenever the state of a patch changes.
│ ├── 📄 PatchTermination [SoftwareEvents]Type: SoftwareEvents
Description: An event emitted whenever a patch is terminated by the task logic.
│ ├── 📄 SpoutParkingPositions [SoftwareEvents]Type: SoftwareEvents
Description: Encodes the spout parking positions to use while fully retracted or extended.
│ └── 📄 PatchStateAtReward [SoftwareEvents]Type: SoftwareEvents
Description: An event emitted whenever the reward is about to be given and the patch state is sampled.
├── 📂 OperationControl [DataStreamCollection]Type: DataStreamCollection
Description: Streams associated with online operation of the task.
│ ├── 📄 CurrentPosition [Csv]Type: Csv
Description: The position of the animal in VR coordinates (cm). The timestamp is derived from the encoder reading that gave rise to the position change.
│ ├── 📄 IsStopped [Csv]Type: Csv
Description: The result of the ongoing stop detection algorithm. The timestamp is derived from the encoder reading that gave rise to the position change.
│ ├── 📄 Torque [Csv]Type: Csv
Description: The torque instructed to be applied to the treadmill. Timestamps are software-derived, use the Harp device events for hardware timestamps.
│ └── 📄 RendererSynchState [Csv]Type: Csv
Description: Contains information that allows the post-hoc alignment of visual stimuli to the behavior data. Seconds are software derived.
├── 📂 Logs [DataStreamCollection]Type: DataStreamCollection
Description: No description available
│ ├── 📄 Launcher [Text]Type: Text
Description: Contains the console log of the launcher process.
│ └── 📄 EndSession [SoftwareEvents]Type: SoftwareEvents
Description: A file that determines the end of the session. If the file is empty, the session is still running or it was not closed properly.
└── 📂 InputSchemas [DataStreamCollection]Type: DataStreamCollection
Description: Configuration files for the behavior rig, task_logic and session.
│ ├── 📄 Rig [PydanticModel]Type: PydanticModel
Description: No description available
│ ├── 📄 TaskLogic [PydanticModel]Type: PydanticModel
Description: No description available
│ └── 📄 Session [PydanticModel]Type: PydanticModel
Description: No description available
└── 📂 BehaviorVideos [MapFromPaths]Type: MapFromPaths
Description: Data from BehaviorVideos modality