holoscan.resources

This module provides a Python API to underlying C++ API Resources.

class holoscan.resources.Allocator

Bases: <a href="holoscan_python_api_gxf.html#holoscan.gxf.GXFResource">holoscan.gxf._gxf.GXFResource</a>

Base allocator class.

Attributes

<a href="#holoscan.resources.Allocator.args">args</a>	The list of arguments associated with the component.
<a href="#holoscan.resources.Allocator.block_size">block_size</a>	Get the block size of the allocator.
<a href="#holoscan.resources.Allocator.description">description</a>	YAML formatted string describing the resource.
<a href="#holoscan.resources.Allocator.fragment">fragment</a>	Fragment that the resource belongs to.
<a href="#holoscan.resources.Allocator.gxf_cid">gxf_cid</a>	The GXF component ID.
<a href="#holoscan.resources.Allocator.gxf_cname">gxf_cname</a>	The name of the component.
<a href="#holoscan.resources.Allocator.gxf_context">gxf_context</a>	The GXF context of the component.
<a href="#holoscan.resources.Allocator.gxf_eid">gxf_eid</a>	The GXF entity ID.
<a href="#holoscan.resources.Allocator.gxf_typename">gxf_typename</a>	The GXF type name of the component.
<a href="#holoscan.resources.Allocator.id">id</a>	The identifier of the component.
<a href="#holoscan.resources.Allocator.name">name</a>	The name of the resource.
<a href="#holoscan.resources.Allocator.resource_type">resource_type</a>	Resource type.

spec

Methods

<a href="#holoscan.resources.Allocator.add_arg">add_arg</a>(*args, **kwargs)	Overloaded function.
<a href="#holoscan.resources.Allocator.allocate">allocate</a>(self, size, type)	Allocate the requested amount of memory.
<a href="#holoscan.resources.Allocator.free">free</a>(self, pointer)	Free the allocated memory
<a href="#holoscan.resources.Allocator.gxf_initialize">gxf_initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.Allocator.initialize">initialize</a>(self)	initialization method for the resource.
<a href="#holoscan.resources.Allocator.is_available">is_available</a>(self, size)	Boolean representing whether the resource is available.
<a href="#holoscan.resources.Allocator.setup">setup</a>(self, arg0)	setup method for the resource.

ResourceType

class ResourceType

Bases: pybind11_builtins.pybind11_object

Members:

NATIVE

GXF

Attributes

<a href="#holoscan.resources.Allocator.ResourceType.name">name</a>

value

GXF = <ResourceType.GXF: 1>

NATIVE = <ResourceType.NATIVE: 0>

__init__(self: holoscan.core._core.Resource.ResourceType, value: int) → None

property name

property value

__init__(self: holoscan.resources._resources.Allocator) → None

Base allocator class.

add_arg(*args, **kwargs)

Overloaded function.

1. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.Arg) -> None

Add an argument to the component.

2. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.ArgList) -> None

Add a list of arguments to the component.

allocate(self: holoscan.resources._resources.Allocator, size: int, type: holoscan.resources._resources.MemoryStorageType) → int

Allocate the requested amount of memory.

Parameters

sizeint

The amount of memory to allocate

typeholoscan.resources.MemoryStorageType

Enum representing the type of memory to allocate.

Returns

Opaque PyCapsule object representing a std::byte* pointer to the allocated memory.

property args

The list of arguments associated with the component.

Returns

arglistholoscan.core.ArgList

property block_size

Get the block size of the allocator.

Returns

int

The block size of the allocator. Returns 1 for byte-based allocators.

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

nameholoscan.core.Fragment

free(self: holoscan.resources._resources.Allocator, pointer: int) → None

Free the allocated memory

Parameters

pointerPyCapsule

Opaque PyCapsule object representing a std::byte* pointer to the allocated memory.

property gxf_cid

The GXF component ID.

property gxf_cname

The name of the component.

property gxf_context

The GXF context of the component.

property gxf_eid

The GXF entity ID.

gxf_initialize(self: holoscan.gxf._gxf.GXFComponent) → None

Initialize the component.

property gxf_typename

The GXF type name of the component.

Returns

str

The GXF type name of the component.

property id

The identifier of the component.

The identifier is initially set to -1, and will become a valid value when the component is initialized.

With the default executor (holoscan.gxf.GXFExecutor), the identifier is set to the GXF component ID.

Returns

idint

initialize(self: holoscan.core._core.Resource) → None

initialization method for the resource.

is_available(self: holoscan.resources._resources.Allocator, size: int) → bool

Boolean representing whether the resource is available.

Returns

bool

Availability of the resource.

property name

The name of the resource.

Returns

namestr

property resource_type

Resource type.

holoscan.core.Resource.ResourceType enum representing the type of the operator. The two types currently implemented are NATIVE and GXF.

setup(self: holoscan.core._core.Resource, arg0: holoscan.core._core.ComponentSpec) → None

setup method for the resource.

property spec

class holoscan.resources.BlockMemoryPool

Bases: <a href="#holoscan.resources.Allocator">holoscan.resources._resources.Allocator</a>

Block memory pool resource.

Provides a maximum number of equally sized blocks of memory.

Parameters

fragmentholoscan.core.Fragment

The fragment to assign the resource to.

storage_typeint or holoscan.resources.MemoryStorageType

The storage type (0=Host, 1=Device, 2=System).

block_sizeint

The size of each block in the memory pool (in bytes).

num_blocksint

The number of blocks in the memory pool.

dev_idint

CUDA device ID. Specifies the device on which to create the memory pool.

namestr, optional

The name of the memory pool.

Attributes

<a href="#holoscan.resources.BlockMemoryPool.args">args</a>	The list of arguments associated with the component.
<a href="#holoscan.resources.BlockMemoryPool.block_size">block_size</a>	Get the block size of the allocator.
<a href="#holoscan.resources.BlockMemoryPool.description">description</a>	YAML formatted string describing the resource.
<a href="#holoscan.resources.BlockMemoryPool.fragment">fragment</a>	Fragment that the resource belongs to.
<a href="#holoscan.resources.BlockMemoryPool.gxf_cid">gxf_cid</a>	The GXF component ID.
<a href="#holoscan.resources.BlockMemoryPool.gxf_cname">gxf_cname</a>	The name of the component.
<a href="#holoscan.resources.BlockMemoryPool.gxf_context">gxf_context</a>	The GXF context of the component.
<a href="#holoscan.resources.BlockMemoryPool.gxf_eid">gxf_eid</a>	The GXF entity ID.
<a href="#holoscan.resources.BlockMemoryPool.gxf_typename">gxf_typename</a>	The GXF type name of the component.
<a href="#holoscan.resources.BlockMemoryPool.id">id</a>	The identifier of the component.
<a href="#holoscan.resources.BlockMemoryPool.name">name</a>	The name of the resource.
<a href="#holoscan.resources.BlockMemoryPool.resource_type">resource_type</a>	Resource type.

spec

Methods

<a href="#holoscan.resources.BlockMemoryPool.add_arg">add_arg</a>(*args, **kwargs)	Overloaded function.
<a href="#holoscan.resources.BlockMemoryPool.allocate">allocate</a>(self, size, type)	Allocate the requested amount of memory.
<a href="#holoscan.resources.BlockMemoryPool.free">free</a>(self, pointer)	Free the allocated memory
<a href="#holoscan.resources.BlockMemoryPool.gxf_initialize">gxf_initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.BlockMemoryPool.initialize">initialize</a>(self)	initialization method for the resource.
<a href="#holoscan.resources.BlockMemoryPool.is_available">is_available</a>(self, size)	Boolean representing whether the resource is available.
<a href="#holoscan.resources.BlockMemoryPool.setup">setup</a>(self, arg0)	setup method for the resource.

ResourceType

class ResourceType

Bases: pybind11_builtins.pybind11_object

Members:

NATIVE

GXF

Attributes

<a href="#holoscan.resources.BlockMemoryPool.ResourceType.name">name</a>

value

GXF = <ResourceType.GXF: 1>

NATIVE = <ResourceType.NATIVE: 0>

__init__(self: holoscan.core._core.Resource.ResourceType, value: int) → None

property name

property value

__init__(self: holoscan.resources._resources.BlockMemoryPool, fragment: holoscan.core._core.Fragment, storage_type: int, block_size: int, num_blocks: int, dev_id: int = 0, name: str = 'block_memory_pool') → None

Block memory pool resource.

Provides a maximum number of equally sized blocks of memory.

Parameters

fragmentholoscan.core.Fragment

The fragment to assign the resource to.

storage_typeint or holoscan.resources.MemoryStorageType

The storage type (0=Host, 1=Device, 2=System).

block_sizeint

The size of each block in the memory pool (in bytes).

num_blocksint

The number of blocks in the memory pool.

dev_idint

CUDA device ID. Specifies the device on which to create the memory pool.

namestr, optional

The name of the memory pool.

add_arg(*args, **kwargs)

Overloaded function.

1. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.Arg) -> None

Add an argument to the component.

2. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.ArgList) -> None

Add a list of arguments to the component.

allocate(self: holoscan.resources._resources.Allocator, size: int, type: holoscan.resources._resources.MemoryStorageType) → int

Allocate the requested amount of memory.

Parameters

sizeint

The amount of memory to allocate

typeholoscan.resources.MemoryStorageType

Enum representing the type of memory to allocate.

Returns

Opaque PyCapsule object representing a std::byte* pointer to the allocated memory.

property args

The list of arguments associated with the component.

Returns

arglistholoscan.core.ArgList

property block_size

Get the block size of the allocator.

Returns

int

The block size of the allocator. Returns 1 for byte-based allocators.

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

nameholoscan.core.Fragment

free(self: holoscan.resources._resources.Allocator, pointer: int) → None

Free the allocated memory

Parameters

pointerPyCapsule

Opaque PyCapsule object representing a std::byte* pointer to the allocated memory.

property gxf_cid

The GXF component ID.

property gxf_cname

The name of the component.

property gxf_context

The GXF context of the component.

property gxf_eid

The GXF entity ID.

gxf_initialize(self: holoscan.gxf._gxf.GXFComponent) → None

Initialize the component.

property gxf_typename

The GXF type name of the component.

Returns

str

The GXF type name of the component.

property id

The identifier of the component.

The identifier is initially set to -1, and will become a valid value when the component is initialized.

With the default executor (holoscan.gxf.GXFExecutor), the identifier is set to the GXF component ID.

Returns

idint

initialize(self: holoscan.core._core.Resource) → None

initialization method for the resource.

is_available(self: holoscan.resources._resources.Allocator, size: int) → bool

Boolean representing whether the resource is available.

