CGraphicsRectangle

class ikomia.core.pycore.CGraphicsRectangle

Graphics item to display rectangle or square in the overlay layer of an image. Such graphics is defined by:

• top-left point (x,y)

• width (float)

• height (float)

Derived from CGraphicsItem.

Import

from ikomia.core import CGraphicsRectangle

Methods

__init__(arg1)

__init__( (object)self) -> None :

Inherited methods

get_bounding_rect(self)	Get graphics item bounding rectangle.
get_category(self)	Get graphics item category.
get_id(self)	Get graphics item unique identifier.
get_type(self)	Get graphics item type.
is_text_item(self)	Check whether item type is TEXT.
set_category(self, category)	Set the graphics item category.

Attributes

height	Rectangle height
width	Rectangle width
x	x coordinate of top-left point
y	y coordinate of top-left point
property	Visual properties GraphicsRectProperty

Details

__init__((object)arg1) → None

__init__( (object)self) -> None :

Default constructor

__init__( (object)self, (float)left, (float)top, (float)width, (float)height) -> None :

Construct a rectangle graphics with the given dimensions.

Args:

left (float): x coordinate of the top-left point

top (float): y coordinate of the top-left point

width (float): rectangle width

height (float): rectangle height

__init__( (object)self, (float)left, (float)top, (float)width, (float)height, (GraphicsRectProperty)property) -> None :

Construct a rectangle graphics with the given dimensions.

Args:

left (float): x coordinate of the top-left point

top (float): y coordinate of the top-left point

width (float): rectangle width

height (float): rectangle height

property (GraphicsRectProperty): information and visual properties.

get_bounding_rect((CGraphicsItem)self) → object :

Get graphics item bounding rectangle.

Returns:

list of float: rectangle coordinate (left, top, width, height)

get_bounding_rect( (CGraphicsItem)arg1) -> None

get_category((CGraphicsItem)self) → str :

Get graphics item category.

Returns:

str: category (label)

get_category( (CGraphicsItem)arg1) -> None

get_id((CGraphicsItem)self) → int :

Get graphics item unique identifier.

Returns:

identifier

Return type:

int

get_type((CGraphicsItem)self) → GraphicsItem :

Get graphics item type. See GraphicsItem for possible values.

Returns:

type

Return type:

GraphicsItem

is_text_item((CGraphicsItem)self) → bool :

Check whether item type is TEXT. In case of object detection workflow, text graphics items should not be useful as input for another task. This method enables to filter only shape-based items (rectangle, polygon…) when processing graphics input.

Returns:

bool: True or False

is_text_item( (CGraphicsItem)self) -> bool

set_category((CGraphicsItem)self, (str)category) → None :

Set the graphics item category. It’s just a generic way to identify the item.

Args:

category (str): identification label

set_category( (CGraphicsItem)arg1, (str)arg2) -> None