Feat/annotation builder

[tadeas0]

Purpose

Create AnnotationHelper class to simplify dai.ImgAnnotations message creation.

Dependencies & Potential Impact

None / not applicable

Deployment Plan

None / not applicable

Testing & Validation

None / not applicable

[codecov-commenter]

❌ 5 Tests Failed:

Tests completed	Failed	Passed	Skipped
233	5	228	2

View the top 3 failed test(s) by shortest run time

tests/unittests/test_helpers/test_annotation_helper.py::test_draw_points

Stack Traces | 0.001s run time

def test_draw_points():
        annotation_helper = AnnotationHelper()
>       annotation_helper.draw_points([(0.0, 0.0), (1.0, 1.0)], (1.0, 0.0, 0.0, 1.0), 2)

tests\unittests\test_helpers\test_annotation_helper.py:158: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
depthai_nodes\utils\annotation_helper.py:96: in draw_points
    points_annot = self._create_points_annotation(
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

self = <depthai_nodes.utils.annotation_helper.AnnotationHelper object at 0x000001DFB7C87040>
points = [(0.0, 0.0), (1.0, 1.0)], color = (1.0, 0.0, 0.0, 1.0)
fill_color = None, type = <PointsAnnotationType.POINTS: 1>

    def _create_points_annotation(
        self,
        points: List[Point],
        color: ColorRGBA,
        fill_color: Optional[ColorRGBA],
        type: dai.PointsAnnotationType,
    ) -> dai.PointsAnnotation:
        points_annot = dai.PointsAnnotation()
        points_annot.outlineColor = self._create_color(color)
        if fill_color is not None:
            points_annot.fillColor = self._create_color(fill_color)
        points_annot.type = type
>       points_annot.points = self._create_points_vector(points)
E       TypeError: (): incompatible function arguments. The following argument types are supported:
E           1. (self: depthai.PointsAnnotation, arg0: depthai.VectorPoint2f) -> None
E       
E       Invoked with: <depthai.PointsAnnotation object at 0x000001DFB7D044F0>, <depthai.VectorPoint2f object at 0x000001DFB7D049B0>

depthai_nodes\utils\annotation_helper.py:260: TypeError

tests/unittests/test_helpers/test_annotation_helper.py::test_draw_polyline

Stack Traces | 0.001s run time

def test_draw_polyline():
        annotation_helper = AnnotationHelper()
>       annotation_helper.draw_polyline(
            [(0.0, 0.0), (0.5, 0.5), (1.0, 1.0)],
            (1.0, 0.0, 0.0, 1.0),
            (0.0, 1.0, 0.0, 1.0),
            2,
            True,
        )

tests\unittests\test_helpers\test_annotation_helper.py:35: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
depthai_nodes\utils\annotation_helper.py:74: in draw_polyline
    points_annot = self._create_points_annotation(
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

self = <depthai_nodes.utils.annotation_helper.AnnotationHelper object at 0x000001DFB7D62920>
points = [(0.0, 0.0), (0.5, 0.5), (1.0, 1.0)], color = (1.0, 0.0, 0.0, 1.0)
fill_color = (0.0, 1.0, 0.0, 1.0), type = <PointsAnnotationType.LINE_LOOP: 2>

    def _create_points_annotation(
        self,
        points: List[Point],
        color: ColorRGBA,
        fill_color: Optional[ColorRGBA],
        type: dai.PointsAnnotationType,
    ) -> dai.PointsAnnotation:
        points_annot = dai.PointsAnnotation()
        points_annot.outlineColor = self._create_color(color)
        if fill_color is not None:
            points_annot.fillColor = self._create_color(fill_color)
        points_annot.type = type
>       points_annot.points = self._create_points_vector(points)
E       TypeError: (): incompatible function arguments. The following argument types are supported:
E           1. (self: depthai.PointsAnnotation, arg0: depthai.VectorPoint2f) -> None
E       
E       Invoked with: <depthai.PointsAnnotation object at 0x000001DFB6A43DB0>, <depthai.VectorPoint2f object at 0x000001DFB6A40970>

depthai_nodes\utils\annotation_helper.py:260: TypeError

tests/unittests/test_helpers/test_annotation_helper.py::test_draw_polyline_closed

Stack Traces | 0.001s run time

def test_draw_polyline_closed():
        annotation_helper = AnnotationHelper()
>       annotation_helper.draw_polyline(
            [(0.0, 0.0), (0.5, 0.5), (1.0, 1.0)],
            (1.0, 0.0, 0.0, 1.0),
            None,
            2,
            False,
        )

tests\unittests\test_helpers\test_annotation_helper.py:63: 
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
depthai_nodes\utils\annotation_helper.py:74: in draw_polyline
    points_annot = self._create_points_annotation(
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

self = <depthai_nodes.utils.annotation_helper.AnnotationHelper object at 0x000001DFB7F554B0>
points = [(0.0, 0.0), (0.5, 0.5), (1.0, 1.0)], color = (1.0, 0.0, 0.0, 1.0)
fill_color = None, type = <PointsAnnotationType.LINE_STRIP: 3>

    def _create_points_annotation(
        self,
        points: List[Point],
        color: ColorRGBA,
        fill_color: Optional[ColorRGBA],
        type: dai.PointsAnnotationType,
    ) -> dai.PointsAnnotation:
        points_annot = dai.PointsAnnotation()
        points_annot.outlineColor = self._create_color(color)
        if fill_color is not None:
            points_annot.fillColor = self._create_color(fill_color)
        points_annot.type = type
>       points_annot.points = self._create_points_vector(points)
E       TypeError: (): incompatible function arguments. The following argument types are supported:
E           1. (self: depthai.PointsAnnotation, arg0: depthai.VectorPoint2f) -> None
E       
E       Invoked with: <depthai.PointsAnnotation object at 0x000001DFB7CCD2F0>, <depthai.VectorPoint2f object at 0x000001DFB7CCDAF0>

depthai_nodes\utils\annotation_helper.py:260: TypeError

To view more test analytics, go to the Test Analytics Dashboard
_{📋 Got 3 mins? Take this short survey to help us improve Test Analytics.}

[dominik737]

Looks great.

[dominik737]

I think the name of this class used to be AnnotationBuilder, why was it replaced for AnnotationHelper? I think that AnnotationBuilder is more suiting name.

[jkbmrz]

Also, why not an ImgAnnotationBuilder if it refers to dai.ImgAnnotation creation?

[tadeas0]

The name was changed after some discussion in this slack thread. Personally I don't have any strong opinions on the name of this class, so we can go with whatever you prefer.

[dominik737]

Also I would consider moving the class from depthai-nodes.ml.helpers.utils to depthai-nodes.utils as the class does not directly relate to ml. And have the class in the __init__ file.

[kkeroo]

LGTM

[jkbmrz]

Also, why not an ImgAnnotationBuilder if it refers to dai.ImgAnnotation creation?