- 1 Overview
- 2 Install the Software
- 3 Tutorial (for users)
- 4 Architecture (for developers)
- 5 Loadmap/Action items
- 6 Other Resources
- 7 People
The 3D Slicer OpenIGTLink Interface Module is a program module that can handle network communications between 3D Slicer and external software / hardware using OpenIGTLink protocol. The module provides following functions:
- Data import: The module can import position, linear transform and image data from OpenIGTLink-compliant software / hardware to the MRML scene.
- Data export: The module can export linear transform and image data from the MRML scene.
- Multi-connection: The module can manage multiple OpenIGTLink connections at the same time.
- Locator visualization: The user can choose one of linear transforms in the MRML scene to visualize its position and orientation in the 3D space.
- Slice driving: The module can control volume re-slicing plane based on linear transform in the MRML scene.
Install the Software
The module is available only in Slicer 3.3 source distribution. For Slicer 3.2, please see old page.
Building instruction can be found in OpenIGTLink/Slicer/Build.
Tutorial (for users)
To test the OpenIGTLink interface module (or other OpenIGTLinkcomplaint devices and software), tracking simulator software is provided as an example program of the OpenIGTLink library (note that the OpenIGTLink library is different from the OpenIGTLink interface module in 3D Slicer).
Obtain a binary file for your environment.
- For Linux (x86, 32-bit).
- For Linux (x86, 64-bit).
- For Windows (32-bit).
- For Mac OS X (x86).
- For Mac OS X (PPC).
The instruction can be found in OpenIGTLink/Library/Build. Please make sure that you enable "build examples" option.
Show Tracking Device in the 3D Slicer
Set up Open IGT Link Module
- Select "OpenIGTLinkIF" from "Modules:" menu
- Open "Connector Browser" frame, and press "Add" button below the "Connectors" list to add a new connector
- Configure and start the connector. Choose "Server" check box in the "Type" option, then clinck "Active" check box. Now the Slicer is ready to accept connections through Open IGT Link.
Run Tracker Simulator
Go to OpenIGTLink binary directory.
$ cd <path to OpenIGTLink-build>/bin
To send dummy coordinate data to the Slicer running on localhost with frame rate of 10 fps, run:
$ ./TrackerClient localhost 18944 10
Visualize Tracker Position
To see the coordinate from the Tracker Simulator,
- Open "Visualization / Slice Control" frame in the OpenIGTLink module interface.
- Choose "Tracker (LinearTransform) from Locator Source menu in Locator Display frame.
- Click the "Show Locator" check button. A locator model shows up on the 3D viewer.
Architecture (for developers)
The OpenIGTLink Interface module is designed to adapt to the 3D Slicer’s scene graph mechanism called Medical Reality Modeling Language (MRML) architecture. MRML provides a unified way to handle various kinds of data including images, transforms, and models in the IGT setting as MRML nodes. In order to manage multiple nodes, all MRML nodes have a tree structure. For example, the user can apply a transform to an image by placing it under the transform node as a child node. When the OpenIGTLink module receives an OpenIGTLink message, it creates a MRML node with the same name as the "device name" in the message and imports the data to the node. If a node with the same name and data type already exists, the module simply updates the data. The module also can export the data from a MRML node through the OpenIGTLink interface. This mechanism maximizes the flexibility to import/export data to/from 3D Slicer, since users can configure the MRML node tree interactively without changing the source code of the software. In addition, this mechanism makes it easy for other software modules to exchange data with external software or hardware through OpenIGTLink.
To manage multiple OpenIGTLink communications simultaneously, the OpenIGTLink Interface module handles an OpenIGTLink connection as a "connector". One connector can establish only one connection, and the user can add as many connectors as needed from the graphical user interface (GUI). Each connector can be configured as either server or client independently (Figure 1). Note that this does not mean directions of data stream; it just determines whether the module or the external software / hardware waits for (listens to) the other side to initiate the connection. Once the connection is established, there is no difference between server and client connectors.
From the developers' point of view, a connector is handled as an instance of vtkIGTLConnector class, which is defined in Modules/OpenIGTLinkIF/vtkIGTLConnector.cxx and vtkIGTLConnectors.h. Each instance has a thread to monitor communication with an external hardware / software.
The OpenIGTLink Interface module is driven by two types of events: arrivals of OpenIGTLink messages and update events in the MRML scene. The module monitors incoming messages, and once it receives a message, it starts a deserialization process to import the data into the MRML scene as a MRML node. Other software modules in 3D Slicer can recognize that the data has been imported into the MRML scene by catching the MRML event. The module also monitors events from MRML nodes, which the user has registered as nodes to export. When one of the nodes is updated from elsewhere in 3D Slicer, the module catches the update event and starts serializing the data into an OpenIGTLink message. The serialized data is transfered to the device through an OpenIGTLink connection. This event-driven architecture allows other software modules in 3D Slicer to exchange various kinds of data with external hardware and software without accessing the API of the OpenIGTLink interface (in other words, with little modification of the code).
"Plug-in" OpenIGTLink-vtkMRMLNode message converter
The module has "plug-in" OpenIGTLink-vtkMRMLNode converter mechanisms, where OpenIGTLink-vtkMRMLNode converting routines are defined as classes independent from the connectors. Thus the developers can add a new data type that is handled by the OpenIGTLink interface module without modifying the module itself. All OpenIGTLink-vtkMRMLNode converting classes are child classes of vtkIGTLToMRMLBase, which defines several virtual functions called by the OpenIGTLink interface module. Instances of those classes are registered before receiving OpenIGTLink messages or exporting vtkMRMLnode.
The following member functions are defined in classes derived from vtkIGTLToMRMLBase class:
virtual const char* GetIGTLName(); virtual const char* GetMRMLName(); virtual vtkIntArray* GetNodeEvents(); virtual vtkMRMLNode* CreateNewNode(vtkMRMLScene* scene, const char* name); virtual int IGTLToMRML(igtl::MessageBase::Pointer buffer, vtkMRMLNode* node); virtual int MRMLToIGTL(unsigned long event, vtkMRMLNode* mrmlNode, int* size, void** igtlMsg);
GetIGTLName() and GetMRMLName() are functions to get the character strings of "device name" of OpenIGTLink messages and "node tag name" of MRML nodes handled by the class. For example, in the case of the position data type, GetIGTLName() returns "POSITION" and GetMRMLName() returns "vtkMRMLLinearTransform", meaning that the class can convert an OpenIGTLink message with the device name "POSITION" into a MRML node with tag name LinearTransform and vice versa. GetNodeEvents() is a function to get a list of events to invoke the routine to convert the MRML node into an OpenIGTLink message, which is defined in MRMLToIGTL(). CreateNewNode() function defines a routine to create a new MRML node, when the OpenIGTLink module cannot find a MRML node to store the received data. Data conversion from OpenIGTLink message to MRML node and MRML node to OpenIGTLink message are defined as IGTLToMRML() and MRMLToIGTL().
OpenIGTLink-vtkMRMLNode converter classes can be registered from other program modules using a member function of vtkOpenIGTLinkIFLogic class as (NOTE "IGTLLogic is a pointer to the OpenIGTLinkIFLogic class):
vtkIGTLToMRMLLinearTransform* LinearTransformConverter = vtkIGTLToMRMLLinearTransform::New(); vtkIGTLToMRMLImage* ImageConverter = vtkIGTLToMRMLImage::New(); vtkIGTLToMRMLPosition* PositionConverter = vtkIGTLToMRMLPosition::New(); IGTLLogic->RegisterMessageConverter(LinearTransformConverter); IGTLLogic->RegisterMessageConverter(ImageConverter); IGTLLogic->RegisterMessageConverter(PositionConverter);
- Abstracted I/O -- allows users to switch between network I/O and file I/O. It can be useful to support logging function.