Skip to content

instancelabeling

instancelabeling

Module for InstanceLabel

Classes

InstanceLabel

Bases: ABC

Abstract class representing an instance of a found object. Additionally, this class is used for visualization purpose

Functions
calc_iou abstractmethod 
calc_iou(other)

Calculates the IOU of two given InstanceLabels

Parameters:

  • other (InstanceLabel) –

    InstanceLabel to calculate the IOU for

Returns:

  • float –

    Calculated IOU

Source code in niceml/utilities/instancelabeling.py 
32
33
34
35
36
37
38
39
40
41
42
@abstractmethod
def calc_iou(self, other: "InstanceLabel") -> float:
    """
    Calculates the IOU of two given `InstanceLabel`s

    Args:
        other: InstanceLabel to calculate the IOU for

    Returns:
        Calculated IOU
    """
scale_label abstractmethod 
scale_label(scale_factor)

Scales an instance label by a given scale_factor

Parameters:

  • scale_factor (float) –

    Factor to scale the instance label by

Returns:

Source code in niceml/utilities/instancelabeling.py 
20
21
22
23
24
25
26
27
28
29
30
@abstractmethod
def scale_label(self, scale_factor: float) -> "InstanceLabel":
    """
    Scales an instance label by a given `scale_factor`

    Args:
        scale_factor: Factor to scale the instance label by

    Returns:
        Scaled instance of this InstanceLabel
    """

Functions

get_kind_of_instance_label_match 

get_kind_of_instance_label_match(
    pred_label,
    gt_label,
    iou,
    iou_threshold,
    hide_gt_over_thresh,
)

Defines color and activation of pred_label and gt_label based on an iou and an iou_threshold. Red = gt label with no matching prediction label; Blue = prediction label with no matching gt label; Green = prediction label which matched at least one gt label in position and class; Yellow = prediction label which matched at least one gt label in position but not in class.

Parameters:

  • pred_label (InstanceLabel) –

    Prediction instance label

  • gt_label (InstanceLabel) –

    Ground truth instance label

  • iou (float) –

    Iou of pred_label and gt_label

  • iou_threshold (float) –

    Threshold to decide which color and activation should be used for the prediction and ground truth instance labels

  • hide_gt_over_thresh (bool) –

    Flag to hide the gt_label if the iou is above the iou_threshold

Returns:

  • InstanceLabel –

    Updated pred_label and gt_label including

  • InstanceLabel –

    color and activation for instance label visualization

Source code in niceml/utilities/instancelabeling.py 
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
89
90
91
92
93
94
95
def get_kind_of_instance_label_match(  # QUEST: move to 'instancelabelmatching'?
    pred_label: InstanceLabel,
    gt_label: InstanceLabel,
    iou: float,
    iou_threshold: float,
    hide_gt_over_thresh: bool,
) -> Tuple[InstanceLabel, InstanceLabel]:
    """
    Defines color and activation of `pred_label` and `gt_label`
    based on an `iou` and an `iou_threshold`. Red = gt label with no matching prediction label;
    Blue = prediction label with no matching gt label; Green = prediction label which
    matched at least one gt label in position and class; Yellow = prediction label
    which matched at least one gt label in position but not in class.

    Args:
        pred_label: Prediction instance label
        gt_label: Ground truth instance label
        iou: Iou of `pred_label` and `gt_label`
        iou_threshold: Threshold to decide which color and activation should be
            used for the prediction and ground truth instance labels
        hide_gt_over_thresh: Flag to hide the `gt_label` if the `iou` is above the `iou_threshold`

    Returns:
        Updated `pred_label` and `gt_label` including
        color and activation for instance label visualization
    """

    if iou >= iou_threshold:
        # pylint:disable=simplifiable-if-expression
        if pred_label.color != Color.GREEN:
            if pred_label.class_index != gt_label.class_index:
                pred_label.color = Color.YELLOW
            else:
                pred_label.color = Color.GREEN

        if not hide_gt_over_thresh:
            gt_label.active = True
            gt_label.color = Color.RED
        else:
            gt_label.active = False

    else:
        if pred_label.color not in (Color.GREEN, Color.YELLOW):
            pred_label.color = Color.BLUE

        if gt_label.active is None or gt_label.active:
            gt_label.active = True
            gt_label.color = Color.RED

    pred_label.active = True
    return pred_label, gt_label