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.StampedPose2ODConverter robokudo.utils.annotation_conversion.Pose2ODConverter robokudo.utils.annotation_conversion.Position2ODConverter robokudo.utils.annotation_conversion.StampedPosition2ODConverter robokudo.utils.annotation_conversion.BoundingBox3DForShapeSizeConverter robokudo.utils.annotation_conversion.Shape2ODConverter robokudo.utils.annotation_conversion.Cuboid2ODConverter robokudo.utils.annotation_conversion.Sphere2ODConverter robokudo.utils.annotation_conversion.Location2ODConverter 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.annotation.robokudo.types.core.Annotation, cas: robokudo.types.annotation.robokudo.cas.CAS = None) -> robokudo.types.annotation.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.annotation.robokudo.types.core.Annotation, cas: robokudo.types.annotation.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: robokudo.types.annotation.robokudo.types.core.Annotation, target_annotation_type: robokudo.types.annotation.robokudo.types.core.Annotation) -> bool .. py:method:: convert(annotation: robokudo.types.annotation.robokudo.types.core.Annotation, cas: robokudo.types.annotation.robokudo.cas.CAS = None) -> robokudo.types.annotation.robokudo.types.annotation.StampedPoseAnnotation .. 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: robokudo.types.annotation.robokudo.types.core.Annotation, target_annotation_type: robokudo.types.annotation.robokudo.types.core.Annotation) -> bool .. py:method:: convert(annotation: robokudo.types.annotation.robokudo.types.core.Annotation, cas: robokudo.types.annotation.robokudo.cas.CAS = None) -> robokudo.types.annotation.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: robokudo.types.annotation.robokudo.types.core.Annotation) -> bool .. py:method:: convert(annotation: robokudo.types.annotation.robokudo.types.core.Annotation, cas: robokudo.types.annotation.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: robokudo.types.annotation.robokudo.types.core.Annotation) -> bool .. py:method:: convert(annotation: robokudo.types.annotation.robokudo.types.core.Annotation, cas: robokudo.types.annotation.robokudo.cas.CAS, object_designator: robokudo_msgs.msg.ObjectDesignator) -> None .. py:class:: StampedPose2ODConverter 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.types.annotation.robokudo.cas.CAS, object_designator: robokudo_msgs.msg.ObjectDesignator) -> None .. py:class:: Pose2ODConverter Bases: :py:obj:`StampedPose2ODConverter` Helper class that provides a standard way to create an ABC using inheritance. .. py:method:: can_convert(annotation: robokudo.types.annotation.robokudo.types.core.Annotation) -> bool .. py:method:: convert(annotation: robokudo.types.annotation.robokudo.types.core.Annotation, cas: robokudo.types.annotation.robokudo.cas.CAS, object_designator: robokudo_msgs.msg.ObjectDesignator) -> None .. py:class:: Position2ODConverter Bases: :py:obj:`Annotation2ODConverter` Helper class that provides a standard way to create an ABC using inheritance. .. py:method:: can_convert(annotation: robokudo.types.annotation.robokudo.types.core.Annotation) -> bool .. py:method:: convert(annotation: robokudo.types.annotation.robokudo.types.annotation.PositionAnnotation, cas: robokudo.types.annotation.robokudo.cas.CAS, object_designator: robokudo_msgs.msg.ObjectDesignator) -> None .. py:class:: StampedPosition2ODConverter Bases: :py:obj:`Annotation2ODConverter` Helper class that provides a standard way to create an ABC using inheritance. .. py:method:: can_convert(annotation: robokudo.types.annotation.robokudo.types.core.Annotation) -> bool .. py:method:: convert(annotation: robokudo.types.annotation.robokudo.types.annotation.StampedPositionAnnotation, cas: robokudo.types.annotation.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: robokudo.types.annotation.robokudo.types.core.Annotation) -> bool .. py:method:: convert(annotation: robokudo.types.annotation.robokudo.types.cv.BoundingBox3D, cas: robokudo.types.annotation.robokudo.cas.CAS, object_designator: robokudo_msgs.msg.ObjectDesignator) -> None .. py:class:: Shape2ODConverter Bases: :py:obj:`Annotation2ODConverter` Helper class that provides a standard way to create an ABC using inheritance. .. py:method:: can_convert(annotation: robokudo.types.annotation.robokudo.types.core.Annotation) -> bool .. py:method:: convert(annotation: robokudo.types.annotation.robokudo.types.annotation.Shape, cas: robokudo.types.annotation.robokudo.cas.CAS, object_designator: robokudo_msgs.msg.ObjectDesignator) -> None .. py:class:: Cuboid2ODConverter Bases: :py:obj:`Shape2ODConverter` Helper class that provides a standard way to create an ABC using inheritance. .. py:method:: can_convert(annotation: robokudo.types.annotation.robokudo.types.core.Annotation) -> bool .. py:method:: convert(annotation: robokudo.types.annotation.robokudo.types.annotation.Cuboid, cas: robokudo.types.annotation.robokudo.cas.CAS, object_designator: robokudo_msgs.msg.ObjectDesignator) -> None .. py:class:: Sphere2ODConverter Bases: :py:obj:`Shape2ODConverter` Helper class that provides a standard way to create an ABC using inheritance. .. py:method:: can_convert(annotation: robokudo.types.annotation.robokudo.types.core.Annotation) -> bool .. py:method:: convert(annotation: robokudo.types.annotation.robokudo.types.annotation.Sphere, cas: robokudo.types.annotation.robokudo.cas.CAS, object_designator: robokudo_msgs.msg.ObjectDesignator) -> None .. py:class:: Location2ODConverter Bases: :py:obj:`Annotation2ODConverter` Helper class that provides a standard way to create an ABC using inheritance. .. py:method:: can_convert(annotation: robokudo.types.annotation.robokudo.types.core.Annotation) -> bool .. py:method:: convert(annotation: robokudo.types.annotation.robokudo.types.annotation.LocationAnnotation, cas: robokudo.types.annotation.robokudo.cas.CAS, object_designator: robokudo_msgs.msg.ObjectDesignator) -> None