json-schema¶
The following json-schemas are used as the format definition of the input for this task. They are the result of the Pydantic` models defined in src/packages/aind_behavior_dynamic_foraging/src/aind_behavior_dynamic_foraging, and are also used to generate src/Extensions/AindBehaviorDynamicForaging.cs via Bonsai.Sgen.
Task Logic Schema¶
AindDynamicForagingTaskLogic¶
Main task logic model for the AIND Dynamic Foraging task. This is the top-level class that encapsulates the complete task logic specification for the dynamic foraging behavioral experiment. It includes all task parameters, environment specifications, and control settings. |
|||
type |
object |
||
properties |
|||
|
Name |
||
Name of the task logic |
|||
type |
string |
||
default |
AindDynamicForaging |
||
const |
AindDynamicForaging |
||
|
Description |
||
Description of the task. |
|||
type |
string |
||
default |
|||
|
Parameters of the task logic |
||
#/$defs/AindDynamicForagingTaskParameters |
|||
|
Version |
||
type |
string |
||
default |
0.4.3 |
||
const |
0.4.3 |
||
|
Stage Name |
||
Optional stage name the Task object instance represents. |
|||
default |
null |
||
oneOf |
type |
string |
|
type |
null |
||
additionalProperties |
False |
||
Rig Schema¶
AindDynamicForagingRig¶
type |
object |
|||
properties |
||||
|
aind_behavior_services package version |
|||
type |
string |
|||
pattern |
^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$ |
|||
default |
0.13.8 |
|||
|
Version |
|||
type |
string |
|||
default |
0.4.3 |
|||
const |
0.4.3 |
|||
|
Computer Name |
|||
Computer name |
||||
type |
string |
|||
|
Rig Name |
|||
Rig name |
||||
type |
string |
|||
|
Data Directory |
|||
Directory where data will be saved to |
||||
type |
string |
|||
format |
path |
|||
|
Required camera controller to triggered cameras. |
|||
|
Optional camera controller for monitoring cameras. |
|||
default |
null |
|||
oneOf |
#/$defs/CameraController_WebCamera_ |
|||
type |
null |
|||
|
Harp behavior |
|||
#/$defs/HarpBehavior |
||||
|
Harp left lickometer |
|||
default |
null |
|||
oneOf |
#/$defs/HarpLicketySplit |
|||
type |
null |
|||
|
Harp right lickometer |
|||
default |
null |
|||
oneOf |
#/$defs/HarpLicketySplit |
|||
type |
null |
|||
|
Harp clock generator |
|||
#/$defs/HarpWhiteRabbit |
||||
|
Harp sound card |
|||
#/$defs/DynamicForagingSoundCard |
||||
|
Harp sniff detector |
|||
default |
null |
|||
oneOf |
#/$defs/HarpSniffDetector |
|||
type |
null |
|||
|
Harp environment sensor |
|||
default |
null |
|||
oneOf |
#/$defs/HarpEnvironmentSensor |
|||
type |
null |
|||
|
Manipulator |
|||
#/$defs/DynamicForagingAindManipulator |
||||
|
Calibration models |
|||
#/$defs/RigCalibration |
||||
|
Networking settings |
|||
default |
zmq_publisher |
connection_string |
@tcp://localhost:5556 |
|
topic |
dynamic_foraging |
|||
zmq_subscriber |
connection_string |
@tcp://localhost:5557 |
||
topic |
dynamic_foraging |
|||
#/$defs/Networking |
||||