PyCore

Module offering core features to handle tasks, I/O, parameters and widgets. It consists of Python bindings from C++ Ikomia Core.

The extension capability of Ikomia platform is based on inheritance and this module offers the main base classes. The system uses the concept of worflow to process images. A worflow is a graph composed of processing tasks, each task comes with its parameters, its inputs and its outputs. Additionnally, a widget (for Graphical User Interface) is associated with the task to ensure user interaction. Through this API we provide base classes that you could override for each component.

Input/Output management

IODataType

Enum - List of available input/output data types

MeasureId

Enum - List of available measures

CMeasure

Class to handle available measures that can be computed on blob object in image.

CWorkflowTaskIO

Base class for the management of task inputs and outputs.

CWorkflowTaskIOFactory

Abstract class defining the core structure of the task I/O factory.

Parameters management

CWorkflowTaskParam

Base class for the management of task parameters.

ParamMap

Data structure (same as Python dict) to store task parameters names and values

Task management

ActionFlag

Enum - List of specific behaviors or actions that can be enable/disable for a task

TaskType

Enum - List of available process or task types

CWorkflowTask

Base class for all tasks that aim to be executed in a workflow.

Widget management

CWorkflowTaskWidget

Base class for all widgets associated with a task.

Graphics management

CPointF

Generic 2D point class.

GraphicsItem

Enum - List of available graphics item types (ie annotations)

GraphicsShape

Enum - List of available graphics shapes

CGraphicsItem

Base class for all graphics items that aim to be displayed on top of images.

CGraphicsComplexPolygon

Graphics item to display complex polygon (with holes) in the overlay layer of an image.

CGraphicsEllipse

Graphics item to display ellipse or circle in the overlay layer of an image.

CGraphicsPoint

Graphics item to display point in the overlay layer of an image.

CGraphicsPolygon

Graphics item to display polygon in the overlay layer of an image.

CGraphicsPolyline

Graphics item to display polyline in the overlay layer of an image.

CGraphicsRectangle

Graphics item to display rectangle or square in the overlay layer of an image.

CGraphicsText

Graphics item to display text in the overlay layer of an image.

GraphicsEllipseProperty

Visual properties for CGraphicsEllipse item.

GraphicsPointProperty

Visual properties for CGraphicsPoint item.

GraphicsPolygonProperty

Visual properties for CGraphicsPolygon item.

GraphicsPolylineProperty

Visual properties for CGraphicsPolyline item.

GraphicsRectProperty

Visual properties for CGraphicsRectangle item.

GraphicsTextProperty

Visual properties for CGraphicsText item.

CGraphicsConversion

Expose conversion operations based on graphics objects and images.