Returns

bool

Availability of the resource.

property name

The name of the resource.

Returns

namestr

property resource_type

Resource type.

holoscan.core.Resource.ResourceType enum representing the type of the operator. The two types currently implemented are NATIVE and GXF.

setup(self: holoscan.core._core.Resource, arg0: holoscan.core._core.ComponentSpec) → None

setup method for the resource.

property spec

class holoscan.resources.Clock

Bases: <a href="holoscan_python_api_gxf.html#holoscan.gxf.GXFResource">holoscan.gxf._gxf.GXFResource</a>

Base clock class.

Attributes

<a href="#holoscan.resources.Clock.args">args</a>	The list of arguments associated with the component.
<a href="#holoscan.resources.Clock.description">description</a>	YAML formatted string describing the resource.
<a href="#holoscan.resources.Clock.fragment">fragment</a>	Fragment that the resource belongs to.
<a href="#holoscan.resources.Clock.gxf_cid">gxf_cid</a>	The GXF component ID.
<a href="#holoscan.resources.Clock.gxf_cname">gxf_cname</a>	The name of the component.
<a href="#holoscan.resources.Clock.gxf_context">gxf_context</a>	The GXF context of the component.
<a href="#holoscan.resources.Clock.gxf_eid">gxf_eid</a>	The GXF entity ID.
<a href="#holoscan.resources.Clock.gxf_typename">gxf_typename</a>	The GXF type name of the component.
<a href="#holoscan.resources.Clock.id">id</a>	The identifier of the component.
<a href="#holoscan.resources.Clock.name">name</a>	The name of the resource.
<a href="#holoscan.resources.Clock.resource_type">resource_type</a>	Resource type.

spec

Methods

<a href="#holoscan.resources.Clock.add_arg">add_arg</a>(*args, **kwargs)	Overloaded function.
<a href="#holoscan.resources.Clock.gxf_initialize">gxf_initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.Clock.initialize">initialize</a>(self)	initialization method for the resource.
<a href="#holoscan.resources.Clock.setup">setup</a>(self, arg0)	setup method for the resource.

ResourceType

class ResourceType

Bases: pybind11_builtins.pybind11_object

Members:

NATIVE

GXF

Attributes

<a href="#holoscan.resources.Clock.ResourceType.name">name</a>

value

GXF = <ResourceType.GXF: 1>

NATIVE = <ResourceType.NATIVE: 0>

__init__(self: holoscan.core._core.Resource.ResourceType, value: int) → None

property name

property value

__init__(*args, **kwargs)

add_arg(*args, **kwargs)

Overloaded function.

1. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.Arg) -> None

Add an argument to the component.

2. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.ArgList) -> None

Add a list of arguments to the component.

property args

The list of arguments associated with the component.

Returns

arglistholoscan.core.ArgList

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

nameholoscan.core.Fragment

property gxf_cid

The GXF component ID.

property gxf_cname

The name of the component.

property gxf_context

The GXF context of the component.

property gxf_eid

The GXF entity ID.

gxf_initialize(self: holoscan.gxf._gxf.GXFComponent) → None

Initialize the component.

property gxf_typename

The GXF type name of the component.

Returns

str

The GXF type name of the component.

property id

The identifier of the component.

The identifier is initially set to -1, and will become a valid value when the component is initialized.

With the default executor (holoscan.gxf.GXFExecutor), the identifier is set to the GXF component ID.

Returns

idint

initialize(self: holoscan.core._core.Resource) → None

initialization method for the resource.

property name

The name of the resource.

Returns

namestr

property resource_type

Resource type.

holoscan.core.Resource.ResourceType enum representing the type of the operator. The two types currently implemented are NATIVE and GXF.

setup(self: holoscan.core._core.Resource, arg0: holoscan.core._core.ComponentSpec) → None

setup method for the resource.

property spec

class holoscan.resources.CudaAllocator

Bases: <a href="#holoscan.resources.Allocator">holoscan.resources._resources.Allocator</a>

Base class for CUDA-based allocators.

Attributes

<a href="#holoscan.resources.CudaAllocator.args">args</a>	The list of arguments associated with the component.
<a href="#holoscan.resources.CudaAllocator.block_size">block_size</a>	Get the block size of the allocator.
<a href="#holoscan.resources.CudaAllocator.description">description</a>	YAML formatted string describing the resource.
<a href="#holoscan.resources.CudaAllocator.fragment">fragment</a>	Fragment that the resource belongs to.
<a href="#holoscan.resources.CudaAllocator.gxf_cid">gxf_cid</a>	The GXF component ID.
<a href="#holoscan.resources.CudaAllocator.gxf_cname">gxf_cname</a>	The name of the component.
<a href="#holoscan.resources.CudaAllocator.gxf_context">gxf_context</a>	The GXF context of the component.
<a href="#holoscan.resources.CudaAllocator.gxf_eid">gxf_eid</a>	The GXF entity ID.
<a href="#holoscan.resources.CudaAllocator.gxf_typename">gxf_typename</a>	The GXF type name of the component.
<a href="#holoscan.resources.CudaAllocator.id">id</a>	The identifier of the component.
<a href="#holoscan.resources.CudaAllocator.name">name</a>	The name of the resource.
<a href="#holoscan.resources.CudaAllocator.pool_size">pool_size</a>	Return the memory pool size for the specified storage type.
<a href="#holoscan.resources.CudaAllocator.resource_type">resource_type</a>	Resource type.

spec

Methods

<a href="#holoscan.resources.CudaAllocator.add_arg">add_arg</a>(*args, **kwargs)	Overloaded function.
<a href="#holoscan.resources.CudaAllocator.allocate">allocate</a>(self, size, type)	Allocate the requested amount of memory.
<a href="#holoscan.resources.CudaAllocator.free">free</a>(self, pointer)	Free the allocated memory
<a href="#holoscan.resources.CudaAllocator.gxf_initialize">gxf_initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.CudaAllocator.initialize">initialize</a>(self)	initialization method for the resource.
<a href="#holoscan.resources.CudaAllocator.is_available">is_available</a>(self, size)	Boolean representing whether the resource is available.
<a href="#holoscan.resources.CudaAllocator.setup">setup</a>(self, arg0)	setup method for the resource.

ResourceType

class ResourceType

Bases: pybind11_builtins.pybind11_object

Members:

NATIVE

GXF

Attributes

<a href="#holoscan.resources.CudaAllocator.ResourceType.name">name</a>

value

GXF = <ResourceType.GXF: 1>

NATIVE = <ResourceType.NATIVE: 0>

__init__(self: holoscan.core._core.Resource.ResourceType, value: int) → None

property name

property value

__init__(self: holoscan.resources._resources.CudaAllocator) → None

Base class for CUDA-based allocators.

add_arg(*args, **kwargs)

Overloaded function.

1. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.Arg) -> None

Add an argument to the component.

2. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.ArgList) -> None

Add a list of arguments to the component.

allocate(self: holoscan.resources._resources.Allocator, size: int, type: holoscan.resources._resources.MemoryStorageType) → int

Allocate the requested amount of memory.

Parameters

sizeint

The amount of memory to allocate

typeholoscan.resources.MemoryStorageType

Enum representing the type of memory to allocate.

Returns

Opaque PyCapsule object representing a std::byte* pointer to the allocated memory.

property args

The list of arguments associated with the component.

Returns

arglistholoscan.core.ArgList

property block_size

Get the block size of the allocator.

Returns

int

The block size of the allocator. Returns 1 for byte-based allocators.

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

nameholoscan.core.Fragment

free(self: holoscan.resources._resources.Allocator, pointer: int) → None

Free the allocated memory

Parameters

pointerPyCapsule

Opaque PyCapsule object representing a std::byte* pointer to the allocated memory.

property gxf_cid

The GXF component ID.

property gxf_cname

The name of the component.

property gxf_context

The GXF context of the component.

property gxf_eid

The GXF entity ID.

gxf_initialize(self: holoscan.gxf._gxf.GXFComponent) → None

Initialize the component.

property gxf_typename

The GXF type name of the component.

Returns

str

The GXF type name of the component.

property id

The identifier of the component.

The identifier is initially set to -1, and will become a valid value when the component is initialized.

With the default executor (holoscan.gxf.GXFExecutor), the identifier is set to the GXF component ID.

Returns

idint

initialize(self: holoscan.core._core.Resource) → None

initialization method for the resource.

is_available(self: holoscan.resources._resources.Allocator, size: int) → bool

Boolean representing whether the resource is available.

Returns

bool

Availability of the resource.

property name

The name of the resource.

Returns

namestr

property pool_size

Return the memory pool size for the specified storage type.

Parameters

storage_typeholoscan.resources.MemoryStorageType

Enum representing the type of memory to allocate.

Returns

sizeint

The size of the memory pool for the specified storage type.

property resource_type

Resource type.

holoscan.core.Resource.ResourceType enum representing the type of the operator. The two types currently implemented are NATIVE and GXF.

setup(self: holoscan.core._core.Resource, arg0: holoscan.core._core.ComponentSpec) → None

setup method for the resource.

property spec

class holoscan.resources.CudaStreamPool

Bases: <a href="#holoscan.resources.Allocator">holoscan.resources._resources.Allocator</a>

CUDA stream pool.

Parameters

fragmentholoscan.core.Fragment

The fragment to assign the resource to.

dev_idint

CUDA device ID. Specifies the device on which to create the stream pool.

stream_flagsint

Flags for CUDA streams in the pool. This will be passed to CUDA’s cudaStreamCreateWithPriority [R47f67d935b70-1] when creating the streams. The default value of 0 corresponds to cudaStreamDefault. A value of 1 corresponds to cudaStreamNonBlocking, indicating that the stream can run concurrently with work in stream 0 (default stream) and should not perform any implicit synchronization with it.

stream_priorityint

Priority value for CUDA streams in the pool. This is an integer value passed to cudaSreamCreateWithPriority [R47f67d935b70-1]. Lower numbers represent higher priorities.

reserved_sizeint

The number of CUDA streams to initially reserve in the pool (prior to first request).

max_sizeint

The maximum number of streams that can be allocated, unlimited by default.

namestr, optional

The name of the stream pool.

References

[1]

https://docs.nvidia.com/cuda/cuda-runtime-api/group__CUDART__STREAM.html

Attributes

