Skip to content

dsdl.geometry.keypoint

Coord2D

Bases: BaseGeometry

Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/keypoint.py 
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
class Coord2D(BaseGeometry):

    def __init__(self, x: float, y: float, visiable: int, label: Label):
        """A Geometry class which abstracts a 2D coordinate object.

        Args:
            x: The horizontal axis of the current `Coord2D` object.
            y: The vertical axis of the current `Coord2D` object.
            visiable: Whether the current `Coord2D` object is visiable in the image. if visiable <= 0, The current `Coord2D` object is not visiable.
            label: The current `Coord2D` object's Label object.
        """
        self._x = x
        self._y = y
        self._visiable = visiable
        self._label = label

    @property
    def x(self):
        """
        Returns:
            The horizontal axis of the current `Coord2D` object.
        """
        return self._x

    @property
    def y(self):
        """
        Returns:
            The vertical axis of the current `Coord2D` object.
        """
        return self._y

    @property
    def point(self):
        """
        Returns:
            The horizontal and vertical axises of the current `Coord2D` object.
        """
        return [self._x, self._y]

    @property
    def value(self):
        """
        Returns:
            The value of the current `Coord2D` object.
        """
        return [self._x, self._y, self._visiable]

    @property
    def visiable(self):
        """
        Returns:
            The visiable value of the current `Coord2D` object.
        """
        return self._visiable

    @property
    def label(self):
        """
        Returns:
            The `Label` object of the current `Coord2D` object.
        """
        return self._label

    @property
    def class_domain(self):
        """
        Returns:
            The `ClassDomain` object of the current `Coord2D` object.
        """
        return self._label.class_domain

    @property
    def name(self):
        """
        Returns:
            The name of the current `Coord2D` object's `Label` object.
        """
        return self._label.name

class_domain property

Returns:

Type Description

The ClassDomain object of the current Coord2D object.

label property

Returns:

Type Description

The Label object of the current Coord2D object.

name property

Returns:

Type Description

The name of the current Coord2D object's Label object.

point property

Returns:

Type Description

The horizontal and vertical axises of the current Coord2D object.

value property

Returns:

Type Description

The value of the current Coord2D object.

visiable property

Returns:

Type Description

The visiable value of the current Coord2D object.

x property

Returns:

Type Description

The horizontal axis of the current Coord2D object.

y property

Returns:

Type Description

The vertical axis of the current Coord2D object.

__init__(x, y, visiable, label)

A Geometry class which abstracts a 2D coordinate object.

Parameters:

Name Type Description Default
x float

The horizontal axis of the current Coord2D object.

 required
y float

The vertical axis of the current Coord2D object.

 required
visiable int

Whether the current Coord2D object is visiable in the image. if visiable <= 0, The current Coord2D object is not visiable.

 required
label Label

The current Coord2D object's Label object.

 required
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/keypoint.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
def __init__(self, x: float, y: float, visiable: int, label: Label):
    """A Geometry class which abstracts a 2D coordinate object.

    Args:
        x: The horizontal axis of the current `Coord2D` object.
        y: The vertical axis of the current `Coord2D` object.
        visiable: Whether the current `Coord2D` object is visiable in the image. if visiable <= 0, The current `Coord2D` object is not visiable.
        label: The current `Coord2D` object's Label object.
    """
    self._x = x
    self._y = y
    self._visiable = visiable
    self._label = label

KeyPoints

Bases: BaseGeometry

Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/keypoint.py 
 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
