Skip to content

OpenIGTLink operator#

Authors: Holoscan Team (NVIDIA)
Supported platforms: x86_64, aarch64
Language: C++
Last modified: March 9, 2026
Latest version: 1.0
Minimum Holoscan SDK version: 1.0.3
Tested Holoscan SDK versions: 1.0.3
Contribution metric: Level 2 - Trusted

The openigtlink operator provides a way to send and receive imaging data using the OpenIGTLink library. The openigtlink operator contains separate operators for transmit and receive. Users may choose one or the other, or use both in applications requiring bidirectional traffic.

The openigtlink operators use class names: OpenIGTLinkTxOp and OpenIGTLinkRxOp

Operator class to send and transmit data using the OpenIGTLink protocol.

Receiver Configuration Parameters#

  • port: Port number of server
  • type: integer
  • out_tensor_name: Name of output tensor
  • type: string
  • flip_width_height: Flip width and height (necessary for receiving from 3D Slicer)
  • type: bool

Transmitter Configuration Parameters#

  • device_name: OpenIGTLink device name
  • type: string
  • input_names: Names of input messages
  • type: std::vector<std::string>
  • host_name: Host name
  • type: string
  • port: Port number of server
  • type: integer

API Reference#

Python#

OpenIGTLinkRxOp#

Operator class to send data using the OpenIGTLink protocol.

Constructor Parameters#
Parameter Type Required Description
fragment holoscan.core.Fragment Required The fragment that the operator belongs to.
allocator holoscan.resources.Allocator Required Memory allocator to use for the output.
port integer Optional Port number of server.
out_tensor_name str Optional Name of output tensor.
flip_width_height bool Optional Flip width and height (necessary for receiving from 3D Slicer).
name str Optional The name of the operator.
Methods#
  • setup: Define the operator specification.

OpenIGTLinkTxOp#

Operator class to transmit data using the OpenIGTLink protocol.

Constructor Parameters#
Parameter Type Required Description
fragment holoscan.core.Fragment Required The fragment that the operator belongs to.
device_name str Optional OpenIGTLink device name.
input_names std::vector<std::string>, optional. Optional Names of input messages.
host_name str, optional. Optional Host name.
port integer Optional Port number of server.
name str Optional The name of the operator.
Methods#
  • setup: Define the operator specification.