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 resource.
<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.

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)	Initialize the component.
<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.

__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

size

The amount of memory to allocate

type

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

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

name

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

Free the allocated memory

Parameters

pointer

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 resource.

Returns

str

The GXF type name of the resource

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

id

initialize(self: holoscan.gxf._gxf.GXFResource) → None

Initialize the component.

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

name

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.

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 resource.
<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.

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)	Initialize the component.
<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, spec)	Define the component specification.

__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

fragment

The fragment to assign the resource to.

storage_type

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

block_size

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

num_blocks

The number of blocks in the memory pool.

dev_id

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

name

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

size

The amount of memory to allocate

type

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

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

name

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

Free the allocated memory

Parameters

pointer

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 resource.

Returns

str

The GXF type name of the resource

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

id

initialize(self: holoscan.gxf._gxf.GXFResource) → None

Initialize the component.

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

name

setup(self: holoscan.resources._resources.BlockMemoryPool, spec: holoscan.core._core.ComponentSpec) → None

Define the component specification.

Parameters

spec

Component specification associated with 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.id">id</a>	The identifier of the component.
<a href="#holoscan.resources.Clock.name">name</a>	The name of the resource.

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)	Initialize the component.
<a href="#holoscan.resources.Clock.setup">setup</a>(self, arg0)	setup method for the resource.

__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

arglist

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

name

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 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

id

initialize(self: holoscan.gxf._gxf.GXFResource) → None

Initialize the component.

property name

The name of the resource.

Returns

name

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.

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 resource.
<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.

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)	Initialize the component.
<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, spec)	Define the component specification.

__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

fragment

The fragment to assign the resource to.

dev_id

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

stream_flags

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_priority

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

reserved_size

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

max_size

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

name

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

size

The amount of memory to allocate

type

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

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

name

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

Free the allocated memory

Parameters

pointer

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 resource.

Returns

str

The GXF type name of the resource

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

id

initialize(self: holoscan.gxf._gxf.GXFResource) → None

Initialize the component.

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

name

setup(self: holoscan.resources._resources.CudaStreamPool, spec: holoscan.core._core.ComponentSpec) → None

Define the component specification.

Parameters

spec

Component specification associated with 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.

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 resource.
<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.

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)	Initialize the component.
<a href="#holoscan.resources.DoubleBufferReceiver.setup">setup</a>(self, spec)	Define the component specification.

__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

fragment

The fragment to assign the resource to.

capacity

The capacity of the receiver.

policy

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

name

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

arglist

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

name

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 resource.

Returns

str

The GXF type name of the resource

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

id

initialize(self: holoscan.gxf._gxf.GXFResource) → None

Initialize the component.

property name

The name of the resource.

Returns

name

setup(self: holoscan.resources._resources.DoubleBufferReceiver, spec: holoscan.core._core.ComponentSpec) → None

Define the component specification.

Parameters

spec

Component specification associated with 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.

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 resource.
<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.

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)	Initialize the component.
<a href="#holoscan.resources.DoubleBufferTransmitter.setup">setup</a>(self, spec)	Define the component specification.

__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

fragment

The fragment to assign the resource to.

capacity

The capacity of the transmitter.

policy

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

name

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

arglist

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

name

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 resource.

Returns

str

The GXF type name of the resource

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

id

initialize(self: holoscan.gxf._gxf.GXFResource) → None

Initialize the component.

property name

The name of the resource.

Returns

name

setup(self: holoscan.resources._resources.DoubleBufferTransmitter, spec: holoscan.core._core.ComponentSpec) → None

Define the component specification.

Parameters

spec

Component specification associated with the resource.

property spec

class holoscan.resources.ManualClock

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

Manual clock class.

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 resource.
<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.

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)	Initialize the component.
<a href="#holoscan.resources.ManualClock.setup">setup</a>(self, spec)	Define the component specification.
<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).

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

Manual clock.

Parameters

fragment

The fragment to assign the resource to.

initial_timestamp

The initial timestamp on the clock (in nanoseconds).

name

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

arglist

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

name

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 resource.

Returns

str

The GXF type name of the resource

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

id

initialize(self: holoscan.gxf._gxf.GXFResource) → None

Initialize the component.

property name

The name of the resource.

Returns

name

setup(self: holoscan.resources._resources.ManualClock, spec: holoscan.core._core.ComponentSpec) → None

Define the component specification.

Parameters

spec

Component specification associated with the resource.

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

Set the GXF scheduler to sleep for a specified duration.

