README.md

DeepLabCut-live-GUI Documentation Index

Welcome to the DeepLabCut-live-GUI documentation! This index will help you find the information you need.

Getting Started

New Users

1. README - Project overview, installation, and quick start
2. User Guide - Step-by-step walkthrough of all features

Quick References

• ARAVIS_QUICK_REF - Aravis backend quick reference
• Features Overview - Complete feature documentation

Core Documentation

Camera Setup

• Camera Support - Overview of all camera backends
• Aravis Backend - Linux/macOS GenICam camera setup
• Platform-specific guides for industrial cameras

Application Features

• Features Documentation - Detailed feature descriptions:
  • Camera control and backends
  • Real-time pose estimation
  • Video recording
  • Configuration management
  • Processor system
  • User interface
  • Performance monitoring
  • Advanced features

User Guide

• User Guide - Complete usage walkthrough:
  • Getting started
  • Camera setup
  • DLCLive configuration
  • Recording videos
  • Configuration management
  • Common workflows
  • Tips and best practices
  • Troubleshooting

Advanced Topics

Processor System

• Processor Plugins - Custom pose processing
• Processor Auto-Recording - Event-triggered recording
• Socket processor documentation

Technical Details

• Timestamp Format - Synchronization and timing
• ARAVIS_BACKEND_SUMMARY - Implementation details

By Use Case

I want to...

Set up a camera

→ Camera Support → Select backend → Follow setup guide

By Platform:

• Windows: README → GenTL setup
• Linux: Aravis Backend → Installation for Ubuntu/Debian
• macOS: Aravis Backend → Installation via Homebrew

By Camera Type:

• Webcam: User Guide → OpenCV backend
• Industrial Camera: Camera Support → GenTL/Aravis
• Basler Camera: Camera Support → pypylon setup
• The Imaging Source: Aravis Backend or GenTL

Run pose estimation

→ User Guide → Load model → Start inference

Record high-speed video

→ Features → Hardware encoding → GPU setup → User Guide → Optimization tips

Create custom processor

→ Processor Plugins → Plugin architecture → Examples

Trigger recording remotely

→ Features → Auto-recording setup → Socket processor documentation

Optimize performance

→ Features → Metrics → Adjustments → User Guide → Best practices

By Topic

Camera Backends

Backend	Documentation	Platform
OpenCV	User Guide	All
GenTL	Camera Support	Windows, Linux
Aravis	Aravis Backend	Linux, macOS
Basler	Camera Support	All

Configuration

• Basics: README
• Management: User Guide
• Templates: User Guide
• Details: Features

Recording

• Quick Start: User Guide
• Features: Features
• Optimization: README
• Auto-Recording: Features

DLCLive

• Setup: User Guide
• Models: Features
• Performance: Features
• Visualization: Features

Troubleshooting

Quick Fixes

1. Camera not detected → User Guide
2. Slow inference → Features
3. Dropped frames → README
4. Recording issues → User Guide

Detailed Troubleshooting

• User Guide - Troubleshooting Section
• README - Troubleshooting
• Aravis Backend - Troubleshooting

Development

Architecture

• Project Structure: README
• Backend Development: Camera Support
• Processor Development: Processor Plugins

Implementation Details

• Aravis Backend: ARAVIS_BACKEND_SUMMARY
• Thread Safety: Features
• Resource Management: Features

Reference

Configuration Schema

{
  "camera": {
    "name": "string",
    "index": "number",
    "fps": "number",
    "backend": "opencv|gentl|aravis|basler",
    "exposure": "number (μs, 0=auto)",
    "gain": "number (0.0=auto)",
    "crop_x0/y0/x1/y1": "number",
    "max_devices": "number",
    "properties": "object"
  },
  "dlc": {
    "model_path": "string",
    "model_type": "base|pytorch",
    "additional_options": "object"
  },
  "recording": {
    "enabled": "boolean",
    "directory": "string",
    "filename": "string",
    "container": "mp4|avi|mov",
    "codec": "h264_nvenc|libx264|hevc_nvenc",
    "crf": "number (0-51)"
  },
  "bbox": {
    "enabled": "boolean",
    "x0/y0/x1/y1": "number"
  }
}

Performance Metrics

• Camera FPS: Features
• DLC Metrics: Features
• Recording Metrics: Features

Keyboard Shortcuts

Action	Shortcut
Load configuration	Ctrl+O
Save configuration	Ctrl+S
Save as	Ctrl+Shift+S
Quit	Ctrl+Q

External Resources

DeepLabCut

• DeepLabCut
• DeepLabCut-live
• DeepLabCut Documentation

Camera Libraries

• Aravis Project
• Harvesters (GenTL)
• pypylon (Basler)
• OpenCV

Video Encoding

• FFmpeg
• NVENC (NVIDIA)

Getting Help

Support Channels

1. Check relevant documentation (use this index!)
2. Search GitHub issues
3. Review example configurations
4. Contact maintainers

Reporting Issues

When reporting bugs, include:

• GUI version
• Platform (OS, Python version)
• Camera backend and model
• Configuration file (if applicable)
• Error messages
• Steps to reproduce

Contributing

Interested in contributing?

• See README - Contributing
• Review Development Section
• Check open GitHub issues
• Read coding guidelines

---

Document Version History

• v1.0 - Initial comprehensive documentation
  • Complete README overhaul
  • User guide creation
  • Features documentation
  • Camera backend guides
  • Aravis backend implementation

Quick Navigation

Popular Pages:

• User Guide - Most comprehensive walkthrough
• Features - All capabilities detailed
• Aravis Setup - Linux industrial cameras
• Camera Support - All camera backends

By Experience Level:

• Beginner: README → User Guide
• Intermediate: Features → Camera Support
• Advanced: Processor Plugins → Implementation details

---

Last updated: 2025-10-24