Handle annotation hole in filters and validation (#983)

Author: A-Artemis

interactive_ai/services/director/app/coordination/dataset_manager/dataset_counter.py

@@ -154,7 +154,7 @@ def on_dataset_update(
             task_node_id=task_node.id_,
             include_empty=False,
         )
-        task_label_ids = [label.id_ for label in task_labels]
+        task_label_ids = [label.id_ for label in task_labels if not label.is_background]
 
         dataset_item_count_repo = DatasetItemCountRepo(
             dataset_storage_identifier=DatasetStorageIdentifier(

interactive_ai/services/resource/app/communication/rest_data_validator/annotation_rest_validator.py

@@ -611,14 +611,6 @@ def __validate_global_annotation(
                 f"{next(iter(non_empty_labels_in_annotation)).id_} for task {task.id_}"
             )
 
-        # Validate that if a background annotation is present, it is not the only annotation in the scene
-        background_labels_in_annotation = {label for label in annotation_labels_current_task if label.is_background}
-        if len(background_labels_in_annotation) > 0 and len(non_empty_labels_in_annotation) == 0:
-            raise BadRequestException(
-                f"Cannot create annotation that has a background label with ID "
-                f"{next(iter(background_labels_in_annotation)).id_} without any other labels for task {task.id_}"
-            )
-
         # Validate that global annotations for the first task use a full box shape
         if previous_task is None and annotation_rest[SHAPE] != AnnotationRESTViews.generate_full_box_rest(
             media_height=media_height, media_width=media_width
@@ -636,7 +628,7 @@ def __validate_global_annotation(
             raise BadRequestException("Annotation for a global task is missing a label for the preceding task.")
 
     @staticmethod
-    def __validate_local_annotation(  # noqa: C901, PLR0913
+    def __validate_local_annotation(  # noqa: C901, PLR0912, PLR0913
         annotation_rest: dict,
         task: TaskNode,
         previous_task: TaskNode | None,
@@ -653,6 +645,7 @@ def __validate_local_annotation(  # noqa: C901, PLR0913
           be present
         - If the annotation contains an empty label, no other annotation for this task may intersect with the empty
           label.
+        - If the annotation contains a background label, it must also contain a label for the current task
         - If the task is (rotated) detection, shape must be (rotated) rectangle
 
         :param annotation_rest: REST view of the annotation
@@ -669,6 +662,17 @@ def __validate_local_annotation(  # noqa: C901, PLR0913
             # If the annotation contains no labels for this task, return without doing validation for this task
             return
 
+        # Validate that a background label is not the only label in the annotation scene
+        background_label_ids = {label.id_ for label in task_labels if label.is_background}
+        only_background_labels = True
+        for annotation in annotation_scene_rest[ANNOTATIONS]:
+            label_ids = {ID(label_rest[ID_]) for label_rest in annotation[LABELS]}
+            if background_label_ids != label_ids:
+                only_background_labels = False
+                break
+        if only_background_labels:
+            raise BadRequestException("It is not allowed to create an annotation with only background labels.")
+
         # Validate that if the task is a local anomaly task, it contains only one of the labels (it's not allowed to
         # have both the normal and the anomalous label).
         if task.task_properties.is_anomaly and not task.task_properties.is_global:

interactive_ai/services/resource/app/usecases/statistics.py

@@ -391,13 +391,15 @@ def get_annotation_stats_for_task(
         - number of annotations including certain labels
         - number of shapes that have certain labels
 
+        If the task is semantic segmentation, then the background label is not included in the statistics.
+
         :param task_node_label_schema: label schema of the task
         :param dataset_storage_identifier: identifier of the dataset storage of interest
         :param include_empty: whether to include the empty label in the stats
         """
         labels = task_node_label_schema.get_labels(include_empty=include_empty)
         ann_scene_repo = AnnotationSceneRepo(dataset_storage_identifier)
-        label_ids = [label.id_ for label in labels]
+        label_ids = [label.id_ for label in labels if not label.is_background]
         (
             obj_sizes_per_label,
             label_count_per_annotation,
@@ -416,6 +418,8 @@ def get_annotation_stats_for_task(
         object_size_distribution_per_label = []
 
         for label in labels:
+            if label.is_background:
+                continue
             count_per_shape = label_count_per_shape.get(label.id_, 0)
             count_per_annotation = label_count_per_annotation.get(label.id_, 0)
             object_size_distribution = computed_size_distribution_per_label[label.id_]

interactive_ai/services/resource/tests/fixtures/label.py

@@ -190,6 +190,19 @@ def fxt_empty_segmentation_label(fxt_mongo_id):
     )
 
 
+@pytest.fixture
+def fxt_background_segmentation_label(fxt_mongo_id):
+    yield Label(
+        name="Empty segmentation label",
+        domain=DummyValues.SEGMENTATION_DOMAIN,
+        color=Color.from_hex_str("#ff0000"),
+        hotkey=DummyValues.LABEL_HOTKEY,
+        is_empty=False,
+        is_background=True,
+        id_=ID(fxt_mongo_id(103)),
+    )
+
+
 @pytest.fixture
 def fxt_label(fxt_mongo_id):
     yield Label(
@@ -352,6 +365,18 @@ def _build_schema(num_labels: int = 2, **kwargs) -> LabelSchema:
     yield _build_schema
 
 
+@pytest.fixture
+def fxt_segmentation_label_schema_with_background(
+    fxt_segmentation_label_factory, fxt_empty_segmentation_label, fxt_background_segmentation_label
+):
+    """
+    Create a label schema for a segmentation task with a background label
+    """
+    yield label_schema_from_labels(
+        [fxt_segmentation_label_factory(0), fxt_empty_segmentation_label, fxt_background_segmentation_label]
+    )
+
+
 @pytest.fixture
 def fxt_anomaly_label_schema(fxt_anomaly_labels):
     yield LabelSchemaView.from_labels(fxt_anomaly_labels)

interactive_ai/services/resource/tests/unit/communication/rest_data_validator/test_annotation_rest_validator.py

@@ -298,6 +298,31 @@ def fxt_annotation_scene_empty_non_empty_label_coincide(fxt_detection_label, fxt
     }
 
 
+@pytest.fixture
+def fxt_annotation_scene_background_label(fxt_background_segmentation_label):
+    yield {
+        "annotations": [
+            {
+                "shape": {
+                    "type": "RECTANGLE",
+                    "x": 0.1 * DummyValues.MEDIA_WIDTH,
+                    "y": 0.1 * DummyValues.MEDIA_HEIGHT,
+                    "width": 0.2 * DummyValues.MEDIA_WIDTH,
+                    "height": 0.2 * DummyValues.MEDIA_HEIGHT,
+                },
+                "labels": [
+                    {
+                        "id": str(fxt_background_segmentation_label.id_),
+                        "name": DummyValues.LABEL_NAME,
+                        "probability": DummyValues.LABEL_PROBABILITY,
+                        "color": "#ff0000ff",
+                    }
+                ],
+            },
+        ]
+    }
+
+
 @pytest.fixture
 def fxt_annotation_scene_empty_detection_not_full_box(fxt_empty_detection_label):
     yield {
@@ -992,6 +1017,34 @@ def test_validate_annotation_scene_empty_non_empty_labels_overlap(
                 label_schema_by_task=label_schema_by_task,
             )
 
+    def test_validate_annotation_scene_background_label(
+        self,
+        fxt_project_with_segmentation_task,
+        fxt_segmentation_label_schema_with_background,
+        fxt_annotation_scene_background_label,
+        fxt_image_identifier_1,
+    ) -> None:
+        """
+        Test validate_annotation_scene on a detection project that contains two
+        annotations, one of which is the empty one.
+        """
+        label_schema: LabelSchema = fxt_segmentation_label_schema_with_background
+        label_schema_by_task = label_schema_by_task_for_single_task_project(
+            fxt_project_with_segmentation_task, label_schema
+        )
+        with pytest.raises(
+            BadRequestException,
+            match="It is not allowed to create an annotation with only background labels.",
+        ):
+            AnnotationRestValidator().validate_annotation_scene(
+                annotation_scene_rest=fxt_annotation_scene_background_label,
+                project=fxt_project_with_segmentation_task,
+                media_identifier=fxt_image_identifier_1,
+                media_width=DummyValues.MEDIA_WIDTH,
+                media_height=DummyValues.MEDIA_HEIGHT,
+                label_schema_by_task=label_schema_by_task,
+            )
+
     def test_validate_annotation_scene_duplicate_annotation_id(
         self,
         fxt_project_with_detection_task,