Skip to content

Rig#

rig #

__semver__ module-attribute #

__semver__ = pep440_to_semver(__version__)

AindManipulatorDevice #

Bases: AindManipulator

Appends a task specific configuration to the base manipulator model.

spout_axis class-attribute instance-attribute #

spout_axis = Field(default=Y1, description='Spout axis')

RigCalibration pydantic-model #

Bases: BaseModel

Container class for calibration models.

Fields:

water_valve pydantic-field #

water_valve

Water valve calibration

AindVrForagingRig #

Bases: Rig

Represents the schema, and concrete instantiation, of a rig configuration to run the VrForaging behavior task.

version class-attribute instance-attribute #

version = __semver__

triggered_camera_controller class-attribute instance-attribute #

triggered_camera_controller = Field(
    description="Required camera controller to triggered cameras."
)

monitoring_camera_controller class-attribute instance-attribute #

monitoring_camera_controller = Field(
    default=None,
    description="Optional camera controller for monitoring cameras.",
)

harp_behavior class-attribute instance-attribute #

harp_behavior = Field(description='Harp behavior')

harp_olfactometer class-attribute instance-attribute #

harp_olfactometer = Field(description='Harp olfactometer')

harp_olfactometer_extension class-attribute instance-attribute #

harp_olfactometer_extension = Field(
    default_factory=list,
    description="A collection of subordinate olfactometers that can be added to increase the number of independently delivered odors. The order of the list determines the order by which odors are numbered",
)

harp_lickometer class-attribute instance-attribute #

harp_lickometer = Field(description='Harp lickometer')

harp_clock_generator class-attribute instance-attribute #

harp_clock_generator = Field(
    description="Harp clock generator"
)

harp_analog_input class-attribute instance-attribute #

harp_analog_input = Field(
    default=None, description="Harp analog input"
)

harp_treadmill class-attribute instance-attribute #

harp_treadmill = Field(description='Harp treadmill')

harp_sniff_detector class-attribute instance-attribute #

harp_sniff_detector = Field(
    default=None, description="Sniff detector settings"
)

harp_environment_sensor class-attribute instance-attribute #

harp_environment_sensor = Field(
    default=None, description="Environment sensor"
)

manipulator class-attribute instance-attribute #

manipulator = Field(description='Manipulator')

screen class-attribute instance-attribute #

screen = Field(
    default=ScreenAssembly(),
    description="Screen settings",
    validate_default=True,
)

calibration class-attribute instance-attribute #

calibration = Field(description='Calibration models')