json-schemas.rig

Download Schema

AindVrForagingRig

type	object
properties
version	Version
	type	string
	default	0.3.0
	const	0.3.0
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.
	allOf	CameraController[SpinnakerCamera]
monitoring_camera_controller	Optional camera controller for monitoring cameras.
	default	null
	oneOf	CameraController[WebCamera]
		type	null
harp_behavior	Harp behavior
	allOf	HarpBehavior
harp_olfactometer	Harp olfactometer
	allOf	HarpOlfactometer
harp_lickometer	Harp lickometer
	allOf	HarpLickometer
harp_clock_generator	Harp clock generator
	allOf	HarpClockGenerator
harp_clock_repeaters	Harp Clock Repeaters
	Harp clock repeaters
	type	array
	default
	items	HarpClockGenerator
harp_analog_input	Harp analog input
	default	null
	oneOf	HarpAnalogInput
		type	null
harp_treadmill	Harp treadmill
	allOf	HarpTreadmill
harp_sniff_detector	Sniff detector settings
	default	null
	oneOf	HarpSniffDetector
		type	null
manipulator	Manipulator
	allOf	AindManipulatorDevice
screen	Screen settings
	default	device_type	Screen
		additional_settings	null
		calibration	null
		display_index	1
		target_render_frequency	60.0
		target_update_frequency	120.0
		calibration_directory	Calibration\Monitors\
		texture_assets_directory	Textures
		brightness	0.0
		contrast	1.0
	allOf	Screen
calibration	Calibration models
	allOf	RigCalibration

AindManipulatorAdditionalSettings

Additional settings for the manipulator device
type	object
properties
spout_axis	Spout axis
	default	2
	allOf	Axis

AindManipulatorCalibration

Aind manipulator calibration class
type	object
properties
device_name	Device name
	Must match a device name in rig/instrument
	type	string
	default	AindManipulator
input	Input of the calibration
	allOf	AindManipulatorCalibrationInput
output	Output of the calibration.
	allOf	AindManipulatorCalibrationOutput
date	Date
	default	null
	oneOf	type	string
		format	date-time
		type	null
description	Description
	type	string
	default	Calibration of the load cells system
	const	Calibration of the load cells system
notes	Notes
	default	null
	oneOf	type	string
		type	null

AindManipulatorCalibrationInput

type	object
properties
full_step_to_mm	Full step to mm. Used to convert steps to SI Units
	default	x	0.01
		y1	0.01
		y2	0.01
		z	0.01
	allOf	ManipulatorPosition
axis_configuration	Axes configuration. Only the axes that are configured will be enabled.
	type	array
	default	axis	2
		step_acceleration_interval	100
		step_interval	100
		microstep_resolution	0
		maximum_step_interval	2000
		motor_operation_mode	0
		max_limit	25.0
		min_limit	-0.01
		axis	3
		step_acceleration_interval	100
		step_interval	100
		microstep_resolution	0
		maximum_step_interval	2000
		motor_operation_mode	0
		max_limit	25.0
		min_limit	-0.01
		axis	1
		step_acceleration_interval	100
		step_interval	100
		microstep_resolution	0
		maximum_step_interval	2000
		motor_operation_mode	0
		max_limit	25.0
		min_limit	-0.01
		axis	4
		step_acceleration_interval	100
		step_interval	100
		microstep_resolution	0
		maximum_step_interval	2000
		motor_operation_mode	0
		max_limit	25.0
		min_limit	-0.01
	items	AxisConfiguration
homing_order	Homing order
	type	array
	default	2
		3
		1
		4
	items	Axis
initial_position	default	x	0.0
		y1	0.0
		y2	0.0
		z	0.0
	allOf	ManipulatorPosition

AindManipulatorCalibrationOutput

type	object
properties

AindManipulatorDevice

Overrides the default settings for the manipulator device by spec’ing additional_settings field
type	object
properties
device_type	Device Type
	type	string
	default	stepperdriver
	const	stepperdriver
additional_settings	Additional settings
	default	spout_axis	2
	allOf	AindManipulatorAdditionalSettings
calibration	Calibration of the manipulator
	default	null
	oneOf	AindManipulatorCalibration
		type	null
who_am_i	Who Am I
	type	integer
	default	1130
	const	1130
serial_number	Serial Number
	Device serial number
	default	null
	oneOf	type	string
		type	null
port_name	Port Name
	Device port name
	type	string

Axis

Motor axis available
type	integer
enum	0, 1, 2, 3, 4

AxisConfiguration

Axis configuration
type	object
properties
axis	Axis to be configured
	allOf	Axis
