robokudo.types.human
====================

.. py:module:: robokudo.types.human

.. autoapi-nested-parse::

   Human-related annotation types for Robokudo.

   This module provides types for representing various aspects of human detection
   and analysis in computer vision applications. It includes:

   * Face detection results
   * Facial expressions and mimics
   * Human attributes
   * Activity recognition
   * Body keypoint detection

   The types support both 2D and 3D representations where applicable.



Classes
-------

.. autoapisummary::

   robokudo.types.human.FaceAnnotation
   robokudo.types.human.MimicAnnotation
   robokudo.types.human.AttributeAnnotation
   robokudo.types.human.ActivityAnnotation
   robokudo.types.human.KeypointAnnotation


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

.. py:class:: FaceAnnotation

   Bases: :py:obj:`robokudo.types.cv.ImageROI`, :py:obj:`robokudo.types.cv.Points3D`, :py:obj:`robokudo.types.tf.Pose`


   Face detection result combining 2D, 3D and pose information.

   Provides:
   * 2D region of interest in image
   * 3D point cloud of face
   * 6-DOF pose of face

   .. note::
      Does not contain identity information. Use Classification annotations
      on the parent HumanAnnotation for identity.

   :ivar mask: Binary mask of face region
   :type mask: numpy.ndarray
   :ivar roi: Rectangular face region
   :type roi: Rect
   :ivar points: 3D point cloud of face
   :type points: o3d.geometry.PointCloud
   :ivar rotation: Face orientation as quaternion [x,y,z,w]
   :type rotation: list[float]
   :ivar translation: Face position [x,y,z]
   :type translation: list[float]


.. py:class:: MimicAnnotation

   Bases: :py:obj:`robokudo.types.core.Annotation`


   Facial expression or mimic detection result.

   Represents detected facial expressions or mimics.

   :ivar type: Type of expression/mimic detected
   :type type: str


   .. py:attribute:: type
      :value: ''



.. py:class:: AttributeAnnotation

   Bases: :py:obj:`robokudo.types.core.Annotation`


   Generic human attribute annotation.

   Used for various human attributes such as:
   * Age
   * Height
   * Clothing
   * Gender
   * Other physical or visual characteristics

   :ivar type: Type of attribute
   :type type: str


   .. py:attribute:: type
      :value: ''



.. py:class:: ActivityAnnotation

   Bases: :py:obj:`robokudo.types.core.Annotation`


   Human activity detection result.

   Represents detected human activities and their context.
   Can be subclassed for specific activity types.

   Examples:
   * Pointing
   * Waving
   * Walking
   * Sitting

   :ivar type: Type of activity detected
   :type type: str
   :ivar interaction_with: Target of interaction if applicable
   :type interaction_with: Any


   .. py:attribute:: type
      :value: ''



   .. py:attribute:: interaction_with
      :value: None



.. py:class:: KeypointAnnotation

   Bases: :py:obj:`robokudo.types.core.Annotation`


   Human body keypoint detection result.

   Represents detected keypoints like:
   * Joint positions
   * Body part locations
   * Facial landmarks

   Supports both 2D and 3D keypoint types.

   :cvar KP_TYPE_2D: Identifier for 2D keypoint sets
   :type KP_TYPE_2D: str
   :cvar KP_TYPE_3D: Identifier for 3D keypoint sets
   :type KP_TYPE_3D: str
   :ivar keypoints: List of detected keypoints
   :type keypoints: list
   :ivar type: Type of keypoints (2D or 3D)
   :type type: str


   .. py:attribute:: KP_TYPE_2D
      :value: '2D'



   .. py:attribute:: KP_TYPE_3D
      :value: '3D'



   .. py:attribute:: keypoints
      :value: []



   .. py:attribute:: type
      :value: None