Difference between revisions of "Documentation/Nightly/Extensions/LightWeightRobotIGT"

From Slicer Wiki
Jump to: navigation, search
 
(28 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
<noinclude>{{documentation/versioncheck}}</noinclude>
 
<noinclude>{{documentation/versioncheck}}</noinclude>
 +
{{ambox
 +
| type  = protection
 +
| image = [[File:InProgress.png|40px|alt=Work in progress]]
 +
| text  = WARNING: This module is Work in Progress, which means:
 +
* the functionality provided by this module may change drastically in the future releases of 3D Slicer
 +
* the scenes containing data types specific to this module may not be readable by the future versions of Slicer
 +
* the functionality and user interface may change at any time
 +
* some functionality may not work as intended
 +
* testing and documentation is limited
 +
}}
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-header}}
 
{{documentation/{{documentation/version}}/module-header}}
Line 10: Line 20:
 
This work is supported in part by the National Institute of Health (R01CA111288, P01CA067165, P41RR019703,P41EB015898, R01CA124377, R01CA138586, R42CA137886, and
 
This work is supported in part by the National Institute of Health (R01CA111288, P01CA067165, P41RR019703,P41EB015898, R01CA124377, R01CA138586, R42CA137886, and
 
U54EB005 149) and is funded by KUKA Laboratories GmbH (Augsburg, Germany).<br>
 
U54EB005 149) and is funded by KUKA Laboratories GmbH (Augsburg, Germany).<br>
−
Author: Sebastian Tauscher, Junichi Tokuda<br>
+
Authors: Sebastian Tauscher, Junichi Tokuda<br>
−
Contact: Sebastian Tauscher, <email>sebastian.tauscher@imes.uni-hannover.de</email><br>
+
Contact: Sebastian Tauscher, <email>sebastian.tauscher@imes.uni-hannover.de</email>, [http://www.imes.uni-hannover.de/institut.html?&L=1 Insitute of Mechatronics Systems], [http://www.uni-hannover.de/en/index.php Leibniz University Hannover]<br>
−
{{documentation/{{documentation/version}}/module-introduction-row}}
+
<br>
−
{{documentation/{{documentation/version}}/module-introduction-logo-gallery
+
[[File:imesLogo.png|200px|center|thumb]]
−
|{{collaborator|logo|namic}}|NA-MIC
+
 
−
}}
+
 
−
{{documentation/{{documentation/version}}/module-introduction-end}}
 
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
−
The LightWeightRobotIGT module allow to communicate with a light weight robot (LWR iiwa, KUKA Laboratories GmbH, Germany, Augsburg) using a open interface concept based on the OpenIGTLink protocol (LWROpenIGTIF). Therefor, a state machine example is available at [http://www.example.com Git Hub] containing the necessary interface classes for the communication on the robot control. A tutorial on how to set up the robotic system for the use with this 3D Slicer module see [http://www.example.com Tutorial-LightWeightRobot-getting started]. For an introduction of the interface concept see [http://www.example.com Tutorial-LightWeightRopbotIGT-Introduction]. The module provides the following features:  
+
The LightWeightRobotIGT module allows to communicate with a light weight robot (LWR iiwa, KUKA Laboratories GmbH, Germany, Augsburg) using an open interface concept based on the [http://openigtlink.org/ OpenIGTLink protocol] (LWROpenIGTIF). Therefore, a state machine example is available at [https://github.com/tauscherSw/LWROpenIGTIF.git Git Hub] containing the necessary interface classes for the communication on the robot control. The software documentation can be found [https://github.com/tauscherSw/LWROpenIGTIF.git Git Hub] as well. A tutorial on how to set up the robotic system for the use with this 3D Slicer module see [[Media:Tutorial_LightWeightRobotIGT_Gettingstarted.pdf| LightWeightRobotIGT Getting Started]]. For an introduction of the interface concept see [[Media:Tutorial_LightWeightRobotIGT_Introduction.pdf| LightWeightRobotIGT Introduction]]. The module provides the following features:  
 
*Communication with the robot control
 
*Communication with the robot control
−
**Bidirectional cyclic communication with a state control running on the robot control. Command strings of the type "CommandName;p1;...;pn;" with the parameters needed to initialise the state p1-pn are sent to the robot control and acknowledge strings are received (see table below for a list of all supported command and acknowledge strings and their parameters).   
+
**Bidirectional cyclic communication via ethernet with a state control running on the robot control. Command strings of the type "CommandName;p1;...;pn;" with the parameters ''p1-pn'' needed to initialise the states are sent to the robot control and acknowledge strings are received (see table below for a list of all supported command and acknowledge strings and their parameters).   
−
**Receiving the transformation matrix containing the pose of each robot joint in robot base coordinate frame and a matrix containing a similar transformation including information about the force direction, absolute value and application point.
+
**Receiving the transformation matrix containing the pose of each robot joint in robot base coordinate frame and a matrix containing a similar transformation including information about the force direction, absolute value, and application point.
−
**Send the transformation matrix describuing the transformation between robot base coordinate frame to image space or CT base coordinate frame
+
**Sending the transformation matrix describing the transformation from robot base coordinate frame to image space or to CT base coordinate frame
 
*Visualisation
 
*Visualisation
−
**a 3D model of the robot can be loaded and is automatically connected to the corresponding transformation matrices received from the robot control.
+
**A 3D model of the robot can be loaded and is automatically connected to the corresponding transformation matrices received from the robot control.
−
**the estimated force at the tool center point, e.g. the tool tip can be visualized by an scaled 3D arrow in the force direction.  
+
**The estimated force at the tool center point, e.g. the tool tip, can be visualized by a scaled 3D arrow in the force direction.  
−
**the color of the robot model changes the color due to the current robot state received in the acknowledge string, and, hence, gives a direct feedback to the user of the current robot state
+
**The color of the robot model changes due to the current robot state received in the acknowledge string and, hence, gives a direct feedback to the user of the current robot state
−
**active virtual fixtures in relation to the robot and the target region changing their color to red when robot reach the fixtures
+
**Active virtual fixtures in relation to the robot and the target region changing their color to red when robot reach the fixtures
 +
{{Gallery
 +
|height=300
 +
|width=300
 +
|lines=3
 +
|align=center
 +
| File:InterfaceConcept.png|Interface concept for the integration of a robot into an image-guided therapy system consisting of a visualization and state control
 +
| File:TaskOverview.png|Overview of the communication structures and the threads on the robot control and the slicer workstation
 +
| File:FiniteStateMachine_colored.png|Exemplary state machine for IGT
 +
| File:StateMachineCommands.png|Command and acknowledge parameter set of the exemplary state machine
 +
}}
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
Line 36: Line 55:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Tutorials}}
 
{{documentation/{{documentation/version}}/module-section|Tutorials}}
−
*General interface concept and communication overview: [http://www.example.com LightWeightRopbotIGT-Introduction]
+
*General interface concept and communication overview see [[Media:Tutorial_LightWeightRobotIGT_Introduction.pdf| LightWeightRobotIGT Introduction]]
−
*Tutorial on how to set up your system and start the example: [http://www.example.com LightWeightRobotIGT-getting started]  
+
*Tutorial on how to set up your system and start the example see [[Media:Tutorial_LightWeightRobotIGT_Gettingstarted.pdf| LightWeightRobotIGT Getting Started]]
−
*and how to add new states to the exemplary state machine [http://www.example.com LightWeightRobotIGT-add state]  
 
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
 
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
−
*''Start Communication'': Starts the cyclic communication with the state machine on the robot control
+
{|
−
*''Start Visualisation'': Send a command to the robot control to activate the Visualisation
+
|[[Image:Panel.jpg|thumb|400px|LighTWeightRobotIGT]]
−
*''Stop Visualisation'': Send a command to the robot control to deactivate the Visualisation
+
|}
−
*''Load Robot'': Loading the stl-File of the robot and the tool in the path defined by "Path". The part shuld be named ....
+
{|style="width: 100%"
−
*''Show TCP Force'': Visualizing the estimate force at the tool center point by a scaled 3D arrow pointing in force direction.
+
|
−
*Registration:
+
*''Start Cyclic Communication'': Starts the cyclic communication with the state machine on the robot control and activates the connector nodes
−
**''Free'': Sending a transition request to the ''free'' state to the robot control in which the robot can be moved freely and manually
+
*''Start Visualisation'': Sends a command to the robot control to activate the visualization
−
**''Get Fiducial'': Saves the current position in a fiducial list which can be used for a fiducial registration using modul XY
+
*''Stop Visualisation'': Sends a command to the robot control to deactivate the visualization
−
*Prepositioning:
+
*''Path'': Path were the robot stl files are located
−
**''Virtual Fixture'': Sending a transition request to the ''VirtualFixtures'' state to the robot control in which the robot can be moved freely and manually in work space restricted by active constraints. The supported virtual fixtures geometries are ''plane'' and ''cone''.
+
*''Load Robot STL'': Loads the stl-files of the robot and the tool from the path defined by "Path".
−
**''PathImp'': Sending a transition request to the ''Path'' state to the robot control in which the robot can be moved on a linear path from the current position towards a target position.
+
*''Show TCP Force'': Visualizing the estimated force at the tool center point by a scaled 3D arrow pointing in force direction.
 +
*Registration tab:
 +
**''Free'': Sends a transition request to the ''Free'' state to the robot control, in which the robot can be moved freely and manually
 +
**''Get Fiducial from Robot'': Saves the current position in a fiducial list which can be used for a fiducial registration using modul Fiducial Registration
 +
| align="right"|
 +
[[Image:PanelPrePositioning.jpg|thumb|400px|Prepositioning tab]]
 +
|-
 +
|
 +
*Prepositioning tab:
 +
**''point x,y,z'': Position of the cone tip or the plane in robot base coordinate frame
 +
**''n'': z-axis of the cone or norm vector of the plane
 +
**''VFtype'': Here you can choose the geometry of the virtual fixture - cone or plane
 +
**''Virtual Fixture'': Sends a transition request to the ''VirtualFixtures'' state to the robot control in which the robot can be moved freely and manually in work space restricted by active constraints. The supported virtual fixtures geometries are ''plane'' and ''cone''.
 +
**''Path Impedence Control'': Sends a transition request to the ''Path'' state to the robot control, in which the robot can be moved on a linear path from the current position towards a target position.
 +
| align="right"|
 +
[[Image:PanelTargeting.jpg|thumb|400px|Prepositioning tab]]
 +
|-
 +
|
 
*Targeting:
 
*Targeting:
−
**''Move To'': Sending a transition request to the ''MoveTo'' state to the robot control in which the robot moves position controlled towards a target position.
+
**''Move To Pose'': Sends a transition request to the ''MoveTo'' state to the robot control in which the robot moves position controlled towards a target position.
−
*''Reset Robot to Idle'': Sending a transition request to the ''Idle'' state to the robot control
+
**''point x, y, z'': Target position in robot base coordinate frame
−
*''Shut Down state machine'': Sends a command to shut down the state machine running on the robot control
+
**''A, B, C'': Euler ankle describing the orientation at the target point in robot b ase coordinate frame of the tool
 +
*''Reset Robot to Idle'': Sends a transition request to the ''Idle'' state to the robot control
 +
*''Shut Down State Machine'': Sends a command to shut down the state machine running on the robot control
 +
|}
 +
 
 
<!--
 
<!--
 
{{documentation/{{documentation/version}}/module-parametersdescription}}
 
{{documentation/{{documentation/version}}/module-parametersdescription}}
Line 67: Line 106:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|References}}
 
{{documentation/{{documentation/version}}/module-section|References}}
−
Tauscher S, Tokuda J, Schreiber G, Neff T, Hata N, Ortmaier T. OpenIGTLink interface for state control and visualisation of a robot for image-guided therapy systems. Int J Comput Assist Radiol Surg. 2014 Jun 13.  
+
#''' Tauscher S''', Tokuda J, Schreiber G, Neff T, Hata N, Ortmaier T. OpenIGTLink interface for state control and visualisation of a robot for image-guided therapy systems. Int J Comput Assist Radiol Surg. 2014 Jun 13.  
 +
#'''Tauscher S''', Ortmaier T, Neff T. Interface concept for the integration of a robot into an image-guided therapy system. Proceedings of the 27th International Congress on Computer Assisted Radiology and Surgery (CARS 2013)
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
Line 73: Line 113:
 
{{documentation/{{documentation/version}}/module-developerinfo}}
 
{{documentation/{{documentation/version}}/module-developerinfo}}
  
 +
Source code: https://github.com/SNRLab/LightWeightRobotIGT
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-footer}}
 
