Module uim.model.semantics.structures
Expand source code
# -*- coding: utf-8 -*-
# Copyright © 2021 Wacom Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from abc import ABC
class BoundingBox(ABC):
"""
BoundingBox
===========
Bounding boxes are represented as rectangle.
Each rectangle is composed of a x, y coordinate representing the lower left point and the height and width.
Parameters
----------
x: float
x-coordinate
y: float
y-coordinate
width: float
Width of the bounding box
height: float
Height of the bounding box
"""
def __init__(self, x: float, y: float, width: float, height: float):
self.__x: float = x
self.__y: float = y
self.__width: float = width
self.__height: float = height
@property
def x(self) -> float:
"""X coordinate of the lower left x coordinate of the bounding box. ('float', read-only)"""
return self.__x
@property
def y(self) -> float:
"""y coordinate of the lower left y coordinate of the bounding box. ('float', read-only)"""
return self.__y
@property
def width(self) -> float:
"""Width of the bounding box. ('float', read-only)"""
return self.__width
@property
def height(self) -> float:
"""Height of the bounding box. ('float', read-only)"""
return self.__height
def enclosing_bounding_box(self, bb: 'BoundingBox') -> 'BoundingBox':
"""
Enclosing bounding box.
Parameters
----------
bb: `BoundingBox`
Other bounding box
Returns
-------
bb: `BoundingBox`
Enclosing bounding box
"""
new_x: float = min(self.x, bb.x)
new_y: float = min(self.y, bb.y)
new_width: float = max(self.width, self.width + self.x - bb.x)
new_height: float = max(self.height, self.height + self.y - bb.y)
return BoundingBox(new_x, new_y, new_width, new_height)
def __repr__(self):
return '<Bounding box : [x:={}, y:={}, width:={}, height:={}]>'.format(self.x, self.y, self.width, self.height)
Classes
class BoundingBox (x: float, y: float, width: float, height: float)
-
BoundingBox
Bounding boxes are represented as rectangle. Each rectangle is composed of a x, y coordinate representing the lower left point and the height and width.
Parameters
x
:float
- x-coordinate
y
:float
- y-coordinate
width
:float
- Width of the bounding box
height
:float
- Height of the bounding box
Expand source code
class BoundingBox(ABC): """ BoundingBox =========== Bounding boxes are represented as rectangle. Each rectangle is composed of a x, y coordinate representing the lower left point and the height and width. Parameters ---------- x: float x-coordinate y: float y-coordinate width: float Width of the bounding box height: float Height of the bounding box """ def __init__(self, x: float, y: float, width: float, height: float): self.__x: float = x self.__y: float = y self.__width: float = width self.__height: float = height @property def x(self) -> float: """X coordinate of the lower left x coordinate of the bounding box. ('float', read-only)""" return self.__x @property def y(self) -> float: """y coordinate of the lower left y coordinate of the bounding box. ('float', read-only)""" return self.__y @property def width(self) -> float: """Width of the bounding box. ('float', read-only)""" return self.__width @property def height(self) -> float: """Height of the bounding box. ('float', read-only)""" return self.__height def enclosing_bounding_box(self, bb: 'BoundingBox') -> 'BoundingBox': """ Enclosing bounding box. Parameters ---------- bb: `BoundingBox` Other bounding box Returns ------- bb: `BoundingBox` Enclosing bounding box """ new_x: float = min(self.x, bb.x) new_y: float = min(self.y, bb.y) new_width: float = max(self.width, self.width + self.x - bb.x) new_height: float = max(self.height, self.height + self.y - bb.y) return BoundingBox(new_x, new_y, new_width, new_height) def __repr__(self): return '<Bounding box : [x:={}, y:={}, width:={}, height:={}]>'.format(self.x, self.y, self.width, self.height)
Ancestors
- abc.ABC
Instance variables
var height : float
-
Height of the bounding box. ('float', read-only)
Expand source code
@property def height(self) -> float: """Height of the bounding box. ('float', read-only)""" return self.__height
var width : float
-
Width of the bounding box. ('float', read-only)
Expand source code
@property def width(self) -> float: """Width of the bounding box. ('float', read-only)""" return self.__width
var x : float
-
X coordinate of the lower left x coordinate of the bounding box. ('float', read-only)
Expand source code
@property def x(self) -> float: """X coordinate of the lower left x coordinate of the bounding box. ('float', read-only)""" return self.__x
var y : float
-
y coordinate of the lower left y coordinate of the bounding box. ('float', read-only)
Expand source code
@property def y(self) -> float: """y coordinate of the lower left y coordinate of the bounding box. ('float', read-only)""" return self.__y
Methods
def enclosing_bounding_box(self, bb: BoundingBox) ‑> BoundingBox
-
Enclosing bounding box.
Parameters
bb
:BoundingBox
- Other bounding box
Returns
bb
:BoundingBox
- Enclosing bounding box
Expand source code
def enclosing_bounding_box(self, bb: 'BoundingBox') -> 'BoundingBox': """ Enclosing bounding box. Parameters ---------- bb: `BoundingBox` Other bounding box Returns ------- bb: `BoundingBox` Enclosing bounding box """ new_x: float = min(self.x, bb.x) new_y: float = min(self.y, bb.y) new_width: float = max(self.width, self.width + self.x - bb.x) new_height: float = max(self.height, self.height + self.y - bb.y) return BoundingBox(new_x, new_y, new_width, new_height)