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.8
version	Version
	type	string
	default	0.1.2
	const	0.1.2
computer_name	Computer Name
	Computer name
	type	string
rig_name	Rig Name
	Rig name
	type	string
triggered_camera_controller_0	Camera controller to triggered cameras. Will use Camera0 register as a trigger.
	default	null
	oneOf	CameraController[SpinnakerCamera]
		type	null
triggered_camera_controller_1	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.
	HarpBehavior
harp_clock_generator	Harp clock generator.
	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

ConnectedClockOutput

type	object
properties
target_device	Target Device
	Optional device name to provide user additional information
	default	null
	oneOf	type	string
		type	null
output_channel	Output Channel
	Output channel
	type	integer
	minimum	0

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
connected_clock_outputs	Connected Clock Outputs
	Connected clock outputs
	type	array
	default
	items	ConnectedClockOutput

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. If None will be left as default.
	default	0
	oneOf	SpinnakerCameraAdcBitDepth
		type	null
pixel_format	Pixel format. If None will be left as default.
	default	0
	oneOf	SpinnakerCameraPixelFormat
		type	null
region_of_interest	Region of interest
	default	x	0
		y	0
		width	0
		height	0
	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

SpinnakerCameraPixelFormat

type

integer

enum

0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143

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	-vf “scale=out_color_matrix=bt709:out_range=full” -c:v h264_nvenc -pix_fmt nv12 -color_range full -colorspace bt709 -color_trc linear -tune hq -preset p4 -rc vbr -cq 12 -b:v 0M -metadata author=”Allen Institute for Neural Dynamics” -maxrate 700M -bufsize 350M
input_arguments	Input Arguments
	Input arguments
	type	string
	default	-v verbose -colorspace bt709 -color_primaries bt709 -color_range full -color_trc linear

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