<a href="#holoscan.resources.CudaStreamPool.args">args</a>	The list of arguments associated with the component.
<a href="#holoscan.resources.CudaStreamPool.block_size">block_size</a>	Get the block size of the allocator.
<a href="#holoscan.resources.CudaStreamPool.description">description</a>	YAML formatted string describing the resource.
<a href="#holoscan.resources.CudaStreamPool.fragment">fragment</a>	Fragment that the resource belongs to.
<a href="#holoscan.resources.CudaStreamPool.gxf_cid">gxf_cid</a>	The GXF component ID.
<a href="#holoscan.resources.CudaStreamPool.gxf_cname">gxf_cname</a>	The name of the component.
<a href="#holoscan.resources.CudaStreamPool.gxf_context">gxf_context</a>	The GXF context of the component.
<a href="#holoscan.resources.CudaStreamPool.gxf_eid">gxf_eid</a>	The GXF entity ID.
<a href="#holoscan.resources.CudaStreamPool.gxf_typename">gxf_typename</a>	The GXF type name of the component.
<a href="#holoscan.resources.CudaStreamPool.id">id</a>	The identifier of the component.
<a href="#holoscan.resources.CudaStreamPool.name">name</a>	The name of the resource.
<a href="#holoscan.resources.CudaStreamPool.resource_type">resource_type</a>	Resource type.

spec

Methods

<a href="#holoscan.resources.CudaStreamPool.add_arg">add_arg</a>(*args, **kwargs)	Overloaded function.
<a href="#holoscan.resources.CudaStreamPool.allocate">allocate</a>(self, size, type)	Allocate the requested amount of memory.
<a href="#holoscan.resources.CudaStreamPool.free">free</a>(self, pointer)	Free the allocated memory
<a href="#holoscan.resources.CudaStreamPool.gxf_initialize">gxf_initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.CudaStreamPool.initialize">initialize</a>(self)	initialization method for the resource.
<a href="#holoscan.resources.CudaStreamPool.is_available">is_available</a>(self, size)	Boolean representing whether the resource is available.
<a href="#holoscan.resources.CudaStreamPool.setup">setup</a>(self, arg0)	setup method for the resource.

ResourceType

class ResourceType

Bases: pybind11_builtins.pybind11_object

Members:

NATIVE

GXF

Attributes

<a href="#holoscan.resources.CudaStreamPool.ResourceType.name">name</a>

value

GXF = <ResourceType.GXF: 1>

NATIVE = <ResourceType.NATIVE: 0>

__init__(self: holoscan.core._core.Resource.ResourceType, value: int) → None

property name

property value

__init__(self: holoscan.resources._resources.CudaStreamPool, fragment: holoscan.core._core.Fragment, dev_id: int = 0, stream_flags: int = 0, stream_priority: int = 0, reserved_size: int = 1, max_size: int = 0, name: str = 'cuda_stream_pool') → None

CUDA stream pool.

Parameters

fragmentholoscan.core.Fragment

The fragment to assign the resource to.

dev_idint

CUDA device ID. Specifies the device on which to create the stream pool.

stream_flagsint

Flags for CUDA streams in the pool. This will be passed to CUDA’s cudaStreamCreateWithPriority [Rb9bddbe55e1a-1] when creating the streams. The default value of 0 corresponds to cudaStreamDefault. A value of 1 corresponds to cudaStreamNonBlocking, indicating that the stream can run concurrently with work in stream 0 (default stream) and should not perform any implicit synchronization with it.

stream_priorityint

Priority value for CUDA streams in the pool. This is an integer value passed to cudaSreamCreateWithPriority [Rb9bddbe55e1a-1]. Lower numbers represent higher priorities.

reserved_sizeint

The number of CUDA streams to initially reserve in the pool (prior to first request).

max_sizeint

The maximum number of streams that can be allocated, unlimited by default.

namestr, optional

The name of the stream pool.

References

[1]

https://docs.nvidia.com/cuda/cuda-runtime-api/group__CUDART__STREAM.html

add_arg(*args, **kwargs)

Overloaded function.

1. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.Arg) -> None

Add an argument to the component.

2. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.ArgList) -> None

Add a list of arguments to the component.

allocate(self: holoscan.resources._resources.Allocator, size: int, type: holoscan.resources._resources.MemoryStorageType) → int

Allocate the requested amount of memory.

Parameters

sizeint

The amount of memory to allocate

typeholoscan.resources.MemoryStorageType

Enum representing the type of memory to allocate.

Returns

Opaque PyCapsule object representing a std::byte* pointer to the allocated memory.

property args

The list of arguments associated with the component.

Returns

arglistholoscan.core.ArgList

property block_size

Get the block size of the allocator.

Returns

int

The block size of the allocator. Returns 1 for byte-based allocators.

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

nameholoscan.core.Fragment

free(self: holoscan.resources._resources.Allocator, pointer: int) → None

Free the allocated memory

Parameters

pointerPyCapsule

Opaque PyCapsule object representing a std::byte* pointer to the allocated memory.

property gxf_cid

The GXF component ID.

property gxf_cname

The name of the component.

property gxf_context

The GXF context of the component.

property gxf_eid

The GXF entity ID.

gxf_initialize(self: holoscan.gxf._gxf.GXFComponent) → None

Initialize the component.

property gxf_typename

The GXF type name of the component.

Returns

str

The GXF type name of the component.

property id

The identifier of the component.

The identifier is initially set to -1, and will become a valid value when the component is initialized.

With the default executor (holoscan.gxf.GXFExecutor), the identifier is set to the GXF component ID.

Returns

idint

initialize(self: holoscan.core._core.Resource) → None

initialization method for the resource.

is_available(self: holoscan.resources._resources.Allocator, size: int) → bool

Boolean representing whether the resource is available.

Returns

bool

Availability of the resource.

property name

The name of the resource.

Returns

namestr

property resource_type

Resource type.

holoscan.core.Resource.ResourceType enum representing the type of the operator. The two types currently implemented are NATIVE and GXF.

setup(self: holoscan.core._core.Resource, arg0: holoscan.core._core.ComponentSpec) → None

setup method for the resource.

property spec

class holoscan.resources.DoubleBufferReceiver

Bases: <a href="#holoscan.resources.Receiver">holoscan.resources._resources.Receiver</a>

Receiver using a double-buffered queue.

New messages are first pushed to a back stage.

Parameters

fragmentholoscan.core.Fragment

The fragment to assign the resource to.

capacityint, optional

The capacity of the receiver.

policyint, optional

The policy to use (0=pop, 1=reject, 2=fault).

namestr, optional

The name of the receiver.

Attributes

<a href="#holoscan.resources.DoubleBufferReceiver.args">args</a>	The list of arguments associated with the component.
<a href="#holoscan.resources.DoubleBufferReceiver.description">description</a>	YAML formatted string describing the resource.
<a href="#holoscan.resources.DoubleBufferReceiver.fragment">fragment</a>	Fragment that the resource belongs to.
<a href="#holoscan.resources.DoubleBufferReceiver.gxf_cid">gxf_cid</a>	The GXF component ID.
<a href="#holoscan.resources.DoubleBufferReceiver.gxf_cname">gxf_cname</a>	The name of the component.
<a href="#holoscan.resources.DoubleBufferReceiver.gxf_context">gxf_context</a>	The GXF context of the component.
<a href="#holoscan.resources.DoubleBufferReceiver.gxf_eid">gxf_eid</a>	The GXF entity ID.
<a href="#holoscan.resources.DoubleBufferReceiver.gxf_typename">gxf_typename</a>	The GXF type name of the component.
<a href="#holoscan.resources.DoubleBufferReceiver.id">id</a>	The identifier of the component.
<a href="#holoscan.resources.DoubleBufferReceiver.name">name</a>	The name of the resource.
<a href="#holoscan.resources.DoubleBufferReceiver.resource_type">resource_type</a>	Resource type.

spec

Methods

<a href="#holoscan.resources.DoubleBufferReceiver.add_arg">add_arg</a>(*args, **kwargs)	Overloaded function.
<a href="#holoscan.resources.DoubleBufferReceiver.gxf_initialize">gxf_initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.DoubleBufferReceiver.initialize">initialize</a>(self)	initialization method for the resource.
<a href="#holoscan.resources.DoubleBufferReceiver.setup">setup</a>(self, arg0)	setup method for the resource.

ResourceType

class ResourceType

Bases: pybind11_builtins.pybind11_object

Members:

NATIVE

GXF

Attributes

<a href="#holoscan.resources.DoubleBufferReceiver.ResourceType.name">name</a>

value

GXF = <ResourceType.GXF: 1>

NATIVE = <ResourceType.NATIVE: 0>

__init__(self: holoscan.core._core.Resource.ResourceType, value: int) → None

property name

property value

__init__(self: holoscan.resources._resources.DoubleBufferReceiver, fragment: holoscan.core._core.Fragment, capacity: int = 1, policy: int = 2, name: str = 'double_buffer_receiver') → None

Receiver using a double-buffered queue.

New messages are first pushed to a back stage.

Parameters

fragmentholoscan.core.Fragment

The fragment to assign the resource to.

capacityint, optional

The capacity of the receiver.

policyint, optional

The policy to use (0=pop, 1=reject, 2=fault).

namestr, optional

The name of the receiver.

add_arg(*args, **kwargs)

Overloaded function.

1. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.Arg) -> None

Add an argument to the component.

2. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.ArgList) -> None

Add a list of arguments to the component.

property args

The list of arguments associated with the component.

Returns

arglistholoscan.core.ArgList

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

nameholoscan.core.Fragment

property gxf_cid

The GXF component ID.

property gxf_cname

The name of the component.

property gxf_context

The GXF context of the component.

property gxf_eid

The GXF entity ID.

gxf_initialize(self: holoscan.gxf._gxf.GXFComponent) → None

Initialize the component.

property gxf_typename

The GXF type name of the component.

Returns

str

The GXF type name of the component.

property id

The identifier of the component.

The identifier is initially set to -1, and will become a valid value when the component is initialized.

With the default executor (holoscan.gxf.GXFExecutor), the identifier is set to the GXF component ID.

Returns

idint

initialize(self: holoscan.core._core.Resource) → None

initialization method for the resource.

property name

The name of the resource.

Returns

namestr

property resource_type

Resource type.

holoscan.core.Resource.ResourceType enum representing the type of the operator. The two types currently implemented are NATIVE and GXF.

setup(self: holoscan.core._core.Resource, arg0: holoscan.core._core.ComponentSpec) → None

setup method for the resource.

property spec

class holoscan.resources.DoubleBufferTransmitter

Bases: <a href="#holoscan.resources.Transmitter">holoscan.resources._resources.Transmitter</a>

Transmitter using a double-buffered queue.

Messages are pushed to a back stage after they are published.

Parameters

fragmentholoscan.core.Fragment

The fragment to assign the resource to.

capacityint, optional

The capacity of the transmitter.

policyint, optional

The policy to use (0=pop, 1=reject, 2=fault).

