CPathIO

class ikomia.dataprocess.pydataprocess.CPathIO

Define input or output for a task to handle file or folder path. Derived from CWorkflowTaskIO.

Import

from ikomia.dataprocess import CPathIO

Methods

__init__(arg1)

__init__( (object)self) -> None :

get_path(self)

Get the path of the input/output.

set_path(self, path)

Set the path of the input/output.

Overridden methods

clear_data(self)

Clear the data stored in the object.

is_data_available(self)

Check whether the video contains valid data.

Inherited methods

copy_static_data(self, io)

Copy the static data from the given input or ouput.

get_unit_element_count(self)

Get the number of unit elements in terms of processing scheme.

Attributes

auto_save

Auto-save status

data_type

I/O data type

dim_count

Number of dimensions

description

Custom description to explain input/output type and use

displayable

Displayable status (Ikomia Studio)

name

I/O name

source_file_path

Path to the source file used as workflow input (if any)

Details

__init__((object)arg1) → None
__init__( (object)self) -> None :

Default constructor

__init__( (object)self, (IODataType)data_type) -> None :

Construct a CPathIO instance with the given data type. Data type can be either a file or folder path (see IODataType).

__init__( (object)self, (IODataType)data_type, (str)path) -> None :

Construct a CPathIO instance with the given data type and path. Data type can be either a file or folder path (see IODataType).

__init__( (object)self, (IODataType)data_type, (str)path, (str)name) -> None :

Construct a CPathIO instance with the given data type, path and name. Data type can be either a file or folder path (see IODataType).

clear_data((CPathIO)self) → None :

Clear the data stored in the object. Should be overriden for custom input or output.

clear_data( (CPathIO)self) -> None

copy_static_data((CWorkflowTaskIO)self, (CWorkflowTaskIO)io) → None :

Copy the static data from the given input or ouput. Static data are those which are not generated at runtime. Should be overriden for custom input or output.

Args:

CWorkflowTaskIO: input or ouput instance from which data is copied

copy_static_data( (CWorkflowTaskIO)self, (CWorkflowTaskIO)io) -> None

get_path((CPathIO)self) → str :

Get the path of the input/output.

get_unit_element_count((CWorkflowTaskIO)self) → int :

Get the number of unit elements in terms of processing scheme. This value is used to define the number of progress steps for progress bar component in Ikomia STUDIO. For an image, the count is 1. For Z-stack volume, the count is the number of Z levels. Should be overriden for custom input or output.

Returns:

int: number of unit element to process

get_unit_element_count( (CWorkflowTaskIO)self) -> int

is_data_available((CPathIO)self) → bool :

Check whether the video contains valid data.

Returns:

bool: True if there is some valid data, False otherwise

is_data_available( (CPathIO)self) -> bool

set_path((CPathIO)self, (str)path) → None :

Set the path of the input/output. The path must exist.