Difference between revisions of "OpenIGTLink/ProtocolV2/Index"

From NAMIC Wiki
Jump to: navigation, search
(Created page with ' << OpenIGTLink =General Information= ==Version 2 Release Timeline== We are inviting proposals from the community for new and modified message formats, wh…')
 
 
(42 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
[[OpenIGTLink | &lt;&lt; OpenIGTLink]]
 
[[OpenIGTLink | &lt;&lt; OpenIGTLink]]
  
−
=General Information=
+
=OpenIGTLink version 2 Summary=
−
==Version 2 Release Timeline==
+
*The header format will not be changed.
−
We are inviting proposals from the community for new and modified message formats, which are potentially included into OpenIGTLink version 2 protocol. The deadline of proposal is September 12 (One week before MICCAI 2010). Anyone, who has an account in NA-MIC wiki, can propose a new message. The proposed messages will be reviewed by the community during a period between MICCAI 2010 and NA-MIC All Hands Meeting 2011.
+
*Simple querying mechanism is defined. See [[OpenIGTLink/ProtocolV2/Query| querying mechanism in version 2]].
 +
*The protocol version 2 continue to focus on message formats. Supporting tools (simulators and interfaces for specific applications e.g. 3D Slicer, Matlab) and transportation layer (use of UDP or other network communication middleware) should be discussed separately.
 +
*More information is available in [[OpenIGTLink/ProtocolV2/Summary| Version 2 Summary page]].
  
−
==Inviting Message Type Proposal -- How to Propose==
+
=OpenIGTLink Protocol Rules=
−
Please add one proposal page per message type. The template for a proposal page is available [[OpenIGTLink/ProtocolV2/ProoposalTemplate| here]]. All proposal pages must be linked from the section [[OpenIGTLink/ProtocolV2/Proposals#Message Proposals|below in this page]].
+
*The OpenIGTLink protocol is a network communication protocol works in the Application Layer in the OSI model.
 +
*The minimum unit in data transfer in OpenIGTLink protocol is an '''OpenIGTLink message'''.
 +
*An OpenIGTLink message consists of '''header''' and '''body''' sections. The header format is consistent and can be interpreted by all software that has OpenIGTLink interface. The header contains device type (or data type) name, which specifies the format of the body.
 +
*The OpenIGTLink protocol is stateless.
  
−
=Basic Information about OpenIGTLink version 2=
+
=Architecture and Header=
−
*The header format will not be changed. The header format in version one is available at [[OpenIGTLink/Protocol|the version 1 protocol page]].
+
*[[OpenIGTLink/ProtocolV2/Header| OpenIGTLink Header]]
−
*Simple querying mechanism is defined. See [[OpenIGTLink/ProtocolV2/Query| querying mechanism in version 2]].
 
−
*The protocol version 2 continue to focus on message formats. Supporting tools (simulators and interfaces for specific applications e.g. 3D Slicer, Matlab) and transportation layer (use of UDP or other network communication middleware) should be discussed separately.
 
−
*'''(TBD)'''Xenios proposed to introduce a "footer" field in addition to header and body in the OpenIGTLink message format. The idea is to use footer as an area, which can be used by the developers to put application-specific information. In most case, this "footer" approach does not violate the rules in version 1 protocol.
 
  
−
=Message Proposals=
+
=Proposed Message Types=
 
==Message types inherited from version 1==
 
==Message types inherited from version 1==
 
*[[OpenIGTLink/ProtocolV2/Type/Transform|TRANSFORM]]
 
*[[OpenIGTLink/ProtocolV2/Type/Transform|TRANSFORM]]
−
*[[OpenIGTLink/ProtocolV2/Type/Position|POSITION]]
+
*[[OpenIGTLink/ProtocolV2/Type/QTransform|QTRANS]] (formerly POSITION)
 +
*[[OpenIGTLink/ProtocolV2/Type/Position|POSITION]] (alias of QTRANSFORM)
 
*[[OpenIGTLink/ProtocolV2/Type/Image|IMAGE]]
 
*[[OpenIGTLink/ProtocolV2/Type/Image|IMAGE]]
 
*[[OpenIGTLink/ProtocolV2/Type/Status|STATUS]]
 
*[[OpenIGTLink/ProtocolV2/Type/Status|STATUS]]
 
*[[OpenIGTLink/ProtocolV2/Type/Capability|CAPABILITY]]
 
*[[OpenIGTLink/ProtocolV2/Type/Capability|CAPABILITY]]
  
−
==New Message types for image-guided surgery (IGS) systems==
+
==New message types for image-guided surgery (IGS) systems==
 
*[[OpenIGTLink/ProtocolV2/Type/ImageMeta|IMGMETA]]
 
*[[OpenIGTLink/ProtocolV2/Type/ImageMeta|IMGMETA]]
 
*[[OpenIGTLink/ProtocolV2/Type/LabelMeta|LBMETA]]
 
*[[OpenIGTLink/ProtocolV2/Type/LabelMeta|LBMETA]]
 +
*[[OpenIGTLink/ProtocolV2/Type/ColorTable|COLORT]]
 
*[[OpenIGTLink/ProtocolV2/Type/Point|POINT]]
 
*[[OpenIGTLink/ProtocolV2/Type/Point|POINT]]
−
*[[OpenIGTLink/ProtocolV2/Type/Trajectory|TRAJECTORY]]
+
*[[OpenIGTLink/ProtocolV2/Type/Trajectory|TRAJ]]
 
*[[OpenIGTLink/ProtocolV2/Type/TrackingData|TDATA]]
 
*[[OpenIGTLink/ProtocolV2/Type/TrackingData|TDATA]]
 +
*[[OpenIGTLink/ProtocolV2/Type/QTrackingData|QTDATA]]
 +
 +
==New message types for other applications==
 +
*[[OpenIGTLink/ProtocolV2/Type/SensorData|SENSOR]]
 +
*[[OpenIGTLink/ProtocolV2/Type/String|STRING]]
 +
*[[OpenIGTLink/ProtocolV2/Type/NDArray|NDARRAY]]
 +
*[[OpenIGTLink/ProtocolV2/Type/Bind|BIND]]
 +
*[[OpenIGTLink/ProtocolV2/Type/PolyData|POLYDATA]]
  
−
<!--
+
=Other Information=
−
* [[OpenIGTLink/ProtocolV2 | Protocol description (draft)]]
+
*[[OpenIGTLink/ProtocolV2/Unit| 64-bit UNIT field in OpenIGTLink]]
−
**[[OpenIGTLink/Discussion/NewCommands | (Discussions for version 2)]]
 
−
* <font color="red">(New!)</font> If you are interested in trying version 2, please see  [[OpenIGTLink/TryVersion2 | Try OpenIGTLink version 2 ]]
 
−
-->
 

Latest revision as of 18:08, 12 December 2011

Home < OpenIGTLink < ProtocolV2 < Index

<< OpenIGTLink

OpenIGTLink version 2 Summary

  • The header format will not be changed.
  • Simple querying mechanism is defined. See querying mechanism in version 2.
  • The protocol version 2 continue to focus on message formats. Supporting tools (simulators and interfaces for specific applications e.g. 3D Slicer, Matlab) and transportation layer (use of UDP or other network communication middleware) should be discussed separately.
  • More information is available in Version 2 Summary page.

OpenIGTLink Protocol Rules

  • The OpenIGTLink protocol is a network communication protocol works in the Application Layer in the OSI model.
  • The minimum unit in data transfer in OpenIGTLink protocol is an OpenIGTLink message.
  • An OpenIGTLink message consists of header and body sections. The header format is consistent and can be interpreted by all software that has OpenIGTLink interface. The header contains device type (or data type) name, which specifies the format of the body.
  • The OpenIGTLink protocol is stateless.

Architecture and Header

Proposed Message Types

Message types inherited from version 1

New message types for image-guided surgery (IGS) systems

New message types for other applications

Other Information

Retrieved from "https://www.na-mic.org/w/index.php?title=OpenIGTLink/ProtocolV2/Index&oldid=72445"