Skip to content

Types

BoundingBox

Class to define a BoundingBox object in a 2D Cartesian coordinate system.

Source code in PytorchWildlife/models/detection/herdnet/animaloc/data/types.py 
 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
class BoundingBox:
    ''' Class to define a BoundingBox object in a 2D Cartesian 
    coordinate system.
    '''

    def __init__(
            self, 
            x_min: Union[int,float], 
            y_min: Union[int,float], 
            x_max: Union[int,float], 
            y_max: Union[int,float]
        ) -> None:
        '''
        Args:
            x_min (int, float): x bbox top-left coordinate
            y_min (int, float): y bbox top-left coordinate
            x_max (int, float): x bbox bottom-right coordinate
            y_max (int, float): y bbox bottom-right coordinate
        '''

        assert all([c >= 0 for c in [x_min,y_min,x_max,y_max]]), \
            f'Coordinates must be positives, got x_min={x_min}, y_min={y_min}, ' \
                f'x_max={x_max} and y_max={y_max}'

        assert x_max >= x_min and y_max >= y_min, \
            'Wrong bounding box coordinates.'

        self.x_min = x_min
        self.y_min = y_min
        self.x_max = x_max
        self.y_max = y_max

    @property
    def area(self) -> Union[int,float]:
        ''' To get bbox area '''
        return max(0, self.width) * max(0, self.height)

    @property
    def width(self) -> Union[int,float]:
        ''' To get bbox width '''
        return max(0, self.x_max - self.x_min)

    @property
    def height(self) -> Union[int,float]:
        ''' To get bbox height '''
        return max(0, self.y_max - self.y_min)

    @property
    def get_tuple(self) -> Tuple[Union[int,float],...]:
        ''' To get bbox coordinates in tuple type '''
        return (self.x_min,self.y_min,self.x_max,self.y_max)

    @property
    def atype(self) -> str:
        ''' To get annotation type string '''
        return 'BoundingBox'

    def __repr__(self) -> str:
        return f'BoundingBox(x_min: {self.x_min}, y_min: {self.y_min}, x_max: {self.x_max}, y_max: {self.y_max})'

    def __eq__(self, other) -> bool:
        return all([
            self.x_min == other.x_min,
            self.y_min == other.y_min,
            self.x_max == other.x_max,
            self.y_max == other.y_max
            ])

area property

To get bbox area

atype property

To get annotation type string

get_tuple property

To get bbox coordinates in tuple type

height property

To get bbox height

width property

To get bbox width

__init__(x_min, y_min, x_max, y_max)

Parameters:

Name Type Description Default
x_min (int, float)

x bbox top-left coordinate

 required
y_min (int, float)

y bbox top-left coordinate

 required
x_max (int, float)

x bbox bottom-right coordinate

 required
y_max (int, float)

y bbox bottom-right coordinate

 required
Source code in PytorchWildlife/models/detection/herdnet/animaloc/data/types.py 
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
def __init__(
        self, 
        x_min: Union[int,float], 
        y_min: Union[int,float], 
        x_max: Union[int,float], 
        y_max: Union[int,float]
    ) -> None:
    '''
    Args:
        x_min (int, float): x bbox top-left coordinate
        y_min (int, float): y bbox top-left coordinate
        x_max (int, float): x bbox bottom-right coordinate
        y_max (int, float): y bbox bottom-right coordinate
    '''

    assert all([c >= 0 for c in [x_min,y_min,x_max,y_max]]), \
        f'Coordinates must be positives, got x_min={x_min}, y_min={y_min}, ' \
            f'x_max={x_max} and y_max={y_max}'

    assert x_max >= x_min and y_max >= y_min, \
        'Wrong bounding box coordinates.'

    self.x_min = x_min
    self.y_min = y_min
    self.x_max = x_max
    self.y_max = y_max

Point

Class to define a Point object in a 2D Cartesian coordinate system.

Source code in PytorchWildlife/models/detection/herdnet/animaloc/data/types.py 
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
class Point:
    ''' Class to define a Point object in a 2D Cartesian 
    coordinate system.
    '''

    def __init__(self, x: Union[int,float], y: Union[int,float]) -> None:
        '''
        Args:
            x (int, float): x coordinate
            y (int, float): y coordinate
        '''

        assert x >= 0 and y >= 0, f'Coordinates must be positives, got x={x} and y={y}'

        self.x = x
        self.y = y
        self.area = 1 # always 1 pixel

    # @property
    # def area(self) -> int:
    #     ''' To get area '''
    #     return 1 # always 1 pixel

    @property
    def get_tuple(self) -> Tuple[Union[int,float],Union[int,float]]:
        ''' To get point's coordinates in tuple '''
        return (self.x,self.y)

    @property
    def atype(self) -> str:
        ''' To get annotation type string '''
        return 'Point'

    def __repr__(self) -> str:
        return f'Point(x: {self.x}, y: {self.y})'

    def __eq__(self, other) -> bool:
        return all([
            self.x == other.x,
            self.y == other.y
            ])

atype property

To get annotation type string

get_tuple property

To get point's coordinates in tuple

__init__(x, y)

Parameters:

Name Type Description Default
x (int, float)

x coordinate

 required
y (int, float)

y coordinate

 required
Source code in PytorchWildlife/models/detection/herdnet/animaloc/data/types.py 
25
26
27
28
29
30
31
32
33
34
35
36
def __init__(self, x: Union[int,float], y: Union[int,float]) -> None:
    '''
    Args:
        x (int, float): x coordinate
        y (int, float): y coordinate
    '''

    assert x >= 0 and y >= 0, f'Coordinates must be positives, got x={x} and y={y}'

    self.x = x
    self.y = y
    self.area = 1 # always 1 pixel