Skip to content

DetectionResult class

DetectionResult

Detection result model for YOLOv8 or MCCDetector card and color patches detection.

A data model that encapsulates YOLOv8 detection or MCCDetector results for a standardized color card and its color patches. The model handles two distinct classes: patches (label 0) and card (label 1). In a typical detection scenario, the model captures one card and 24 color patches inside/outside the card.

Notes

The detection typically yields 25 objects:

  • 1 color checker card 24 Patches (class_id: 1)
  • 24 color patches (class_id: 0)

Attributes:

Name Type Description
boxes list[tuple[int, int, int, int]] | None

List of bounding boxes for detected objects. List of bounding boxes as (x1, y1, x2, y2). Representing the top-left and bottom-right corners of the detection. if not None, the boxes are not used. it means coming from Object Detection.

Class identifiers for each detected object where:

  • 0: represents color patches
  • 1: represents the color checker card 24 Patches
segment list[SegmentPoint] | None

List of segmentation points for detected objects. Each point is represented as a tuple of (x, y) coordinates. [[x1, y1], [x2, y2], [x3, y3], [x4, y4], [x1, y1]] for each patch. The last point is a repeat of the first to close the polygon. if not None, the segment is not used. it means coming from MCCDetector.
scores list[float]

List of confidence scores for each detection.
class_ids list[int]

List of class IDs corresponding to each detection.
Source code in color_correction/schemas/det_yv8.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
class DetectionResult(BaseModel):
    """
    Detection result model for YOLOv8 or MCCDetector card and color patches detection.

    A data model that encapsulates YOLOv8 detection or MCCDetector results for a standardized color
    card and its color patches. The model handles two distinct classes:
    patches (label 0) and card (label 1). In a typical detection scenario,
    the model captures one card and 24 color patches inside/outside the card.

    Notes
    -----
    The detection typically yields 25 objects:

    - 1 color checker card 24 Patches (class_id: 1)
    - 24 color patches (class_id: 0)

    Attributes
    ----------
    boxes : list[tuple[int, int, int, int]] | None
        List of bounding boxes for detected objects.
        List of bounding boxes as (x1, y1, x2, y2).
        Representing the top-left and bottom-right corners of the detection.
        if not None, the boxes are not used. it means coming from Object Detection.

        Class identifiers for each detected object where:

        - 0: represents color patches
        - 1: represents the color checker card 24 Patches

    segment : list[SegmentPoint] | None
        List of segmentation points for detected objects.
        Each point is represented as a tuple of (x, y) coordinates.
        [[x1, y1], [x2, y2], [x3, y3], [x4, y4], [x1, y1]] for each patch.
        The last point is a repeat of the first to close the polygon.
        if not None, the segment is not used. it means coming from MCCDetector.

    scores : list[float]
        List of confidence scores for each detection.

    class_ids : list[int]
        List of class IDs corresponding to each detection.
    """

    boxes: list[BoundingBox] | None = None
    segment: list[SegmentPoint] | None = None
    scores: list[float]
    class_ids: list[int]

    def draw_detections(
        self,
        image: np.ndarray,
    ) -> np.ndarray:
        """
        Draw detection boxes on the provided image.

        Parameters
        ----------
        image : numpy.ndarray
            The image on which the detection boxes will be drawn.

        Returns
        -------
        numpy.ndarray
            The image with the drawn detection boxes.
        """
        if self.boxes is not None:
            return draw_detections(image, self.boxes, self.scores, self.class_ids)
        if self.segment is not None:
            return draw_segmentation(image, self.segment, self.scores, self.class_ids)

Functions

draw_detections 

draw_detections(image: np.ndarray) -> np.ndarray

Draw detection boxes on the provided image.

Parameters:

Name Type Description Default
image numpy.ndarray

The image on which the detection boxes will be drawn.

 required

Returns:

Type Description
numpy.ndarray

The image with the drawn detection boxes.
Source code in color_correction/schemas/det_yv8.py 
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
def draw_detections(
    self,
    image: np.ndarray,
) -> np.ndarray:
    """
    Draw detection boxes on the provided image.

    Parameters
    ----------
    image : numpy.ndarray
        The image on which the detection boxes will be drawn.

    Returns
    -------
    numpy.ndarray
        The image with the drawn detection boxes.
    """
    if self.boxes is not None:
        return draw_detections(image, self.boxes, self.scores, self.class_ids)
    if self.segment is not None:
        return draw_segmentation(image, self.segment, self.scores, self.class_ids)