step_acceleration_interval	Acceleration
	Acceleration of the step interval in microseconds
	type	integer
	maximum	2000
	minimum	2
	default	100
step_interval	Step interval
	Step interval in microseconds.
	type	integer
	maximum	20000
	minimum	100
	default	100
microstep_resolution	Microstep resolution
	default	0
	allOf	MicrostepResolution
maximum_step_interval	Configures the time between step motor pulses (us) used when starting or stopping a movement
	type	integer
	maximum	20000
	minimum	100
	default	2000
motor_operation_mode	Motor operation mode
	default	0
	allOf	MotorOperationMode
max_limit	Maximum limit in SI units. A value of 0 disables this limit.
	type	number
	default	25
min_limit	Minimum limit in SI units. A value of 0 disables this limit.
	type	number
	default	-0.01

BaseModel

type	object
properties

CameraController[SpinnakerCamera]

type	object
properties
device_type	Device Type
	type	string
	default	CameraController
	const	CameraController
additional_settings	Additional settings
	default	null
	oneOf	BaseModel
		type	null
calibration	Calibration
	default	null
	oneOf	BaseModel
		type	null
cameras	Cameras
	Cameras to be instantiated
	type	object
	additionalProperties	SpinnakerCamera
frame_rate	Frame Rate
	Frame rate of the trigger to all cameras
	default	30
	oneOf	type	integer
		minimum	0
		type	null

CameraController[WebCamera]

type	object
properties
device_type	Device Type
	type	string
	default	CameraController
	const	CameraController
additional_settings	Additional settings
	default	null
	oneOf	BaseModel
		type	null
calibration	Calibration
	default	null
	oneOf	BaseModel
		type	null
cameras	Cameras
	Cameras to be instantiated
	type	object
	additionalProperties	WebCamera
frame_rate	Frame Rate
	Frame rate of the trigger to all cameras
	default	30
	oneOf	type	integer
		minimum	0
		type	null

HarpAnalogInput

type	object
properties
device_type	Device Type
	type	string
	default	analoginput
	const	analoginput
additional_settings	Additional settings
	default	null
	oneOf	BaseModel
		type	null
calibration	Calibration
	default	null
	oneOf	BaseModel
		type	null
who_am_i	Who Am I
	type	integer
	default	1236
	const	1236
serial_number	Serial Number
	Device serial number
	default	null
	oneOf	type	string
		type	null
port_name	Port Name
	Device port name
	type	string

HarpBehavior

type	object
properties
device_type	Device Type
	type	string
	default	behavior
	const	behavior
additional_settings	Additional settings
	default	null
	oneOf	BaseModel
		type	null
calibration	Calibration
	default	null
	oneOf	BaseModel
		type	null
who_am_i	Who Am I
	type	integer
	default	1216
	const	1216
serial_number	Serial Number
	Device serial number
	default	null
	oneOf	type	string
		type	null
port_name	Port Name
	Device port name
	type	string

HarpClockGenerator

type	object
properties
device_type	Device Type
	type	string
	default	clockgenerator
	const	clockgenerator
additional_settings	Additional settings
	default	null
	oneOf	BaseModel
		type	null
calibration	Calibration
	default	null
	oneOf	BaseModel
		type	null
who_am_i	Who Am I
	type	integer
	default	1158
	const	1158
serial_number	Serial Number
	Device serial number
	default	null
	oneOf	type	string
		type	null
port_name	Port Name
	Device port name
	type	string

HarpLickometer

type	object
properties
device_type	Device Type
	type	string
	default	lickometer
	const	lickometer
additional_settings	Additional settings
	default	null
	oneOf	BaseModel
		type	null
calibration	Calibration
	default	null
	oneOf	BaseModel
		type	null
who_am_i	Who Am I
	type	integer
	default	1400
	const	1400
serial_number	Serial Number
	Device serial number
	default	null
	oneOf	type	string
		type	null
port_name	Port Name
	Device port name
	type	string

HarpOlfactometer

Overrides the default settings for the olfactometer calibration
type	object
properties
device_type	Device Type
	type	string
	default	olfactometer
	const	olfactometer
additional_settings	Additional settings
	default	null
	oneOf	BaseModel
		type	null
calibration	Olfactometer calibration
	default	null
	oneOf	OlfactometerCalibration
		type	null
who_am_i	Who Am I
	type	integer
	default	1140
	const	1140
serial_number	Serial Number
	Device serial number
	default	null
	oneOf	type	string
		type	null
port_name	Port Name
	Device port name
	type	string

HarpSniffDetector

type	object
properties
device_type	Device Type
	type	string
	default	sniffdetector
	const	sniffdetector
additional_settings	Additional settings
	default	null
	oneOf	BaseModel
		type	null