namestr, optional

The name of the transmitter.

Attributes

<a href="#holoscan.resources.DoubleBufferTransmitter.args">args</a>	The list of arguments associated with the component.
<a href="#holoscan.resources.DoubleBufferTransmitter.description">description</a>	YAML formatted string describing the resource.
<a href="#holoscan.resources.DoubleBufferTransmitter.fragment">fragment</a>	Fragment that the resource belongs to.
<a href="#holoscan.resources.DoubleBufferTransmitter.gxf_cid">gxf_cid</a>	The GXF component ID.
<a href="#holoscan.resources.DoubleBufferTransmitter.gxf_cname">gxf_cname</a>	The name of the component.
<a href="#holoscan.resources.DoubleBufferTransmitter.gxf_context">gxf_context</a>	The GXF context of the component.
<a href="#holoscan.resources.DoubleBufferTransmitter.gxf_eid">gxf_eid</a>	The GXF entity ID.
<a href="#holoscan.resources.DoubleBufferTransmitter.gxf_typename">gxf_typename</a>	The GXF type name of the component.
<a href="#holoscan.resources.DoubleBufferTransmitter.id">id</a>	The identifier of the component.
<a href="#holoscan.resources.DoubleBufferTransmitter.name">name</a>	The name of the resource.
<a href="#holoscan.resources.DoubleBufferTransmitter.resource_type">resource_type</a>	Resource type.

spec

Methods

<a href="#holoscan.resources.DoubleBufferTransmitter.add_arg">add_arg</a>(*args, **kwargs)	Overloaded function.
<a href="#holoscan.resources.DoubleBufferTransmitter.gxf_initialize">gxf_initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.DoubleBufferTransmitter.initialize">initialize</a>(self)	initialization method for the resource.
<a href="#holoscan.resources.DoubleBufferTransmitter.setup">setup</a>(self, arg0)	setup method for the resource.

ResourceType

class ResourceType

Bases: pybind11_builtins.pybind11_object

Members:

NATIVE

GXF

Attributes

<a href="#holoscan.resources.DoubleBufferTransmitter.ResourceType.name">name</a>

value

GXF = <ResourceType.GXF: 1>

NATIVE = <ResourceType.NATIVE: 0>

__init__(self: holoscan.core._core.Resource.ResourceType, value: int) → None

property name

property value

__init__(self: holoscan.resources._resources.DoubleBufferTransmitter, fragment: holoscan.core._core.Fragment, capacity: int = 1, policy: int = 2, name: str = 'double_buffer_transmitter') → None

Transmitter using a double-buffered queue.

Messages are pushed to a back stage after they are published.

Parameters

fragmentholoscan.core.Fragment

The fragment to assign the resource to.

capacityint, optional

The capacity of the transmitter.

policyint, optional

The policy to use (0=pop, 1=reject, 2=fault).

namestr, optional

The name of the transmitter.

add_arg(*args, **kwargs)

Overloaded function.

1. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.Arg) -> None

Add an argument to the component.

2. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.ArgList) -> None

Add a list of arguments to the component.

property args

The list of arguments associated with the component.

Returns

arglistholoscan.core.ArgList

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

nameholoscan.core.Fragment

property gxf_cid

The GXF component ID.

property gxf_cname

The name of the component.

property gxf_context

The GXF context of the component.

property gxf_eid

The GXF entity ID.

gxf_initialize(self: holoscan.gxf._gxf.GXFComponent) → None

Initialize the component.

property gxf_typename

The GXF type name of the component.

Returns

str

The GXF type name of the component.

property id

The identifier of the component.

The identifier is initially set to -1, and will become a valid value when the component is initialized.

With the default executor (holoscan.gxf.GXFExecutor), the identifier is set to the GXF component ID.

Returns

idint

initialize(self: holoscan.core._core.Resource) → None

initialization method for the resource.

property name

The name of the resource.

Returns

namestr

property resource_type

Resource type.

holoscan.core.Resource.ResourceType enum representing the type of the operator. The two types currently implemented are NATIVE and GXF.

setup(self: holoscan.core._core.Resource, arg0: holoscan.core._core.ComponentSpec) → None

setup method for the resource.

property spec

class holoscan.resources.GXFComponentResource(fragment, *args, **kwargs)

Bases: holoscan.resources._resources.GXFComponentResource

Class that wraps a GXF Component as a Holoscan Resource.

Parameters

fragmentholoscan.core.Fragment (constructor only)

The fragment that the resource belongs to.

gxf_typenamestr

The GXF type name that identifies the specific GXF Component being wrapped.

namestr, optional (constructor only)

The name of the resource. Default value is "gxf_component".

kwargsdict

The additional keyword arguments that can be passed depend on the underlying GXF Component. These parameters can provide further customization and functionality to the resource.

Attributes

<a href="#holoscan.resources.GXFComponentResource.args">args</a>	The list of arguments associated with the component.
<a href="#holoscan.resources.GXFComponentResource.description">description</a>	YAML formatted string describing the resource.
<a href="#holoscan.resources.GXFComponentResource.fragment">fragment</a>	Fragment that the resource belongs to.
<a href="#holoscan.resources.GXFComponentResource.gxf_cid">gxf_cid</a>	The GXF component ID.
<a href="#holoscan.resources.GXFComponentResource.gxf_cname">gxf_cname</a>	The name of the component.
<a href="#holoscan.resources.GXFComponentResource.gxf_context">gxf_context</a>	The GXF context of the component.
<a href="#holoscan.resources.GXFComponentResource.gxf_eid">gxf_eid</a>	The GXF entity ID.
<a href="#holoscan.resources.GXFComponentResource.gxf_typename">gxf_typename</a>	The GXF type name of the component.
<a href="#holoscan.resources.GXFComponentResource.id">id</a>	The identifier of the component.
<a href="#holoscan.resources.GXFComponentResource.name">name</a>	The name of the resource.
<a href="#holoscan.resources.GXFComponentResource.resource_type">resource_type</a>	Resource type.

spec

Methods

<a href="#holoscan.resources.GXFComponentResource.add_arg">add_arg</a>(*args, **kwargs)	Overloaded function.
<a href="#holoscan.resources.GXFComponentResource.gxf_initialize">gxf_initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.GXFComponentResource.initialize">initialize</a>(self)	initialization method for the resource.
<a href="#holoscan.resources.GXFComponentResource.setup">setup</a>(self, arg0)	setup method for the resource.

ResourceType

class ResourceType

Bases: pybind11_builtins.pybind11_object

Members:

NATIVE

GXF

Attributes

<a href="#holoscan.resources.GXFComponentResource.ResourceType.name">name</a>

value

GXF = <ResourceType.GXF: 1>

NATIVE = <ResourceType.NATIVE: 0>

__init__(self: holoscan.core._core.Resource.ResourceType, value: int) → None

property name

property value

__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: holoscan.resources._resources.GXFComponentResource) -> None

2. __init__(self: holoscan.resources._resources.GXFComponentResource, component: object, fragment: holoscan.core._core.Fragment, gxf_typename: str, *, name: str = ‘gxf_component’, **kwargs) -> None

Class that wraps a GXF Component as a Holoscan Resource.

Parameters

fragmentholoscan.core.Fragment (constructor only)

The fragment that the resource belongs to.

gxf_typenamestr

The GXF type name that identifies the specific GXF Component being wrapped.

namestr, optional (constructor only)

The name of the resource. Default value is "gxf_component".

kwargsdict

The additional keyword arguments that can be passed depend on the underlying GXF Component. These parameters can provide further customization and functionality to the resource.

add_arg(*args, **kwargs)

Overloaded function.

1. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.Arg) -> None

Add an argument to the component.

2. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.ArgList) -> None

Add a list of arguments to the component.

property args

The list of arguments associated with the component.

Returns

arglistholoscan.core.ArgList

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

nameholoscan.core.Fragment

property gxf_cid

The GXF component ID.

property gxf_cname

The name of the component.

property gxf_context

The GXF context of the component.

property gxf_eid

The GXF entity ID.

gxf_initialize(self: holoscan.gxf._gxf.GXFComponent) → None

Initialize the component.

property gxf_typename

The GXF type name of the component.

Returns

str

The GXF type name of the component.

property id

The identifier of the component.

The identifier is initially set to -1, and will become a valid value when the component is initialized.

With the default executor (holoscan.gxf.GXFExecutor), the identifier is set to the GXF component ID.

Returns

idint

initialize(self: holoscan.core._core.Resource) → None

initialization method for the resource.

property name

The name of the resource.

Returns

namestr

property resource_type

Resource type.

holoscan.core.Resource.ResourceType enum representing the type of the operator. The two types currently implemented are NATIVE and GXF.

setup(self: holoscan.core._core.Resource, arg0: holoscan.core._core.ComponentSpec) → None

setup method for the resource.

property spec

class holoscan.resources.ManualClock

Bases: <a href="#holoscan.resources.Clock">holoscan.resources._resources.Clock</a>

Manual clock.

Parameters

fragmentholoscan.core.Fragment

The fragment to assign the resource to.

initial_timestampint, optional

The initial timestamp on the clock (in nanoseconds).

namestr, optional

The name of the clock.

Attributes

<a href="#holoscan.resources.ManualClock.args">args</a>	The list of arguments associated with the component.
<a href="#holoscan.resources.ManualClock.description">description</a>	YAML formatted string describing the resource.
<a href="#holoscan.resources.ManualClock.fragment">fragment</a>	Fragment that the resource belongs to.
<a href="#holoscan.resources.ManualClock.gxf_cid">gxf_cid</a>	The GXF component ID.
<a href="#holoscan.resources.ManualClock.gxf_cname">gxf_cname</a>	The name of the component.
<a href="#holoscan.resources.ManualClock.gxf_context">gxf_context</a>	The GXF context of the component.
<a href="#holoscan.resources.ManualClock.gxf_eid">gxf_eid</a>	The GXF entity ID.
<a href="#holoscan.resources.ManualClock.gxf_typename">gxf_typename</a>	The GXF type name of the component.
<a href="#holoscan.resources.ManualClock.id">id</a>	The identifier of the component.
<a href="#holoscan.resources.ManualClock.name">name</a>	The name of the resource.
<a href="#holoscan.resources.ManualClock.resource_type">resource_type</a>	Resource type.

spec

Methods

