village village village
  • Documentation
  • API
  • Resources
  • FAQ
/
  • DOCUMENTATION
    • INITIAL SETUP
      • Prerequisites & Requirements
      • First-Time Configuration
      • Remote Access Setup
      • Telegram Bot Integration
      • Data Persistence & Backups
      • Remote Heartbeat Signals
    • SYSTEM OPERATION
      • GUI & Interface Overview
      • System Settings
      • Subject Management
      • Corridor & Hardware Calibration
      • Animal Detection Setup
      • Animal Handling & Procedures
      • System Logic (State Machine)
    • PROTOCOL & TASK DESIGN
      • Using Existing Protocols
      • Creating New Protocols
      • Task Development Guide
      • Core, Audio & Video Functions
      • Saved Data Structure
      • Custom Plotting
      • Custom Interaction Triggers
    • TROUBLESHOOTING & MAINTENANCE
      • Alarm System Overview
      • General Troubleshooting Guide
      • Cleaning & Routine Maintenance
  • API
    • calibration
      • sound_calibration
        • SoundCalibration
      • water_calibration
        • WaterCalibration
    • classes
      • collection
        • Collection
      • enums
        • Actions
        • Active
        • AreaActive
        • Color
        • ControllerEnum
        • Cycle
        • DataTable
        • Info
        • Save
        • ScreenActive
        • State
        • SuperEnum
        • SyncType
      • null_classes
        • NullBpod
        • NullCamera
        • NullCollection
        • NullMotor
        • NullScale
        • NullSoftCodeToBpod
        • NullSoundDevice
        • NullStateMachine
        • NullTelegramBot
        • NullTempSensor
      • settings_class
        • Setting
        • Settings
      • subject
        • Subject
    • custom_classes
      • after_session_base
        • AfterSessionBase
      • camera_trigger_base
        • CameraTriggerBase
      • change_cycle_base
        • ChangeCycleBase
      • online_plot_base
        • OnlinePlotBase
      • session_plot_base
        • SessionPlotBase
      • subject_plot_base
        • SubjectPlotBase
      • task
        • BpodEvent
        • BpodOutput
        • Task
        • village.custom_classes.task.TaskError
      • training_protocol_base
        • Settings
        • TrainingProtocolBase
        • village.custom_classes.training_protocol_base.TrainingError
    • devices
      • camera
        • get_camera
        • print_info_about_the_connected_cameras
        • Camera
        • LowFreqQPicamera2
      • motor
        • find_pwmchip
        • get_motor
        • Motor
      • rfid
        • Rfid
      • scale
        • get_scale
        • Scale
      • sound_device
        • get_sound_device
        • get_sound_devices
        • SoundDevice
      • telegram_bot
        • get_telegram_bot
        • TelegramBot
      • temp_sensor
        • get_temp_sensor
        • TempSensor
    • gui
      • data_layout
      • gui
        • Gui
      • gui_window
      • layout
      • main_layout
      • monitor_layout
        • LabelButtons
      • settings_layout
      • sound_calibration_layout
        • DummyTask
      • tasks_layout
      • water_calibration_layout
    • plots
      • corridor_plot
        • corridor_plot
      • sound_calibration_plot
        • sound_calibration_plot
      • temperatures_plot
        • temperatures_plot
      • water_calibration_plot
        • water_calibration_plot
      • weights_plot
        • weights_plot
    • screen
      • behavior_window
      • video_worker
        • VideoWorker
    • scripts
      • error_queue
      • global_csv_for_subject
        • main
      • import_all
        • import_all
      • log
        • Log
      • parse_bpod_messages
        • parse_input_to_tuple_override
        • parse_output_to_tuple
        • parse_output_to_tuple_override
      • playground
        • measure_softcode_latency
        • BpodWithLatencyTest
      • rsync_to_hard_drive
        • main
        • run_rsync_local
      • rsync_to_server
        • main
        • run_rsync
      • safe_removal_of_data
        • check_files_for_backup_local
        • check_files_for_backup_remote
        • main
        • parse_timestamp_from_filename
        • remove_file
        • remove_old_data
      • time_utils
        • TimeUtils
      • utils
        • calculate_active_hours
        • change_directory_settings
        • change_system_directory_settings
        • create_directories
        • create_directories_from_path
        • create_pixmap
        • delete_all_elements_from_layout
        • download_github_repositories
        • get_x_value_interp
        • has_low_disk_space
        • interpolate
        • is_active
        • is_active_regular
        • reformat_trial_data
        • setup_logging
        • transform_raw_to_clean
        • validate_subject_name
    • manager
      • Manager
    • main
      • main
      • system_run
  • RESOURCES
    • HARDWARE RESOURCES
      • List of Parts
      • 3D Printing & CAD Files
      • Hardware Assembly Guide
    • SOFTWARE RESOURCES
      • Manual Software Installation
      • Disk Image & Source Code
  • FAQ
    • FAQ
      • Frequently Asked Questions
  1. village /
  2. API /
  3. classes
View Source Open in ChatGPT Open in Claude

classes

Modules

collection

enums

null_classes

settings_class

subject

Previous
WaterCalibration
Next
collection

© Brain Circuits and Behavior Lab

Made with Sphinx and Shibuya theme.

GitHub Contact: marinraf@gmail.com