{{documentation/{{documentation/version}}/module-footer}}
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->

Latest revision as of 17:32, 16 December 2018

Home < Documentation < Nightly < Extensions < LightWeightRobotIGT


For the latest Slicer documentation, visit the read-the-docs.


Work in progress
 WARNING: This module is Work in Progress, which means:
  • the functionality provided by this module may change drastically in the future releases of 3D Slicer
  • the scenes containing data types specific to this module may not be readable by the future versions of Slicer
  • the functionality and user interface may change at any time
  • some functionality may not work as intended
  • testing and documentation is limited

Introduction and Acknowledgements

This work is supported in part by the National Institute of Health (R01CA111288, P01CA067165, P41RR019703,P41EB015898, R01CA124377, R01CA138586, R42CA137886, and U54EB005 149) and is funded by KUKA Laboratories GmbH (Augsburg, Germany).
Authors: Sebastian Tauscher, Junichi Tokuda
Contact: Sebastian Tauscher, <email>sebastian.tauscher@imes.uni-hannover.de</email>, Insitute of Mechatronics Systems, Leibniz University Hannover

ImesLogo.png


Module Description

The LightWeightRobotIGT module allows to communicate with a light weight robot (LWR iiwa, KUKA Laboratories GmbH, Germany, Augsburg) using an open interface concept based on the OpenIGTLink protocol (LWROpenIGTIF). Therefore, a state machine example is available at Git Hub containing the necessary interface classes for the communication on the robot control. The software documentation can be found Git Hub as well. A tutorial on how to set up the robotic system for the use with this 3D Slicer module see LightWeightRobotIGT Getting Started. For an introduction of the interface concept see LightWeightRobotIGT Introduction. The module provides the following features:

  • Communication with the robot control
    • Bidirectional cyclic communication via ethernet with a state control running on the robot control. Command strings of the type "CommandName;p1;...;pn;" with the parameters p1-pn needed to initialise the states are sent to the robot control and acknowledge strings are received (see table below for a list of all supported command and acknowledge strings and their parameters).
    • Receiving the transformation matrix containing the pose of each robot joint in robot base coordinate frame and a matrix containing a similar transformation including information about the force direction, absolute value, and application point.
    • Sending the transformation matrix describing the transformation from robot base coordinate frame to image space or to CT base coordinate frame
  • Visualisation
    • A 3D model of the robot can be loaded and is automatically connected to the corresponding transformation matrices received from the robot control.
    • The estimated force at the tool center point, e.g. the tool tip, can be visualized by a scaled 3D arrow in the force direction.
    • The color of the robot model changes due to the current robot state received in the acknowledge string and, hence, gives a direct feedback to the user of the current robot state
    • Active virtual fixtures in relation to the robot and the target region changing their color to red when robot reach the fixtures