<a href="#holoscan.resources.ManualClock.add_arg">add_arg</a>(*args, **kwargs)	Overloaded function.
<a href="#holoscan.resources.ManualClock.gxf_initialize">gxf_initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.ManualClock.initialize">initialize</a>(self)	initialization method for the resource.
<a href="#holoscan.resources.ManualClock.setup">setup</a>(self, arg0)	setup method for the resource.
<a href="#holoscan.resources.ManualClock.sleep_for">sleep_for</a>(self, arg0)	Set the GXF scheduler to sleep for a specified duration.
<a href="#holoscan.resources.ManualClock.sleep_until">sleep_until</a>(self, target_time_ns)	Set the GXF scheduler to sleep until a specified timestamp.
<a href="#holoscan.resources.ManualClock.time">time</a>(self)	The current time of the clock (in seconds).
<a href="#holoscan.resources.ManualClock.timestamp">timestamp</a>(self)	The current timestamp of the clock (in nanoseconds).

ResourceType

class ResourceType

Bases: pybind11_builtins.pybind11_object

Members:

NATIVE

GXF

Attributes

<a href="#holoscan.resources.ManualClock.ResourceType.name">name</a>

value

GXF = <ResourceType.GXF: 1>

NATIVE = <ResourceType.NATIVE: 0>

__init__(self: holoscan.core._core.Resource.ResourceType, value: int) → None

property name

property value

__init__(self: holoscan.resources._resources.ManualClock, fragment: holoscan.core._core.Fragment, initial_timestamp: int = 0, name: str = 'realtime_clock') → None

Manual clock.

Parameters

fragmentholoscan.core.Fragment

The fragment to assign the resource to.

initial_timestampint, optional

The initial timestamp on the clock (in nanoseconds).

namestr, optional

The name of the clock.

add_arg(*args, **kwargs)

Overloaded function.

1. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.Arg) -> None

Add an argument to the component.

2. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.ArgList) -> None

Add a list of arguments to the component.

property args

The list of arguments associated with the component.

Returns

arglistholoscan.core.ArgList

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

nameholoscan.core.Fragment

property gxf_cid

The GXF component ID.

property gxf_cname

The name of the component.

property gxf_context

The GXF context of the component.

property gxf_eid

The GXF entity ID.

gxf_initialize(self: holoscan.gxf._gxf.GXFComponent) → None

Initialize the component.

property gxf_typename

The GXF type name of the component.

Returns

str

The GXF type name of the component.

property id

The identifier of the component.

The identifier is initially set to -1, and will become a valid value when the component is initialized.

With the default executor (holoscan.gxf.GXFExecutor), the identifier is set to the GXF component ID.

Returns

idint

initialize(self: holoscan.core._core.Resource) → None

initialization method for the resource.

property name

The name of the resource.

Returns

namestr

property resource_type

Resource type.

holoscan.core.Resource.ResourceType enum representing the type of the operator. The two types currently implemented are NATIVE and GXF.

setup(self: holoscan.core._core.Resource, arg0: holoscan.core._core.ComponentSpec) → None

setup method for the resource.

sleep_for(self: holoscan.resources._resources.ManualClock, arg0: object) → None

Set the GXF scheduler to sleep for a specified duration.

Parameters

duration_nsint

The duration to sleep (in nanoseconds).

sleep_until(self: holoscan.resources._resources.ManualClock, target_time_ns: int) → None

Set the GXF scheduler to sleep until a specified timestamp.

Parameters

target_time_nsint

The target timestamp (in nanoseconds).

property spec

time(self: holoscan.resources._resources.ManualClock) → float

The current time of the clock (in seconds).

Parameters

timedouble

The current time of the clock (in seconds).

timestamp(self: holoscan.resources._resources.ManualClock) → int

The current timestamp of the clock (in nanoseconds).

Parameters

timestampint

The current timestamp of the clock (in nanoseconds).

class holoscan.resources.MemoryStorageType

Bases: pybind11_builtins.pybind11_object

Members:

HOST

DEVICE

SYSTEM

Attributes

<a href="#holoscan.resources.MemoryStorageType.name">name</a>

value

DEVICE = <MemoryStorageType.DEVICE: 1>

HOST = <MemoryStorageType.HOST: 0>

SYSTEM = <MemoryStorageType.SYSTEM: 2>

__init__(self: holoscan.resources._resources.MemoryStorageType, value: int) → None

property name

property value

class holoscan.resources.RMMAllocator

Bases: <a href="#holoscan.resources.CudaAllocator">holoscan.resources._resources.CudaAllocator</a>

Device and Host allocator using RAPIDS memory manager (RMM).

Provides memory pools for asynchronously allocated CUDA device memory and pinned host memory.

Parameters

fragmentholoscan.core.Fragment

The fragment to assign the resource to.

device_memory_initial_sizestr, optional

The initial size of the device memory pool. See the Notes section for the format accepted.

device_memory_max_sizestr, optional

The maximum size of the device memory pool. See the Notes section for the format accepted.

host_memory_initial_sizestr, optional

The initial size of the host memory pool. See the Notes section for the format accepted.

host_memory_max_sizestr, optional

The maximum size of the host memory pool. See the Notes section for the format accepted.

dev_idint

GPU device ID. Specifies the device on which to create the memory pool.

namestr, optional

The name of the memory pool.

Notes

The values for the memory parameters, such as device_memory_initial_size must be specified in the form of a string containing a non-negative integer value followed by a suffix representing the units. Supported units are B, KB, MB, GB and TB where the values are powers of 1024 bytes (e.g. MB = 1024 * 1024 bytes). Examples of valid units are “512MB”, “256 KB”, “1 GB”. If a floating point number is specified that decimal portion will be truncated (i.e. the value is rounded down to the nearest integer).

Attributes

<a href="#holoscan.resources.RMMAllocator.args">args</a>	The list of arguments associated with the component.
<a href="#holoscan.resources.RMMAllocator.block_size">block_size</a>	Get the block size of the allocator.
<a href="#holoscan.resources.RMMAllocator.description">description</a>	YAML formatted string describing the resource.
<a href="#holoscan.resources.RMMAllocator.fragment">fragment</a>	Fragment that the resource belongs to.
<a href="#holoscan.resources.RMMAllocator.gxf_cid">gxf_cid</a>	The GXF component ID.
<a href="#holoscan.resources.RMMAllocator.gxf_cname">gxf_cname</a>	The name of the component.
<a href="#holoscan.resources.RMMAllocator.gxf_context">gxf_context</a>	The GXF context of the component.
<a href="#holoscan.resources.RMMAllocator.gxf_eid">gxf_eid</a>	The GXF entity ID.
<a href="#holoscan.resources.RMMAllocator.gxf_typename">gxf_typename</a>	The GXF type name of the component.
<a href="#holoscan.resources.RMMAllocator.id">id</a>	The identifier of the component.
<a href="#holoscan.resources.RMMAllocator.name">name</a>	The name of the resource.
<a href="#holoscan.resources.RMMAllocator.pool_size">pool_size</a>	Return the memory pool size for the specified storage type.
<a href="#holoscan.resources.RMMAllocator.resource_type">resource_type</a>	Resource type.

spec

Methods

<a href="#holoscan.resources.RMMAllocator.add_arg">add_arg</a>(*args, **kwargs)	Overloaded function.
<a href="#holoscan.resources.RMMAllocator.allocate">allocate</a>(self, size, type)	Allocate the requested amount of memory.
<a href="#holoscan.resources.RMMAllocator.free">free</a>(self, pointer)	Free the allocated memory
<a href="#holoscan.resources.RMMAllocator.gxf_initialize">gxf_initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.RMMAllocator.initialize">initialize</a>(self)	initialization method for the resource.
<a href="#holoscan.resources.RMMAllocator.is_available">is_available</a>(self, size)	Boolean representing whether the resource is available.
<a href="#holoscan.resources.RMMAllocator.setup">setup</a>(self, arg0)	setup method for the resource.

ResourceType

class ResourceType

Bases: pybind11_builtins.pybind11_object

Members:

NATIVE

GXF

Attributes

<a href="#holoscan.resources.RMMAllocator.ResourceType.name">name</a>

value

GXF = <ResourceType.GXF: 1>

NATIVE = <ResourceType.NATIVE: 0>

__init__(self: holoscan.core._core.Resource.ResourceType, value: int) → None

property name

property value

__init__(self: holoscan.resources._resources.RMMAllocator, fragment: holoscan.core._core.Fragment, device_memory_initial_size: str = '16MB', device_memory_max_size: str = '32MB', host_memory_initial_size: str = '16MB', host_memory_max_size: str = '32MB', dev_id: int = 0, name: str = 'rmm_pool') → None

Device and Host allocator using RAPIDS memory manager (RMM).

Provides memory pools for asynchronously allocated CUDA device memory and pinned host memory.

Parameters

fragmentholoscan.core.Fragment

The fragment to assign the resource to.

device_memory_initial_sizestr, optional

The initial size of the device memory pool. See the Notes section for the format accepted.

device_memory_max_sizestr, optional

The maximum size of the device memory pool. See the Notes section for the format accepted.

host_memory_initial_sizestr, optional

The initial size of the host memory pool. See the Notes section for the format accepted.

host_memory_max_sizestr, optional

The maximum size of the host memory pool. See the Notes section for the format accepted.

dev_idint

GPU device ID. Specifies the device on which to create the memory pool.

namestr, optional

The name of the memory pool.

Notes

The values for the memory parameters, such as device_memory_initial_size must be specified in the form of a string containing a non-negative integer value followed by a suffix representing the units. Supported units are B, KB, MB, GB and TB where the values are powers of 1024 bytes (e.g. MB = 1024 * 1024 bytes). Examples of valid units are “512MB”, “256 KB”, “1 GB”. If a floating point number is specified that decimal portion will be truncated (i.e. the value is rounded down to the nearest integer).

add_arg(*args, **kwargs)

Overloaded function.

1. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.Arg) -> None

Add an argument to the component.

2. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.ArgList) -> None

Add a list of arguments to the component.

allocate(self: holoscan.resources._resources.Allocator, size: int, type: holoscan.resources._resources.MemoryStorageType) → int

Allocate the requested amount of memory.

Parameters

sizeint

The amount of memory to allocate

typeholoscan.resources.MemoryStorageType

Enum representing the type of memory to allocate.

Returns

Opaque PyCapsule object representing a std::byte* pointer to the allocated memory.

property args

The list of arguments associated with the component.

Returns

arglistholoscan.core.ArgList

property block_size

Get the block size of the allocator.

Returns

int

The block size of the allocator. Returns 1 for byte-based allocators.

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

nameholoscan.core.Fragment

free(self: holoscan.resources._resources.Allocator, pointer: int) → None

Free the allocated memory

Parameters

pointerPyCapsule

Opaque PyCapsule object representing a std::byte* pointer to the allocated memory.

property gxf_cid

The GXF component ID.

property gxf_cname

The name of the component.