calibration	Calibration
	default	null
	oneOf	BaseModel
		type	null
who_am_i	Who Am I
	type	integer
	default	1401
	const	1401
serial_number	Serial Number
	Device serial number
	default	null
	oneOf	type	string
		type	null
port_name	Port Name
	Device port name
	type	string

HarpTreadmill

Overrides the default settings for the treadmill calibration
type	object
properties
device_type	Device Type
	type	string
	default	treadmill
	const	treadmill
additional_settings	Additional settings
	default	null
	oneOf	BaseModel
		type	null
calibration	Treadmill calibration settings
	default	wheel_diameter	15.0
		pulses_per_revolution	28800
		invert_direction	False
		brake_lookup_calibration	0.0
			0.0
			1.0
			65535.0
	allOf	Treadmill
who_am_i	Who Am I
	type	integer
	default	1402
	const	1402
serial_number	Serial Number
	Device serial number
	default	null
	oneOf	type	string
		type	null
port_name	Port Name
	Device port name
	type	string

ManipulatorPosition

type	object
properties
x	X coordinate
	type	number
y1	Y1 coordinate
	type	number
y2	Y2 coordinate
	type	number
z	Z coordinate
	type	number

Measurement

Input for water valve calibration class
type	object
properties
valve_open_interval	Valve open interval
	Time between two consecutive valve openings (s)
	type	number
	exclusiveMinimum	0.0
valve_open_time	Valve open time
	Valve open interval (s)
	type	number
	exclusiveMinimum	0.0
water_weight	Water weight
	Weight of water delivered (g)
	type	array
	items	type	number
		exclusiveMinimum	0.0
	minItems	1
repeat_count	Repeat count
	Number of times the valve opened.
	type	integer
	minimum	0

MicrostepResolution

type	integer
enum	0, 1, 2, 3

MotorOperationMode

type	integer
enum	0, 1

OlfactometerCalibration

Olfactometer calibration class
type	object
properties
device_name	Device name
	Name of the device being calibrated
	type	string
	default	Olfactometer
input	Input of the calibration
	allOf	OlfactometerCalibrationInput
output	Output of the calibration
	allOf	OlfactometerCalibrationOutput
date	Date
	default	null
	oneOf	type	string
		format	date-time
		type	null
description	Description
	type	string
	default	Calibration of the harp olfactometer device
	const	Calibration of the harp olfactometer device
notes	Notes
	default	null
	oneOf	type	string
		type	null

OlfactometerCalibrationInput

type	object
properties
channel_config	Channel Config
	Configuration of olfactometer channels
	type	object
	default
	additionalProperties	OlfactometerChannelConfig

OlfactometerCalibrationOutput

type	object
properties

OlfactometerChannelConfig

type	object
properties
channel_index	Channel index
	type	integer
channel_type	Channel type
	default	Odor
	allOf	OlfactometerChannelType
flow_rate_capacity	Flow capacity. mL/min
	type	integer
	enum	100, 1000
	default	100
flow_rate	Target flow rate. mL/min. If channel_type == CARRIER, this value is ignored.
	type	number
	maximum	100.0
	default	100
odorant	Odorant name
	default	null
	oneOf	type	string
		type	null
odorant_dilution	Odorant dilution (%v/v)
	default	null
	oneOf	type	number
		type	null

OlfactometerChannelType

Channel type
type	string
enum	Odor, Carrier

RigCalibration

Container class for calibration models. In a future release these will be moved to the respective devices
type	object
properties
water_valve	Water valve calibration
	allOf	WaterValveCalibration

Screen

type	object
properties
device_type	Device Type
	Device type
	type	string
	default	Screen
	const	Screen
additional_settings	Additional settings
	default	null
	oneOf	BaseModel
		type	null
calibration	Calibration
	default	null
	oneOf	BaseModel
		type	null
display_index	Display Index
	Display index
	type	integer
	default	1
target_render_frequency	Target Render Frequency
	Target render frequency
	type	number
	default	60
target_update_frequency	Target Update Frequency
	Target update frequency
	type	number
	default	120
calibration_directory	Calibration Directory
	Calibration directory
	type	string
	default	Calibration\Monitors\
texture_assets_directory	Texture Assets Directory
	Calibration directory
	type	string
	default	Textures
brightness	Brightness
	Brightness
	type	number
	maximum	1.0
	minimum	-1.0
	default	0
contrast	Contrast
	Contrast
	type	number
	maximum	1.0
	minimum	-1.0
	default	1

SpinnakerCamera

type	object
properties
device_type	Device Type
	Device type
	type	string
	default	SpinnakerCamera
	const	SpinnakerCamera