Parameters

duration_ns

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_ns

The target timestamp (in nanoseconds).

property spec

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

The current time of the clock (in seconds).

Parameters

time

The current time of the clock (in seconds).

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

The current timestamp of the clock (in nanoseconds).

Parameters

timestamp

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.RealtimeClock

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

Real-time clock class.

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 resource.
<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.

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)	Initialize the component.
<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, spec)	Define the component specification.
<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).

__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

fragment

The fragment to assign the resource to.

initial_timestamp

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

initial_time_scale

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

use_time_since_epoch

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

name

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

arglist

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

name

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 resource.

Returns

str

The GXF type name of the resource

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

id

initialize(self: holoscan.gxf._gxf.GXFResource) → None

Initialize the component.

property name

The name of the resource.

Returns

name

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

Adjust the time scaling used by the clock.

Parameters

time_scale

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.resources._resources.RealtimeClock, spec: holoscan.core._core.ComponentSpec) → None

Define the component specification.

Parameters

spec

Component specification associated with the resource.

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

Set the GXF scheduler to sleep for a specified duration.

Parameters

duration_ns

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_ns

The target timestamp (in nanoseconds).

property spec

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

The current time of the clock (in seconds).

Parameters

time

The current time of the clock (in seconds).

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

The current timestamp of the clock (in nanoseconds).

Parameters

timestamp

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 resource.
<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.

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)	Initialize the component.
<a href="#holoscan.resources.Receiver.setup">setup</a>(self, arg0)	setup method for the resource.

__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

arglist

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

name

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 resource.

Returns

str

The GXF type name of the resource

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

id

initialize(self: holoscan.gxf._gxf.GXFResource) → None

Initialize the component.

property name

The name of the resource.

Returns

name

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.

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 resource.
<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.

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)	Initialize the component.
<a href="#holoscan.resources.SerializationBuffer.setup">setup</a>(self, spec)	Define the component specification.

__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

fragment

The fragment to assign the resource to.

allocator

The memory allocator for tensor components.

buffer_size

The size of the buffer in bytes.

name

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

arglist

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

name

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 resource.

Returns

str

The GXF type name of the resource

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

id

initialize(self: holoscan.gxf._gxf.GXFResource) → None

Initialize the component.

property name

The name of the resource.

Returns

name

setup(self: holoscan.resources._resources.SerializationBuffer, spec: holoscan.core._core.ComponentSpec) → None

Define the component specification.

Parameters

spec

Component specification associated with 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.

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 resource.
<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.

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, spec)	Define the component specification.

__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

fragment

The fragment to assign the resource to.

name

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

arglist

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

name

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 resource.

Returns

str

The GXF type name of the resource

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

id

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

name

setup(self: holoscan.resources._resources.StdComponentSerializer, spec: holoscan.core._core.ComponentSpec) → None

Define the component specification.

Parameters

spec

Component specification associated with 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.

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 resource.
<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.

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)	Initialize the resource
<a href="#holoscan.resources.StdEntitySerializer.setup">setup</a>(self, spec)	Define the component specification.

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

Default serializer for GXF entities.

Parameters

fragment

The fragment to assign the resource to.

name

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

arglist

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

name

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 resource.

Returns

str

The GXF type name of the resource

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

id

initialize(self: holoscan.resources._resources.StdEntitySerializer) → 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

name

setup(self: holoscan.resources._resources.StdEntitySerializer, spec: holoscan.core._core.ComponentSpec) → None

Define the component specification.

Parameters

spec

Component specification associated with the resource.

property spec

class holoscan.resources.Transmitter

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

Base GXF transmitter class.

Attributes

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

spec

Methods

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

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

Base GXF transmitter 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

arglist

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

name

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 resource.

Returns

str

The GXF type name of the resource

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

id

initialize(self: holoscan.gxf._gxf.GXFResource) → None

Initialize the component.

property name

The name of the resource.

Returns

name

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

setup method for the resource.

property spec

class holoscan.resources.UcxComponentSerializer

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

UCX component serializer.

Attributes

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

spec

Methods

<a href="#holoscan.resources.UcxComponentSerializer.add_arg">add_arg</a>(*args, **kwargs)	Overloaded function.
<a href="#holoscan.resources.UcxComponentSerializer.gxf_initialize">gxf_initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.UcxComponentSerializer.initialize">initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.UcxComponentSerializer.setup">setup</a>(self, spec)	Define the component specification.