Interface concept for the integration of a robot into an image-guided therapy system consisting of a visualization and state control  
Overview of the communication structures and the threads on the robot control and the slicer workstation  
Exemplary state machine for IGT  
Command and acknowledge parameter set of the exemplary state machine  

Use Cases

N/A

Tutorials

Panels and their use

LighTWeightRobotIGT
  • Start Cyclic Communication: Starts the cyclic communication with the state machine on the robot control and activates the connector nodes
  • Start Visualisation: Sends a command to the robot control to activate the visualization
  • Stop Visualisation: Sends a command to the robot control to deactivate the visualization
  • Path: Path were the robot stl files are located
  • Load Robot STL: Loads the stl-files of the robot and the tool from the path defined by "Path".
  • Show TCP Force: Visualizing the estimated force at the tool center point by a scaled 3D arrow pointing in force direction.
  • Registration tab:
    • Free: Sends a transition request to the Free state to the robot control, in which the robot can be moved freely and manually
    • Get Fiducial from Robot: Saves the current position in a fiducial list which can be used for a fiducial registration using modul Fiducial Registration
Prepositioning tab
  • Prepositioning tab:
    • point x,y,z: Position of the cone tip or the plane in robot base coordinate frame
    • n: z-axis of the cone or norm vector of the plane
    • VFtype: Here you can choose the geometry of the virtual fixture - cone or plane
    • Virtual Fixture: Sends a transition request to the VirtualFixtures state to the robot control in which the robot can be moved freely and manually in work space restricted by active constraints. The supported virtual fixtures geometries are plane and cone.
    • Path Impedence Control: Sends a transition request to the Path state to the robot control, in which the robot can be moved on a linear path from the current position towards a target position.
Prepositioning tab
  • Targeting:
    • Move To Pose: Sends a transition request to the MoveTo state to the robot control in which the robot moves position controlled towards a target position.
    • point x, y, z: Target position in robot base coordinate frame
    • A, B, C: Euler ankle describing the orientation at the target point in robot b ase coordinate frame of the tool
  • Reset Robot to Idle: Sends a transition request to the Idle state to the robot control
  • Shut Down State Machine: Sends a command to shut down the state machine running on the robot control


Similar Modules

N/A

References

  1. Tauscher S, Tokuda J, Schreiber G, Neff T, Hata N, Ortmaier T. OpenIGTLink interface for state control and visualisation of a robot for image-guided therapy systems. Int J Comput Assist Radiol Surg. 2014 Jun 13.
  2. Tauscher S, Ortmaier T, Neff T. Interface concept for the integration of a robot into an image-guided therapy system. Proceedings of the 27th International Congress on Computer Assisted Radiology and Surgery (CARS 2013)

Information for Developers

Work in progress
 Section under construction.


Source code: https://github.com/SNRLab/LightWeightRobotIGT


Retrieved from "https://www.slicer.org/w/index.php?title=Documentation/Nightly/Extensions/LightWeightRobotIGT&oldid=60657"