Skip to content

dsdl.geometry.box

BBox

Bases: BaseGeometry

Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/box.py 
  9
 10
 11
 12
 13
 14
 15
 16
 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
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
class BBox(BaseGeometry):

    def __init__(self, data: List[_ELE_TYPE], mode):
        """A Geometry class which abstracts a 2D bounding box object.

        Args:
            x: The bounding box's top left point horizontal axis.
            y: The bounding box's top left point vertical axis.
            width: The bounding box's width.
            height: The bounding box's height.

        Attributes:
            _data(list[float]): A list which contains the bounding box's top left point horizontal axis, top left point vertical axis, width and height.
        """
        assert mode in ("xyxy", "xywh")
        if mode == "xyxy":
            data = [data[0], data[1], data[2] - data[0], data[3] - data[1]]
        self._data = data

    @property
    def x(self) -> _ELE_TYPE:
        """
        Returns:
            The bounding box's top left point horizontal axis.
        """
        return self._data[0]

    @property
    def y(self) -> _ELE_TYPE:
        """
        Returns:
            The bounding box's top left point vertical axis.
        """
        return self._data[1]

    @property
    def width(self) -> _ELE_TYPE:
        """
        Returns:
            The bounding box's width.
        """
        return self._data[2]

    @property
    def height(self) -> _ELE_TYPE:
        """
        Returns:
            The bounding box's height.
        """
        return self._data[3]

    @property
    def xmin(self) -> _ELE_TYPE:
        """
        Returns:
            The bounding box's top left point horizontal axis.
        """
        return self._data[0]

    @property
    def ymin(self) -> _ELE_TYPE:
        """
        Returns:
            The bounding box's top left point vertical axis.
        """
        return self._data[1]

    @property
    def xmax(self) -> _ELE_TYPE:
        """
        Returns:
            The bounding box's bottom right point horizontal axis.
        """
        return self._data[0] + self._data[2]

    @property
    def ymax(self) -> _ELE_TYPE:
        """
        Returns:
            The bounding box's bottom right point vertical axis.
        """
        return self._data[1] + self._data[3]

    @property
    def area(self) -> _ELE_TYPE:
        """
        Returns:
            The bounding box's area.
        """
        return self.width * self.height

    @property
    def xyxy(self) -> List[_ELE_TYPE]:
        """
        Returns:
            The bounding box's [xmin ymin xmax ymax] format.
        """
        return [self.xmin, self.ymin, self.xmax, self.ymax]

    @property
    def xywh(self) -> List[_ELE_TYPE]:
        """
        Returns:
            The bounding box's [x y w h] format.
        """
        return [self.xmin, self.ymin, self.width, self.height]

    @property
    def openmmlabformat(self) -> List[_ELE_TYPE]:
        """
        Returns:
            The bounding box's [xmin ymin xmax ymax] format, which is used in openmmlab project.
        """
        return [self.xmin, self.ymin, self.xmax, self.ymax]

    def to_int(self):
        """Convert the value in `self._data` to `int` type.
        """
        self._data = [int(_) for _ in self._data]

    def to_float(self):
        """Convert the value in `self._data` to `float` type.
        """
        self._data = [float(_) for _ in self._data]

    def visualize(self, image, palette, **kwargs):
        """Draw the current bounding box on an given image.

        Args:
            image: The image where the bounding box to be drawn.
            palette: The palette which stores the color of different category name.
            **kwargs: Other annotations which may be used when drawing the current bounding box, such as `Label` annotation.

        Returns:
            The image where the current bounding box has been drawn on.
        """
        draw_obj = ImageDraw.Draw(image)
        color = (0, 255, 0)
        if "label" in kwargs:
            for label in kwargs["label"].values():
                if label.category_name not in palette:
                    palette[label.category_name] = tuple(np.random.randint(0, 255, size=[3]))

                color = palette[label.category_name]
        draw_obj.rectangle(self.xyxy, outline=(*color, 255), width=2)
        del draw_obj
        return image

    def __repr__(self):
        return str(self.xyxy)

area: _ELE_TYPE property

Returns:

Type Description
_ELE_TYPE

The bounding box's area.

