json-schemas.rig¶
AindVrForagingRig¶
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.9.0 |
||||||
|
Version |
||||||
type |
string |
||||||
default |
0.4.0 |
||||||
const |
0.4.0 |
||||||
|
Computer Name |
||||||
Computer name |
|||||||
type |
string |
||||||
|
Rig Name |
||||||
Rig name |
|||||||
type |
string |
||||||
|
Required camera controller to triggered cameras. |
||||||
|
Optional camera controller for monitoring cameras. |
||||||
default |
null |
||||||
oneOf |
|||||||
type |
null |
||||||
|
Harp behavior |
||||||
|
Harp olfactometer |
||||||
|
Harp lickometer |
||||||
|
Harp clock generator |
||||||
|
Harp Clock Repeaters |
||||||
Harp clock repeaters |
|||||||
type |
array |
||||||
default |
|||||||
items |
|||||||
|
Harp analog input |
||||||
default |
null |
||||||
oneOf |
|||||||
type |
null |
||||||
|
Harp treadmill |
||||||
|
Sniff detector settings |
||||||
default |
null |
||||||
oneOf |
|||||||
type |
null |
||||||
|
Environment sensor |
||||||
default |
null |
||||||
oneOf |
|||||||
type |
null |
||||||
|
Manipulator |
||||||
|
Screen settings |
||||||
default |
device_type |
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 |
||||||
|
Calibration models |
||||||
AindManipulatorAdditionalSettings¶
Additional settings for the manipulator device |
||
type |
object |
|
properties |
||
|
Spout axis |
|
default |
2 |
|
AindManipulatorCalibration¶
Aind manipulator calibration class |
|||
type |
object |
||
properties |
|||
|
Device name |
||
Must match a device name in rig/instrument |
|||
type |
string |
||
default |
AindManipulator |
||
|
Input of the calibration |
||
|
Output of the calibration. |
||
|
Date |
||
default |
null |
||
oneOf |
type |
string |
|
format |
date-time |
||
type |
null |
||
|
Description |
||
type |
string |
||
default |
Calibration of the load cells system |
||
const |
Calibration of the load cells system |
||
|
Notes |
||
default |
null |
||
oneOf |
type |
string |
|
type |
null |
AindManipulatorCalibrationInput¶
type |
object |
||
properties |
|||
|
Full step to mm. Used to convert steps to SI Units |
||
default |
x |
0.01 |
|
y1 |
0.01 |
||
y2 |
0.01 |
||
z |
0.01 |
||
|
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 |
|||
|
Homing order |
||
type |
array |
||
default |
2 |
||
3 |
|||
1 |
|||
4 |
|||
items |
|||
|
default |
x |
0.0 |
y1 |
0.0 |
||
y2 |
0.0 |
||
z |
0.0 |
||
AindManipulatorCalibrationOutput¶
type |
object |
properties |
AindManipulatorDevice¶
Overrides the default settings for the manipulator device by spec’ing additional_settings field |
|||
type |
object |
||
properties |
|||
|
Device Type |
||
type |
string |
||
default |
stepperdriver |
||
const |
stepperdriver |
||
|
Additional settings |
||
default |
spout_axis |
2 |
|
|
Calibration of the manipulator |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Who Am I |
||
type |
integer |
||
default |
1130 |
||
const |
1130 |
||
|
Serial Number |
||
Device serial number |
|||
default |
null |
||
oneOf |
type |
string |
|
type |
null |
||
|
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 to be configured |
|
|
Acceleration |
|
Acceleration of the step interval in microseconds |
||
type |
integer |
|
maximum |
2000 |
|
minimum |
2 |
|
default |
100 |
|
|
Step interval |
|
Step interval in microseconds. |
||
type |
integer |
|
maximum |
20000 |
|
minimum |
100 |
|
default |
100 |
|
|
Microstep resolution |
|
default |
0 |
|
|
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 |
|
default |
0 |
|
|
Maximum limit in SI units. A value of 0 disables this limit. |
|
type |
number |
|
default |
25 |
|
|
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 |
||
type |
string |
||
default |
CameraController |
||
const |
CameraController |
||
|
Additional settings |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Calibration |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Cameras |
||
Cameras to be instantiated |
|||
type |
object |
||
additionalProperties |
|||
|
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 |
||
type |
string |
||
default |
CameraController |
||
const |
CameraController |
||
|
Additional settings |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Calibration |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Cameras |
||
Cameras to be instantiated |
|||
type |
object |
||
additionalProperties |
|||
|
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 |
||
Optional device name to provide user additional information |
|||
default |
null |
||
oneOf |
type |
string |
|
type |
null |
||
|
Output Channel |
||
Output channel |
|||
type |
integer |
||
minimum |
0 |
DisplayCalibration¶
type |
object |
|||
properties |
||||
|
Intrinsics |
|||
default |
frame_width |
1920 |
||
frame_height |
1080 |
|||
display_width |
20.0 |
|||
display_height |
15.0 |
|||
|
Extrinsics |
|||
default |
rotation |
x |
0.0 |
|
y |
0.0 |
|||
z |
0.0 |
|||
translation |
x |
0.0 |
||
y |
1.309016 |
|||
z |
-13.27 |
|||
DisplayExtrinsics¶
DisplayIntrinsics¶
type |
object |
|
properties |
||
|
Frame Width |
|
Frame width (px) |
||
type |
integer |
|
minimum |
0 |
|
default |
1920 |
|
|
Frame Height |
|
Frame height (px) |
||
type |
integer |
|
minimum |
0 |
|
default |
1080 |
|
|
Display Width |
|
Display width (cm) |
||
type |
number |
|
minimum |
0.0 |
|
default |
20 |
|
|
Display Height |
|
Display width (cm) |
||
type |
number |
|
minimum |
0.0 |
|
default |
15 |
DisplaysCalibration¶
type |
object |
||||
properties |
|||||
|
Left display calibration |
||||
default |
intrinsics |
display_height |
15.0 |
||
display_width |
20.0 |
||||
frame_height |
1080 |
||||
frame_width |
1920 |
||||
extrinsics |
rotation |
x |
0.0 |
||
y |
1.0472 |
||||
z |
0.0 |
||||
translation |
x |
-16.6917756 |
|||
y |
1.309016 |
||||
z |
-3.575264 |
||||
|
Center display calibration |
||||
default |
intrinsics |
display_height |
15.0 |
||
display_width |
20.0 |
||||
frame_height |
1080 |
||||
frame_width |
1920 |
||||
extrinsics |
rotation |
x |
0.0 |
||
y |
0.0 |
||||
z |
0.0 |
||||
translation |
x |
0.0 |
|||
y |
1.309016 |
||||
z |
-13.27 |
||||
|
Right display calibration |
||||
default |
intrinsics |
display_height |
15.0 |
||
display_width |
20.0 |
||||
frame_height |
1080 |
||||
frame_width |
1920 |
||||
extrinsics |
rotation |
x |
0.0 |
||
y |
-1.0472 |
||||
z |
0.0 |
||||
translation |
x |
16.6917756 |
|||
y |
1.309016 |
||||
z |
-3.575264 |
||||
HarpAnalogInput¶
type |
object |
||
properties |
|||
|
Device Type |
||
type |
string |
||
default |
analoginput |
||
const |
analoginput |
||
|
Additional settings |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Calibration |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Who Am I |
||
type |
integer |
||
default |
1236 |
||
const |
1236 |
||
|
Serial Number |
||
Device serial number |
|||
default |
null |
||
oneOf |
type |
string |
|
type |
null |
||
|
Port Name |
||
Device port name |
|||
type |
string |
HarpBehavior¶
type |
object |
||
properties |
|||
|
Device Type |
||
type |
string |
||
default |
behavior |
||
const |
behavior |
||
|
Additional settings |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Calibration |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Who Am I |
||
type |
integer |
||
default |
1216 |
||
const |
1216 |
||
|
Serial Number |
||
Device serial number |
|||
default |
null |
||
oneOf |
type |
string |
|
type |
null |
||
|
Port Name |
||
Device port name |
|||
type |
string |
HarpClockGenerator¶
type |
object |
||
properties |
|||
|
Device Type |
||
type |
string |
||
default |
clockgenerator |
||
const |
clockgenerator |
||
|
Additional settings |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Calibration |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Who Am I |
||
type |
integer |
||
default |
1158 |
||
const |
1158 |
||
|
Serial Number |
||
Device serial number |
|||
default |
null |
||
oneOf |
type |
string |
|
type |
null |
||
|
Port Name |
||
Device port name |
|||
type |
string |
||
|
Connected Clock Outputs |
||
Connected clock outputs |
|||
type |
array |
||
default |
|||
items |
HarpEnvironmentSensor¶
type |
object |
||
properties |
|||
|
Device Type |
||
type |
string |
||
default |
environmentsensor |
||
const |
environmentsensor |
||
|
Additional settings |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Calibration |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Who Am I |
||
type |
integer |
||
default |
1405 |
||
const |
1405 |
||
|
Serial Number |
||
Device serial number |
|||
default |
null |
||
oneOf |
type |
string |
|
type |
null |
||
|
Port Name |
||
Device port name |
|||
type |
string |
HarpLickometer¶
type |
object |
||
properties |
|||
|
Device Type |
||
type |
string |
||
default |
lickometer |
||
const |
lickometer |
||
|
Additional settings |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Calibration |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Who Am I |
||
type |
integer |
||
default |
1400 |
||
const |
1400 |
||
|
Serial Number |
||
Device serial number |
|||
default |
null |
||
oneOf |
type |
string |
|
type |
null |
||
|
Port Name |
||
Device port name |
|||
type |
string |
HarpOlfactometer¶
Overrides the default settings for the olfactometer calibration |
|||
type |
object |
||
properties |
|||
|
Device Type |
||
type |
string |
||
default |
olfactometer |
||
const |
olfactometer |
||
|
Additional settings |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Olfactometer calibration |
||
default |
null |
||
|
Who Am I |
||
type |
integer |
||
default |
1140 |
||
const |
1140 |
||
|
Serial Number |
||
Device serial number |
|||
default |
null |
||
oneOf |
type |
string |
|
type |
null |
||
|
Port Name |
||
Device port name |
|||
type |
string |
HarpSniffDetector¶
type |
object |
||
properties |
|||
|
Device Type |
||
type |
string |
||
default |
sniffdetector |
||
const |
sniffdetector |
||
|
Additional settings |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Calibration |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Who Am I |
||
type |
integer |
||
default |
1401 |
||
const |
1401 |
||
|
Serial Number |
||
Device serial number |
|||
default |
null |
||
oneOf |
type |
string |
|
type |
null |
||
|
Port Name |
||
Device port name |
|||
type |
string |
ManipulatorPosition¶
type |
object |
|
properties |
||
|
X coordinate |
|
type |
number |
|
|
Y1 coordinate |
|
type |
number |
|
|
Y2 coordinate |
|
type |
number |
|
|
Z coordinate |
|
type |
number |
Measurement¶
Input for water valve calibration class |
|||
type |
object |
||
properties |
|||
|
Valve open interval |
||
Time between two consecutive valve openings (s) |
|||
type |
number |
||
exclusiveMinimum |
0.0 |
||
|
Valve open time |
||
Valve open interval (s) |
|||
type |
number |
||
exclusiveMinimum |
0.0 |
||
|
Water weight |
||
Weight of water delivered (g) |
|||
type |
array |
||
items |
type |
number |
|
exclusiveMinimum |
0.0 |
||
minItems |
1 |
||
|
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 |
||
Name of the device being calibrated |
|||
type |
string |
||
default |
Olfactometer |
||
|
Input of the calibration |
||
|
Output of the calibration |
||
|
Date |
||
default |
null |
||
oneOf |
type |
string |
|
format |
date-time |
||
type |
null |
||
|
Description |
||
type |
string |
||
default |
Calibration of the harp olfactometer device |
||
const |
Calibration of the harp olfactometer device |
||
|
Notes |
||
default |
null |
||
oneOf |
type |
string |
|
type |
null |
OlfactometerCalibrationInput¶
type |
object |
|
properties |
||
|
Channel Config |
|
Configuration of olfactometer channels |
||
type |
object |
|
default |
||
additionalProperties |
OlfactometerCalibrationOutput¶
type |
object |
properties |
OlfactometerChannel¶
Harp Olfactometer available channel |
|
type |
integer |
enum |
0, 1, 2, 3 |
OlfactometerChannelConfig¶
type |
object |
||
properties |
|||
|
Channel index |
||
type |
integer |
||
|
Channel type |
||
default |
Odor |
||
|
Flow capacity. mL/min |
||
type |
integer |
||
enum |
100, 1000 |
||
default |
100 |
||
|
Target flow rate. mL/min. If channel_type == CARRIER, this value is ignored. |
||
type |
number |
||
maximum |
100.0 |
||
default |
100 |
||
|
Odorant name |
||
default |
null |
||
oneOf |
type |
string |
|
type |
null |
||
|
Odorant dilution (%v/v) |
||
default |
null |
||
oneOf |
type |
number |
|
type |
null |
OlfactometerChannelType¶
Channel type |
|
type |
string |
enum |
Odor, Carrier |
Rect¶
type |
object |
|
properties |
||
|
X |
|
X coordinate of the top-left corner |
||
type |
integer |
|
minimum |
0 |
|
default |
0 |
|
|
Y |
|
Y coordinate of the top-left corner |
||
type |
integer |
|
minimum |
0 |
|
default |
0 |
|
|
Width |
|
Width of the rectangle |
||
type |
integer |
|
minimum |
0 |
|
default |
0 |
|
|
Height |
|
Height of the rectangle |
||
type |
integer |
|
minimum |
0 |
|
default |
0 |
RigCalibration¶
Container class for calibration models. In a future release these will be moved to the respective devices |
|
type |
object |
properties |
|
|
Water valve calibration |
Screen¶
type |
object |
|||||
properties |
||||||
|
Device Type |
|||||
Device type |
||||||
type |
string |
|||||
default |
Screen |
|||||
const |
Screen |
|||||
|
Additional settings |
|||||
default |
null |
|||||
oneOf |
||||||
type |
null |
|||||
|
Screen calibration |
|||||
default |
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 |
|||||
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 |
|||||
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 |
|||||
Display index |
||||||
type |
integer |
|||||
default |
1 |
|||||
|
Target Render Frequency |
|||||
Target render frequency |
||||||
type |
number |
|||||
default |
60 |
|||||
|
Target Update Frequency |
|||||
Target update frequency |
||||||
type |
number |
|||||
default |
120 |
|||||
|
Texture Assets Directory |
|||||
Calibration directory |
||||||
type |
string |
|||||
default |
Textures |
|||||
|
Brightness |
|||||
Brightness |
||||||
type |
number |
|||||
maximum |
1.0 |
|||||
minimum |
-1.0 |
|||||
default |
0 |
|||||
|
Contrast |
|||||
Contrast |
||||||
type |
number |
|||||
maximum |
1.0 |
|||||
minimum |
-1.0 |
|||||
default |
1 |
SpinnakerCamera¶
type |
object |
||
properties |
|||
|
Device Type |
||
Device type |
|||
type |
string |
||
default |
SpinnakerCamera |
||
const |
SpinnakerCamera |
||
|
Additional settings |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Calibration |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Serial Number |
||
Camera serial number |
|||
type |
string |
||
|
Binning |
||
Binning |
|||
type |
integer |
||
minimum |
1 |
||
default |
1 |
||
|
Color Processing |
||
Color processing |
|||
type |
string |
||
enum |
Default, NoColorProcessing |
||
default |
Default |
||
|
Exposure |
||
Exposure time |
|||
type |
integer |
||
minimum |
100 |
||
default |
1000 |
||
|
Gain |
||
Gain |
|||
type |
number |
||
minimum |
0.0 |
||
default |
0 |
||
|
Gamma |
||
Gamma. If None, will disable gamma correction. |
|||
default |
null |
||
oneOf |
type |
number |
|
minimum |
0.0 |
||
type |
null |
||
|
ADC bit depth. If None will be left as default. |
||
default |
0 |
||
oneOf |
|||
type |
null |
||
|
Pixel format. If None will be left as default. |
||
default |
0 |
||
oneOf |
|||
type |
null |
||
|
Region of interest |
||
default |
x |
0 |
|
y |
0 |
||
width |
0 |
||
height |
0 |
||
|
Video writer. If not provided, no video will be saved. |
||
default |
null |
||
oneOf |
|||
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 |
Treadmill¶
type |
object |
||
properties |
|||
|
Device Type |
||
type |
string |
||
default |
treadmill |
||
const |
treadmill |
||
|
Additional settings |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Calibration of the treadmill |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Who Am I |
||
type |
integer |
||
default |
1402 |
||
const |
1402 |
||
|
Serial Number |
||
Device serial number |
|||
default |
null |
||
oneOf |
type |
string |
|
type |
null |
||
|
Port Name |
||
Device port name |
|||
type |
string |
TreadmillCalibration¶
Treadmill calibration class |
|||
type |
object |
||
properties |
|||
|
Device name |
||
Must match a device name in rig/instrument |
|||
type |
string |
||
default |
Treadmill |
||
|
Input of the calibration |
||
|
Output of the calibration. |
||
|
Date |
||
default |
null |
||
oneOf |
type |
string |
|
format |
date-time |
||
type |
null |
||
|
Description |
||
type |
string |
||
default |
Calibration of the treadmill system |
||
const |
Calibration of the treadmill system |
||
|
Notes |
||
default |
null |
||
oneOf |
type |
string |
|
type |
null |
TreadmillCalibrationInput¶
type |
object |
properties |
TreadmillCalibrationOutput¶
type |
object |
|||
properties |
||||
|
Wheel Diameter |
|||
Wheel diameter |
||||
type |
number |
|||
minimum |
0.0 |
|||
default |
15 |
|||
|
Pulses Per Revolution |
|||
Pulses per revolution |
||||
type |
integer |
|||
minimum |
1 |
|||
default |
28800 |
|||
|
Invert Direction |
|||
Invert direction |
||||
type |
boolean |
|||
default |
False |
|||
|
Brake Lookup Calibration |
|||
Brake lookup calibration. Each pair of values define (input [torque], output [brake set-point U16]) |
||||
type |
array |
|||
items |
type |
array |
||
items |
type |
number |
||
maxItems |
2 |
|||
minItems |
2 |
|||
minItems |
2 |
Vector3¶
type |
object |
|
properties |
||
|
X |
|
X coordinate of the point |
||
type |
number |
|
default |
0 |
|
|
Y |
|
Y coordinate of the point |
||
type |
number |
|
default |
0 |
|
|
Z |
|
Z coordinate of the point |
||
type |
number |
|
default |
0 |
VideoWriter¶
VideoWriterFfmpeg¶
type |
object |
|
properties |
||
|
Video Writer Type |
|
type |
string |
|
default |
FFMPEG |
|
const |
FFMPEG |
|
|
Frame Rate |
|
Encoding frame rate |
||
type |
integer |
|
minimum |
0 |
|
default |
30 |
|
|
Container Extension |
|
Container extension |
||
type |
string |
|
default |
mp4 |
|
|
Output Arguments |
|
Output arguments |
||
type |
string |
|
default |
-vf “scale=out_color_matrix=bt709:out_range=full,format=bgr24,scale=out_range=full” -c:v h264_nvenc -pix_fmt yuv420p -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 |
||
type |
string |
|
default |
-colorspace bt709 -color_primaries bt709 -color_range full -color_trc linear |
VideoWriterOpenCv¶
type |
object |
|
properties |
||
|
Video Writer Type |
|
type |
string |
|
default |
OPENCV |
|
const |
OPENCV |
|
|
Frame Rate |
|
Encoding frame rate |
||
type |
integer |
|
minimum |
0 |
|
default |
30 |
|
|
Container Extension |
|
Container extension |
||
type |
string |
|
default |
avi |
|
|
Four Cc |
|
Four character code |
||
type |
string |
|
default |
FMP4 |
WaterValveCalibration¶
Water valve calibration class |
|||
type |
object |
||
properties |
|||
|
Device name |
||
Name of the device being calibrated |
|||
type |
string |
||
default |
WaterValve |
||
|
Input of the calibration |
||
|
Output of the calibration. |
||
|
Date |
||
default |
null |
||
oneOf |
type |
string |
|
format |
date-time |
||
type |
null |
||
|
Description |
||
type |
string |
||
default |
Calibration of the water valve delivery system |
||
const |
Calibration of the water valve delivery system |
||
|
Notes |
||
default |
null |
||
oneOf |
type |
string |
|
type |
null |
WaterValveCalibrationInput¶
type |
object |
|
properties |
||
|
Measurements |
|
List of measurements |
||
type |
array |
|
default |
||
items |
WaterValveCalibrationOutput¶
Output for water valve calibration class |
||||
type |
object |
|||
properties |
||||
|
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 |
|||
|
Regression slope |
|||
Slope of the linear regression : Volume(g) = Slope(g/s) * time(s) + offset(g) |
||||
type |
number |
|||
|
Regression offset |
|||
Offset of the linear regression : Volume(g) = Slope(g/s) * time(s) + offset(g) |
||||
type |
number |
|||
|
R2 |
|||
R2 metric from the linear model. |
||||
default |
null |
|||
oneOf |
type |
number |
||
maximum |
1.0 |
|||
minimum |
0.0 |
|||
type |
null |
|||
|
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 |
|||
type |
string |
||
default |
WebCamera |
||
const |
WebCamera |
||
|
Additional settings |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Calibration |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Index |
||
Camera index |
|||
type |
integer |
||
minimum |
0 |
||
default |
0 |
||
|
Video writer. If not provided, no video will be saved. |
||
default |
null |
||
oneOf |
|||
type |
null |