OrientedBBox¶

class OrientedBBox(top, left, bottom, right, angle=0, sly_id=None, class_id=None, labeler_login=None, updated_at=None, created_at=None)[source]¶

Bases: Rectangle

2D bounding box with rotation angle; axis-aligned coordinates plus angle. Immutable.

OrientedBBox geometry for a single Label. OrientedBBox class object is immutable.

Parameters:

top : int or float¶

Minimal vertical value of the oriented bounding box.

left : int or float¶

Minimal horizontal value of the oriented bounding box.

bottom : int or float¶

Maximal vertical value of the oriented bounding box.

right : int or float¶

Maximal vertical value of the oriented bounding box.

angle : int or float, optional¶

Angle of rotation in radians. Positive values mean clockwise rotation.

sly_id : int, optional¶

OrientedBBox ID in Supervisely server.

class_id : int, optional¶

ID of ObjClass to which OrientedBBox belongs.

labeler_login : str, optional¶

Login of the user who created the oriented bounding box.

updated_at : str, optional¶

Date and Time when OrientedBBox was modified last. Date Format: Year:Month:Day:Hour:Minute:Seconds. Example: ‘2021-01-22T19:37:50.158Z’.

created_at : str, optional¶

Date and Time when OrientedBBox was created. Date Format is the same as in “updated_at” parameter.

Raises:

ValueError – if top argument has greater value than bottom, or left argument has greater value than right

Usage Example:

import supervisely as sly

import math

top = 100
left = 100
bottom = 700
right = 900
angle = math.pi / 12  # 15 degrees in radians
figure = sly.OrientedBBox(top, left, bottom, right, angle=angle)

Methods

allowed_transforms	Returns the allowed transforms for the OrientedBBox.
calculate_rotated_corners	Get the corners of the OrientedBBox.
clone	Clone from GEOMETRYYY
config_from_json	Convert geometry config from json format
config_to_json	Convert geometry config to json format
contains	Checks if Rectangle contains a given Rectangle object.
contains_obb	Check if the OrientedBBox contains the given OrientedBBox.
contains_point	Check if the OrientedBBox contains the given point.
contains_point_location	Check if the OrientedBBox contains the given point.
contains_rectangle	Check if the OrientedBBox contains the given Rectangle.
convert	Convert geometry to another geometry shape.
crop	Crop the OrientedBBox by another OrientedBBox using the Sutherland-Hodgman algorithm.
draw
draw_contour	Draws the figure contour on a given bitmap canvas :param bitmap: np.ndarray :param color: [R, G, B] :param thickness: (int) :param config: drawing config specific to a concrete subclass, e.g. per edge colors.
fliplr	Flips current Rectangle in horizontal.
flipud	Flips current Rectangle in vertical.
from_array	Create OrientedBBox with given array shape.
from_bbox	Create OrientedBBox from given Rectangle.
from_geometries_list	Create Rectangle from given geometry objects.
from_json	Convert a json dict to OrientedBBox.
from_size	Create Rectangle with given size shape.
geometry_name	Returns the name of the geometry.
get_cropped_numpy_slice	Slice of given numpy array with OrientedBBox align bbox.
get_mask	Returns 2D boolean mask of the geometry.
intersects_with	Checks intersects Rectangle with given Rectangle object or not.
name	Get the name of the geometry.
relative_crop	Crops object like "crop" method, but return results with coordinates relative to rect :param rect: Rectangle for crop.
resize	Resizes current Rectangle.
rotate	Rotates current Rectangle.
scale	Scales current Rectangle.
to_bbox	Convert the OrientedBBox to the axis-aligned Rectangle that fully contains the OrientedBBox.
to_json	Convert the OrientedBBox to a json dict.
to_size	Height and width of Rectangle.
translate	Translates current Rectangle.
validate	Validate geometry.

Attributes

angle	Angle of rotation in radians.
area	Rectangle area.
bottom	Maximal vertical value of Rectangle.
center	Center of Rectangle.
corners	Get list of Rectangle corners.
height	Height of Rectangle
left	Minimal horizontal value of Rectangle.
right	Maximal horizontal value of Rectangle.
top	Minimal vertical value of Rectangle.
width	Width of Rectangle.

classmethod allowed_transforms()[source]¶

Returns the allowed transforms for the OrientedBBox.

classmethod from_array(arr, angle=0)[source]¶

Create OrientedBBox with given array shape.

