api.rig

pydantic model aind_behavior_force_foraging.rig.AindForceForagingRig

Bases: AindBehaviorRigModel

Fields:

• calibration (aind_behavior_force_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_load_cells (aind_behavior_force_foraging.rig.HarpLoadCells)

• manipulator (aind_behavior_force_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.2.0'])

Validators:

• coerce_version » version

field calibration: RigCalibration = None

Load cells calibration

field harp_analog_input: rig.HarpAnalogInput | None = None

Harp analog input

field harp_behavior: rig.HarpBehavior [Required]

Harp behavior

field harp_clock_generator: rig.HarpClockGenerator [Required]

Harp clock generator

field harp_clock_repeaters: List[rig.HarpClockGenerator] = []

Harp clock repeaters

field harp_lickometer: rig.HarpLickometer [Required]

Harp lickometer

field harp_load_cells: HarpLoadCells [Required]

Harp load cells

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.2.0'

Validated by:

• coerce_version

pydantic model aind_behavior_force_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_force_foraging.rig.AindManipulatorDevice

Bases: AindManipulatorDevice

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

Fields:

• additional_settings (aind_behavior_force_foraging.rig.AindManipulatorAdditionalSettings)

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

Additional settings

pydantic model aind_behavior_force_foraging.rig.HarpLoadCells

Bases: HarpLoadCells

Fields:

• calibration (aind_behavior_services.calibration.load_cells.LoadCellsCalibration)

field calibration: lcc.LoadCellsCalibration [Required]

Load cells calibration

pydantic model aind_behavior_force_foraging.rig.RigCalibration

Bases: BaseModel

Fields:

• water_valve (aind_behavior_services.calibration.water_valve.WaterValveCalibration)

field water_valve: wvc.WaterValveCalibration [Required]

Water valve calibration