api.rig

pydantic model aind_behavior_vr_foraging.rig.AindManipulatorAdditionalSettings[source]

Bases: BaseModel

Additional settings for the manipulator device

Fields:
field spout_axis: aind_manipulator.Axis = Axis.Y1[source]

Spout axis

pydantic model aind_behavior_vr_foraging.rig.AindManipulatorDevice[source]

Bases: AindManipulatorDevice

Overrides the default settings for the manipulator device by spec’ing additional_settings field

Fields:
field additional_settings: AindManipulatorAdditionalSettings = AindManipulatorAdditionalSettings(spout_axis=<Axis.Y1: 2>)[source]

Additional settings

pydantic model aind_behavior_vr_foraging.rig.AindVrForagingRig[source]

Bases: AindBehaviorRigModel

Fields:
Validators:
field calibration: RigCalibration [Required][source]

Calibration models

field harp_analog_input: HarpAnalogInput | None = None[source]

Harp analog input

field harp_behavior: HarpBehavior [Required][source]

Harp behavior

field harp_clock_generator: HarpClockGenerator [Required][source]

Harp clock generator

field harp_clock_repeaters: List[HarpClockGenerator] = [][source]

Harp clock repeaters

field harp_environment_sensor: rig.HarpEnvironmentSensor | None = None[source]

Environment sensor

field harp_lickometer: HarpLickometer [Required][source]

Harp lickometer

field harp_olfactometer: HarpOlfactometer [Required][source]

Harp olfactometer

field harp_sniff_detector: HarpSniffDetector | None = None[source]

Sniff detector settings

field harp_treadmill: Treadmill [Required][source]

Harp treadmill

field manipulator: AindManipulatorDevice [Required][source]

Manipulator

field monitoring_camera_controller: rig.CameraController[rig.WebCamera] | None = None[source]

Optional camera controller for monitoring cameras.

field screen: rig.Screen = Screen(device_type='Screen', additional_settings=None, calibration=DisplaysCalibration(left=DisplayCalibration(intrinsics=DisplayIntrinsics(frame_width=1920, frame_height=1080, display_width=20, display_height=15), extrinsics=DisplayExtrinsics(rotation=Vector3(x=0.0, y=1.0472, z=0.0), translation=Vector3(x=-16.6917756, y=1.309016, z=-3.575264))), center=DisplayCalibration(intrinsics=DisplayIntrinsics(frame_width=1920, frame_height=1080, display_width=20, display_height=15), extrinsics=DisplayExtrinsics(rotation=Vector3(x=0.0, y=0.0, z=0.0), translation=Vector3(x=0.0, y=1.309016, z=-13.27))), right=DisplayCalibration(intrinsics=DisplayIntrinsics(frame_width=1920, frame_height=1080, display_width=20, display_height=15), extrinsics=DisplayExtrinsics(rotation=Vector3(x=0.0, y=-1.0472, z=0.0), translation=Vector3(x=16.6917756, y=1.309016, z=-3.575264)))), display_index=1, target_render_frequency=60, target_update_frequency=120, texture_assets_directory='Textures', brightness=0, contrast=1)[source]

Screen settings

field triggered_camera_controller: rig.CameraController[rig.SpinnakerCamera] [Required][source]

Required camera controller to triggered cameras.

field version: Literal[__version__] = '0.4.0'[source]
Validated by:

  • coerce_version

pydantic model aind_behavior_vr_foraging.rig.HarpOlfactometer[source]

Bases: HarpOlfactometer

Overrides the default settings for the olfactometer calibration

Fields:
field calibration: oc.OlfactometerCalibration = None[source]

Olfactometer calibration

pydantic model aind_behavior_vr_foraging.rig.RigCalibration[source]

Bases: BaseModel

Container class for calibration models. In a future release these will be moved to the respective devices

Fields:
field water_valve: wvc.WaterValveCalibration [Required][source]

Water valve calibration