Parameters:

arr : np.ndarray¶

Numpy array to create OrientedBBox from.

Returns:

OrientedBBox from Numpy array.

Return type:

OrientedBBox

Usage Example:

import supervisely as sly

np_array = np.zeros((300, 400))
figure_from_np = sly.OrientedBBox.from_array(np_array, angle=15)

classmethod from_bbox(bbox)[source]¶

Create OrientedBBox from given Rectangle.

Parameters:

bbox¶

Rectangle to create OrientedBBox from.

Returns:

OrientedBBox from Rectangle.

Return type:

OrientedBBox

Usage Example:

import supervisely as sly

axis_aligned_bbox = sly.Rectangle(100, 100, 700, 900)
figure_from_bbox = sly.OrientedBBox.from_bbox(axis_aligned_bbox)

classmethod from_geometries_list(geometries)¶

Create Rectangle from given geometry objects.

Parameters:

geometries¶

List of geometry type objects: Bitmap>, Cuboid>, Point>, Polygon>, Polyline>, Rectangle>, GraphNodes>.

Returns:

Rectangle from given geometry objects.

Return type:

Rectangle

Usage Example:

import supervisely as sly

geom_objs = [sly.Point(100, 200), sly.Polyline([sly.PointLocation(730, 2104), sly.PointLocation(2479, 402)])]
figure_from_geom_objs = sly.Rectangle.from_geometries_list(geom_objs)

classmethod from_json(data)[source]¶

Convert a json dict to OrientedBBox. Read more about Supervisely format.

Parameters:

data : Dict¶

OrientedBBox in json format as a dict.

Returns:

OrientedBBox from json.

Return type:

OrientedBBox

Usage Example:

import supervisely as sly

import math

figure_json = {
    "points": [
        [100, 100],
        [900, 700]
    ],
    "angle": math.pi / 12  # 15 degrees in radians
}
figure = sly.OrientedBBox.from_json(figure_json)

classmethod from_size(size)¶

Create Rectangle with given size shape.

Parameters:

size : Tuple[int, int]¶

Input size.

Returns:

Rectangle from size.

Return type:

Rectangle

Usage Example:

import supervisely as sly

size = (300, 400)
figure_from_size = sly.Rectangle.from_size(size)

classmethod name()¶

Get the name of the geometry.

Same as geometry_name(), but shorter. In order to make the code more concise.

Returns:

string with name of geometry

static config_from_json(config)¶

Convert geometry config from json format

Parameters:

config : dict¶

dictionary(geometry config) in json format

Returns:

dictionary(geometry config) in json format

Return type:

dict

static config_to_json(config)¶

Convert geometry config to json format

Parameters:

config : dict¶

dictionary(geometry config)

Returns:

dictionary(geometry config) in json format

Return type:

dict

static geometry_name()[source]¶

Returns the name of the geometry.

Returns:

name of the geometry

Return type:

str

calculate_rotated_corners()[source]¶

Get the corners of the OrientedBBox.

Returns:

List of corners as PointLocation objects.

Return type:

List[PointLocation]

Usage Example:

corners = oriented_bbox.calculate_rotated_corners()

clone()¶

Clone from GEOMETRYYY

contains(rect)¶

Checks if Rectangle contains a given Rectangle object.

Parameters:

rect¶

Rectangle to check if it contains.

Returns:

True if Rectangle contains given Rectangle, otherwise False

Return type:

bool

Usage Example:

import supervisely as sly

rect = sly.Rectangle(200, 250, 400, 500))
print(figure.contains(rect))
# Output: True

contains_obb(obb)[source]¶

Check if the OrientedBBox contains the given OrientedBBox.

Parameters:

obb¶

OrientedBBox to check.

Returns:

True if the OrientedBBox is inside the OrientedBBox, False otherwise

Return type:

bool

Usage Example:

obb2 = sly.OrientedBBox(150, 200, 400, 500, angle=10)
is_inside = obb1.contains_obb(obb2)

contains_point(geometry)[source]¶

Check if the OrientedBBox contains the given point.

Parameters:

geometry¶

Geometry to check.

Returns:

True if the point is inside the OrientedBBox, False otherwise

Return type:

bool

Usage Example:

point = sly.PointLocation(150, 200)
is_inside = oriented_bbox.contains_point(point)

contains_point_location(point)[source]¶

Check if the OrientedBBox contains the given point.

Parameters:

