NAMIC Wiki - User contributions [en]

OpenIGTLink OldPage

2015-02-17T16:55:05Z

Rjollos: /* License */ Fixed link to New BSD license.

OpenIGTLink provides a standardized mechanism for communications among computers and devices in operating rooms (OR) for wide variety of image-guided therapy (IGT) applications.
Examples of such applications include:
*Stereotactic surgical guidance using optical position sensor and medical image visualization software.
*Intraoperative image guidance using real-time MRI and medical image visualization software
*Robot-assisted intervention using robotic device and surgical planning software

See [[#Applications| Applications section below]] for a list of research projects using OpenIGTLink.

OpenIGTLink is a set of digital messaging formats and rules (protocol) used for data exchange on a local area network (LAN). The specification of OpenIGTLink and its reference implementation, the OpenIGTLink Library, are available free of charge for any purpose including commercial use.
An OpenIGTLink interface is available in popular medical image processing and visualization software [http://slicer.org/ 3D Slicer].

[[OpenIGTLink/News|Recent updates.]]

<div class="floatleft">__TOC__</div>
<center>
[[Image:OpenIGTLink_concept.png]]
</center>

=Protocol=
<hr/>
==OpenIGTLink Version 2==
* [[OpenIGTLink/ProtocolV2/Index| Version 2 Protocol Page]]

==Extended Protocols==
* [[OpenIGTLink/ExtendedProtocols| List of site- and project-specific extended protocols]]

 

=Downloads=
<hr/>
==Reference Library==
*[[OpenIGTLink/Library | The OpenIGTLink Library (C/C++)]] ([[OpenIGTLink/Library/Tutorial |Tutorial]])
*[[OpenIGTLink/Matlab | OpenIGTLink Interface for Matlab / Octave (Experimental)]]

==Software ==
* [http://www.slicer.org/slicerWiki/index.php/Modules:OpenIGTLinkIF Interface for 3D Slicer]
* [[OpenIGTLink/Simlators | Simulator programs]]

 

=Tutorials/Events=
<hr/>
*Tutorial Materials
**Tutorials on image-guided therapy (IGT) using Slicer 3 and OpenIGTLink are available at [[IGT:ToolKit]]
** [[OpenIGTLink/IGSTK | Interface for Image-Guided Surgery Toolkit (IGSTK)]]
**[http://www.slicer.org/slicerWiki/index.php/Modules:OpenIGTLinkIF-Documentation-3.6 Tutorial on 3D Slicer and Tracker simulator in 3D Slicer OpenIGTLink IF Documentation page.]
** [[OpenIGTLink/ProtocolV2/Trial| How to use the new features in Version 2 in 3D Slicer.]]

*Meetings / Workshops
** [[OpenIGTLink/Meetings| OpenIGTLink Meetings and Workshops]]

 

= Applications =
<hr/>
OpenIGTLink has been used in a number of research projects. Here are some examples:

<gallery widths="180" perrow="3">
Image:OpenIGTLink_Diagram_JHURobot.png| Integration of transperineal prostate robot and navigation software (BRP -- Brigham and Women's Hospital/Johns Hopkins University/Queen's University/Acoustic MedSystems)
Image:Slicer_IGTL_NITRobot.jpg| Prototype integration of a neurosurgical robot and 3D Slicer v3 using OpenIGTLink (Hideo Fujimoto, Nagoya Institute of Technology, Japan)
Image:OpenIGTLink_Slicer_Screenshot.png|Screenshot of tracker tool visualization on 3D Slicer (Brigham and Women's Hospital)
Image:OpenIGTLink_JHUProstateRobot.jpg|Integration of transperineal prostate robot (BRP -- Brigham and Women's Hospital/Johns Hopkins University/Queen's University/Acoustic MedSystems)
</gallery>

Please see [[OpenIGTLink/List| the list of hardware]] that supports the OpenIGTLink Protocol.

=References=
<hr/>
*Studies using OpenIGTLink
**Tokuda J, Fischer GS, Papademetris X, Yaniv Z, Ibáñez L, Cheng P, Liu H, Blevins J, Arata J, Golby AJ, Kapur T, Pieper S, Burdette EC, Fichtinger G, Tempany CM, Hata N. [http://www.spl.harvard.edu/publications/item/view/1709 OpenIGTLink: an open network protocol for image-guided therapy environment]. [http://www3.interscience.wiley.com/journal/112094293/home Int J Med Robot]. 2009 Dec;5(4):423-34.
**Arata J, Kozuka H, Kim HW, Takesue N, Vladimirov B, Sakaguchi M, Tokuda J, Hata N, Chinzei K, Fujimoto H. Open core control software for surgical robots. Int J Comput Assist Radiol Surg. 2010 May;5(3):211-20. Epub 2009 Jul 28.
**Tokuda J, Fischer GS, DiMaio SP, Gobbi DG, Csoma C, Mewes PW, Fichtinger G, Tempany CM, Hata N. Integrated navigation and control software system for MRI-guided robotic prostate interventions. Comput Med Imaging Graph. 2010 Jan;34(1):3-8. Epub 2009 Aug 20.
**Elhawary H, Liu H, Patel P, Norton I, Rigolo L, Papademetris X, Hata N, Golby AJ. Intraoperative real-time querying of white matter tracts during frameless stereotactic neuronavigation. Neurosurgery. 2011 Feb;68(2):506-16.
**Egger J, Tokuda J, Chauvin L, Freisleben B, Nimsky C, Kapur T, Wells W. Integration of the OpenIGTLink Network Protocol for image-guided therapy with the medical platform MeVisLab, Int J Med Robot Article first published online: 28 FEB 2012 [http://onlinelibrary.wiley.com/doi/10.1002/rcs.1415/abstract DOI: 10.1002/rcs.1415]

*Related web pages
** [http://www.slicer.org/slicerWiki/index.php/Slicer3:_Image_Guided_Therapy_(IGT) Slicer 3 Image-Guided Therapy (IGT) suite]
** [http://www.slicer.org/slicerWiki/index.php/Slicer3:Slicer_Daemon Slicer 3 Daemon] Another network interface in 3D Slicer
** [http://www.opendmtp.org/ OpenDMTP] - Open Device Monitoring and Tracking Protocol
** [http://en.wikipedia.org/wiki/Uniform_Driver_Interface Uniform Driver Interface (UDI)]
** [http://packages.debian.org/source/sid/openigtlink Debian Source Package: OpenIGTLink]
 

= Support =
<hr/>
== License==
[http://opensource.org/licenses/BSD-3-Clause New BSD license] ©2008 Insight Software Consortium 

== Mailing List / Contact ==
We are launching the OpenIGTLink mailing list (openigtlink@bwh.harvard.edu). If you would like to join, please subscribe from
[http://massmail.spl.harvard.edu/mailman/listinfo/openigtlink OpenIGTLink ML Info Page] or send
[[User:Tokuda| Junichi Tokuda (tokuda at bwh.harvard.edu) ]] a message with:
*Your name
*e-mail address you would like to use to post and receive ML articles on
*Affiliation
*Your research topic

 

= Acknowledgements =
<hr/>
*Contributors
** [http://www.kitware.com/profile/team/ibanez.html Luis Ibáñez, Ph.D.], Kitware, Inc.
** [http://www.spl.harvard.edu/pages/People/tokuda Junichi Tokuda, Ph.D.], BWH
** [http://www.cisst.org/wiki/User:Csoma Csaba Csoma], John's Hopkins University
** Jack Blevins, Acoustic MedSystems, Inc.
** Patrick Cheng, Ph.D., Georgetown University
** [http://www.spl.harvard.edu/pages/People/hliu Haying Liu], Brigham and Women's Hospital
** [http://staff.aist.go.jp/k.chinzei/ Kiyoyuki Chinzei, Ph.D.], National Institute of Advanced Industrial Science and Technology, Japan
** [http://arata.web.nitech.ac.jp/index.html Jumpei Arata, Ph.D.], Nagoya Institute of Technology, Japan
** [http://www.spl.harvard.edu/pages/People/pieper Steve Pieper, Ph.D.], Isomics, Inc.
** Yuichiro Hayashi, Ph.D., Nagoya University, Japan
** Atsushi Yamada, Ph.D., Nagoya Institute of Technology, Japan
** [http://www.insightsoftwareconsortium.org/ Insight Software Consortium]
*Funding Support
** Enabling Technologies for MRI-Guided Prostate Interventions funded by NIH (PI: [http://www.spl.harvard.edu/pages/People/ctempany Clare Tempany, MD])
** [http://www.ncigt.org/ National Center for Image-Guided Therapy (NCIGT)]
** [http://www.na-mic.org/ National Alliance for Medical Image Computing (NA-MIC)]
** [http://www.intelli-si.org Intelligent Surgical Instrument Project] sponsored by The Ministry of International Trade and Industry, Japan

OpenIGTLink/Library

2015-02-17T16:53:42Z

Rjollos: /* License */ Fix link to New BSD license. The link directed to the 2-Clause license, rather than the 3-Clause license. The 3-Clause license is "new BSD".

[[OpenIGTLink | << OpenIGTLink]]

=General Information=
<hr/>
== Supported platforms ==
* Microsoft Windows (tested on XP and 7 (32-bit and 64-bit))
* Linux (Tested on Ubuntu 10.10 (32-bit and 64-bit))
* Mac OS X 10.5/6/7/8/9 (Intel 64-bit)
* Sun Solaris (GNU CC and Sun CC) (tested on Solaris 8 and 10)
* QNX (Not tested well -- feedbacks from QNX users are greatly appreciated)

== License ==
This code is distributed under the [http://opensource.org/licenses/BSD-3-Clause new BSD License].

=Instruction=
<hr/>
==Downloading Source Code with Example Programs==
Since December 2011, the source code repository is hosted by GitHub. The code can be obtained from:
git@github.com:openigtlink/OpenIGTLink.git
or
git://github.com/openigtlink/OpenIGTLink.git
If you would like to have read/write access to participate the development, please send your SSH public key to [[User:Tokuda| Junichi Tokuda]]. The source code is also available in the following Subversion repository.
http://svn.na-mic.org/NAMICSandBox/trunk/OpenIGTLink

==Building the Library==
* [[OpenIGTLink/Library/Build | How to build the library]]

== Tutorial==
* [[OpenIGTLink/Library/Tutorial | The Open IGT Link Library Tutorial]]
* [[OpenIGTLink/Approaches | What is the best way to build your OpenIGTLink application?]]

= Acknowledgements =
<hr/>
*Attila Nagy has been helping the team to support Sun OS.
*Dominique Belhachemi contributed to make the OpenIGTLink library available as a Debian Package.

= Contact =
<hr/>
*Please contact [[User:Tokuda| Junichi Tokuda]] at Brigham and Women's Hospital

=Seoul=
making change.

OpenIGTLink/Library/Build

2015-02-17T16:50:54Z

Rjollos: CMake download page has apparently moved.

[[OpenIGTLink | << OpenIGTLink]] | [[OpenIGTLink/Library | Library]]

== Linux / Mac OS X ==

First, obtain the source code from the repository using Git. To simply download the code, run the following command from a terminal:

$ git clone git://github.com/openigtlink/OpenIGTLink.git

If you have any plan to contribute your source code to the repository, please do:

$ git clone git@github.com:openigtlink/OpenIGTLink.git

Note that your SSH public key must be registered to the repository prior to the access. Please send a key to [[User:Tokuda|Junichi Tokuda]] with your contact information.

Then configure using CMake. The library requires CMake version higher than 2.4.
$ mkdir OpenIGTLink-build
$ cd OpenIGTLink-build
$ cmake -DBUILD_EXAMPLES:BOOL=ON ../OpenIGTLink
$ make

You may install the library into your disk (optional). The default target directory is /usr/local, but you can configure it from the CMake configuration screen. To install the files, run

$ make install

You might need super user access.

== Sun OS ==

For Sun OS (Solaris), you may follow the instruction for Linux/Mac OS X described above. If you want to explicitly specify Sun CC instead of GNU CC, options for cmake look like:
cmake -DCMAKE_C_COMPILER:STRING=/opt/SUNWspro/bin/cc -DCMAKE_CXX_COMPILER:STRING=/opt/SUNWspro/bin/CC -DBUILD_EXAMPLES:BOOL=ON ../OpenIGTLink

== Windows ==
* Download Git Windows client, if you don't have one already
* You will also need [http://www.cmake.org/download CMake] and a C/C++ compiler as [http://www.microsoft.com/express/vc/ Microsoft Visual C++]
* Download the source code from Git repository.
** URL of repository: git://github.com/openigtlink/OpenIGTLink.git
** Click OK
* Run CMake
** Where is the source code: C:\Devel\OpenIGT\OpenIGTLink
** Where to build the binaries: C:\Devel\OpenIGT\OpenIGTLink-build
** Click "Configure" and select your compiler (usually just click "OK")
** Message: "Build directory does not exit, should I create it?" - click "OK"
** Click "Configure"
** Click "OK" to close CMake
* Start Visual C and compile the project (C:\Devel\OpenIGT\OpenIGTLink-build\OpenIGTLink.sln)

If all went OK you will have the executable and the library:
* C:\Devel\OpenIGT\OpenIGTLink-build\bin\debug\igtlSocketTest.exe
* C:\Devel\OpenIGT\OpenIGTLink-build\bin\debug\OpenIGTLink.lib

== !!Note on Windows!! ==
If you are planning to link the OpenIGTLink Library with IGSTK, or the 3D Slicer OpenIGTLinkIF module, please make sure that you use the Windows version of CMake (not the one contained in the Cygwin environment) and Visual Studio 2008. Since IGSTK and 3D Slicer are compiled with Visual Studio, the OpenIGTLink library built in cygwin environment using GCC cannot be linked with those software.

== iOS (iPhone and iPod) ==
NOTE: OpenIGTLinkIF is tested on iOS with the following condition:
Target: iOS 5.0.1
Host: Mac OS X 10.7.2 with Xcode 4.2
CMake: 2.8.6
OpenIGTLink: git@github.com:openigtlink/OpenIGTLink.git (commit 68e903965f3f2dde8c0303f6c41cdc81a68d28f4)

Suppose we have a copy of the OpenIGTLink source files in IGTL_SOURCE_DIR and will build the library in IGTL_BINARY_DIR.
First, create a XCode project with CMake:
cd IGTL_BINARY_DIR
ccmake -GXcode IGTL_SOURCE_DIR
No option needs to be edited in the ccmake interface. Simply press 'c' twice and then 'g' to generate a project file and other necessary files for XCode.

Once the files are generated, open "OpenIGTLink.xcodeproj" from XCode. Before building OpenIGTLink for iOS, we generate binary for Mac OS X.
At the left-top of XCode window, choose "OpenIGTLink > My Mac 64-bit" as a target from a pull down-menu and press "Run" just next to the pull-down. If everything goes well, the status window at the center of the window top shows "Build ALL_BUILD: Succeeded."

[[Image:OpenIGTLink_Library_Build_iOS_1.png]]

The next step is to build a binary for iOS simulator. Choose "OpenIGTLink" from "PROJECT" column and change Base SDK to "iOS 5" in Build settings.

[[Image:OpenIGTLink_Library_Build_iOS_2.png|600px]]

[[Image:OpenIGTLink_Library_Build_iOS_3.png|600px]]

After making sure that the target is set to "OpenIGTLink > iPhone 5.0 Simulator," press run button to start compilation process. If everything goes well, the binary file "libOpenIGTLink.a" is stored in IGTL_BINARY_DIR/bin/Debug. It may be a good idea to change the name of "Debug" directory to something like "Sim5.0Debug", since you will need to have also a binary for actual device and switch between two binaries (or four binaries if you build Release version as well).

To use the binary file from your iPhone program, specify the following directories as "Header Search Path":
* IGTL_SOURCE_DIR/Source
* IGTL_SOURCE_DIR/Source/igtlutil
* IGTL_BINARY_DIR/
Also, add the binary file ("libOpenIGTLink.a") under a new group "OpenIGTLink" in the navigation area in on the left of XCode Window.

[[Image:OpenIGTLink_Library_Build_iOS_4.png]]

Reference
*Shabash B, Hamarneh G, Huang ZF, Ibanez L, ITK on the iOS, http://www.sfu.ca/~zfh/IJ_755_1_BuildingITKinTheiPhone.pdf