170
171
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
class KeyPoints(BaseGeometry):
    def __init__(self, value, dom: Union[List[ClassDomainMeta], ClassDomainMeta]):
        """A Geometry class which abstracts a 2D keypoints annotation object.

        Args:
            value: The list of `Coord2D` objects comprise the current `KeyPoints` object.
            dom: The class domain object which the current `KeyPoints` object belongs to.
        """
        if isinstance(dom, list):
            assert len(dom) == 1, "You can only assign one class dom in KeypointField."
            dom = dom[0]
        keypoints = []
        for class_ind, p in enumerate(value, start=1):
            label = dom.get_label(class_ind)
            coord2d = Coord2D(x=p[0], y=p[1], visiable=int(p[2]), label=label)
            keypoints.append(coord2d)
        self._keypoints = keypoints
        self._dom = dom

    @property
    def value(self):
        """
        Returns:
            The list of all the `Coord2D` objects' values.
        """
        return [_.value for _ in self._keypoints]

    @property
    def points(self):
        """
        Returns:
            The list of all the `Coord2D` objects' points.
        """
        return [_.point for _ in self._keypoints]

    @property
    def visables(self):
        """
        Returns:
            The list of all the `Coord2D` objects' visiable values.
        """
        return [_.visiable for _ in self._keypoints]

    @property
    def keypoints(self):
        """
        Returns:
            The list of `Coord2D` objects comprise the current `KeyPoints` object.
        """
        return self._keypoints

    @property
    def class_domain(self):
        """
        Returns:
            The class domain object which the current `KeyPoints` object belongs to.
        """
        return self._dom

    @property
    def names(self):
        """
        Returns:
            The names of all the `Coord2D` objects comprising the current `KeyPoints` object.
        """
        return [_.name for _ in self._keypoints]

    def __getitem__(self, item):
        """Given the index or the category name, return the coresponding `Coord2D` object.
        Args:
            item: The index or the category name of one of all the `Coord2D` object.

        Returns:
            The coresponding `Coord2D` object.
        """
        assert isinstance(item, (str, int)), "The index must be str or int type value."
        if isinstance(item, int):
            return self._keypoints[item]
        elif isinstance(item, str):
            for ind, label_name in enumerate(self._dom.get_label_names()):
                if label_name == item:
                    return self._keypoints[ind]
        raise ClassNotFoundError(f"Category '{item}' not defined in domain {self._dom.__name__}.")

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

        Args:
            image: The image where the current `Keypoints` object 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 `Keypoints` object.

        Returns:
            The image where the current `Keypoints` object has been drawn on.
        """
        draw_obj = ImageDraw.Draw(image)
        line_color = (0, 255, 0)  # green
        point_radius = 3
        skeleton = self._dom.get_attribute("Skeleton")
        if skeleton is not None:
            point_pairs = skeleton.get_point_pairs(self)
            for point_pair in point_pairs:
                p1, p2 = point_pair[:2]
                if p1.visiable > 0 and p2.visiable:
                    draw_obj.line([*p1.point, *p2.point], width=2, fill=(*line_color, 255))
        for point in self._keypoints:
            if point.visiable > 0:
                label_ = point.label.category_name
                if label_ not in palette:
                    palette[label_] = tuple(np.random.randint(0, 255, size=[3]))
                point_color = palette[label_]
                x, y = point.point
                draw_obj.ellipse((x - point_radius, y - point_radius, x + point_radius, y + point_radius),
                                 fill=(*point_color, 255))
        del draw_obj
        return image

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

class_domain property

Returns:

Type Description

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

keypoints property

Returns:

Type Description

The list of Coord2D objects comprise the current KeyPoints object.

names property

Returns:

Type Description

The names of all the Coord2D objects comprising the current KeyPoints object.

points property

Returns:

Type Description

The list of all the Coord2D objects' points.

value property

Returns:

Type Description

The list of all the Coord2D objects' values.

visables property

Returns:

Type Description

The list of all the Coord2D objects' visiable values.

__getitem__(item)

Given the index or the category name, return the coresponding Coord2D object.

Parameters:

Name Type Description Default
item

The index or the category name of one of all the Coord2D object.

 required

Returns:

Type Description

The coresponding Coord2D object.
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/keypoint.py 
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
def __getitem__(self, item):
    """Given the index or the category name, return the coresponding `Coord2D` object.
    Args:
        item: The index or the category name of one of all the `Coord2D` object.

    Returns:
        The coresponding `Coord2D` object.
    """
    assert isinstance(item, (str, int)), "The index must be str or int type value."
    if isinstance(item, int):
        return self._keypoints[item]
    elif isinstance(item, str):
        for ind, label_name in enumerate(self._dom.get_label_names()):
            if label_name == item:
                return self._keypoints[ind]
    raise ClassNotFoundError(f"Category '{item}' not defined in domain {self._dom.__name__}.")

__init__(value, dom)

A Geometry class which abstracts a 2D keypoints annotation object.

Parameters:

Name Type Description Default
value

The list of Coord2D objects comprise the current KeyPoints object.

 required
dom Union[List[ClassDomainMeta], ClassDomainMeta]

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

 required
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/keypoint.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
def __init__(self, value, dom: Union[List[ClassDomainMeta], ClassDomainMeta]):
    """A Geometry class which abstracts a 2D keypoints annotation object.

    Args:
        value: The list of `Coord2D` objects comprise the current `KeyPoints` object.
        dom: The class domain object which the current `KeyPoints` object belongs to.
    """
    if isinstance(dom, list):
        assert len(dom) == 1, "You can only assign one class dom in KeypointField."
        dom = dom[0]
    keypoints = []
    for class_ind, p in enumerate(value, start=1):
        label = dom.get_label(class_ind)
        coord2d = Coord2D(x=p[0], y=p[1], visiable=int(p[2]), label=label)
        keypoints.append(coord2d)
    self._keypoints = keypoints
    self._dom = dom

visualize(image, palette, **kwargs)

Draw the current Keypoints object on an given image.

Parameters:

Name Type Description Default
image

The image where the current Keypoints object 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 Keypoints object.

 {}

Returns:

Type Description

The image where the current Keypoints object has been drawn on.
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/keypoint.py 
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
def visualize(self, image, palette, **kwargs):
    """Draw the current `Keypoints` object on an given image.

    Args:
        image: The image where the current `Keypoints` object 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 `Keypoints` object.

    Returns:
        The image where the current `Keypoints` object has been drawn on.
    """
    draw_obj = ImageDraw.Draw(image)
    line_color = (0, 255, 0)  # green
    point_radius = 3
    skeleton = self._dom.get_attribute("Skeleton")
    if skeleton is not None:
        point_pairs = skeleton.get_point_pairs(self)
        for point_pair in point_pairs:
            p1, p2 = point_pair[:2]
            if p1.visiable > 0 and p2.visiable:
                draw_obj.line([*p1.point, *p2.point], width=2, fill=(*line_color, 255))
    for point in self._keypoints:
        if point.visiable > 0:
            label_ = point.label.category_name
            if label_ not in palette:
                palette[label_] = tuple(np.random.randint(0, 255, size=[3]))
            point_color = palette[label_]
            x, y = point.point
            draw_obj.ellipse((x - point_radius, y - point_radius, x + point_radius, y + point_radius),
                             fill=(*point_color, 255))
    del draw_obj
    return image