Skip to content

camera_support.md

Latest commit

 

History

History
76 lines (58 loc) · 2.48 KB

camera_support.md

File metadata and controls

76 lines (58 loc) · 2.48 KB
Raw

Camera Support

DeepLabCut-live-GUI supports multiple camera backends for different platforms and camera types:

Supported Backends

  1. OpenCV - Universal webcam and USB camera support (all platforms)
  2. GenTL - Industrial cameras via GenTL producers (Windows, Linux)
  3. Aravis - GenICam/GigE Vision cameras (Linux, macOS)
  4. Basler - Basler cameras via pypylon (all platforms)

Backend Selection

You can select the backend in the GUI from the "Backend" dropdown, or in your configuration file:

{
  "camera": {
    "backend": "aravis",
    "index": 0,
    "fps": 30.0
  }
}

Platform-Specific Recommendations

Windows

  • OpenCV compatible cameras: Best for webcams and simple USB cameras. OpenCV is installed with DeepLabCut-live-GUI.
  • GenTL backend: Recommended for industrial cameras (The Imaging Source, Basler, etc.) via vendor-provided CTI files.
  • Basler cameras: Can use either GenTL or pypylon backend.

Linux

  • OpenCV compatible cameras: Good for webcams via Video4Linux drivers. Installed with DeepLabCut-live-GUI.
  • Aravis backend: Recommended for GenICam/GigE Vision industrial cameras (The Imaging Source, Basler, Point Grey, etc.)
  • GenTL backend: Alternative for industrial cameras if vendor provides Linux CTI files.

macOS

  • OpenCV compatible cameras: For webcams and compatible USB cameras.
  • Aravis backend: For GenICam/GigE Vision cameras (requires Homebrew installation).

Quick Installation Guide

Aravis (Linux/Ubuntu)

sudo apt-get install gir1.2-aravis-0.8 python3-gi

Aravis (macOS)

brew install aravis
pip install pygobject

GenTL (Windows)

Install vendor-provided camera drivers and SDK. CTI files are typically in:

  • C:\Program Files\The Imaging Source Europe GmbH\IC4 GenTL Driver\bin\

Backend Comparison

Feature OpenCV GenTL Aravis Basler (pypylon)
Exposure control No Yes Yes Yes
Gain control No Yes Yes Yes
Windows ✅ ✅ ❌ ✅
Linux ✅ ✅ ✅ ✅
macOS ✅ ❌ ✅ ✅

Detailed Backend Documentation

  • Aravis Backend - GenICam/GigE cameras on Linux/macOS
  • GenTL Backend - Industrial cameras via vendor CTI files
  • OpenCV Backend - Universal webcam support