__init__(self: holoscan.resources._resources.UcxComponentSerializer, fragment: holoscan.core._core.Fragment, allocator: holoscan.resources._resources.Allocator = None, name: str = 'ucx_component_serializer') → None

UCX component serializer.

Parameters

fragment

The fragment to assign the resource to.

allocator

The memory allocator for tensor components.

name

The name of the component 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

arglist

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

name

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 resource.

Returns

str

The GXF type name of the resource

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

id

initialize(self: holoscan.gxf._gxf.GXFResource) → None

Initialize the component.

property name

The name of the resource.

Returns

name

setup(self: holoscan.resources._resources.UcxComponentSerializer, spec: holoscan.core._core.ComponentSpec) → None

Define the component specification.

Parameters

spec

Component specification associated with the resource.

property spec

class holoscan.resources.UcxEntitySerializer

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

UCX entity serializer.

Attributes

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

spec

Methods

<a href="#holoscan.resources.UcxEntitySerializer.add_arg">add_arg</a>(*args, **kwargs)	Overloaded function.
<a href="#holoscan.resources.UcxEntitySerializer.gxf_initialize">gxf_initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.UcxEntitySerializer.initialize">initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.UcxEntitySerializer.setup">setup</a>(self, spec)	Define the component specification.

__init__(self: holoscan.resources._resources.UcxEntitySerializer, fragment: holoscan.core._core.Fragment, verbose_warning: bool = False, name: str = 'ucx_entity_serializer') → None

UCX entity serializer.

Parameters

fragment

The fragment to assign the resource to.

component_serializer

The component serializers used by the entity serializer.

verbose_warning

Whether to use verbose warnings during serialization.

name

The name of the entity 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

arglist

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

name

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 resource.

Returns

str

The GXF type name of the resource

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

id

initialize(self: holoscan.gxf._gxf.GXFResource) → None

Initialize the component.

property name

The name of the resource.

Returns

name

setup(self: holoscan.resources._resources.UcxEntitySerializer, spec: holoscan.core._core.ComponentSpec) → None

Define the component specification.

Parameters

spec

Component specification associated with the resource.

property spec

class holoscan.resources.UcxHoloscanComponentSerializer

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

UCX Holoscan component serializer.

Attributes

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

spec

Methods

<a href="#holoscan.resources.UcxHoloscanComponentSerializer.add_arg">add_arg</a>(*args, **kwargs)	Overloaded function.
<a href="#holoscan.resources.UcxHoloscanComponentSerializer.gxf_initialize">gxf_initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.UcxHoloscanComponentSerializer.initialize">initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.UcxHoloscanComponentSerializer.setup">setup</a>(self, spec)	Define the component specification.

__init__(self: holoscan.resources._resources.UcxHoloscanComponentSerializer, fragment: holoscan.core._core.Fragment, allocator: holoscan.resources._resources.Allocator = None, name: str = 'ucx_component_serializer') → None

UCX Holoscan component serializer.

Parameters

fragment

The fragment to assign the resource to.

allocator

The memory allocator for tensor components.

name

The name of the component 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

arglist

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

name

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 resource.

Returns

str

The GXF type name of the resource

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

id

initialize(self: holoscan.gxf._gxf.GXFResource) → None

Initialize the component.

property name

The name of the resource.

Returns

name

setup(self: holoscan.resources._resources.UcxHoloscanComponentSerializer, spec: holoscan.core._core.ComponentSpec) → None

Define the component specification.

Parameters

spec

Component specification associated with the resource.

property spec

class holoscan.resources.UcxReceiver

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

UCX network receiver using a double-buffered queue.

New messages are first pushed to a back stage.

Attributes

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

spec

Methods

<a href="#holoscan.resources.UcxReceiver.add_arg">add_arg</a>(*args, **kwargs)	Overloaded function.
<a href="#holoscan.resources.UcxReceiver.gxf_initialize">gxf_initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.UcxReceiver.initialize">initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.UcxReceiver.setup">setup</a>(self, spec)	Define the component specification.

__init__(self: holoscan.resources._resources.UcxReceiver, fragment: holoscan.core._core.Fragment, buffer: holoscan::UcxSerializationBuffer = None, capacity: int = 1, policy: int = 2, address: str = '0.0.0.0', port: int = 13337, name: str = 'ucx_receiver') → None

UCX network receiver using a double-buffered queue.

New messages are first pushed to a back stage.

Parameters

fragment

The fragment to assign the resource to.

buffer

The serialization buffer used by the transmitter.

capacity

