robokudo.utils.annotation_conversion
====================================

.. py:module:: robokudo.utils.annotation_conversion

.. autoapi-nested-parse::

   This module provides conversion methods from Annotations to other types, such as ROS Message types.
   It's mainly used to in the result generation to fill the query result from the available annotations,
   hence it requires a target ObjectDesignator to act on.



Classes
-------

.. autoapisummary::

   robokudo.utils.annotation_conversion.Annotation2AnnotationConverter
   robokudo.utils.annotation_conversion.Annotation2ODConverter
   robokudo.utils.annotation_conversion.PoseAnnotationToStampedPoseAnnotationConverter
   robokudo.utils.annotation_conversion.PositionAnnotationToStampedPoseAnnotationConverter
   robokudo.utils.annotation_conversion.SemanticColor2ODConverter
   robokudo.utils.annotation_conversion.Classification2ODConverter
   robokudo.utils.annotation_conversion.StampedPoseConverter
   robokudo.utils.annotation_conversion.BoundingBox3DForShapeSizeConverter


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

.. py:class:: Annotation2AnnotationConverter

   Bases: :py:obj:`abc.ABC`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:method:: can_convert(annotation, target_annotation_type) -> bool
      :abstractmethod:



   .. py:method:: convert(annotation: robokudo.types.core.Annotation, cas: robokudo.cas.CAS = None) -> robokudo.types.core.Annotation
      :abstractmethod:



.. py:class:: Annotation2ODConverter

   Bases: :py:obj:`abc.ABC`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:method:: can_convert(annotation) -> bool
      :abstractmethod:



   .. py:method:: convert(annotation: robokudo.types.core.Annotation, cas: robokudo.cas.CAS, object_designator: robokudo_msgs.msg.ObjectDesignator) -> None
      :abstractmethod:



.. py:class:: PoseAnnotationToStampedPoseAnnotationConverter

   Bases: :py:obj:`Annotation2AnnotationConverter`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:method:: can_convert(annotation, target_annotation_type) -> bool


   .. py:method:: convert(annotation: robokudo.types.core.Annotation, cas: robokudo.cas.CAS = None) -> robokudo.types.core.Annotation


.. py:class:: PositionAnnotationToStampedPoseAnnotationConverter

   Bases: :py:obj:`Annotation2AnnotationConverter`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:method:: can_convert(annotation, target_annotation_type) -> bool


   .. py:method:: convert(annotation: robokudo.types.core.Annotation, cas: robokudo.cas.CAS = None) -> robokudo.types.core.Annotation


.. py:class:: SemanticColor2ODConverter

   Bases: :py:obj:`Annotation2ODConverter`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:method:: can_convert(annotation) -> bool


   .. py:method:: convert(annotation: robokudo.types.core.Annotation, cas: robokudo.cas.CAS, object_designator: robokudo_msgs.msg.ObjectDesignator) -> None


.. py:class:: Classification2ODConverter

   Bases: :py:obj:`Annotation2ODConverter`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:method:: can_convert(annotation) -> bool


   .. py:method:: convert(annotation: robokudo.types.core.Annotation, cas: robokudo.cas.CAS, object_designator: robokudo_msgs.msg.ObjectDesignator) -> None


.. py:class:: StampedPoseConverter

   Bases: :py:obj:`Annotation2ODConverter`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:method:: can_convert(annotation) -> bool


   .. py:method:: convert(annotation: robokudo.types.annotation.StampedPoseAnnotation, cas: robokudo.cas.CAS, object_designator: robokudo_msgs.msg.ObjectDesignator) -> None


.. py:class:: BoundingBox3DForShapeSizeConverter

   Bases: :py:obj:`Annotation2ODConverter`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:method:: can_convert(annotation) -> bool


   .. py:method:: convert(annotation: robokudo.types.cv.BoundingBox3D, cas: robokudo.cas.CAS, object_designator: robokudo_msgs.msg.ObjectDesignator) -> None