property gxf_context

The GXF context of the component.

property gxf_eid

The GXF entity ID.

gxf_initialize(self: holoscan.gxf._gxf.GXFComponent) → None

Initialize the component.

property gxf_typename

The GXF type name of the component.

Returns

str

The GXF type name of the component.

property id

The identifier of the component.

The identifier is initially set to -1, and will become a valid value when the component is initialized.

With the default executor (holoscan.gxf.GXFExecutor), the identifier is set to the GXF component ID.

Returns

idint

initialize(self: holoscan.core._core.Resource) → None

initialization method for the resource.

is_available(self: holoscan.resources._resources.Allocator, size: int) → bool

Boolean representing whether the resource is available.

Returns

bool

Availability of the resource.

property name

The name of the resource.

Returns

namestr

property pool_size

Return the memory pool size for the specified storage type.

Parameters

storage_typeholoscan.resources.MemoryStorageType

Enum representing the type of memory to allocate.

Returns

sizeint

The size of the memory pool for the specified storage type.

property resource_type

Resource type.

holoscan.core.Resource.ResourceType enum representing the type of the operator. The two types currently implemented are NATIVE and GXF.

setup(self: holoscan.core._core.Resource, arg0: holoscan.core._core.ComponentSpec) → None

setup method for the resource.

property spec

class holoscan.resources.RealtimeClock

Bases: <a href="#holoscan.resources.Clock">holoscan.resources._resources.Clock</a>

Realtime clock.

Parameters

fragmentholoscan.core.Fragment

The fragment to assign the resource to.

initial_timestampfloat, optional

The initial time offset used until time scale is changed manually.

initial_time_scalefloat, optional

The initial time scale used until time scale is changed manually.

use_time_since_epochbool, optional

If True, clock time is time since epoch + initial_time_offset at initialize(). Otherwise clock time is initial_time_offset at initialize().

namestr, optional

The name of the clock.

Attributes

<a href="#holoscan.resources.RealtimeClock.args">args</a>	The list of arguments associated with the component.
<a href="#holoscan.resources.RealtimeClock.description">description</a>	YAML formatted string describing the resource.
<a href="#holoscan.resources.RealtimeClock.fragment">fragment</a>	Fragment that the resource belongs to.
<a href="#holoscan.resources.RealtimeClock.gxf_cid">gxf_cid</a>	The GXF component ID.
<a href="#holoscan.resources.RealtimeClock.gxf_cname">gxf_cname</a>	The name of the component.
<a href="#holoscan.resources.RealtimeClock.gxf_context">gxf_context</a>	The GXF context of the component.
<a href="#holoscan.resources.RealtimeClock.gxf_eid">gxf_eid</a>	The GXF entity ID.
<a href="#holoscan.resources.RealtimeClock.gxf_typename">gxf_typename</a>	The GXF type name of the component.
<a href="#holoscan.resources.RealtimeClock.id">id</a>	The identifier of the component.
<a href="#holoscan.resources.RealtimeClock.name">name</a>	The name of the resource.
<a href="#holoscan.resources.RealtimeClock.resource_type">resource_type</a>	Resource type.

spec

Methods

<a href="#holoscan.resources.RealtimeClock.add_arg">add_arg</a>(*args, **kwargs)	Overloaded function.
<a href="#holoscan.resources.RealtimeClock.gxf_initialize">gxf_initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.RealtimeClock.initialize">initialize</a>(self)	initialization method for the resource.
<a href="#holoscan.resources.RealtimeClock.set_time_scale">set_time_scale</a>(self, time_scale)	Adjust the time scaling used by the clock.
<a href="#holoscan.resources.RealtimeClock.setup">setup</a>(self, arg0)	setup method for the resource.
<a href="#holoscan.resources.RealtimeClock.sleep_for">sleep_for</a>(self, arg0)	Set the GXF scheduler to sleep for a specified duration.
<a href="#holoscan.resources.RealtimeClock.sleep_until">sleep_until</a>(self, target_time_ns)	Set the GXF scheduler to sleep until a specified timestamp.
<a href="#holoscan.resources.RealtimeClock.time">time</a>(self)	The current time of the clock (in seconds).
<a href="#holoscan.resources.RealtimeClock.timestamp">timestamp</a>(self)	The current timestamp of the clock (in nanoseconds).

ResourceType

class ResourceType

Bases: pybind11_builtins.pybind11_object

Members:

NATIVE

GXF

Attributes

<a href="#holoscan.resources.RealtimeClock.ResourceType.name">name</a>

value

GXF = <ResourceType.GXF: 1>

NATIVE = <ResourceType.NATIVE: 0>

__init__(self: holoscan.core._core.Resource.ResourceType, value: int) → None

property name

property value

__init__(self: holoscan.resources._resources.RealtimeClock, fragment: holoscan.core._core.Fragment, initial_time_offset: float = 0.0, initial_time_scale: float = 1.0, use_time_since_epoch: bool = False, name: str = 'realtime_clock') → None

Realtime clock.

Parameters

fragmentholoscan.core.Fragment

The fragment to assign the resource to.

initial_timestampfloat, optional

The initial time offset used until time scale is changed manually.

initial_time_scalefloat, optional

The initial time scale used until time scale is changed manually.

use_time_since_epochbool, optional

If True, clock time is time since epoch + initial_time_offset at initialize(). Otherwise clock time is initial_time_offset at initialize().

namestr, optional

The name of the clock.

add_arg(*args, **kwargs)

Overloaded function.

1. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.Arg) -> None

Add an argument to the component.

2. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.ArgList) -> None

Add a list of arguments to the component.

property args

The list of arguments associated with the component.

Returns

arglistholoscan.core.ArgList

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

nameholoscan.core.Fragment

property gxf_cid

The GXF component ID.

property gxf_cname

The name of the component.

property gxf_context

The GXF context of the component.

property gxf_eid

The GXF entity ID.

gxf_initialize(self: holoscan.gxf._gxf.GXFComponent) → None

Initialize the component.

property gxf_typename

The GXF type name of the component.

Returns

str

The GXF type name of the component.

property id

The identifier of the component.

The identifier is initially set to -1, and will become a valid value when the component is initialized.

With the default executor (holoscan.gxf.GXFExecutor), the identifier is set to the GXF component ID.

Returns

idint

initialize(self: holoscan.core._core.Resource) → None

initialization method for the resource.

property name

The name of the resource.

Returns

namestr

property resource_type

Resource type.

holoscan.core.Resource.ResourceType enum representing the type of the operator. The two types currently implemented are NATIVE and GXF.

set_time_scale(self: holoscan.resources._resources.RealtimeClock, time_scale: float) → None

Adjust the time scaling used by the clock.

Parameters

time_scalefloat, optional

Durations (e.g. for periodic condition or sleep_for) are reduced by this scale value. A scale of 1.0 represents real-time while a scale of 2.0 would represent a clock where time elapses twice as fast.

setup(self: holoscan.core._core.Resource, arg0: holoscan.core._core.ComponentSpec) → None

setup method for the resource.

sleep_for(self: holoscan.resources._resources.RealtimeClock, arg0: object) → None

Set the GXF scheduler to sleep for a specified duration.

Parameters

duration_nsint

The duration to sleep (in nanoseconds).

sleep_until(self: holoscan.resources._resources.RealtimeClock, target_time_ns: int) → None

Set the GXF scheduler to sleep until a specified timestamp.

Parameters

target_time_nsint

The target timestamp (in nanoseconds).

property spec

time(self: holoscan.resources._resources.RealtimeClock) → float

The current time of the clock (in seconds).

Parameters

timedouble

The current time of the clock (in seconds).

timestamp(self: holoscan.resources._resources.RealtimeClock) → int

The current timestamp of the clock (in nanoseconds).

Parameters

timestampint

The current timestamp of the clock (in nanoseconds).

class holoscan.resources.Receiver

Bases: <a href="holoscan_python_api_gxf.html#holoscan.gxf.GXFResource">holoscan.gxf._gxf.GXFResource</a>

Base GXF receiver class.

Attributes

<a href="#holoscan.resources.Receiver.args">args</a>	The list of arguments associated with the component.
<a href="#holoscan.resources.Receiver.description">description</a>	YAML formatted string describing the resource.
<a href="#holoscan.resources.Receiver.fragment">fragment</a>	Fragment that the resource belongs to.
<a href="#holoscan.resources.Receiver.gxf_cid">gxf_cid</a>	The GXF component ID.
<a href="#holoscan.resources.Receiver.gxf_cname">gxf_cname</a>	The name of the component.
<a href="#holoscan.resources.Receiver.gxf_context">gxf_context</a>	The GXF context of the component.
<a href="#holoscan.resources.Receiver.gxf_eid">gxf_eid</a>	The GXF entity ID.
<a href="#holoscan.resources.Receiver.gxf_typename">gxf_typename</a>	The GXF type name of the component.
<a href="#holoscan.resources.Receiver.id">id</a>	The identifier of the component.
<a href="#holoscan.resources.Receiver.name">name</a>	The name of the resource.
<a href="#holoscan.resources.Receiver.resource_type">resource_type</a>	Resource type.

spec

Methods

<a href="#holoscan.resources.Receiver.add_arg">add_arg</a>(*args, **kwargs)	Overloaded function.
<a href="#holoscan.resources.Receiver.gxf_initialize">gxf_initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.Receiver.initialize">initialize</a>(self)	initialization method for the resource.
<a href="#holoscan.resources.Receiver.setup">setup</a>(self, arg0)	setup method for the resource.

ResourceType

class ResourceType

Bases: pybind11_builtins.pybind11_object

Members:

NATIVE

GXF

Attributes

<a href="#holoscan.resources.Receiver.ResourceType.name">name</a>

value

GXF = <ResourceType.GXF: 1>

NATIVE = <ResourceType.NATIVE: 0>

__init__(self: holoscan.core._core.Resource.ResourceType, value: int) → None

property name

property value

__init__(self: holoscan.resources._resources.Receiver) → None

Base GXF receiver class.

add_arg(*args, **kwargs)

Overloaded function.

1. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.Arg) -> None

Add an argument to the component.

2. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.ArgList) -> None

Add a list of arguments to the component.

property args

The list of arguments associated with the component.

Returns

arglistholoscan.core.ArgList

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

nameholoscan.core.Fragment

property gxf_cid

The GXF component ID.

property gxf_cname

The name of the component.

property gxf_context

The GXF context of the component.

property gxf_eid

The GXF entity ID.

gxf_initialize(self: holoscan.gxf._gxf.GXFComponent) → None

Initialize the component.

property gxf_typename

The GXF type name of the component.

Returns

str

The GXF type name of the component.

