api.rig¶

class aind_behavior_dynamic_foraging.rig.AindDynamicForagingRig(*, aind_behavior_services_pkg_version: Annotated[Literal['0.13.0-rc2'], _PydanticGeneralMetadata(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-]+)*))?$')] = '0.13.0-rc2', version: Literal['0.0.2-rc2'] = '0.0.2-rc2', computer_name: str, rig_name: str, data_directory: Path, triggered_camera_controller: CameraController[SpinnakerCamera], monitoring_camera_controller: CameraController[WebCamera] | None = None, harp_behavior: HarpBehavior, harp_lickometer_left: HarpLicketySplit, harp_lickometer_right: HarpLicketySplit, harp_clock_generator: HarpWhiteRabbit, harp_sound_card: HarpSoundCard, harp_sniff_detector: HarpSniffDetector | None = None, harp_environment_sensor: HarpEnvironmentSensor | None = None, manipulator: AindManipulator, calibration: RigCalibration)[source]¶

Bases: Rig

calibration: RigCalibration[source]¶

harp_behavior: HarpBehavior[source]¶

harp_clock_generator: HarpWhiteRabbit[source]¶

harp_environment_sensor: HarpEnvironmentSensor | None[source]¶

harp_lickometer_left: HarpLicketySplit[source]¶

harp_lickometer_right: HarpLicketySplit[source]¶

harp_sniff_detector: HarpSniffDetector | None[source]¶

harp_sound_card: HarpSoundCard[source]¶

manipulator: AindManipulator[source]¶

model_config = {}[source]¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

monitoring_camera_controller: CameraController[WebCamera] | None[source]¶

triggered_camera_controller: CameraController[SpinnakerCamera][source]¶

version: Literal['0.0.2-rc2'][source]¶

class aind_behavior_dynamic_foraging.rig.RigCalibration(*, water_valve_left: WaterValveCalibration, water_valve_right: WaterValveCalibration)[source]¶

Bases: BaseModel

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

model_config = {}[source]¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

water_valve_left: WaterValveCalibration[source]¶

water_valve_right: WaterValveCalibration[source]¶