point¶

PointLocation to check.

Returns:

True if the point is inside the OrientedBBox, False otherwise

Return type:

bool

Usage Example:

point = sly.PointLocation(150, 200)
is_inside = oriented_bbox.contains_point_location(point)

contains_rectangle(rectangle)[source]¶

Check if the OrientedBBox contains the given Rectangle.

Parameters:

rectangle¶

Rectangle to check.

Returns:

True if the Rectangle is inside the OrientedBBox, False otherwise

Return type:

bool

Usage Example:

rectangle = sly.Rectangle(150, 200, 400, 500)
is_inside = obb.contains_rectangle(rectangle)

convert(new_geometry, contour_radius=0, approx_epsilon=None)¶

Convert geometry to another geometry shape.

Parameters:

new_geometry¶

New geometry shape.

contour_radius : int¶

Radius of the contour.

approx_epsilon : float¶

Approximation epsilon.

Returns:

List of geometries.

Return type:

List[Geometry]

crop(clip)[source]¶

Crop the OrientedBBox by another OrientedBBox using the Sutherland-Hodgman algorithm.

draw(bitmap, color, thickness=1, config=None)¶

Parameters:

bitmap¶

np.ndarray

color¶

Color [R, G, B]

thickness=1¶

used only in Polyline and Point

config : dict¶

Drawing config specific to a concrete subclass, e.g. per edge colors

Raises:

NotImplementedError – if method is not implemented in subclass

draw_contour(bitmap, color, thickness=1, config=None)¶

Draws the figure contour on a given bitmap canvas :param bitmap: np.ndarray :param color: [R, G, B] :param thickness: (int) :param config: drawing config specific to a concrete subclass, e.g. per edge colors

fliplr(img_size)¶

Flips current Rectangle in horizontal.

Parameters:

img_size : Tuple[int, int]¶

Input image size (height, width) to which belongs Rectangle.

Returns:

Flipped Rectangle in horizontal.

Return type:

Rectangle

Usage Example:

# Remember that Rectangle class object is immutable, and we need to assign new instance of Rectangle to a new variable
height, width = 300, 400
fliplr_figure = figure.fliplr((height, width))

flipud(img_size)¶

Flips current Rectangle in vertical.

Parameters:

img_size : Tuple[int, int]¶

Input image size (height, width) to which belongs Rectangle.

Returns:

Flipped Rectangle in vertical.

Return type:

Rectangle

Usage Example:

# Remember that Rectangle class object is immutable, and we need to assign new instance of Rectangle to a new variable
height, width = 300, 400
flipud_figure = figure.flipud((height, width))

get_cropped_numpy_slice(data)[source]¶

Slice of given numpy array with OrientedBBox align bbox.

Parameters:

data : np.ndarray¶

Numpy array to slice.

Returns:

Sliced numpy array

Return type:

np.ndarray

Usage Example:

np_slice = np.zeros((200, 500))
mask_slice = figure.get_cropped_numpy_slice(np_slice)
print(mask_slice.shape)

get_mask(img_size)¶

Returns 2D boolean mask of the geometry. With shape as img_size (height, width) and filled with True values inside the geometry and False values outside. dtype = np.bool shape = img_size

Parameters:

img_size : Tuple[int, int]¶

size of the image (height, width)

Returns:

2D boolean mask of the geometry

Return type:

np.ndarray

intersects_with(rect)¶

Checks intersects Rectangle with given Rectangle object or not.

Parameters:

rect¶

Rectangle to check if it intersects with.

Returns:

True if given Rectangle intersects with Rectangle, otherwise False

Return type:

bool

Usage Example:

import supervisely as sly

rect = sly.Rectangle(90, 90, 400, 500)
print(figure.intersects_with(rect))
# Output: True

relative_crop(rect)¶