additional_settings	Additional settings
	default	null
	oneOf	BaseModel
		type	null
calibration	Calibration
	default	null
	oneOf	BaseModel
		type	null
serial_number	Serial Number
	Camera serial number
	type	string
binning	Binning
	Binning
	type	integer
	minimum	1
	default	1
color_processing	Color Processing
	Color processing
	type	string
	enum	Default, NoColorProcessing
	default	Default
exposure	Exposure
	Exposure time
	type	integer
	minimum	100
	default	1000
gain	Gain
	Gain
	type	number
	minimum	0.0
	default	0
video_writer	Video writer. If not provided, no video will be saved.
	default	null
	oneOf	VideoWriter
		type	null

Treadmill

Overrides the default settings for the treadmill calibration by spec’ing brake_lookup_calibration field
type	object
properties
wheel_diameter	Wheel Diameter
	Wheel diameter
	type	number
	minimum	0.0
	default	15
pulses_per_revolution	Pulses Per Revolution
	Pulses per revolution
	type	integer
	minimum	1
	default	28800
invert_direction	Invert Direction
	Invert direction
	type	boolean
	default	False
brake_lookup_calibration	Brake Lookup Calibration
	Brake lookup calibration. Each Tuple is (0-1 (percent), 0-full-scale). Values are linearly interpolated
	type	array
	default	0
		0
		1
		65535
	items	A tuple of two values
		type	array
		items	type	number
		maxItems	2
		minItems	2
	minItems	2

VideoWriter

oneOf	VideoWriterFfmpeg
	VideoWriterOpenCv

VideoWriterFfmpeg

type	object
properties
video_writer_type	Video Writer Type
	type	string
	default	FFMPEG
	const	FFMPEG
frame_rate	Frame Rate
	Encoding frame rate
	type	integer
	minimum	0
	default	30
container_extension	Container Extension
	Container extension
	type	string
	default	mp4
output_arguments	Output Arguments
	Output arguments
	type	string
	default	-c:v hevc_nvenc -pix_fmt x2rgb10le -color_range full -tune hq -preset p3 -rc vbr -cq 16 -rc-lookahead 56 -temporal-aq 1 -qmin 0 -qmax 10

VideoWriterOpenCv

type	object
properties
video_writer_type	Video Writer Type
	type	string
	default	OPENCV
	const	OPENCV
frame_rate	Frame Rate
	Encoding frame rate
	type	integer
	minimum	0
	default	30
container_extension	Container Extension
	Container extension
	type	string
	default	avi
four_cc	Four Cc
	Four character code
	type	string
	default	FMP4

WaterValveCalibration

Water valve calibration class
type	object
properties
device_name	Device name
	Name of the device being calibrated
	type	string
	default	WaterValve
input	Input of the calibration
	allOf	WaterValveCalibrationInput
output	Output of the calibration.
	allOf	WaterValveCalibrationOutput
date	Date
	default	null
	oneOf	type	string
		format	date-time
		type	null
description	Description
	type	string
	default	Calibration of the water valve delivery system
	const	Calibration of the water valve delivery system
notes	Notes
	default	null
	oneOf	type	string
		type	null

WaterValveCalibrationInput

type	object
properties
measurements	Measurements
	List of measurements
	type	array
	default
	items	Measurement

WaterValveCalibrationOutput

Output for water valve calibration class
type	object
properties
interval_average	Interval average
	Dictionary keyed by measured valve interval and corresponding average single event volume.
	default	null
	oneOf	type	object
		additionalProperties	type	number
			exclusiveMinimum	0.0
		type	null
slope	Regression slope
	Slope of the linear regression : Volume(g) = Slope(g/s) * time(s) + offset(g)
	type	number
offset	Regression offset
	Offset of the linear regression : Volume(g) = Slope(g/s) * time(s) + offset(g)
	type	number
r2	R2
	R2 metric from the linear model.
	default	null
	oneOf	type	number
		maximum	1.0
		minimum	0.0
		type	null
valid_domain	Valid domain
	The optional time-intervals the calibration curve was calculated on.
	default	null
	oneOf	type	array
		items	type	number
			exclusiveMinimum	0.0
		minItems	2
		type	null

WebCamera

type	object
properties
device_type	Device Type
	Device type
	type	string
	default	WebCamera
	const	WebCamera
additional_settings	Additional settings
	default	null
	oneOf	BaseModel
		type	null
calibration	Calibration
	default	null
	oneOf	BaseModel
		type	null
index	Index
	Camera index
	type	integer
	minimum	0
	default	0
video_writer	Video writer. If not provided, no video will be saved.
	default	null
	oneOf	VideoWriter
		type	null