property id

The identifier of the component.

The identifier is initially set to -1, and will become a valid value when the component is initialized.

With the default executor (holoscan.gxf.GXFExecutor), the identifier is set to the GXF component ID.

Returns

idint

initialize(self: holoscan.core._core.Resource) → None

initialization method for the resource.

property name

The name of the resource.

Returns

namestr

property resource_type

Resource type.

holoscan.core.Resource.ResourceType enum representing the type of the operator. The two types currently implemented are NATIVE and GXF.

setup(self: holoscan.core._core.Resource, arg0: holoscan.core._core.ComponentSpec) → None

setup method for the resource.

property spec

class holoscan.resources.SerializationBuffer

Bases: <a href="holoscan_python_api_gxf.html#holoscan.gxf.GXFResource">holoscan.gxf._gxf.GXFResource</a>

Serialization Buffer.

Parameters

fragmentholoscan.core.Fragment

The fragment to assign the resource to.

allocatorholoscan.resource.Allocator

The memory allocator for tensor components.

buffer_sizeint, optional

The size of the buffer in bytes.

namestr, optional

The name of the serialization buffer

Attributes

<a href="#holoscan.resources.SerializationBuffer.args">args</a>	The list of arguments associated with the component.
<a href="#holoscan.resources.SerializationBuffer.description">description</a>	YAML formatted string describing the resource.
<a href="#holoscan.resources.SerializationBuffer.fragment">fragment</a>	Fragment that the resource belongs to.
<a href="#holoscan.resources.SerializationBuffer.gxf_cid">gxf_cid</a>	The GXF component ID.
<a href="#holoscan.resources.SerializationBuffer.gxf_cname">gxf_cname</a>	The name of the component.
<a href="#holoscan.resources.SerializationBuffer.gxf_context">gxf_context</a>	The GXF context of the component.
<a href="#holoscan.resources.SerializationBuffer.gxf_eid">gxf_eid</a>	The GXF entity ID.
<a href="#holoscan.resources.SerializationBuffer.gxf_typename">gxf_typename</a>	The GXF type name of the component.
<a href="#holoscan.resources.SerializationBuffer.id">id</a>	The identifier of the component.
<a href="#holoscan.resources.SerializationBuffer.name">name</a>	The name of the resource.
<a href="#holoscan.resources.SerializationBuffer.resource_type">resource_type</a>	Resource type.

spec

Methods

<a href="#holoscan.resources.SerializationBuffer.add_arg">add_arg</a>(*args, **kwargs)	Overloaded function.
<a href="#holoscan.resources.SerializationBuffer.gxf_initialize">gxf_initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.SerializationBuffer.initialize">initialize</a>(self)	initialization method for the resource.
<a href="#holoscan.resources.SerializationBuffer.setup">setup</a>(self, arg0)	setup method for the resource.

ResourceType

class ResourceType

Bases: pybind11_builtins.pybind11_object

Members:

NATIVE

GXF

Attributes

<a href="#holoscan.resources.SerializationBuffer.ResourceType.name">name</a>

value

GXF = <ResourceType.GXF: 1>

NATIVE = <ResourceType.NATIVE: 0>

__init__(self: holoscan.core._core.Resource.ResourceType, value: int) → None

property name

property value

__init__(self: holoscan.resources._resources.SerializationBuffer, fragment: holoscan.core._core.Fragment, allocator: holoscan.resources._resources.Allocator = None, buffer_size: int = 4096, name: str = 'serialization_buffer') → None

Serialization Buffer.

Parameters

fragmentholoscan.core.Fragment

The fragment to assign the resource to.

allocatorholoscan.resource.Allocator

The memory allocator for tensor components.

buffer_sizeint, optional

The size of the buffer in bytes.

namestr, optional

The name of the serialization buffer

add_arg(*args, **kwargs)

Overloaded function.

1. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.Arg) -> None

Add an argument to the component.

2. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.ArgList) -> None

Add a list of arguments to the component.

property args

The list of arguments associated with the component.

Returns

arglistholoscan.core.ArgList

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

nameholoscan.core.Fragment

property gxf_cid

The GXF component ID.

property gxf_cname

The name of the component.

property gxf_context

The GXF context of the component.

property gxf_eid

The GXF entity ID.

gxf_initialize(self: holoscan.gxf._gxf.GXFComponent) → None

Initialize the component.

property gxf_typename

The GXF type name of the component.

Returns

str

The GXF type name of the component.

property id

The identifier of the component.

The identifier is initially set to -1, and will become a valid value when the component is initialized.

With the default executor (holoscan.gxf.GXFExecutor), the identifier is set to the GXF component ID.

Returns

idint

initialize(self: holoscan.core._core.Resource) → None

initialization method for the resource.

property name

The name of the resource.

Returns

namestr

property resource_type

Resource type.

holoscan.core.Resource.ResourceType enum representing the type of the operator. The two types currently implemented are NATIVE and GXF.

setup(self: holoscan.core._core.Resource, arg0: holoscan.core._core.ComponentSpec) → None

setup method for the resource.

property spec

class holoscan.resources.StdComponentSerializer

Bases: <a href="holoscan_python_api_gxf.html#holoscan.gxf.GXFResource">holoscan.gxf._gxf.GXFResource</a>

Serializer for GXF Timestamp and Tensor components.

Parameters

fragmentholoscan.core.Fragment

The fragment to assign the resource to.

namestr, optional

The name of the serializer.

Attributes

<a href="#holoscan.resources.StdComponentSerializer.args">args</a>	The list of arguments associated with the component.
<a href="#holoscan.resources.StdComponentSerializer.description">description</a>	YAML formatted string describing the resource.
<a href="#holoscan.resources.StdComponentSerializer.fragment">fragment</a>	Fragment that the resource belongs to.
<a href="#holoscan.resources.StdComponentSerializer.gxf_cid">gxf_cid</a>	The GXF component ID.
<a href="#holoscan.resources.StdComponentSerializer.gxf_cname">gxf_cname</a>	The name of the component.
<a href="#holoscan.resources.StdComponentSerializer.gxf_context">gxf_context</a>	The GXF context of the component.
<a href="#holoscan.resources.StdComponentSerializer.gxf_eid">gxf_eid</a>	The GXF entity ID.
<a href="#holoscan.resources.StdComponentSerializer.gxf_typename">gxf_typename</a>	The GXF type name of the component.
<a href="#holoscan.resources.StdComponentSerializer.id">id</a>	The identifier of the component.
<a href="#holoscan.resources.StdComponentSerializer.name">name</a>	The name of the resource.
<a href="#holoscan.resources.StdComponentSerializer.resource_type">resource_type</a>	Resource type.

spec

Methods

<a href="#holoscan.resources.StdComponentSerializer.add_arg">add_arg</a>(*args, **kwargs)	Overloaded function.
<a href="#holoscan.resources.StdComponentSerializer.gxf_initialize">gxf_initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.StdComponentSerializer.initialize">initialize</a>(self)	Initialize the resource
<a href="#holoscan.resources.StdComponentSerializer.setup">setup</a>(self, arg0)	setup method for the resource.

ResourceType

class ResourceType

Bases: pybind11_builtins.pybind11_object

Members:

NATIVE

GXF

Attributes

<a href="#holoscan.resources.StdComponentSerializer.ResourceType.name">name</a>

value

GXF = <ResourceType.GXF: 1>

NATIVE = <ResourceType.NATIVE: 0>

__init__(self: holoscan.core._core.Resource.ResourceType, value: int) → None

property name

property value

__init__(self: holoscan.resources._resources.StdComponentSerializer, fragment: holoscan.core._core.Fragment, name: str = 'standard_component_serializer') → None

Serializer for GXF Timestamp and Tensor components.

Parameters

fragmentholoscan.core.Fragment

The fragment to assign the resource to.

namestr, optional

The name of the serializer.

add_arg(*args, **kwargs)

Overloaded function.

1. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.Arg) -> None

Add an argument to the component.

2. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.ArgList) -> None

Add a list of arguments to the component.

property args

The list of arguments associated with the component.

Returns

arglistholoscan.core.ArgList

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

nameholoscan.core.Fragment

property gxf_cid

The GXF component ID.

property gxf_cname

The name of the component.

property gxf_context

The GXF context of the component.

property gxf_eid

The GXF entity ID.

gxf_initialize(self: holoscan.gxf._gxf.GXFComponent) → None

Initialize the component.

property gxf_typename

The GXF type name of the component.

Returns

str

The GXF type name of the component.

property id

The identifier of the component.

The identifier is initially set to -1, and will become a valid value when the component is initialized.

With the default executor (holoscan.gxf.GXFExecutor), the identifier is set to the GXF component ID.

Returns

idint

initialize(self: holoscan.resources._resources.StdComponentSerializer) → None

Initialize the resource

This method is called only once when the resource is created for the first time, and uses a light-weight initialization.

property name

The name of the resource.

Returns

namestr

property resource_type

Resource type.

holoscan.core.Resource.ResourceType enum representing the type of the operator. The two types currently implemented are NATIVE and GXF.

setup(self: holoscan.core._core.Resource, arg0: holoscan.core._core.ComponentSpec) → None

setup method for the resource.

property spec

class holoscan.resources.StdEntitySerializer

Bases: <a href="holoscan_python_api_gxf.html#holoscan.gxf.GXFResource">holoscan.gxf._gxf.GXFResource</a>

Default serializer for GXF entities.

Parameters

fragmentholoscan.core.Fragment

The fragment to assign the resource to.

namestr, optional

The name of the serializer.

Attributes

<a href="#holoscan.resources.StdEntitySerializer.args">args</a>	The list of arguments associated with the component.
<a href="#holoscan.resources.StdEntitySerializer.description">description</a>	YAML formatted string describing the resource.
<a href="#holoscan.resources.StdEntitySerializer.fragment">fragment</a>	Fragment that the resource belongs to.
<a href="#holoscan.resources.StdEntitySerializer.gxf_cid">gxf_cid</a>	The GXF component ID.
<a href="#holoscan.resources.StdEntitySerializer.gxf_cname">gxf_cname</a>	The name of the component.
<a href="#holoscan.resources.StdEntitySerializer.gxf_context">gxf_context</a>	The GXF context of the component.
<a href="#holoscan.resources.StdEntitySerializer.gxf_eid">gxf_eid</a>	The GXF entity ID.
<a href="#holoscan.resources.StdEntitySerializer.gxf_typename">gxf_typename</a>	The GXF type name of the component.
<a href="#holoscan.resources.StdEntitySerializer.id">id</a>	The identifier of the component.
<a href="#holoscan.resources.StdEntitySerializer.name">name</a>	The name of the resource.
<a href="#holoscan.resources.StdEntitySerializer.resource_type">resource_type</a>	Resource type.

