json-schemas.rig

Download Schema

AindVideoEncodingBenchmarksRig

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.8.0-rc1
version	Version
	type	string
	default	0.1.1
	const	0.1.1
computer_name	Computer Name
	Computer name
	type	string
rig_name	Rig Name
	Rig name
	type	string
triggered_camera_controller_0	Required camera controller to triggered cameras. Will use Camera0 register as a trigger.
	oneOf	CameraController[SpinnakerCamera]
		type	null
triggered_camera_controller_1	Optional camera controller to triggered cameras. Will use Camera1 register as a trigger.
	default	null
	oneOf	CameraController[SpinnakerCamera]
		type	null
harp_behavior	Harp behavior board. Will be the source of triggers for the two camera controllers.
	allOf	HarpBehavior
harp_clock_generator	Harp clock generator.
	allOf	HarpClockGenerator

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

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

Rect

type	object
properties
x	X
	X coordinate of the top-left corner
	type	integer
	minimum	0
	default	0
y	Y
	Y coordinate of the top-left corner
	type	integer
	minimum	0
	default	0
width	Width
	Width of the rectangle
	type	integer
	minimum	0
	default	0
height	Height
	Height of the rectangle
	type	integer
	minimum	0
	default	0

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
gamma	Gamma
	Gamma. If None, will disable gamma correction.
	default	null
	oneOf	type	number
		minimum	0.0
		type	null
adc_bit_depth	ADC bit depth
	default	0
	allOf	SpinnakerCameraAdcBitDepth
region_of_interest	Region of interest
	default	x	0
		y	0
		width	0
		height	0
	allOf	Rect
video_writer	Video writer. If not provided, no video will be saved.
	default	null
	oneOf	VideoWriter
		type	null

SpinnakerCameraAdcBitDepth

type	integer
enum	0, 1, 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