height: _ELE_TYPE property

Returns:

Type Description
_ELE_TYPE

The bounding box's height.

openmmlabformat: List[_ELE_TYPE] property

Returns:

Type Description
List[_ELE_TYPE]

The bounding box's [xmin ymin xmax ymax] format, which is used in openmmlab project.

width: _ELE_TYPE property

Returns:

Type Description
_ELE_TYPE

The bounding box's width.

x: _ELE_TYPE property

Returns:

Type Description
_ELE_TYPE

The bounding box's top left point horizontal axis.

xmax: _ELE_TYPE property

Returns:

Type Description
_ELE_TYPE

The bounding box's bottom right point horizontal axis.

xmin: _ELE_TYPE property

Returns:

Type Description
_ELE_TYPE

The bounding box's top left point horizontal axis.

xywh: List[_ELE_TYPE] property

Returns:

Type Description
List[_ELE_TYPE]

The bounding box's [x y w h] format.

xyxy: List[_ELE_TYPE] property

Returns:

Type Description
List[_ELE_TYPE]

The bounding box's [xmin ymin xmax ymax] format.

y: _ELE_TYPE property

Returns:

Type Description
_ELE_TYPE

The bounding box's top left point vertical axis.

ymax: _ELE_TYPE property

Returns:

Type Description
_ELE_TYPE

The bounding box's bottom right point vertical axis.

ymin: _ELE_TYPE property

Returns:

Type Description
_ELE_TYPE

The bounding box's top left point vertical axis.

__init__(data, mode)

A Geometry class which abstracts a 2D bounding box object.

Parameters:

Name Type Description Default
x

The bounding box's top left point horizontal axis.

 required
y

The bounding box's top left point vertical axis.

 required
width

The bounding box's width.

 required
height

The bounding box's height.

 required

Attributes:

Name Type Description
_data(list[float])

A list which contains the bounding box's top left point horizontal axis, top left point vertical axis, width and height.
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/box.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
def __init__(self, data: List[_ELE_TYPE], mode):
    """A Geometry class which abstracts a 2D bounding box object.

    Args:
        x: The bounding box's top left point horizontal axis.
        y: The bounding box's top left point vertical axis.
        width: The bounding box's width.
        height: The bounding box's height.

    Attributes:
        _data(list[float]): A list which contains the bounding box's top left point horizontal axis, top left point vertical axis, width and height.
    """
    assert mode in ("xyxy", "xywh")
    if mode == "xyxy":
        data = [data[0], data[1], data[2] - data[0], data[3] - data[1]]
    self._data = data

to_float()

Convert the value in self._data to float type.

Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/box.py 
129
130
131
132
def to_float(self):
    """Convert the value in `self._data` to `float` type.
    """
    self._data = [float(_) for _ in self._data]

to_int()

Convert the value in self._data to int type.

Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/box.py 
124
125
126
127
def to_int(self):
    """Convert the value in `self._data` to `int` type.
    """
    self._data = [int(_) for _ in self._data]

visualize(image, palette, **kwargs)

Draw the current bounding box on an given image.

Parameters:

Name Type Description Default
image

The image where the bounding box to be drawn.

 required
palette

The palette which stores the color of different category name.

 required
**kwargs

Other annotations which may be used when drawing the current bounding box, such as Label annotation.

 {}

Returns:

Type Description

The image where the current bounding box has been drawn on.
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/box.py 
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
def visualize(self, image, palette, **kwargs):
    """Draw the current bounding box on an given image.

    Args:
        image: The image where the bounding box to be drawn.
        palette: The palette which stores the color of different category name.
        **kwargs: Other annotations which may be used when drawing the current bounding box, such as `Label` annotation.

    Returns:
        The image where the current bounding box has been drawn on.
    """
    draw_obj = ImageDraw.Draw(image)
    color = (0, 255, 0)
    if "label" in kwargs:
        for label in kwargs["label"].values():
            if label.category_name not in palette:
                palette[label.category_name] = tuple(np.random.randint(0, 255, size=[3]))

            color = palette[label.category_name]
    draw_obj.rectangle(self.xyxy, outline=(*color, 255), width=2)
    del draw_obj
    return image