holoscan.resources

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

class holoscan.resources.Allocator

Bases: holoscan.gxf._gxf.GXFResource

Base allocator class.

Attributes

args	The list of arguments associated with the component.
fragment	Fragment that the resource belongs to.
gxf_cid	The GXF component ID.
gxf_cname	The name of the component.
gxf_context	The GXF context of the component.
gxf_eid	The GXF entity ID.
gxf_typename	The GXF type name of the resource.
id	The identifier of the component.
name	The name of the resource.

Methods

add_arg(*args, **kwargs)	Overloaded function.
allocate(self, size, type)	Allocate the requested amount of memory.
free(self, pointer)	Free the allocated memory
gxf_initialize(self)	Initialize the component.
initialize(self)	Initialize the component.
is_available(self, size)	Boolean representing whether the resource is available.
setup(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.Component, arg: holoscan.core._core.Arg) -> None

Add an argument to the component.

2. add_arg(self: holoscan.core._core.Component, 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) → std::byte

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 fragment

Fragment that the resource belongs to.

Returns

nameholoscan.core.Fragment

free(self: holoscan.resources._resources.Allocator, pointer: std::byte) → 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 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

idint

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

namestr

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

setup method for the resource.

class holoscan.resources.BlockMemoryPool

Bases: holoscan.resources._resources.Allocator

Block memory pool resource.

Provides a maximum number of equally sized blocks of memory.

Attributes

args	The list of arguments associated with the component.
fragment	Fragment that the resource belongs to.
gxf_cid	The GXF component ID.
gxf_cname	The name of the component.
gxf_context	The GXF context of the component.
gxf_eid	The GXF entity ID.
gxf_typename	The GXF type name of the resource.
id	The identifier of the component.
name	The name of the resource.

Methods

add_arg(*args, **kwargs)	Overloaded function.
allocate(self, size, type)	Allocate the requested amount of memory.
free(self, pointer)	Free the allocated memory
gxf_initialize(self)	Initialize the component.
initialize(self)	Initialize the component.
is_available(self, size)	Boolean representing whether the resource is available.
setup(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, name: str = 'block_memory_pool') → None

Block memory pool resource.

Provides a maximum number of equally sized blocks of memory.

Parameters

fragmentFragment

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.

namestr, optional

The name of the memory pool.

add_arg(*args, **kwargs)

Overloaded function.

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

Add an argument to the component.

2. add_arg(self: holoscan.core._core.Component, 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) → std::byte

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 fragment

Fragment that the resource belongs to.

Returns

nameholoscan.core.Fragment

free(self: holoscan.resources._resources.Allocator, pointer: std::byte) → 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 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

idint

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

namestr

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

Define the component specification.

Parameters

specComponentSpec

Component specification associated with the resource.

class holoscan.resources.CudaStreamPool

Bases: holoscan.resources._resources.Allocator

CUDA stream pool.

Attributes

args	The list of arguments associated with the component.
fragment	Fragment that the resource belongs to.
gxf_cid	The GXF component ID.
gxf_cname	The name of the component.
gxf_context	The GXF context of the component.
gxf_eid	The GXF entity ID.
gxf_typename	The GXF type name of the resource.
id	The identifier of the component.
name	The name of the resource.

Methods

add_arg(*args, **kwargs)	Overloaded function.
allocate(self, size, type)	Allocate the requested amount of memory.
free(self, pointer)	Free the allocated memory
gxf_initialize(self)	Initialize the component.
initialize(self)	Initialize the component.
is_available(self, size)	Boolean representing whether the resource is available.
setup(self, spec)	Define the component specification.

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

CUDA stream pool.

Parameters

fragmentFragment

The fragment to assign the resource to.

dev_idint

CUDA device ID.

stream_flagsint

Flag values used in creating CUDA streams.

stream_priorityint

Priority values used in creating CUDA streams.

reserved_sizeint

TODO

max_sizeint

Maximum stream size.

namestr, optional

The name of the stream pool.

