Skip to content

dsdl.geometry.label

Label

Bases: BaseGeometry, FontMixin

Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/label.py 
  8
  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
159
160
161
162
163
164
165
166
167
168
169
class Label(BaseGeometry, FontMixin):

    def __init__(self, name, supercategories=(), domain_name=None):
        """A Geometry class which abstracts a label object.

        Args:
            name: The name of the current label object.
            supercategories: The collection of the current label's super category objects.
            domain_name: The name of the class domain which the current label object belongs to.
        """
        self._name = name
        self._supercategories = [_ for _ in supercategories if isinstance(_, Label)]
        self._domain_name = domain_name

    @property
    def supercategories(self):
        """
        Returns:
            The collection of the current label's super category objects.
        """
        return self._supercategories

    @property
    def supercategories_names(self):
        """
        Returns:
            The names of the current label's supercategories.
        """
        return [_.name for _ in self._supercategories]

    @property
    def parent_names(self):
        """
        Returns:
            The names of the current label's supercategories.
        """
        return [_.name for _ in self._supercategories]

    @property
    def domain_name(self):
        """
        Returns:
            The name of the class domain which the current label object belongs to.
        """
        return self._domain_name

    @property
    def parents(self):
        """
        Returns:
            The collection of the current label's super category objects.
        """
        return self._supercategories

    @property
    def name(self):
        """
        Returns:
            The name of the current label object.
        """
        return self._name

    @property
    def registry_name(self):
        """
        Returns:
            The registry name of the current label object which is unique in the `LABEL` registry.
        """
        return f"{self._domain_name}__{self._name}"

    def set_domain(self, domain_name):
        """
        Set the `_domain_name` of the current label object.
        """
        if self._domain_name is None:
            self._domain_name = domain_name

    @property
    def category_name(self):
        """
        Returns:
            The name of the current label object.
        """
        return self._name

    @property
    def openmmlabformat(self):
        """
        Returns:
            The name of the current label object.
        """
        return self._name

    @property
    def class_domain(self):
        """
        Returns:
            (dsdl.geometry.ClassDomain): The class domain object which the current label object belongs to.
        """
        return CLASSDOMAIN.get(self.domain_name)

    def index_in_domain(self):
        """
        Returns:
            The index of the current label object in the class domain which it belongs to.
        """
        return self.class_domain.get_cat2ind_mapping()[self.category_name]

    def __eq__(self, other):
        """Compare whether the current label object is equal to the other.

        Args:
            other: Another Label object to be compared with the current one.

        Returns:
            Whether the current label object is equal to the other.
        """
        if self.domain_name != other.domain_name:
            return False
        if self.name != other.name:
            return False
        if len(self.parents) != len(self.parents):
            return False
        for p1 in self.parents:
            for p2 in other.parents:
                if p1 != p2:
                    return False
        return True

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

        Args:
            image: The image where the label 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 label object, such as `BBox` annotation.

        Returns:
            The image where the current label object has been drawn on.
        """
        draw_obj = ImageDraw.Draw(image)
        if self.category_name not in palette:
            palette[self.category_name] = tuple(np.random.randint(0, 255, size=[3]))
        color = palette[self.category_name]
        if self.font is None:
            self.set_font(ImageFont.truetype(os.path.join(os.path.dirname(__file__), "source", "Arial_Font.ttf")))
        label_size = draw_obj.textsize(self.category_name, self.font)
        if "bbox" in kwargs:
            coords = np.array([[item.xyxy[0], item.xyxy[1] + 0.2 * label_size[1]] for item in kwargs["bbox"].values()])
        elif "polygon" in kwargs:
            coords = np.array([[item.point_for_draw()[0], item.point_for_draw()[1] + 0.2 * label_size[1]] for item in
                               kwargs["polygon"].values()])
        else:
            coords = np.array([[0, 0.2 * label_size[1]]])
        for coord in coords:
            draw_obj.rectangle([tuple(coord), tuple(coord + label_size)], fill=(*color, 255))
            draw_obj.text(tuple(coord), self.category_name, fill=(255, 255, 255, 255), font=self.font)
        del draw_obj
        return image

    def __repr__(self):
        return self.category_name

category_name property

Returns:

Type Description

The name of the current label object.

class_domain property

Returns:

Type Description
dsdl.geometry.ClassDomain

The class domain object which the current label object belongs to.

domain_name property

Returns:

Type Description

The name of the class domain which the current label object belongs to.

name property

Returns:

Type Description

The name of the current label object.

openmmlabformat property

Returns:

Type Description

The name of the current label object.

parent_names property

Returns:

Type Description

The names of the current label's supercategories.

parents property

Returns:

Type Description

The collection of the current label's super category objects.

registry_name property

Returns:

Type Description

The registry name of the current label object which is unique in the LABEL registry.

supercategories property

Returns:

Type Description

The collection of the current label's super category objects.

supercategories_names property

Returns:

Type Description

The names of the current label's supercategories.

__eq__(other)

Compare whether the current label object is equal to the other.

Parameters:

Name Type Description Default
other

Another Label object to be compared with the current one.

 required

Returns:

Type Description

Whether the current label object is equal to the other.
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/label.py 
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
def __eq__(self, other):
    """Compare whether the current label object is equal to the other.

    Args:
        other: Another Label object to be compared with the current one.

    Returns:
        Whether the current label object is equal to the other.
    """
    if self.domain_name != other.domain_name:
        return False
    if self.name != other.name:
        return False
    if len(self.parents) != len(self.parents):
        return False
    for p1 in self.parents:
        for p2 in other.parents:
            if p1 != p2:
                return False
    return True

__init__(name, supercategories=(), domain_name=None)

A Geometry class which abstracts a label object.

Parameters:

Name Type Description Default
name

The name of the current label object.

 required
supercategories

The collection of the current label's super category objects.

 ()
domain_name

The name of the class domain which the current label object belongs to.

 None
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/label.py 
10
11
12
13
14
15
16
17
18
19
20
def __init__(self, name, supercategories=(), domain_name=None):
    """A Geometry class which abstracts a label object.

    Args:
        name: The name of the current label object.
        supercategories: The collection of the current label's super category objects.
        domain_name: The name of the class domain which the current label object belongs to.
    """
    self._name = name
    self._supercategories = [_ for _ in supercategories if isinstance(_, Label)]
    self._domain_name = domain_name

index_in_domain()

Returns:

Type Description

The index of the current label object in the class domain which it belongs to.
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/label.py 
109
110
111
112
113
114
def index_in_domain(self):
    """
    Returns:
        The index of the current label object in the class domain which it belongs to.
    """
    return self.class_domain.get_cat2ind_mapping()[self.category_name]

set_domain(domain_name)

Set the _domain_name of the current label object.

Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/label.py 
78
79
80
81
82
83
def set_domain(self, domain_name):
    """
    Set the `_domain_name` of the current label object.
    """
    if self._domain_name is None:
        self._domain_name = domain_name

visualize(image, palette, **kwargs)

Draw the current label object on an given image.

Parameters:

Name Type Description Default
image

The image where the label 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 label object, such as BBox annotation.

 {}

Returns:

Type Description

The image where the current label object has been drawn on.
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/label.py 
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
def visualize(self, image, palette, **kwargs):
    """Draw the current label object on an given image.

    Args:
        image: The image where the label 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 label object, such as `BBox` annotation.

    Returns:
        The image where the current label object has been drawn on.
    """
    draw_obj = ImageDraw.Draw(image)
    if self.category_name not in palette:
        palette[self.category_name] = tuple(np.random.randint(0, 255, size=[3]))
    color = palette[self.category_name]
    if self.font is None:
        self.set_font(ImageFont.truetype(os.path.join(os.path.dirname(__file__), "source", "Arial_Font.ttf")))
    label_size = draw_obj.textsize(self.category_name, self.font)
    if "bbox" in kwargs:
        coords = np.array([[item.xyxy[0], item.xyxy[1] + 0.2 * label_size[1]] for item in kwargs["bbox"].values()])
    elif "polygon" in kwargs:
        coords = np.array([[item.point_for_draw()[0], item.point_for_draw()[1] + 0.2 * label_size[1]] for item in
                           kwargs["polygon"].values()])
    else:
        coords = np.array([[0, 0.2 * label_size[1]]])
    for coord in coords:
        draw_obj.rectangle([tuple(coord), tuple(coord + label_size)], fill=(*color, 255))
        draw_obj.text(tuple(coord), self.category_name, fill=(255, 255, 255, 255), font=self.font)
    del draw_obj
    return image

LabelList

Bases: BaseGeometry, FontMixin

Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/label.py 
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
class LabelList(BaseGeometry, FontMixin):

    def __init__(self, label_list):
        """A Geometry class which abstracts a list of label objects.

        Args:
            label_list: A collection of `Label` objects.
        """
        self._label_list = list(label_list)

    @property
    def names(self):
        """
        Returns:
            All the names of the label object in the current `LabelList` object.
        """
        return [label.category_name for label in self._label_list]

    @property
    def category_names(self):
        """
        Returns:
            All the names of the label object in the current `LabelList` object.
        """
        return [label.category_name for label in self._label_list]

    @property
    def label_list(self):
        """
        Returns:
            All the `Label` objects in the current `LabelList` object.
        """
        return self._label_list

    @property
    def class_domains(self):
        """
        Returns:
            (List[dsdl.geometry.ClassDomain]): The class domain objects of all the `Label` objects in the current `LabelList` object.
        """
        return [label.class_domain for label in self._label_list]

    def visualize(self, image, palette, **kwargs):
        """Draw the current `LabelList` object on an given image.

        Args:
            image: The image where the labels 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 `LabelList` object, such as `BBox` annotation.

        Returns:
            The image where the current `LabelList` object has been drawn on.
        """
        draw_obj = ImageDraw.Draw(image)
        if self.font is None:
            self.set_font(ImageFont.truetype(os.path.join(os.path.dirname(__file__), "source", "Arial_Font.ttf")))
        y_offset = np.zeros((1, 2))
        for label_obj in self.label_list:

            category_name = label_obj.category_name

            if category_name not in palette:
                palette[category_name] = tuple(np.random.randint(0, 255, size=[3]))
            color = palette[category_name]

            label_size = draw_obj.textsize(category_name, self.font)
            if "bbox" in kwargs:
                # coords.shape = [num_box, 2]
                coords = y_offset + np.array(
                    [[item.xyxy[0], item.xyxy[1] + 0.2 * label_size[1]] for item in kwargs["bbox"].values()])
            elif "polygon" in kwargs:
                coords = y_offset + np.array(
                    [[item.point_for_draw()[0], item.point_for_draw()[1] + 0.2 * label_size[1]] for item in
                     kwargs["polygon"].values()])
            elif "rotatedbbox" in kwargs:
                coords = y_offset + np.array(
                    [[item.point_for_draw()[0], item.point_for_draw()[1] + 0.2 * label_size[1]] for item in
                     kwargs["rotatedbbox"].values()])
            elif "image_label_list" not in kwargs:
                coords = y_offset + np.array([[0, 0.2 * label_size[1]]])
            else:
                coords = []
                kwargs["image_label_list"].append(label_obj)

            y_offset += np.array([[0., 1.2 * label_size[1]]])
            for coord in coords:
                draw_obj.rectangle([tuple(coord), tuple(coord + label_size)], fill=(*color, 255))
                draw_obj.text(tuple(coord), category_name, fill=(255, 255, 255, 255), font=self.font)

        del draw_obj
        return image

category_names property

Returns:

Type Description

All the names of the label object in the current LabelList object.

class_domains property

Returns:

Type Description
List[dsdl.geometry.ClassDomain]

The class domain objects of all the Label objects in the current LabelList object.

label_list property

Returns:

Type Description

All the Label objects in the current LabelList object.

names property

Returns:

Type Description

All the names of the label object in the current LabelList object.

__init__(label_list)

A Geometry class which abstracts a list of label objects.

Parameters:

Name Type Description Default
label_list

A collection of Label objects.

 required
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/label.py 
174
175
176
177
178
179
180
def __init__(self, label_list):
    """A Geometry class which abstracts a list of label objects.

    Args:
        label_list: A collection of `Label` objects.
    """
    self._label_list = list(label_list)

visualize(image, palette, **kwargs)

Draw the current LabelList object on an given image.

Parameters:

Name Type Description Default
image

The image where the labels 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 LabelList object, such as BBox annotation.

 {}

Returns:

Type Description

The image where the current LabelList object has been drawn on.
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/label.py 
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
def visualize(self, image, palette, **kwargs):
    """Draw the current `LabelList` object on an given image.

    Args:
        image: The image where the labels 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 `LabelList` object, such as `BBox` annotation.

    Returns:
        The image where the current `LabelList` object has been drawn on.
    """
    draw_obj = ImageDraw.Draw(image)
    if self.font is None:
        self.set_font(ImageFont.truetype(os.path.join(os.path.dirname(__file__), "source", "Arial_Font.ttf")))
    y_offset = np.zeros((1, 2))
    for label_obj in self.label_list:

        category_name = label_obj.category_name

        if category_name not in palette:
            palette[category_name] = tuple(np.random.randint(0, 255, size=[3]))
        color = palette[category_name]

        label_size = draw_obj.textsize(category_name, self.font)
        if "bbox" in kwargs:
            # coords.shape = [num_box, 2]
            coords = y_offset + np.array(
                [[item.xyxy[0], item.xyxy[1] + 0.2 * label_size[1]] for item in kwargs["bbox"].values()])
        elif "polygon" in kwargs:
            coords = y_offset + np.array(
                [[item.point_for_draw()[0], item.point_for_draw()[1] + 0.2 * label_size[1]] for item in
                 kwargs["polygon"].values()])
        elif "rotatedbbox" in kwargs:
            coords = y_offset + np.array(
                [[item.point_for_draw()[0], item.point_for_draw()[1] + 0.2 * label_size[1]] for item in
                 kwargs["rotatedbbox"].values()])
        elif "image_label_list" not in kwargs:
            coords = y_offset + np.array([[0, 0.2 * label_size[1]]])
        else:
            coords = []
            kwargs["image_label_list"].append(label_obj)

        y_offset += np.array([[0., 1.2 * label_size[1]]])
        for coord in coords:
            draw_obj.rectangle([tuple(coord), tuple(coord + label_size)], fill=(*color, 255))
            draw_obj.text(tuple(coord), category_name, fill=(255, 255, 255, 255), font=self.font)

    del draw_obj
    return image