CGraphicsItem#

class ikomia.core.pycore.CGraphicsItem#

Base class for all graphics items that aim to be displayed on top of images. Such graphics items are inserted into an overlay layer associated with an image. Image content is not modified so that it can be forwarded directly as input of another task. Moreover, graphics layer can also be forwarded as input of another task. One can imagine an example where we want to apply a specific process to tracked objects. Each graphics item has a type (see GraphicsItem for possible values) and a category (ie label).

Import

from ikomia.core import CGraphicsItem

Methods

`__init__`(self)	Default constructor
`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.
`insert_to_image`(arg1, arg2, arg3, arg4, ...)	Internal use only.
`is_text_item`(self)	Check whether item type is TEXT.
`set_category`(self, category)	Set the graphics item category.

Details

__init__((object)self) → None :#

Default constructor

__init__( (object)self, (GraphicsItem)type) -> None :: Constructor with item type definition

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