robokudo.descriptors.camera_configs.config_cv_camera_without_depth
==================================================================

.. py:module:: robokudo.descriptors.camera_configs.config_cv_camera_without_depth

.. autoapi-nested-parse::

   This is the camera config for a openCV camera without depth information.



Classes
-------

.. autoapisummary::

   robokudo.descriptors.camera_configs.config_cv_camera_without_depth.OpenCVCameraConfig


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

.. py:class:: OpenCVCameraConfig

   Bases: :py:obj:`robokudo.descriptors.camera_configs.base_camera_config.BaseCameraConfig`


   Configuration class for OpenCV-based cameras without depth information.

   This class defines the configuration parameters for cameras that can be accessed
   through OpenCV's video capture interface. It supports various input sources
   including physical cameras, video files, image sequences, and network streams.

   .. note::
       When using image sequences as input, the first image must have a number
       between 0 and 4, and there cannot be any gaps in the sequence numbering.


   .. py:attribute:: registry_name
      :type:  typing_extensions.ClassVar[str]
      :value: 'opencv'


      Name of the camera configuration in the registry. Must be unique.



   .. py:attribute:: interface_type
      :type:  str
      :value: 'OpenCV'


      Type of camera interface



   .. py:attribute:: device
      :type:  typing_extensions.Union[int, str]
      :value: 0


      Input source identifier (camera index, file path, or URL).

      device (integer for I/O device or path to image/video file) and flag
      integer:  id of the video capturing device to open
                Use 0 to open default camera using default backend
      string:   path to a video file
                path to image sequence (e.g. 'my/path/img_%02d.jpg').
                    Note: First image needs number between 0 and 4 and the following numbers cannot contain any gaps.
                URL of video/camera stream or image



   .. py:attribute:: api_preference
      :type:  int

      Preferred OpenCV capture API backend



   .. py:attribute:: device_driver_flag
      :type:  int
      :value: 0


      Flag argument to use when retrieving/reading the frames



   .. py:attribute:: normalize_rgb
      :type:  bool
      :value: True


      Normalize/stabilise rgb image contrast/brightness



   .. py:attribute:: loop_mode
      :type:  int
      :value: -1


      Loop after iterating over all frames of the video file
      > 0: number of repetitions before to stop
      = 0: never loop
      < 0: infinite loop

      ... note::
          Only works with a file as source



   .. py:attribute:: depth
      :type:  typing_extensions.Optional[numpy.typing.NDArray]
      :value: None


      Static depth image, which is used as depth image for all rgb images



   .. py:attribute:: update_global_with_depth_parameter
      :type:  bool
      :value: True


      Flag to update global depth parameters



   .. py:attribute:: cam_info
      :type:  typing_extensions.Dict[str, typing_extensions.Any]
      :value: None


      Camera config as dict



   .. py:attribute:: cam_intrinsic
      :value: None


      Camera intrinsic parameters



   .. py:attribute:: color2depth_ratio
      :type:  typing_extensions.Tuple[float, float]
      :value: (1.0, 1.0)


      If the resolution of the depth image differs from the color image, we need to define the factor for (x, y).



   .. py:attribute:: viewpoint_cam_to_world
      :value: None


      Camera to world transformation