Skip to content

Groundtruth

Bases: StaticCollection

An object describing a ground truth (e.g., a human-drawn bounding box on an image).

Attributes:

Name Type Description
datum Datum

The datum associated with the groundtruth.
annotations List[Annotation]

The list of annotations associated with the groundtruth.

Examples:

>>> GroundTruth(
...     datum=Datum(uid="uid1"),
...     annotations=[
...         Annotation(
...             labels=[Label(key="k1", value="v1")],
...         )
...     ]
... )
Source code in valor/coretypes.py 
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
86
87
88
class GroundTruth(StaticCollection):
    """
    An object describing a ground truth (e.g., a human-drawn bounding box on an image).

    Attributes
    ----------
    datum : Datum
        The datum associated with the groundtruth.
    annotations : List[Annotation]
        The list of annotations associated with the groundtruth.

    Examples
    --------
    >>> GroundTruth(
    ...     datum=Datum(uid="uid1"),
    ...     annotations=[
    ...         Annotation(
    ...             labels=[Label(key="k1", value="v1")],
    ...         )
    ...     ]
    ... )
    """

    datum: Datum = Datum.symbolic(owner="groundtruth", name="datum")
    annotations: SymbolicList[Annotation] = SymbolicList[Annotation].symbolic(
        owner="groundtruth", name="annotations"
    )

    def __init__(
        self,
        *,
        datum: Datum,
        annotations: List[Annotation],
    ):
        """
        Creates a ground truth.

        Parameters
        ----------
        datum : Datum
            The datum that the ground truth is operating over.
        annotations : List[Annotation]
            The list of ground truth annotations.
        """
        super().__init__(datum=datum, annotations=annotations)

        for annotation in self.annotations:
            for label in annotation.labels:
                if label.score is not None:
                    raise ValueError(
                        "GroundTruth labels should not have scores."
                    )

Functions

valor.GroundTruth.__init__(*, datum, annotations)

Creates a ground truth.

Parameters:

Name Type Description Default
datum Datum

The datum that the ground truth is operating over.

 required
annotations List[Annotation]

The list of ground truth annotations.

 required
Source code in valor/coretypes.py 
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
def __init__(
    self,
    *,
    datum: Datum,
    annotations: List[Annotation],
):
    """
    Creates a ground truth.

    Parameters
    ----------
    datum : Datum
        The datum that the ground truth is operating over.
    annotations : List[Annotation]
        The list of ground truth annotations.
    """
    super().__init__(datum=datum, annotations=annotations)

    for annotation in self.annotations:
        for label in annotation.labels:
            if label.score is not None:
                raise ValueError(
                    "GroundTruth labels should not have scores."
                )