Skip to content

Box

Box #

Bases: BaseModel

Used in the Locate and Draw Validation sets. All coordinates are in ratio of the image size (0.0 to 1.0).

Parameters:

Name Type Description Default
x_min float

The minimum x value of the box in ratio of the image size.

 required
y_min float

The minimum y value of the box in ratio of the image size.

 required
x_max float

The maximum x value of the box in ratio of the image size.

 required
y_max float

The maximum y value of the box in ratio of the image size.

 required

calculate_boxes_coverage #

calculate_boxes_coverage(boxes: list[Box]) -> float

Calculate the ratio of image area covered by a list of boxes.

Parameters:

Name Type Description Default
boxes list[Box]

List of Box objects with coordinates in range [0, 1].

 required

Returns:

Name Type Description
float float

Coverage ratio between 0.0 and 1.0.
Source code in src/rapidata/rapidata_client/validation/rapids/box.py 
 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
 96
 97
 98
 99
100
101
102
def calculate_boxes_coverage(boxes: list[Box]) -> float:
    """Calculate the ratio of image area covered by a list of boxes.

    Args:
        boxes: List of Box objects with coordinates in range [0, 1].

    Returns:
        float: Coverage ratio between 0.0 and 1.0.
    """
    if not boxes:
        return 0.0

    # Sweep line over x: at each x-interval, sum the merged y-coverage of the
    # currently active boxes, weighted by the interval width.
    events: list[tuple[float, str, int]] = []
    for i, box in enumerate(boxes):
        events.append((box.x_min, "start", i))
        events.append((box.x_max, "end", i))

    events.sort(key=lambda e: (e[0], e[1] == "end"))

    total_area = 0.0
    active_boxes: set[int] = set()
    prev_x = 0.0

    for x, event_type, box_id in events:
        if active_boxes and x > prev_x:
            y_intervals = sorted(
                (boxes[i].y_min, boxes[i].y_max) for i in active_boxes
            )
            merged: list[tuple[float, float]] = []
            for start, end in y_intervals:
                if merged and start <= merged[-1][1]:
                    merged[-1] = (merged[-1][0], max(merged[-1][1], end))
                else:
                    merged.append((start, end))
            y_coverage = sum(end - start for start, end in merged)
            total_area += (x - prev_x) * y_coverage

        if event_type == "start":
            active_boxes.add(box_id)
        else:
            active_boxes.discard(box_id)

        prev_x = x

    return total_area