robokudo.descriptors.analysis_engines.demo_usb_camera
=====================================================

.. py:module:: robokudo.descriptors.analysis_engines.demo_usb_camera

.. autoapi-nested-parse::

   Analysis engine for demonstrating USB camera integration.

   This module provides an analysis engine that demonstrates how to read and process
   video data from various sources using OpenCV, including:
   - USB webcams
   - Video files
   - Image files
   - Network video streams

   The pipeline implements basic video capture and visualization functionality,
   serving as a starting point for more complex video processing applications.

   .. note::
       The default configuration uses a USB webcam (device 0), but can be easily
       modified to use other video sources by changing the device parameter.



Classes
-------

.. autoapisummary::

   robokudo.descriptors.analysis_engines.demo_usb_camera.AnalysisEngine


Module Contents
---------------

.. py:class:: AnalysisEngine

   Bases: :py:obj:`robokudo.analysis_engine.AnalysisEngineInterface`


   Analysis engine for basic video capture and visualization.

   This class implements a simple pipeline for reading video data from various
   sources and visualizing it. It supports multiple input sources through OpenCV's
   video capture interface.

   Supported input sources:
   - USB webcams (default)
   - Local video files (e.g., .webm, .mp4)
   - Image files (e.g., .jpg, .png)
   - Network video streams (via URL)

   .. note::
       The pipeline is configured to loop once through the input source by default.
       This can be modified using the loop_mode parameter in the camera config.


   .. py:method:: name()

      Get the name of the analysis engine.

      :return: The name identifier of this analysis engine
      :rtype: str



   .. py:method:: implementation()

      Basic demo to read video data from a local usb webcam.

      This method constructs a simple processing pipeline that reads video data
      from a configured source and visualizes it. The source can be configured
      by modifying the device parameter in the camera configuration.

      Example device configurations:
      - USB webcam: device = 0
      - Video file: device = "/path/to/video.webm"
      - Image file: device = "/path/to/image.jpg"
      - Network stream: device = "https://example.com/video.gif"

      :return: The configured pipeline for video processing
      :rtype: robokudo.pipeline.Pipeline