Merge pull request #312 from Mosquito-Alert/photoprediction_relative_bbox

epou · web-flow · commit 7e8a27c9e31d · 2025-06-17T12:58:23.000+02:00
Make photoprediction bbox to be relative
diff --git a/api/tests/integration/identification_tasks/predictions/create.tavern.yml b/api/tests/integration/identification_tasks/predictions/create.tavern.yml
@@ -62,8 +62,8 @@ stages:
         bbox:
           x_min: 0
           y_min: 0
-          x_max: 50
-          y_max: 50
+          x_max: 0.50
+          y_max: 0.50
         insect_confidence: 0.9
         predicted_class: 'ae_albopictus'
         threshold_deviation: 0.9
@@ -87,8 +87,8 @@ stages:
         bbox:
           x_min: 0
           y_min: 0
-          x_max: 50
-          y_max: 50
+          x_max: 0.5
+          y_max: 0.5
         insect_confidence: 0.9
         predicted_class: 'ae_albopictus'
         is_decisive: false
diff --git a/api/tests/integration/identification_tasks/predictions/factories.py b/api/tests/integration/identification_tasks/predictions/factories.py
@@ -38,7 +38,7 @@ def create_photo_prediction(photo: Photo) -> PhotoPrediction:
         other_species_score=0.01,
         not_sure_score=0,
         x_tl=0,
-        x_br=photo.photo.width / 2,
+        x_br=0.5,
         y_tl=0,
-        y_br=photo.photo.height / 2
+        y_br=0.5
     )
diff --git a/api/tests/integration/identification_tasks/predictions/schema.yml b/api/tests/integration/identification_tasks/predictions/schema.yml
@@ -9,10 +9,10 @@ variables:
       uuid: !anystr
       url: !anystr
     bbox:
-      x_min: !anyint
-      y_min: !anyint
-      x_max: !anyint
-      y_max: !anyint
+      x_min: !anyfloat
+      y_min: !anyfloat
+      x_max: !anyfloat
+      y_max: !anyfloat
     insect_confidence: !anyfloat
     predicted_class: !anystr
     is_decisive: !anybool
diff --git a/api/tests/integration/identification_tasks/predictions/update.tavern.yml b/api/tests/integration/identification_tasks/predictions/update.tavern.yml
@@ -39,10 +39,10 @@ stages:
       method: "{method}"
       json:
         bbox:
-          x_min: 50
-          y_min: 50
-          x_max: 51
-          y_max: 51
+          x_min: 0.50
+          y_min: 0.50
+          x_max: 0.51
+          y_max: 0.51
         insect_confidence: 0.2
         predicted_class: 'not_sure'
         threshold_deviation: 0.9
@@ -88,10 +88,10 @@ stages:
       method: "{method}"
       json:
         bbox:
-          x_min: 50
-          y_min: 50
-          x_max: 51
-          y_max: 51
+          x_min: 0.50
+          y_min: 0.50
+          x_max: 0.51
+          y_max: 0.51
         insect_confidence: 0.2
         predicted_class: 'not_sure'
         threshold_deviation: 0.9
@@ -115,10 +115,10 @@ stages:
           uuid: "{photo_prediction.photo.uuid}"
           url: !anystr
         bbox:
-          x_min: 50
-          y_min: 50
-          x_max: 51
-          y_max: 51
+          x_min: 0.50
+          y_min: 0.50
+          x_max: 0.51
+          y_max: 0.51
         insect_confidence: 0.2
         predicted_class: 'not_sure'
         threshold_deviation: 0.9
diff --git a/api/tests/integration/photos/predictions/schema.yml b/api/tests/integration/photos/predictions/schema.yml
@@ -9,10 +9,10 @@ variables:
       uuid: !anystr
       url: !anystr
     bbox:
-      x_min: !anyint
-      y_min: !anyint
-      x_max: !anyint
-      y_max: !anyint
+      x_min: !anyfloat
+      y_min: !anyfloat
+      x_max: !anyfloat
+      y_max: !anyfloat
     insect_confidence: !anyfloat
     predicted_class: !anystr
     is_decisive: !anybool
diff --git a/api/tests/integration/photos/predictions/update.tavern.yml b/api/tests/integration/photos/predictions/update.tavern.yml
@@ -39,10 +39,10 @@ stages:
       method: "{method}"
       json:
         bbox:
-          x_min: 50
-          y_min: 50
-          x_max: 51
-          y_max: 51
+          x_min: 0.50
+          y_min: 0.50
+          x_max: 0.51
+          y_max: 0.51
         insect_confidence: 0.2
         predicted_class: 'not_sure'
         threshold_deviation: 0.9
@@ -66,10 +66,10 @@ stages:
           uuid: "{photo_prediction.photo.uuid}"
           url: !anystr
         bbox:
