monai.deploy.core.domain.DataPath

class monai.deploy.core.domain.DataPath(path, read_only=False, metadata=None)[source]

Bases: monai.deploy.core.domain.domain.Domain

Initializes a DataPath object.

Parameters
  • path (Union[str, Path]) – Path to the data file/directory.

  • read_only (bool) – True if the the file/directory path cannot be modified.

  • metadata (Optional[Dict]) – A metadata.

Methods

__init__(path[, read_only, metadata])

Initializes a DataPath object.

metadata()

rtype

Dict

to_absolute()

Convert the internal representation of the path to an absolute path.

Attributes

path

Returns the path of the data file/directory.

__init__(path, read_only=False, metadata=None)[source]

Initializes a DataPath object.

Parameters
  • path (Union[str, Path]) – Path to the data file/directory.

  • read_only (bool) – True if the the file/directory path cannot be modified.

  • metadata (Optional[Dict]) – A metadata.

property path

Returns the path of the data file/directory.

to_absolute()[source]

Convert the internal representation of the path to an absolute path.