The capacity of the receiver.

policy

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

address

The IP address used by the transmitter.

port

The network port used by the transmitter.

name

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

arglist

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

name

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 resource.

Returns

str

The GXF type name of the resource

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

id

initialize(self: holoscan.gxf._gxf.GXFResource) → None

Initialize the component.

property name

The name of the resource.

Returns

name

setup(self: holoscan.resources._resources.UcxReceiver, spec: holoscan.core._core.ComponentSpec) → None

Define the component specification.

Parameters

spec

Component specification associated with the resource.

property spec

class holoscan.resources.UcxSerializationBuffer

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

UCX serialization buffer.

Attributes

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

spec

Methods

<a href="#holoscan.resources.UcxSerializationBuffer.add_arg">add_arg</a>(*args, **kwargs)	Overloaded function.
<a href="#holoscan.resources.UcxSerializationBuffer.gxf_initialize">gxf_initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.UcxSerializationBuffer.initialize">initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.UcxSerializationBuffer.setup">setup</a>(self, spec)	Define the component specification.

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

UCX serialization buffer.

Parameters

fragment

The fragment to assign the resource to.

allocator

The memory allocator for tensor components.

buffer_size

The size of the buffer in bytes.

name

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

arglist

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

name

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 resource.

Returns

str

The GXF type name of the resource

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

id

initialize(self: holoscan.gxf._gxf.GXFResource) → None

Initialize the component.

property name

The name of the resource.

Returns

name

setup(self: holoscan.resources._resources.UcxSerializationBuffer, spec: holoscan.core._core.ComponentSpec) → None

Define the component specification.

Parameters

spec

Component specification associated with the resource.

property spec

class holoscan.resources.UcxTransmitter

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

UCX network transmitter using a double-buffered queue.

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

Attributes

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

spec

Methods

<a href="#holoscan.resources.UcxTransmitter.add_arg">add_arg</a>(*args, **kwargs)	Overloaded function.
<a href="#holoscan.resources.UcxTransmitter.gxf_initialize">gxf_initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.UcxTransmitter.initialize">initialize</a>(self)	Initialize the component.
<a href="#holoscan.resources.UcxTransmitter.setup">setup</a>(self, spec)	Define the component specification.

__init__(self: holoscan.resources._resources.UcxTransmitter, fragment: holoscan.core._core.Fragment, buffer: holoscan::UcxSerializationBuffer = None, capacity: int = 1, policy: int = 2, receiver_address: str = '0.0.0.0', local_address: str = '0.0.0.0', port: int = 13337, local_port: int = 0, maximum_connection_retries: int = 10, name: str = 'ucx_transmitter') → None

UCX network transmitter using a double-buffered queue.

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

Parameters

fragment

The fragment to assign the resource to.

buffer

The serialization buffer used by the transmitter.

capacity

The capacity of the transmitter.

policy

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

receiver_address

The IP address used by the transmitter.

local_address

The local IP address to use for connection.

port

The network port used by the transmitter.

local_port

The local network port to use for connection.

maximum_connection_retries

The maximum number of times the transmitter will retry making a connection.

name

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

arglist

property description

YAML formatted string describing the resource.

property fragment

Fragment that the resource belongs to.

Returns

name

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 resource.

Returns

str

The GXF type name of the resource

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

id

initialize(self: holoscan.gxf._gxf.GXFResource) → None

Initialize the component.

property name

The name of the resource.

Returns

name

setup(self: holoscan.resources._resources.UcxTransmitter, spec: holoscan.core._core.ComponentSpec) → None

Define the component specification.

Parameters

spec

Component specification associated with the resource.

property spec

class holoscan.resources.UnboundedAllocator

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

Unbounded allocator.

This allocator uses dynamic memory allocation without an upper bound.

Attributes

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

spec

Methods

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

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

Unbounded allocator.

This allocator uses dynamic memory allocation without an upper bound.

Parameters

fragment

The fragment to assign the resource to.

name

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.

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

Allocate the requested amount of memory.

Parameters

size

The amount of memory to allocate

type

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

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

name

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

Free the allocated memory

Parameters

pointer

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 resource.

Returns

str

The GXF type name of the resource

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

id

initialize(self: holoscan.gxf._gxf.GXFResource) → None

Initialize the component.

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

name

setup(self: holoscan.resources._resources.UnboundedAllocator, spec: holoscan.core._core.ComponentSpec) → None

Define the component specification.

Parameters

spec

Component specification associated with the resource.

property spec