-          x_min: 50
-          y_min: 50
-          x_max: 51
-          y_max: 51
+          x_min: 0.50
+          y_min: 0.50
+          x_max: 0.51
+          y_max: 0.51
         insect_confidence: 0.2
         predicted_class: 'not_sure'
         threshold_deviation: 0.9
diff --git a/tigacrafting/migrations/0035_photoprediction_height_default_0.py b/tigacrafting/migrations/0035_photoprediction_height_default_0.py
@@ -0,0 +1,20 @@
+# Generated by Django 3.2.25 on 2025-06-16 14:45
+
+import django.core.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('tigacrafting', '0034_auto_20250616_1427'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='photoprediction',
+            name='height',
+            field=models.PositiveIntegerField(default=0),
+            preserve_default=False,
+        ),
+    ]
diff --git a/tigacrafting/migrations/0036_photoprediction_width_default_0.py b/tigacrafting/migrations/0036_photoprediction_width_default_0.py
@@ -0,0 +1,20 @@
+# Generated by Django 3.2.25 on 2025-06-16 14:45
+
+import django.core.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('tigacrafting', '0035_photoprediction_height_default_0'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='photoprediction',
+            name='width',
+            field=models.PositiveIntegerField(default=0),
+            preserve_default=False,
+        ),
+    ]
diff --git a/tigacrafting/migrations/0037_populate_bbox_relative.py b/tigacrafting/migrations/0037_populate_bbox_relative.py
@@ -0,0 +1,70 @@
+# Generated by Django 3.2.25 on 2025-06-16 14:46
+
+import django.core.validators
+from django.db import migrations, models
+from django.db.models import F, Case, When, Value, FloatField
+
+def convert_bbox_to_relative(apps, schema_editor):
+    PhotoPrediction = apps.get_model('tigacrafting', 'PhotoPrediction')
+
+    PhotoPrediction.objects.update(
+        x_tl=Case(
+            When(width=0, then=Value(0)),
+            default=F('x_tl') / F('width'),
+            output_field=FloatField()
+        ),
+        x_br=Case(
+            When(width=0, then=Value(0)),
+            default=F('x_br') / F('width'),
+            output_field=FloatField()
+        ),
+        y_tl=Case(
+            When(height=0, then=Value(0)),
+            default=F('y_tl') / F('height'),
+            output_field=FloatField()
+        ),
+        y_br=Case(
+            When(height=0, then=Value(0)),
+            default=F('y_br') / F('height'),
+            output_field=FloatField()
+        ),
+    )
+
+def convert_bbox_to_absolute(apps, schema_editor):
+    PhotoPrediction = apps.get_model('tigacrafting', 'PhotoPrediction')
+    PhotoPrediction.objects.update(
+        x_tl=models.F('x_tl') * models.F('width'),
+        x_br=models.F('x_br') * models.F('width'),
+        y_tl=models.F('y_tl') * models.F('height'),
+        y_br=models.F('y_br') * models.F('height'),
+    )
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('tigacrafting', '0036_photoprediction_width_default_0'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='photoprediction',
+            name='x_br',
+            field=models.FloatField(help_text='photo bounding box relative coordinates bottom right x', validators=[django.core.validators.MinValueValidator(0.0), django.core.validators.MaxValueValidator(1.0)]),
+        ),
+        migrations.AlterField(
+            model_name='photoprediction',
+            name='x_tl',
+            field=models.FloatField(help_text='photo bounding box relative coordinates top left x', validators=[django.core.validators.MinValueValidator(0.0), django.core.validators.MaxValueValidator(1.0)]),
+        ),
+        migrations.AlterField(
+            model_name='photoprediction',
+            name='y_br',
+            field=models.FloatField(help_text='photo bounding box relative coordinates bottom right y', validators=[django.core.validators.MinValueValidator(0.0), django.core.validators.MaxValueValidator(1.0)]),
+        ),
+        migrations.AlterField(
+            model_name='photoprediction',
+            name='y_tl',
+            field=models.FloatField(help_text='photo bounding box relative coordinates top left y', validators=[django.core.validators.MinValueValidator(0.0), django.core.validators.MaxValueValidator(1.0)]),
+        ),
+        migrations.RunPython(convert_bbox_to_relative, convert_bbox_to_absolute)
+    ]
diff --git a/tigacrafting/migrations/0038_photoprediction_constraints.py b/tigacrafting/migrations/0038_photoprediction_constraints.py
@@ -0,0 +1,37 @@
+# Generated by Django 3.2.25 on 2025-06-16 14:46
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('tigacrafting', '0037_populate_bbox_relative'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='photoprediction',
+            name='height',
+        ),
+        migrations.RemoveField(
+            model_name='photoprediction',
+            name='width',
+        ),
+        migrations.AddConstraint(
+            model_name='photoprediction',
+            constraint=models.CheckConstraint(check=models.Q(('x_tl__range', (0, 1))), name='tigacrafting_photoprediction_x_tl_between_0_and_1'),
+        ),
+        migrations.AddConstraint(
+            model_name='photoprediction',
+            constraint=models.CheckConstraint(check=models.Q(('x_br__range', (0, 1))), name='tigacrafting_photoprediction_x_br_between_0_and_1'),
+        ),
+        migrations.AddConstraint(
+            model_name='photoprediction',
+            constraint=models.CheckConstraint(check=models.Q(('y_tl__range', (0, 1))), name='tigacrafting_photoprediction_y_tl_between_0_and_1'),
+        ),
+        migrations.AddConstraint(
+            model_name='photoprediction',
+            constraint=models.CheckConstraint(check=models.Q(('y_br__range', (0, 1))), name='tigacrafting_photoprediction_y_br_between_0_and_1'),
+        ),
+    ]
diff --git a/tigacrafting/models.py b/tigacrafting/models.py
@@ -1816,13 +1816,22 @@ def get_score_fieldnames(cls) -> List[str]:
         ],
     )
 
