json-schemas.rig¶
AindForceForagingRig¶
type |
object |
||
properties |
|||
|
Version |
||
type |
string |
||
default |
0.2.0 |
||
const |
0.2.0 |
||
|
Computer Name |
||
Computer name |
|||
type |
string |
||
|
Rig Name |
||
Rig name |
|||
type |
string |
||
|
Required camera controller to triggered cameras. |
||
allOf |
|||
|
Optional camera controller for monitoring cameras. |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Harp behavior |
||
allOf |
|||
|
Harp lickometer |
||
allOf |
|||
|
Harp load cells |
||
allOf |
|||
|
Harp clock generator |
||
allOf |
|||
|
Harp Clock Repeaters |
||
Harp clock repeaters |
|||
type |
array |
||
default |
|||
items |
|||
|
Harp analog input |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Manipulator |
||
allOf |
|||
|
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 |
|||
|
Load cells calibration |
||
default |
null |
||
allOf |
AindManipulatorAdditionalSettings¶
Additional settings for the manipulator device |
||
type |
object |
|
properties |
||
|
Spout axis |
|
default |
2 |
|
allOf |
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 |
||
allOf |
|||
|
Output of the calibration. |
||
allOf |
|||
|
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 |
||
allOf |
|||
|
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 |
||
allOf |
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 |
|
allOf |
|||
|
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 |
|
allOf |
||
|
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 |
|
allOf |
||
|
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 |
|
allOf |
||
|
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 |
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 |
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 |
HarpLoadCells¶
type |
object |
||
properties |
|||
|
Device Type |
||
type |
string |
||
default |
loadcells |
||
const |
loadcells |
||
|
Additional settings |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Load cells calibration |
||
allOf |
|||
|
Who Am I |
||
type |
integer |
||
default |
1232 |
||
const |
1232 |
||
|
Serial Number |
||
Device serial number |
|||
default |
null |
||
oneOf |
type |
string |
|
type |
null |
||
|
Port Name |
||
Device port name |
|||
type |
string |
LoadCellCalibration¶
type |
object |
||
properties |
|||
|
Load cells offset. Each entry is expected to be in the format of: Channel : (offset, baseline) |
||
type |
object |
||
default |
|||
additionalProperties |
type |
number |
|
|
Load cells measured weight. Each entry is expected to be in the format of: (known weight(g), baseline) |
||
type |
array |
||
default |
|||
items |
type |
array |
|
maxItems |
2 |
||
minItems |
2 |
LoadCellsCalibration¶
Load cells calibration class |
|||
type |
object |
||
properties |
|||
|
Device name |
||
Must match a device name in rig/instrument |
|||
type |
string |
||
default |
LoadCells |
||
|
Input of the calibration |
||
allOf |
|||
|
Output of the calibration. |
||
allOf |
|||
|
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 |
LoadCellsCalibrationInput¶
type |
object |
|
properties |
||
|
Load cells calibration data |
|
type |
object |
|
default |
||
additionalProperties |
LoadCellsCalibrationOutput¶
type |
object |
||
properties |
|||
|
Load cells offset |
||
type |
object |
||
default |
0 |
0 |
|
1 |
0 |
||
2 |
0 |
||
3 |
0 |
||
4 |
0 |
||
5 |
0 |
||
6 |
0 |
||
7 |
0 |
||
additionalProperties |
Load cell offset value [-255, 255] |
||
type |
integer |
||
maximum |
255 |
||
minimum |
-255 |
||
|
Load cells baseline to be subtracted from the raw data after applying the offset. |
||
type |
object |
||
default |
0 |
0 |
|
1 |
0 |
||
2 |
0 |
||
3 |
0 |
||
4 |
0 |
||
5 |
0 |
||
6 |
0 |
||
7 |
0 |
||
additionalProperties |
type |
number |
|
|
Load cells lookup calibration table for each channel: (weight, baseline). |
||
type |
object |
||
default |
|||
additionalProperties |
type |
array |
|
maxItems |
2 |
||
minItems |
2 |
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 |
RigCalibration¶
type |
object |
|
properties |
||
|
Water valve calibration |
|
allOf |
Screen¶
type |
object |
||
properties |
|||
|
Device Type |
||
Device type |
|||
type |
string |
||
default |
Screen |
||
const |
Screen |
||
|
Additional settings |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
Calibration |
||
default |
null |
||
oneOf |
|||
type |
null |
||
|
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 |
||
|
Calibration Directory |
||
Calibration directory |
|||
type |
string |
||
default |
Calibration\Monitors\ |
||
|
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 |
||
|
Video writer. If not provided, no video will be saved. |
||
default |
null |
||
oneOf |
|||
type |
null |
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 |
-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 |
|
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 |
||
allOf |
|||
|
Output of the calibration. |
||
allOf |
|||
|
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 |