Crops object like “crop” method, but return results with coordinates relative to rect :param rect: Rectangle for crop. :type rect: Rectangle :returns: List of Geometry after relative crop. :rtype: List[Geometry]` :raises NotImplementedError: if method is not implemented in subclass

resize(in_size, out_size)¶

Resizes current Rectangle.

Parameters:

in_size : Tuple[int, int]¶

Input image size (height, width) to which belongs Rectangle.

out_size : Tuple[int, int]¶

Desired output image size (height, width) to which belongs Rectangle.

Returns:

Resized Rectangle.

Return type:

Rectangle

Usage Example:

# Remember that Rectangle class object is immutable, and we need to assign new instance of Rectangle to a new variable
in_height, in_width = 300, 400
out_height, out_width = 600, 800
resize_figure = figure.resize((in_height, in_width), (out_height, out_width))

rotate(rotator)¶

Rotates current Rectangle.

Parameters:

rotator¶

Class for object rotation.

Returns:

Rotated Rectangle.

Return type:

Rectangle

Usage Example:

from supervisely.geometry.image_rotator import ImageRotator

# Remember that Rectangle class object is immutable, and we need to assign new instance of Rectangle to a new variable
height, width = 300, 400
rotator = ImageRotator((height, width), 25)
rotate_figure = figure.rotate(rotator)

scale(factor)¶

Scales current Rectangle.

Parameters:

factor : float¶

Scale parameter.

Returns:

Scaled Rectangle.

Return type:

Rectangle

Usage Example:

# Remember that Rectangle class object is immutable, and we need to assign new instance of Rectangle to a new variable
scale_figure = figure.scale(0.75)

to_bbox()[source]¶

Convert the OrientedBBox to the axis-aligned Rectangle that fully contains the OrientedBBox.

Returns:

Axis-aligned Rectangle that fully contains the OrientedBBox.

Return type:

Rectangle

Usage Example:

axis_aligned_bbox = oriented_bbox.to_bbox()

to_json()[source]¶

Convert the OrientedBBox to a json dict. Read more about Supervisely format.

Returns:

Json format as a dict

Return type:

dict

Usage Example:

figure_json = figure.to_json()
print(figure_json)
# Output: {
#    "points": [
#        [100, 100],
#        [900, 700]
#    ],
#    "angle": 0.2618  # radians (15 degrees)
# }

to_size()¶

Height and width of Rectangle.

Returns:

Height and width of Rectangle.

Return type:

Tuple[int, int]

Usage Example:

height, width = figure.to_size()
print(height, width)
# Output: 700 900

translate(drow, dcol)¶

Translates current Rectangle.

Parameters:

drow : int¶

Horizontal shift.

dcol : int¶

Vertical shift.

Returns:

Translated Rectangle.

Return type:

Rectangle

Usage Example:

# Remember that Rectangle class object is immutable, and we need to assign new instance of Rectangle to a new variable
translate_figure = figure.translate(150, 250)

validate(obj_class_shape, settings)¶

Validate geometry.

Parameters:

obj_class_shape : str¶

Object class shape.

settings : dict¶

Settings.

Raises:

ValueError – if geometry validation error

property angle : int | float¶

Angle of rotation in radians. Positive values mean clockwise rotation.

Returns:

Angle of rotation in radians

Return type:

int or float

Usage Example:

angle = oriented_bbox.angle

property area : float¶

Rectangle area.

Returns:

Area of current Rectangle.

Return type:

float

Usage Example:

print(figure.area)
# Output: 7288.0

property bottom : int¶

Maximal vertical value of Rectangle.

Returns:

Maximal vertical value

Return type:

int

Usage Example:

print(figure.bottom)
# Output: 700

property center : supervisely.geometry.point_location.PointLocation¶

Center of Rectangle.

Returns:

Center of Rectangle.

Return type:

PointLocation

Usage Example:

center = figure.center()

property corners : list[PointLocation, PointLocation, PointLocation, PointLocation]¶

Get list of Rectangle corners.

Returns:

List of Rectangle corners.

Return type:

List[PointLocation]

Usage Example:

corners = figure.corners
for corner in corners:
    print(corner.row, corner.col)
# Output:
# 100 100
# 100 900
# 700 900
# 700 100

property height : int¶

Height of Rectangle

Returns:

Height

Return type:

int

Usage Example:

print(figure.height)
# Output: 601

property left : int¶

Minimal horizontal value of Rectangle.

Returns:

Minimal horizontal value

Return type:

int

Usage Example:

print(figure.left)
# Output: 100

property right : int¶

Maximal horizontal value of Rectangle.

Returns:

Maximal horizontal value

Return type:

int

Usage Example:

print(figure.right)
# Output: 900

property top : int¶

Minimal vertical value of Rectangle.

Returns:

Minimal vertical value

Return type:

int

Usage Example:

print(rectangle.top)
# Output: 100

property width : int¶

Width of Rectangle.

Returns:

Width

Return type:

int

Usage Example:

print(figure.width)
# Output: 801