add_arg(*args, **kwargs)

Overloaded function.

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

Add an argument to the component.

2. add_arg(self: holoscan.core._core.Component, 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) → std::byte

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 fragment

Fragment that the resource belongs to.

Returns

nameholoscan.core.Fragment

free(self: holoscan.resources._resources.Allocator, pointer: std::byte) → 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 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

idint

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

namestr

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

Define the component specification.

Parameters

specComponentSpec

Component specification associated with the resource.

class holoscan.resources.DoubleBufferReceiver

Bases: holoscan.resources._resources.Receiver

Receiver using a double-buffered queue.

New messages are first pushed to a back stage.

Attributes

args	The list of arguments associated with the component.
fragment	Fragment that the resource belongs to.
gxf_cid	The GXF component ID.
gxf_cname	The name of the component.
gxf_context	The GXF context of the component.
gxf_eid	The GXF entity ID.
gxf_typename	The GXF type name of the resource.
id	The identifier of the component.
name	The name of the resource.

Methods

add_arg(*args, **kwargs)	Overloaded function.
gxf_initialize(self)	Initialize the component.
initialize(self)	Initialize the component.
setup(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

fragmentFragment

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.Component, arg: holoscan.core._core.Arg) -> None

Add an argument to the component.

2. add_arg(self: holoscan.core._core.Component, 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 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 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

idint

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

Initialize the component.

property name

The name of the resource.

Returns

namestr

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

Define the component specification.

Parameters

specComponentSpec

Component specification associated with the resource.

class holoscan.resources.DoubleBufferTransmitter

Bases: holoscan.resources._resources.Transmitter

Transmitter using a double-buffered queue.

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

Attributes

args	The list of arguments associated with the component.
fragment	Fragment that the resource belongs to.
gxf_cid	The GXF component ID.
gxf_cname	The name of the component.
gxf_context	The GXF context of the component.
gxf_eid	The GXF entity ID.
gxf_typename	The GXF type name of the resource.
id	The identifier of the component.
name	The name of the resource.

Methods

add_arg(*args, **kwargs)	Overloaded function.
gxf_initialize(self)	Initialize the component.
initialize(self)	Initialize the component.
setup(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

fragmentFragment

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.Component, arg: holoscan.core._core.Arg) -> None

Add an argument to the component.

2. add_arg(self: holoscan.core._core.Component, 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 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 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

idint

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

Initialize the component.

property name

The name of the resource.

Returns

namestr

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

Define the component specification.

Parameters

specComponentSpec

Component specification associated with the resource.

class holoscan.resources.MemoryStorageType

Bases: pybind11_builtins.pybind11_object

Members:

HOST

DEVICE

SYSTEM

Attributes

name

value

DEVICE =

HOST =

SYSTEM =

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

property name

property value

class holoscan.resources.Receiver

Bases: holoscan.gxf._gxf.GXFResource

Base GXF receiver class.

Attributes

args	The list of arguments associated with the component.
fragment	Fragment that the resource belongs to.
gxf_cid	The GXF component ID.
gxf_cname	The name of the component.
gxf_context	The GXF context of the component.
gxf_eid	The GXF entity ID.
gxf_typename	The GXF type name of the resource.
id	The identifier of the component.
name	The name of the resource.

Methods

add_arg(*args, **kwargs)	Overloaded function.
gxf_initialize(self)	Initialize the component.
initialize(self)	Initialize the component.
setup(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.Component, arg: holoscan.core._core.Arg) -> None

Add an argument to the component.

2. add_arg(self: holoscan.core._core.Component, 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 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 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

idint

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

Initialize the component.

property name

The name of the resource.

Returns

namestr

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

setup method for the resource.

class holoscan.resources.StdComponentSerializer

Bases: holoscan.gxf._gxf.GXFResource

Serializer for GXF Timestamp and Tensor components.

Attributes

args	The list of arguments associated with the component.
fragment	Fragment that the resource belongs to.
gxf_cid	The GXF component ID.
gxf_cname	The name of the component.
gxf_context	The GXF context of the component.
gxf_eid	The GXF entity ID.
gxf_typename	The GXF type name of the resource.
id	The identifier of the component.
name	The name of the resource.

Methods

add_arg(*args, **kwargs)	Overloaded function.
gxf_initialize(self)	Initialize the component.
initialize(self)	Initialize the resource
setup(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

fragmentFragment

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.Component, arg: holoscan.core._core.Arg) -> None

Add an argument to the component.

2. add_arg(self: holoscan.core._core.Component, 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 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 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

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

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

Define the component specification.

Parameters

specComponentSpec

Component specification associated with the resource.

class holoscan.resources.Transmitter

Bases: holoscan.gxf._gxf.GXFResource

Base GXF transmitter class.

Attributes

args	The list of arguments associated with the component.
fragment	Fragment that the resource belongs to.
gxf_cid	The GXF component ID.
gxf_cname	The name of the component.
gxf_context	The GXF context of the component.
gxf_eid	The GXF entity ID.
gxf_typename	The GXF type name of the resource.
id	The identifier of the component.
name	The name of the resource.

Methods

add_arg(*args, **kwargs)	Overloaded function.
gxf_initialize(self)	Initialize the component.
initialize(self)	Initialize the component.
setup(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.Component, arg: holoscan.core._core.Arg) -> None

Add an argument to the component.

2. add_arg(self: holoscan.core._core.Component, 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 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 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

idint

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

Initialize the component.

property name

The name of the resource.

Returns

namestr

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

setup method for the resource.

class holoscan.resources.UnboundedAllocator

Bases: holoscan.resources._resources.Allocator

Unbounded allocator.

This allocator uses dynamic memory allocation without an upper bound.

Attributes

args	The list of arguments associated with the component.
fragment	Fragment that the resource belongs to.
gxf_cid	The GXF component ID.
gxf_cname	The name of the component.
gxf_context	The GXF context of the component.
gxf_eid	The GXF entity ID.
gxf_typename	The GXF type name of the resource.
id	The identifier of the component.
name	The name of the resource.

Methods

add_arg(*args, **kwargs)	Overloaded function.
allocate(self, size, type)	Allocate the requested amount of memory.
free(self, pointer)	Free the allocated memory
gxf_initialize(self)	Initialize the component.
initialize(self)	Initialize the component.
is_available(self, size)	Boolean representing whether the resource is available.
setup(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

fragmentFragment

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.Component, arg: holoscan.core._core.Arg) -> None

Add an argument to the component.

2. add_arg(self: holoscan.core._core.Component, 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) → std::byte

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 fragment

Fragment that the resource belongs to.

Returns

nameholoscan.core.Fragment

free(self: holoscan.resources._resources.Allocator, pointer: std::byte) → 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 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

idint

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

namestr

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

Define the component specification.

Parameters

specComponentSpec

Component specification associated with the resource.

class holoscan.resources.VideoStreamSerializer

Bases: holoscan.gxf._gxf.GXFResource

Serializer for video streams.

Attributes

args	The list of arguments associated with the component.
fragment	Fragment that the resource belongs to.
gxf_cid	The GXF component ID.
gxf_cname	The name of the component.
gxf_context	The GXF context of the component.
gxf_eid	The GXF entity ID.
gxf_typename	The GXF type name of the resource.
id	The identifier of the component.
name	The name of the resource.

Methods

add_arg(*args, **kwargs)	Overloaded function.
gxf_initialize(self)	Initialize the component.
initialize(self)	Initialize the resource
setup(self, spec)	Define the component specification.

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

Serializer for video streams.

Parameters

fragmentFragment

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.Component, arg: holoscan.core._core.Arg) -> None

Add an argument to the component.

2. add_arg(self: holoscan.core._core.Component, 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 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 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

idint

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

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

Define the component specification.

Parameters

specComponentSpec

Component specification associated with the resource.