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/aind_behavior_vr_foraging, and are also used to generate src/Extensions/AindBehaviorVrForaging.cs via Bonsai.Sgen.

Download Schema

Task Logic Schema

AindVrForagingTaskLogic

Main task logic model for the AIND VR Foraging task. This is the top-level class that encapsulates the complete task logic specification for the virtual reality foraging behavioral experiment. It includes all task parameters, environment specifications, and control settings.
type	object
properties
name	Name
	Name of the task logic
	type	string
	default	AindVrForaging
	const	AindVrForaging
description	Description
	Description of the task.
	type	string
	default
task_parameters	Parameters of the task logic
	#/$defs/AindVrForagingTaskParameters
version	Version
	type	string
	default	0.6.0-rc1
	const	0.6.0-rc1
stage_name	Stage Name
	Optional stage name the Task object instance represents.
	default	null
	oneOf	type	string
		type	null
additionalProperties	False

Rig Schema

AindVrForagingRig

type	object
properties
aind_behavior_services_pkg_version	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.12.0
version	Version
	type	string
	default	0.6.0-rc1
	const	0.6.0-rc1
computer_name	Computer Name
	Computer name
	type	string
rig_name	Rig Name
	Rig name
	type	string
triggered_camera_controller	Required camera controller to triggered cameras.
	#/$defs/CameraController_SpinnakerCamera_
monitoring_camera_controller	Optional camera controller for monitoring cameras.
	default	null
	oneOf	#/$defs/CameraController_WebCamera_
		type	null
harp_behavior	Harp behavior
	#/$defs/HarpBehavior
harp_olfactometer	Harp olfactometer
	#/$defs/Olfactometer
harp_lickometer	Harp lickometer
	#/$defs/HarpLicketySplit
harp_clock_generator	Harp clock generator
	#/$defs/HarpWhiteRabbit
harp_analog_input	Harp analog input
	default	null
	oneOf	#/$defs/HarpAnalogInput
		type	null
harp_treadmill	Harp treadmill
	#/$defs/Treadmill
harp_sniff_detector	Sniff detector settings
	default	null
	oneOf	#/$defs/HarpSniffDetector
		type	null
harp_environment_sensor	Environment sensor
	default	null
	oneOf	#/$defs/HarpEnvironmentSensor
		type	null
manipulator	Manipulator
	#/$defs/AindManipulatorDevice
screen	Screen settings
	default	device_type	Screen
		device_name	Screen
		additional_settings	null
		calibration	center	extrinsics	rotation	x	0.0
						y	0.0
						z	0.0
					translation	x	0.0
						y	1.309016
						z	-13.27
				intrinsics	display_height	15.0
					display_width	20.0
					frame_height	1080
					frame_width	1920
			left	extrinsics	rotation	x	0.0
						y	1.0472
						z	0.0
					translation	x	-16.6917756
						y	1.309016
						z	-3.575264
				intrinsics	display_height	15.0
					display_width	20.0
					frame_height	1080
					frame_width	1920
			right	extrinsics	rotation	x	0.0
						y	-1.0472
						z	0.0
					translation	x	16.6917756
						y	1.309016
						z	-3.575264
				intrinsics	display_height	15.0
					display_width	20.0
					frame_height	1080
					frame_width	1920
		display_index	1
		target_render_frequency	60.0
		target_update_frequency	120.0
		texture_assets_directory	Textures
		brightness	0.0
		contrast	1.0
	#/$defs/Screen
calibration	Calibration models
	#/$defs/RigCalibration