endoreg-db 0.8.6.1__py3-none-any.whl → 0.8.8.9__py3-none-any.whl

endoreg_db/models/media/frame/frame.py

@@ -1,14 +1,17 @@
 import logging
-from typing import TYPE_CHECKING, Optional
-from django.db import models
 from pathlib import Path
+from typing import TYPE_CHECKING, Optional
+
 import cv2
 import numpy as np
+from django.db import models
+
 if TYPE_CHECKING:
-    from endoreg_db.models import Label, ImageClassificationAnnotation, VideoFile
+    from endoreg_db.models import ImageClassificationAnnotation, VideoFile
 
 logger = logging.getLogger(__name__)
 
+
 # Unified Frame model
 class Frame(models.Model):
     video = models.ForeignKey(
@@ -25,61 +28,58 @@ class Frame(models.Model):
 
     if TYPE_CHECKING:
         image_classification_annotations: models.QuerySet["ImageClassificationAnnotation"]
-        labels: models.QuerySet["Label"]
-        video: "VideoFile"
+        video: models.ForeignKey["VideoFile"]
+
     class Meta:
-        unique_together = ('video', 'frame_number')
-        ordering = ['video', 'frame_number']
+        unique_together = ("video", "frame_number")
+        ordering = ["video", "frame_number"]
 
     @property
     def file_path(self) -> Path:
         """
         Return the absolute filesystem path to the frame image by combining the video's frame directory with the frame's relative path.
-        
+
         Returns:
             Path: The absolute path to the frame image file.
         """
         base_dir = self.video.get_frame_dir_path()
+        assert base_dir is not None, "Video frame directory path should not be None"
         return base_dir / self.relative_path
-    
+
     @property
     def predictions(self) -> models.QuerySet["ImageClassificationAnnotation"]:
         """
         Return all image classification annotations for this frame that are linked to an information source of type "prediction".
-        
+
         Returns:
             QuerySet: A queryset of related ImageClassificationAnnotation objects filtered to those whose information source type is "prediction".
         """
-        return self.image_classification_annotations.filter(
-            information_source__information_source_types__name="prediction"
-        )
-    
+        return self.image_classification_annotations.filter(information_source__information_source_types__name="prediction")
+
     @property
     def manual_annotations(self) -> models.QuerySet["ImageClassificationAnnotation"]:
         """
         Return all manual image classification annotations associated with this frame.
-        
+
         Returns:
             QuerySet: A queryset of related ImageClassificationAnnotation objects whose information source type is "manual_annotation".
         """
-        return self.image_classification_annotations.filter(
-            information_source__information_source_types__name="manual_annotation"
-        )
+        return self.image_classification_annotations.filter(information_source__information_source_types__name="manual_annotation")
 
     @property
     def has_predictions(self) -> bool:
         """
         Returns True if the frame has any associated prediction annotations.
-        
+
         A prediction annotation is defined as an ImageClassificationAnnotation whose information source type is "prediction".
         """
         return self.predictions.exists()
-    
+
     @property
     def has_manual_annotations(self) -> bool:
         """
         Returns True if the frame has any manual image classification annotations.
-        
+
         Manual annotations are identified as related ImageClassificationAnnotation objects whose information source type is named "manual_annotation".
         """
         return self.manual_annotations.exists()
@@ -87,7 +87,7 @@ class Frame(models.Model):
     def get_image(self) -> Optional[np.ndarray]:
         """
         Load and return the frame image as a NumPy array using OpenCV.
-        
+
         Returns:
             The image as a NumPy array if successfully loaded, or None if the file does not exist or cannot be read.
         """