api.rig

pydantic model aind_behavior_vr_foraging.rig.AindManipulatorAdditionalSettings

Bases: BaseModel

Additional settings for the manipulator device

Fields:

• spout_axis (aind_behavior_services.calibration.aind_manipulator.Axis)

field spout_axis: aind_manipulator.Axis = Axis.Y1

Spout axis

pydantic model aind_behavior_vr_foraging.rig.AindManipulatorDevice

Bases: AindManipulatorDevice

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

Fields:

• additional_settings (aind_behavior_vr_foraging.rig.AindManipulatorAdditionalSettings)

field additional_settings: AindManipulatorAdditionalSettings = AindManipulatorAdditionalSettings(spout_axis=<Axis.Y1: 2>)

Additional settings

pydantic model aind_behavior_vr_foraging.rig.AindVrForagingRig

Bases: AindBehaviorRigModel

Fields:

• calibration (aind_behavior_vr_foraging.rig.RigCalibration)

• harp_analog_input (aind_behavior_services.rig.HarpAnalogInput | None)

• harp_behavior (aind_behavior_services.rig.HarpBehavior)

• harp_clock_generator (aind_behavior_services.rig.HarpClockGenerator)

• harp_clock_repeaters (List[aind_behavior_services.rig.HarpClockGenerator])

• harp_lickometer (aind_behavior_services.rig.HarpLickometer)

• harp_olfactometer (aind_behavior_vr_foraging.rig.HarpOlfactometer)

• harp_sniff_detector (aind_behavior_services.rig.HarpSniffDetector | None)

• harp_treadmill (aind_behavior_vr_foraging.rig.HarpTreadmill)

• manipulator (aind_behavior_vr_foraging.rig.AindManipulatorDevice)

• monitoring_camera_controller (aind_behavior_services.rig.CameraController[WebCamera] | None)

• screen (aind_behavior_services.rig.Screen)

• triggered_camera_controller (aind_behavior_services.rig.CameraController[SpinnakerCamera])

• version (Literal['0.3.0'])

Validators:

• coerce_version » version

field calibration: RigCalibration [Required]

Calibration models

field harp_analog_input: HarpAnalogInput | None = None

Harp analog input

field harp_behavior: HarpBehavior [Required]

Harp behavior

field harp_clock_generator: HarpClockGenerator [Required]

Harp clock generator

field harp_clock_repeaters: List[HarpClockGenerator] = []

Harp clock repeaters

field harp_lickometer: HarpLickometer [Required]

Harp lickometer

field harp_olfactometer: HarpOlfactometer [Required]

Harp olfactometer

field harp_sniff_detector: HarpSniffDetector | None = None

Sniff detector settings

field harp_treadmill: HarpTreadmill [Required]

Harp treadmill

field manipulator: AindManipulatorDevice [Required]

Manipulator

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

Optional camera controller for monitoring cameras.

field screen: rig.Screen = Screen(device_type='Screen', additional_settings=None, calibration=None, display_index=1, target_render_frequency=60, target_update_frequency=120, calibration_directory='Calibration\\Monitors\\', texture_assets_directory='Textures', brightness=0, contrast=1)

Screen settings

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

Required camera controller to triggered cameras.

field version: Literal[__version__] = '0.3.0'

Validated by:

• coerce_version

pydantic model aind_behavior_vr_foraging.rig.HarpOlfactometer

Bases: HarpOlfactometer

Overrides the default settings for the olfactometer calibration

Fields:

• calibration (aind_behavior_services.calibration.olfactometer.OlfactometerCalibration | None)

field calibration: oc.OlfactometerCalibration | None = None

Olfactometer calibration

pydantic model aind_behavior_vr_foraging.rig.HarpTreadmill

Bases: HarpTreadmill

Overrides the default settings for the treadmill calibration

Fields:

• calibration (aind_behavior_vr_foraging.rig.Treadmill)

field calibration: Treadmill = Treadmill(wheel_diameter=15, pulses_per_revolution=28800, invert_direction=False, brake_lookup_calibration=[[0.0, 0.0], [1.0, 65535.0]])

Treadmill calibration settings

pydantic model aind_behavior_vr_foraging.rig.RigCalibration

Bases: BaseModel

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

Fields:

• water_valve (aind_behavior_services.calibration.water_valve.WaterValveCalibration)

field water_valve: wvc.WaterValveCalibration [Required]

Water valve calibration

pydantic model aind_behavior_vr_foraging.rig.Treadmill

Bases: Treadmill

Overrides the default settings for the treadmill calibration by spec’ing brake_lookup_calibration field

Fields:

• brake_lookup_calibration (List[List[float]])

field brake_lookup_calibration: List[ValuePair] = [[0, 0], [1, 65535]]

Brake lookup calibration. Each Tuple is (0-1 (percent), 0-full-scale). Values are linearly interpolated

Constraints:

• min_length = 2