spec

Methods

<a href="#holoscan.resources.StdEntitySerializer.add_arg">add_arg</a>(*args, **kwargs)	Overloaded function.
<a href="#holoscan.resources.StdEntitySerializer.gxf_initialize">gxf_initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.StdEntitySerializer.initialize">initialize</a>(self)	initialization method for the resource.
<a href="#holoscan.resources.StdEntitySerializer.setup">setup</a>(self, arg0)	setup method for the resource.

ResourceType

class ResourceType

Bases: pybind11_builtins.pybind11_object

Members:

NATIVE

GXF

Attributes

<a href="#holoscan.resources.StdEntitySerializer.ResourceType.name">name</a>

value

GXF = <ResourceType.GXF: 1>

NATIVE = <ResourceType.NATIVE: 0>

__init__(self: holoscan.core._core.Resource.ResourceType, value: int) → None

property name

property value

__init__(self: holoscan.resources._resources.StdEntitySerializer, fragment: holoscan.core._core.Fragment, name: str = 'std_entity_serializer') → None

Default serializer for GXF entities.

Parameters

fragmentholoscan.core.Fragment

The fragment to assign the resource to.

namestr, optional

The name of the serializer.

add_arg(*args, **kwargs)

Overloaded function.

1. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.Arg) -> None

Add an argument to the component.

2. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.ArgList) -> None

Add a list of arguments to the component.

property args

The list of arguments associated with the component.

Returns

arglistholoscan.core.ArgList

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

nameholoscan.core.Fragment

property gxf_cid

The GXF component ID.

property gxf_cname

The name of the component.

property gxf_context

The GXF context of the component.

property gxf_eid

The GXF entity ID.

gxf_initialize(self: holoscan.gxf._gxf.GXFComponent) → None

Initialize the component.

property gxf_typename

The GXF type name of the component.

Returns

str

The GXF type name of the component.

property id

The identifier of the component.

The identifier is initially set to -1, and will become a valid value when the component is initialized.

With the default executor (holoscan.gxf.GXFExecutor), the identifier is set to the GXF component ID.

Returns

idint

initialize(self: holoscan.core._core.Resource) → None

initialization method for the resource.

property name

The name of the resource.

Returns

namestr

property resource_type

Resource type.

holoscan.core.Resource.ResourceType enum representing the type of the operator. The two types currently implemented are NATIVE and GXF.

setup(self: holoscan.core._core.Resource, arg0: holoscan.core._core.ComponentSpec) → None

setup method for the resource.

property spec

class holoscan.resources.StreamOrderedAllocator

Bases: <a href="#holoscan.resources.CudaAllocator">holoscan.resources._resources.CudaAllocator</a>

Device and Host allocator using RAPIDS memory manager (StreamOrdered).

Provides memory pools for asynchronously allocated CUDA device memory and pinned host memory.

Parameters

fragmentholoscan.core.Fragment

The fragment to assign the resource to.

device_memory_initial_sizestr, optional

The initial size of the device memory pool. See the Notes section for the format accepted.

device_memory_max_sizestr, optional

The maximum size of the device memory pool. See the Notes section for the format accepted.

release_thresholdstr, optional

The amount of reserved memory to hold onto before trying to release memory back to the OS. See the Notes section for the format accepted.

dev_idint, optional

GPU device ID. Specifies the device on which to create the memory pool.

namestr, optional

The name of the memory pool.

Notes

The values for the memory parameters, such as device_memory_initial_size must be specified in the form of a string containing a non-negative integer value followed by a suffix representing the units. Supported units are B, KB, MB, GB and TB where the values are powers of 1024 bytes (e.g. MB = 1024 * 1024 bytes). Examples of valid units are “512MB”, “256 KB”, “1 GB”. If a floating point number is specified that decimal portion will be truncated (i.e. the value is rounded down to the nearest integer).

Attributes

<a href="#holoscan.resources.StreamOrderedAllocator.args">args</a>	The list of arguments associated with the component.
<a href="#holoscan.resources.StreamOrderedAllocator.block_size">block_size</a>	Get the block size of the allocator.
<a href="#holoscan.resources.StreamOrderedAllocator.description">description</a>	YAML formatted string describing the resource.
<a href="#holoscan.resources.StreamOrderedAllocator.fragment">fragment</a>	Fragment that the resource belongs to.
<a href="#holoscan.resources.StreamOrderedAllocator.gxf_cid">gxf_cid</a>	The GXF component ID.
<a href="#holoscan.resources.StreamOrderedAllocator.gxf_cname">gxf_cname</a>	The name of the component.
<a href="#holoscan.resources.StreamOrderedAllocator.gxf_context">gxf_context</a>	The GXF context of the component.
<a href="#holoscan.resources.StreamOrderedAllocator.gxf_eid">gxf_eid</a>	The GXF entity ID.
<a href="#holoscan.resources.StreamOrderedAllocator.gxf_typename">gxf_typename</a>	The GXF type name of the component.
<a href="#holoscan.resources.StreamOrderedAllocator.id">id</a>	The identifier of the component.
<a href="#holoscan.resources.StreamOrderedAllocator.name">name</a>	The name of the resource.
<a href="#holoscan.resources.StreamOrderedAllocator.pool_size">pool_size</a>	Return the memory pool size for the specified storage type.
<a href="#holoscan.resources.StreamOrderedAllocator.resource_type">resource_type</a>	Resource type.

spec

Methods

<a href="#holoscan.resources.StreamOrderedAllocator.add_arg">add_arg</a>(*args, **kwargs)	Overloaded function.
<a href="#holoscan.resources.StreamOrderedAllocator.allocate">allocate</a>(self, size, type)	Allocate the requested amount of memory.
<a href="#holoscan.resources.StreamOrderedAllocator.free">free</a>(self, pointer)	Free the allocated memory
<a href="#holoscan.resources.StreamOrderedAllocator.gxf_initialize">gxf_initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.StreamOrderedAllocator.initialize">initialize</a>(self)	initialization method for the resource.
<a href="#holoscan.resources.StreamOrderedAllocator.is_available">is_available</a>(self, size)	Boolean representing whether the resource is available.
<a href="#holoscan.resources.StreamOrderedAllocator.setup">setup</a>(self, arg0)	setup method for the resource.

ResourceType

class ResourceType

Bases: pybind11_builtins.pybind11_object

Members:

NATIVE

GXF

Attributes

<a href="#holoscan.resources.StreamOrderedAllocator.ResourceType.name">name</a>

value

GXF = <ResourceType.GXF: 1>

NATIVE = <ResourceType.NATIVE: 0>

__init__(self: holoscan.core._core.Resource.ResourceType, value: int) → None

property name

property value

__init__(self: holoscan.resources._resources.StreamOrderedAllocator, fragment: holoscan.core._core.Fragment, device_memory_initial_size: str = '16MB', device_memory_max_size: str = '32MB', release_threshold: str = '4MB', dev_id: int = 0, name: str = 'stream_ordered_allocator') → None

Device and Host allocator using RAPIDS memory manager (StreamOrdered).

Provides memory pools for asynchronously allocated CUDA device memory and pinned host memory.

Parameters

fragmentholoscan.core.Fragment

The fragment to assign the resource to.

device_memory_initial_sizestr, optional

The initial size of the device memory pool. See the Notes section for the format accepted.

device_memory_max_sizestr, optional

The maximum size of the device memory pool. See the Notes section for the format accepted.

release_thresholdstr, optional

The amount of reserved memory to hold onto before trying to release memory back to the OS. See the Notes section for the format accepted.

dev_idint, optional

GPU device ID. Specifies the device on which to create the memory pool.

namestr, optional

The name of the memory pool.

Notes

The values for the memory parameters, such as device_memory_initial_size must be specified in the form of a string containing a non-negative integer value followed by a suffix representing the units. Supported units are B, KB, MB, GB and TB where the values are powers of 1024 bytes (e.g. MB = 1024 * 1024 bytes). Examples of valid units are “512MB”, “256 KB”, “1 GB”. If a floating point number is specified that decimal portion will be truncated (i.e. the value is rounded down to the nearest integer).

add_arg(*args, **kwargs)

Overloaded function.

1. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.Arg) -> None

Add an argument to the component.

2. add_arg(self: holoscan.core._core.ComponentBase, arg: holoscan.core._core.ArgList) -> None

Add a list of arguments to the component.

allocate(self: holoscan.resources._resources.Allocator, size: int, type: holoscan.resources._resources.MemoryStorageType) → int

Allocate the requested amount of memory.

Parameters

sizeint

The amount of memory to allocate

typeholoscan.resources.MemoryStorageType

Enum representing the type of memory to allocate.

Returns

Opaque PyCapsule object representing a std::byte* pointer to the allocated memory.

property args

The list of arguments associated with the component.

Returns

arglistholoscan.core.ArgList

property block_size

Get the block size of the allocator.

Returns

int

The block size of the allocator. Returns 1 for byte-based allocators.

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

nameholoscan.core.Fragment

free(self: holoscan.resources._resources.Allocator, pointer: int) → None

Free the allocated memory

Parameters

pointerPyCapsule

Opaque PyCapsule object representing a std::byte* pointer to the allocated memory.

property gxf_cid

The GXF component ID.

property gxf_cname

The name of the component.

property gxf_context

The GXF context of the component.

property gxf_eid

The GXF entity ID.

gxf_initialize(self: holoscan.gxf._gxf.GXFComponent) → None

Initialize the component.

property gxf_typename

The GXF type name of the component.

Returns

str

The GXF type name of the component.

property id

The identifier of the component.

The identifier is initially set to -1, and will become a valid value when the component is initialized.

With the default executor (holoscan.gxf.GXFExecutor), the identifier is set to the GXF component ID.

Returns

idint

initialize(self: holoscan.core._core.Resource) → None

initialization method for the resource.

is_available(self: holoscan.resources._resources.Allocator, size: int) → bool

Boolean representing whether the resource is available.

Returns

bool

Availability of the resource.

property name

The name of the resource.

Returns

namestr

property pool_size

Return the memory pool size for the specified storage type.

Parameters

storage_typeholoscan.resources.MemoryStorageType

Enum representing the type of memory to allocate.

Returns

sizeint

The size of the memory pool for the specified storage type.

property resource_type

Resource type.

holoscan.core.Resource.ResourceType enum representing the type of the operator. The two types currently implemented are NATIVE and GXF.

setup(self: holoscan.core._core.Resource, arg0: holoscan.core._core.ComponentSpec) → None

setup method for the resource.

property spec