-    x_tl = models.PositiveIntegerField(help_text="photo bounding box coordinates top left x")
-    x_br = models.PositiveIntegerField(help_text="photo bounding box coordinates bottom right x")
-    y_tl = models.PositiveIntegerField(help_text="photo bounding box coordinates top left y")
-    y_br = models.PositiveIntegerField(help_text="photo bounding box coordinates bottom right y")
-
-    height = models.PositiveIntegerField(null=True)
-    width = models.PositiveIntegerField(null=True)
+    x_tl = models.FloatField(
+        validators=[MinValueValidator(0.0), MaxValueValidator(1.0)],
+        help_text="photo bounding box relative coordinates top left x"
+    )
+    x_br = models.FloatField(
+        validators=[MinValueValidator(0.0), MaxValueValidator(1.0)],
+        help_text="photo bounding box relative coordinates bottom right x"
+    )
+    y_tl = models.FloatField(
+        validators=[MinValueValidator(0.0), MaxValueValidator(1.0)],
+        help_text="photo bounding box relative coordinates top left y"
+    )
+    y_br = models.FloatField(
+        validators=[MinValueValidator(0.0), MaxValueValidator(1.0)],
+        help_text="photo bounding box relative coordinates bottom right y"
+    )
 
     created_at = models.DateTimeField(auto_now_add=True, editable=False)
     updated_at = models.DateTimeField(auto_now=True, editable=False)
@@ -1842,14 +1851,6 @@ def uncertainty(self) -> float:
         ])
 
     def clean(self):
-        # Check if x_br is greater than the photo width
-        if self.width is not None and self.x_br > self.width:
-            raise ValidationError("Bottom right x-coordinate (x_br) cannot exceed the width of the photo.")
-
-        # Check if y_br is greater than the photo height
-        if self.height is not None and self.y_br > self.height:
-            raise ValidationError("Bottom right y-coordinate (y_br) cannot exceed the height of the photo.")
-
         if self.is_decisive:
             if self.taxon is None:
                 raise ValidationError("Taxon must be set when is_decisive is True.")
@@ -1864,11 +1865,6 @@ def clean(self):
     def save(self, *args, **kwargs):
         self.taxon = Taxon.objects.filter(pk=self.PREDICTED_CLASS_TO_TAXON[self.predicted_class]).first()
 
-        try:
-            self.width, self.height = self.photo.photo.width, self.photo.photo.height
-        except FileNotFoundError:
-            self.width = self.height = None
-
         self.clean()
 
         if self.is_decisive:
@@ -1904,6 +1900,26 @@ class Meta:
                 check=models.Q(y_tl__lte=models.F('y_br')),
                 name='y_tl_less_equal_y_br'
             ),
+            # Ensure x_tl is between 0 and 1
+            models.CheckConstraint(
+                check=models.Q(x_tl__range=(0, 1)),
+                name="%(app_label)s_%(class)s_x_tl_between_0_and_1",
+            ),
+            # Ensure x_br is between 0 and 1
+            models.CheckConstraint(
+                check=models.Q(x_br__range=(0, 1)),
+                name="%(app_label)s_%(class)s_x_br_between_0_and_1",
+            ),
+            # Ensure y_tl is between 0 and 1
+            models.CheckConstraint(
+                check=models.Q(y_tl__range=(0, 1)),
+                name="%(app_label)s_%(class)s_y_tl_between_0_and_1",
+            ),
+            # Ensure y_br is between 0 and 1
+            models.CheckConstraint(
+                check=models.Q(y_br__range=(0, 1)),
+                name="%(app_label)s_%(class)s_y_br_between_0_and_1",
+            ),
             # Ensure only one final prediction per task
             models.UniqueConstraint(
                 fields=['identification_task'],
