For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Introduction
Setup
Holoscan CLI
- Holoscan CLI
Using the SDK
Operators
Components
AI Skills
- Ai Skills
API reference
Performance
HoloHub
- HoloHub Overview
FAQ
- FAQ

Overview
Relevant Technologies
Getting Started
SDK Installation
Additional Setup
Enabling GPUDirect RDMA
Enable G-SYNC
Disable variable backlight
Enable exclusive display
Use iGPU with dGPU
Optimizing JetPack
Deployment stack
Third Party Hardware Setup
Holoscan Sensor Bridge
Holoscan CLI
Holoscan Core
GPU Resident Execution
Holoscan by Example
Hello World
Ping Simple
Ping Custom Op
Ping Multi Port
Video Replayer
Video Replayer Distributed
BYOM
Custom CUDA Kernel Sample
Create an Application
Create a Distributed Application
Create an Operator
Create an Operator via Decorator
Create a Condition
Dynamic Flow Control
CUDA Stream Handling
Logging
Data Logging
Debugging
Python Operator Bindings
Operators and Extensions
Visualization
Inference
Testing
Video I/O Vendor Implementation Guide
Schedulers
Conditions
Resources
Analytics
Ai Skills
Allocator
AnnotatedDoubleBufferReceiver
AnnotatedDoubleBufferTransmitter
AppDriver
Application
AppWorker
Arg
ArgList
ArgType
ArgumentSetter
AsyncBufferReceiver
AsyncBufferTransmitter
AsyncDataLoggerBackend
AsyncDataLoggerResource
AsynchronousCondition
BlockMemoryPool
BooleanCondition
CLIParser
Clock
ClockInterface
CodecRegistry
Component
ComponentBase
ComponentSpec
Condition
ConditionCombiner
Config
CountCondition
CPUResourceMonitor
CPUThread
CsvDataExporter
CudaAllocator
CudaBufferAvailableCondition
CudaContextScopedPush
CudaEventCondition
CudaFunctionLauncher
CudaGreenContext
CudaGreenContextPool
CudaObjectHandler
CudaStreamCondition
CudaStreamHandler
CudaStreamPool
DataExporter
DataFlowTracker
DataLogger
DataLoggerQueue
DataLoggerResource
DefaultFragmentService
DFFTCollector
DistributedAppService
DLManagedMemoryBufferVersioned
DoubleBufferReceiver
DoubleBufferTransmitter
DownstreamMessageAffordableCondition
Endpoint
EventBasedScheduler
ExecutionContext
Executor
ExpiringMessageAvailableCondition
ExtensionManager
FastDdsDiscovery
FastDdsEndpoint
FastDdsHoloscanEntityTypeSupport
FastDdsNativeBufferAdapter
FastDdsPubSubContext
FastDdsPubSubNetworkContext
FastDdsSerializer
FastDdsTransport
FileFIFOMutex
FirstFitAllocator
FirstFitAllocatorBase
FirstPixelOutCondition
FlowGraph
FlowGraphImpl
Fragment
FragmentAllocationStrategy
FragmentScheduler
FragmentService
FragmentServiceProvider
GPUDevice
GPUResidentDeck
GPUResidentExecutor
GPUResidentOperator
GPUResourceMonitor
GreedyFragmentAllocationStrategy
GreedyScheduler
GXFComponentResource
HoloEntitySerializerBase
HoloIpcCudaNativeBufferAdapterBase
HoloscanAsyncBufferReceiver
HoloscanAsyncBufferTransmitter
HoloscanLogger
HoloscanUcxReceiver
HoloscanUcxTransmitter
InMemoryPubSubNetworkContext
InMemoryPubSubSession
InputContext
IOSpec
LockFreeQueue
Logger
ManualClock
Map
MatXAllocator
MemoryAvailableCondition
Message
MessageAvailableCondition
MessageLabel
MetadataDictionary
MetaParameter
MultiMessageAvailableCondition
MultiMessageAvailableTimeoutCondition
MultiThreadScheduler
NativeBufferProtocolAdapter
NetworkContext
Nullable
Operator
OperatorSpec
OrConditionCombiner
OrderedQueue
OutputContext
ParameterWrapper
PathMetrics
PeriodicCondition
PoseTree
PoseTreeEdgeHistory
PoseTreeManager
PoseTreeUCXClient
PoseTreeUCXServer
PresentDoneCondition
PublisherAvailableCondition
PubSubContext
PubSubReceiver
PubSubTransmitter
RealtimeClock
Receiver
Resource
RMMAllocator
RuntimeError
Scheduler
ScopedFlock
ScopedWaitedFlock
SerializationBuffer
SessionDiscoveryFrontend
SessionTransportFrontend
SidecarDispatchQueue
SignalHandler
SO2
SO3
StdComponentSerializer
StdEntitySerializer
StdPubSubEntitySerializer
StreamOrderedAllocator
Subgraph
SubscriberAvailableCondition
SyntheticClock
SystemResourceManager
Tensor
TensorMap
ThreadPool
Timer
Topology
Transmitter
UcxComponentSerializer
UcxContext
UcxEntitySerializer
UcxHoloscanComponentSerializer
UcxReceiver
UcxSerializationBuffer
UcxTransmitter
UnboundedAllocator
Is Array V
Is One Of Derived V
Is One Of V
Is Scalar V
Is Shared Ptr V
Is Vector V
Is Yaml Convertable V
AppWorkerTerminationCode
ArgContainerType
ArgElementType
AsynchronousEventState
AsyncQueuePolicy
ConditionType
ControlCommand
DataFlowMetric
DataLoggerQueueType
DeltaType
ErrorCode
LogLevel
MemoryStorageType
MessageType
MetadataPolicy
OperatorStatus
ParameterFlag
PeriodicConditionPolicy
SchedulerType
SchedulingStatusType
Annotate Message
Async Logger Shutdown In Progress
Build Native Buffer Capability
Calc Strides
Convert Double With Check
Convert Float To Integer With Check
Convert Float With Check
Convert Signed Integer With Check
Convert Unsigned Integer With Check
Create Data Logger Queue
Create Pose Tree Edge Delta
Create Pose Tree Frame Delta
Deannotate Message
Decode Message Label Payload
Decode Message Payload
Decode Metadata Dictionary Payload
Deserialize Array
Deserialize Binary Blob
Deserialize Pose3d
Deserialize Snapshot
Deserialize Trivial Type
Deserialize Vector Of Vectors
Dldatatype From Typestr
Dldevice From Pointer
Encode Message Label Payload
Encode Message Payload
Encode Metadata Dictionary Payload
Forward Error
Get Associated Local Ip
Get Current Time Us
Get Preferred Network Ports
Get Unused Network Ports
Get Well Formed Name
Interpolate
Is Almost One
Is Almost Zero
Is Pose Almost Identity
Load Stable Host Id
Log Critical
Log Debug
Log Error
Log Info
Log Level
Log Message
Log Trace
Log Warn
Make Application
Make Unexpected
Numpy Dtype
Operator Minus
Operator Plus
Parse Native Buffer Policy
Pose2 Exp
Pose2 Log
Pose2 Magnitude
Pose3 Exp
Pose3 Log
Pose3 Magnitude
Query Gpu Device Info
Serialize Binary Blob
Serialize Pose3d
Serialize Snapshot
Serialize Trivial Type
Serialize Vector Of Vectors
Set Log Level
Set Log Pattern
Slerp Interpolate
Static Handle Signal
CPUMetricEnum
BayerFormat
PixelFormat
CudaDeviceProp
CUuuid St
CudaDeviceGetPCIBusId T
CudaError T
CudaGetDeviceCount T
CudaGetDeviceProperties T
CudaGetErrorString T
CudaMemGetInfo T
CudaUUID T
CUuuid
AsyncConsoleBackend
BasicConsoleLogger
GXFConsoleLogger
SimpleTextSerializer
Console Output Mutex
Apply Reader Qos
Apply Writer Qos
Cached Tid Init Flag
Cached Tids
Dtype String To Primitive Type
Initialize Cached Type Ids
Ndpl Append Bytes
Ndpl Append String
Ndpl Read String
Primitive Type To Dtype String
Safe Tensor Element Bytes
Shape From Metadata
Strides From Metadata
Tensor Metadata From Tensor
Tid Equals
KNdplMagic
KNdplVersion
AppDriverServer
AppWorkerServer
ServiceDriverEndpoint
ServiceWorkerEndpoint
KDefaultAppDriverPort
KDefaultConnectionRetryIntervalMs
KDefaultMaxConnectionRetryCount
KMaxNetworkPort
KMinNetworkPort
GPUMetricEnum
Clock
ComponentInfo
CudaObjectHandler
Endpoint
Entity
EntityGroup
GXFComponent
GXFCondition
GXFExecutionContext
GXFExecutor
GXFExtensionManager
GXFExtensionRegistrar
GXFInputContext
GXFLogger
GXFNetworkContext
GXFOutputContext
GXFParameterAdaptor
GXFResource
GXFScheduler
GXFSchedulingTermWrapper
GXFSystemResourceBase
GXFWrapper
Add Entity Group
Create Name
Find Component Handle
Get Component Eid
Get Default Queue Policy
Get Full Component Name
Get Gxf Receiver
Get Videobuffer
Gxf Device Id
Gxf Entity Group Id
Gxf Entity Group Name
Has Component
Notify Entity Event
PROF DEFINE EVENT
Should Print Backtrace
CodecRegistry
CudaStream
CudaStreamHandle
CudaStreamId
GxfExtensionFactory
KGxfExtensionFactoryName
KGXFExtensionsMaxSize
NvmlTemperatureSensors T
NvmlMemory St
NvmlPciInfo St
NvmlUtilization St
NvmlDevice T
NvmlDeviceGetCount T
NvmlDeviceGetHandleByIndex T
NvmlDeviceGetHandleByPciBusId T
NvmlDeviceGetHandleBySerial T
NvmlDeviceGetHandleByUUID T
NvmlDeviceGetIndex T
NvmlDeviceGetMemoryInfo T
NvmlDeviceGetName T
NvmlDeviceGetPciInfo T
NvmlDeviceGetPowerManagementLimit T
NvmlDeviceGetPowerUsage T
NvmlDeviceGetSerial T
NvmlDeviceGetTemperature T
NvmlDeviceGetUtilizationRates T
NvmlDeviceGetUUID T
NvmlErrorString T
NvmlInit T
NvmlMemory T
NvmlPciInfo T
NvmlReturn T
NvmlShutdown T
NvmlUtilization T
AsyncPingRxOp
AsyncPingTxOp
BayerDemosaicGpuResidentOp
BayerDemosaicOp
DataTypeRxTestOp
DataTypeTxTestOp
FormatConverterGpuResidentOp
FormatConverterOp
ForwardOp
GPUResidentInferenceOp
GXFCodeletOp
GXFOperator
HolovizOp
InferenceOp
InferenceProcessorOp
OperatorRunner
PingRxOp
PingTensorRxOp
PingTensorTxOp
PingTxOp
PoseTreeManagerLookupOp
RawImageProcessorOp
SegmentationPostprocessorOp
V4L2VideoCaptureOp
VideoAcquisitionOperator
VideoStreamRecorderOp
VideoStreamReplayerOp
VideoTransmissionOperator
VirtualOperator
VirtualReceiverOp
VirtualTransmitterOp
FormatConversionType
FormatDType
ElementSizeFromFormatDType
FormatDTypeFromPrimitiveType
GetFormatConversionType
NormalizeFormatDType
PrimitiveTypeFromFormatDType
ToFormatDType
VerifyFormatDTypeChannels
VerifyFormatDTypeChannelsOrThrow
DataFormat
NetworkOutputType
Cuda Postprocess
Shape
Output Type T
SyncClockMode
VideoColorSpaceKind
VideoTransport
Enumerate Video Acquisition Devices
Enumerate Video Transmission Devices
Register Video Acquisition Enumerator
Register Video Transmission Enumerator
To Video Device Capabilities
ChannelCapabilities
FramerateRange
PixelFormatDesc
Resolution
VideoCaptureCapabilities
VideoCaptureChannelCapabilities
VideoDeviceCapabilities
VideoLatencyHint
VideoTransmitCapabilities
VideoTransmitChannelCapabilities
VideoCaptureCapabilityEnumerator
VideoTransmitCapabilityEnumerator
KVideoIoMaxStreams
BufferInfo
FormatConverterPlaneLayout
HashMap
Interpolate
Trace
Trace Enabled
Domain
Category
Message
Named Category
Scoped Range
GxfTensorBuffer
Get Data Per Model
Report Error
Set Activation Per Model
Transmit Data Per Model
Buffer
CudaAllocator
CudaFree
CudaHostFree
CudaHostMappedAllocator
CudaHostMappedBuffer
DeviceBuffer
BufferDataType
CudaGraphAddNodeCompat
Get Cuda Runtime Version
Get Element Size
TensorTransmitCache
InstanceHandle
AppWorkerTerminationStatus
Array Type
AvailableSystemResource
Base Type
Base Type T Typename Stdenable If T Stdis Base Of V Condition Stddecay T T
Base Type T Typename Stdenable If T Stdis Base Of V Resource Stddecay T T
CLIOptions
CloudPickleSerializedObject
Codec
Codec CloudPickleSerializedObject
Codec OpsHolovizOpInputSpec
Codec OpsHolovizOpInputSpecView
Codec OpsInferenceOpActivationSpec
Codec Stdarray TypeT N
Codec Stdshared Ptr TypeT
Codec Stdstring
Codec Stdunordered Map KeyType ValueType
Codec Stdvector Bool
Codec Stdvector OpsHolovizOpInputSpec
Codec Stdvector OpsHolovizOpInputSpecView
Codec Stdvector OpsInferenceOpActivationSpec
Codec Stdvector Stdstring
Codec Stdvector Stdvector TypeT
Codec Stdvector TypeT
Condition Default Name
Condition Default Name AsynchronousCondition
Condition Default Name BooleanCondition
Condition Default Name CountCondition
Condition Default Name CudaBufferAvailableCondition
Condition Default Name CudaEventCondition
Condition Default Name CudaStreamCondition
Condition Default Name DownstreamMessageAffordableCondition
Condition Default Name ExpiringMessageAvailableCondition
Condition Default Name MemoryAvailableCondition
Condition Default Name MessageAvailableCondition
Condition Default Name MultiMessageAvailableCondition
Condition Default Name MultiMessageAvailableTimeoutCondition
Condition Default Name PeriodicCondition
Condition Default Name PublisherAvailableCondition
Condition Default Name SubscriberAvailableCondition
ConnectionItem
ContiguousDataHeader
CPUInfo
DataEntry
Deleter
DeltaMessage
DistributedConfig
EdgeData
EncodedMessagePayload
FrameData
FrameInfo
GpuDeviceInfo
GPUInfo
HoloscanEntityData
ImportedNativeTensor
InMemorySessionParticipant
InterfacePort
Is Array
Is Scalar
Is Shared Ptr
Is Shared Ptr Stdshared Ptr T
Is Vector
Is Yaml Convertable
MultiMessageConditionInfo
NativeTensorMetadata
Network Context Default Name
Network Context Default Name FastDdsPubSubNetworkContext
Network Context Default Name InMemoryPubSubNetworkContext
Network Context Default Name PubSubContext
Network Context Default Name UcxContext
NoAccessibleMessageType
NoMessageType
Operator Default Name
Operator Default Name OpsAsyncPingRxOp
Operator Default Name OpsAsyncPingTxOp
Operator Default Name OpsBayerDemosaicOp
Operator Default Name OpsDataTypeRxTestOp
Operator Default Name OpsDataTypeTxTestOp
Operator Default Name OpsFormatConverterOp
Operator Default Name OpsGXFCodeletOp
Operator Default Name OpsHolovizOp
Operator Default Name OpsInferenceOp
Operator Default Name OpsInferenceProcessorOp
Operator Default Name OpsPingRxOp
Operator Default Name OpsPingTensorRxOp
Operator Default Name OpsPingTensorTxOp
Operator Default Name OpsPingTxOp
Operator Default Name OpsRawImageProcessorOp
Operator Default Name OpsSegmentationPostprocessorOp
Operator Default Name OpsV4L2VideoCaptureOp
Operator Default Name OpsVideoStreamRecorderOp
Operator Default Name OpsVideoStreamReplayerOp
OperatorTimestampLabel
Pose2
Pose3
PoseTreeUCXClientConfig
PoseTreeUCXServerConfig
Remove Pointer
Remove Pointer Stdshared Ptr T
Resource Default Name
Resource Default Name AsyncBufferReceiver
Resource Default Name AsyncBufferTransmitter
Resource Default Name BlockMemoryPool
Resource Default Name CPUThread
Resource Default Name CudaGreenContext
Resource Default Name CudaGreenContextPool
Resource Default Name CudaStreamPool
Resource Default Name Data LoggersAsyncConsoleLogger
Resource Default Name Data LoggersBasicConsoleLogger
Resource Default Name Data LoggersGXFConsoleLogger
Resource Default Name Data LoggersSimpleTextSerializer
Resource Default Name DoubleBufferReceiver
Resource Default Name DoubleBufferTransmitter
Resource Default Name GPUDevice
Resource Default Name ManualClock
Resource Default Name OrConditionCombiner
Resource Default Name PubSubReceiver
Resource Default Name PubSubTransmitter
Resource Default Name RealtimeClock
Resource Default Name RMMAllocator
Resource Default Name SerializationBuffer
Resource Default Name StdComponentSerializer
Resource Default Name StdEntitySerializer
Resource Default Name StreamOrderedAllocator
Resource Default Name SyntheticClock
Resource Default Name ThreadPool
Resource Default Name UcxComponentSerializer
Resource Default Name UcxEntitySerializer
Resource Default Name UcxHoloscanComponentSerializer
Resource Default Name UcxReceiver
Resource Default Name UcxSerializationBuffer
Resource Default Name UcxTransmitter
Resource Default Name UnboundedAllocator
Scalar Type
Scheduler Default Name
Scheduler Default Name EventBasedScheduler
Scheduler Default Name GreedyScheduler
Scheduler Default Name MultiThreadScheduler
ServiceKey
ServiceKeyHash
SnapshotAckMessage
SubscribeMessage
SystemResourceRequirement
Vector Type
YAMLNodeParser
YAMLNodeParser Int8 T
YAMLNodeParser IOSpec Ptr
YAMLNodeParser Stdarray TypeT N
YAMLNodeParser Stdcomplex TypeT
YAMLNodeParser Stdshared Ptr TypeT
YAMLNodeParser Stdvector IOSpec Ptr
YAMLNodeParser Stdvector TypeT
YAMLNodeParser TypeT
YAMLNodeParser Uint8 T
Bad Expected Access
Base Type T
ColVector
ColVectorX
ColVectorXf
DLManagedMemoryBuffer
DLManagedTensorContext
Element Of
Element Of T
Expected
FragmentEdgeDataElementType
FragmentFlowGraph
FragmentFlowGraphImpl
FragmentNodeType
FragmentPortMap
Is Array T
Is Scalar T
Is Shared Ptr T
Is Vector T
Is Yaml Convertable T
Matrix
Matrix2
Matrix2d
Matrix2f
Matrix2i
Matrix2X
Matrix2Xd
Matrix2Xf
Matrix2Xi
Matrix3
Matrix34
Matrix34d
Matrix34f
Matrix34i
Matrix3d
Matrix3f
Matrix3i
Matrix3X
Matrix3Xd
Matrix3Xf
Matrix3Xi
Matrix4
Matrix43
Matrix43d
Matrix43f
Matrix43i
Matrix4d
Matrix4f
Matrix4i
Matrix4X
Matrix4Xd
Matrix4Xf
Matrix4Xi
Matrix5
Matrix5d
Matrix5f
Matrix5i
Matrix5X
Matrix5Xd
Matrix5Xf
Matrix5Xi
Matrix6
Matrix6d
Matrix6f
Matrix6i
Matrix6X
Matrix6Xd
Matrix6Xf
Matrix6Xi
Matrix7
Matrix7d
Matrix7f
Matrix7i
Matrix7X
Matrix7Xd
Matrix7Xf
Matrix7Xi
Matrix8
Matrix8d
Matrix8f
Matrix8i
Matrix8X
Matrix8Xd
Matrix8Xf
Matrix8Xi
MatrixX
MatrixXd
MatrixXf
MatrixXi
MetadataObject
MultipleFragmentsPortMap
OperatorEdgeDataElementType
OperatorFlowGraph
OperatorFlowGraphImpl
OperatorNodeType
Parameter
Pose2d
Pose2f
Pose3d
Pose3f
Quaternion
Quaterniond
Quaternionf
Remove Pointer T
RowVector
RowVectorX
RowVectorXf
SchedulingPolicy
SO2d
SO2f
SO3d
SO3f
Type Info
Unexpect T
Unexpected
UniqueCUdeviceptr
UniqueCUevent
UniqueCUhostptr
UniqueCUstream
Vector
Vector2
Vector2d
Vector2f
Vector2i
Vector2ub
Vector3
Vector3d
Vector3f
Vector3i
Vector3ub
Vector4
Vector4d
Vector4f
Vector4i
Vector4ub
Vector5
Vector5d
Vector5f
Vector5i
Vector5ub
Vector6
Vector6d
Vector6f
Vector6i
Vector6ub
Vector7
Vector7d
Vector7f
Vector7i
Vector7ub
Vector8
Vector8d
Vector8f
Vector8i
Vector8ub
VectorX
VectorXd
VectorXf
VectorXi
VectorXub
Condition Default Name V
Console Output Mutex
DEFAULT FIFOMUTEX WAIT TIME MS
Dimension Of V
G Async Logger Shutdown In Progress
HOLOSCAN DLPACK IMPL VERSION MAJOR
HOLOSCAN DLPACK IMPL VERSION MINOR
KAnalyticsOutputFileName
KDefaultCpuMetrics
KDefaultGpuMetrics
KDefaultLatencyThreshold
KDefaultLogfileName
KDefaultMetadataEnabled
KDefaultMetadataPolicy
KDefaultNumBufferedMessages
KDefaultNumLastMessagesToDiscard
KDefaultNumStartMessagesToSkip
KDefaultSerializationBufferSize
KDefaultTCPIPSegmentSize
KDefaultUcxPort
KDefaultUcxSerializationBufferSize
KNoReceivedMessage
KStartOperatorName
MetricToString
Network Context Default Name V
Operator Default Name V
Resource Default Name V
Scheduler Default Name V
Unexpect
Performance Considerations
Flow Tracking
GXF Job Statistics
Nsight Profiling
HoloHub Overview
FAQ

API reference C++ API Variables

holoscan::console_output_mutex

Beta

||View as Markdown|

std::mutex holoscan::console_output_mutex

Developer-friendly docs for your API