Difference between revisions of "Modules:VMTKSlicerModule"

From Slicer Wiki
Jump to: navigation, search
m (Text replacement - "\[http:\/\/www\.slicer\.org\/slicerWiki\/images\/([^ ]+) ([^]]+)]" to "[http://www.slicer.org/w/img_auth.php/$1 $2]")
 
(11 intermediate revisions by one other user not shown)
Line 1: Line 1:
[[Documentation-3.4|Return to Slicer 3.4 Documentation]]
+
[[Documentation-3.6|Return to Slicer 3.6 Documentation]]
  
[[Announcements:Slicer3.4#Highlights|Gallery of New Features]]
+
[[Announcements:Slicer3.6#Highlights|Gallery of New Features]]
  
 
__NOTOC__
 
__NOTOC__
Line 7: Line 7:
 
VmtkSlicerModule
 
VmtkSlicerModule
  
 +
{|
 +
|[[Image:Slicervmtk_logo.png|thumb|280px|Part of the VMTK in 3D Slicer collection]]
 +
|}
  
 
== General Information ==
 
== General Information ==
Line 17: Line 20:
 
===Authors, Collaborators & Contact===
 
===Authors, Collaborators & Contact===
 
* Author: Daniel Haehn, University of Heidelberg
 
* Author: Daniel Haehn, University of Heidelberg
* Supervisor: Luca Antiga, Mario Negri Institute
+
* Acknowledgments: Luca Antiga, Mario Negri Institute; Steve Pieper, Isomics Inc.
 
* Contact: Daniel Haehn, haehn@bwh.harvard.edu
 
* Contact: Daniel Haehn, haehn@bwh.harvard.edu
  
Line 27: Line 30:
 
'''Official project page:''' http://www.vmtk.org/Main/VmtkIn3DSlicer
 
'''Official project page:''' http://www.vmtk.org/Main/VmtkIn3DSlicer
  
== Usage and Installation ==
+
== Usage ==
This module can be installed as a 3D Slicer Extension or manually. Either way will automatically include the latest version of the VMTK libraries by accessing the official VMTK SVN repository.
+
===Installation===
 +
This module can be installed using the '''3D Slicer extension wizard'''. The extension is called ''VmtkSlicerModule''.
  
* '''Installation as a 3D Slicer Extension'''
+
When the module was successfully installed, all VMTK extensions can be used.
Inside the [[Slicer3:Extensions|3D Slicer extension system]], the module is called ''VmtkSlicerModule''.
 
 
 
* '''Manual Installation'''
 
1. To get the latest source code, perform the following SVN checkout command:
 
<pre>svn checkout https://www.nitrc.org/svn/slicervmtklvlst</pre>
 
2. A directory named ''VmtkSlicerModule'' is downloaded and the latest VMTK libraries get checked out as well.
 
 
 
3. Copy this directory to ''Slicer3/Modules/'' of your local Slicer installation.
 
 
 
4. Edit the ''Slicer3/Modules/CMakeLists.txt'' file and add ''VmtkSlicerModule'' to the Subdirs directive.
 
 
 
5. Change directory to ''Slicer3-build/'' and issue a ''make -j2'' command to start the compilation.
 
  
 +
===Examples, Use Cases & Tutorials===
 +
The actual VMTK functions for end users are provided as Python scripted modules.
  
When the module was successfully installed, all VMTK methods are available for developer access within 3D Slicer.
+
After installing this module, the following extensions can be installed and used.
  
===Examples, Use Cases & Tutorials===
+
*[[Modules:VMTKCenterlines|VMTKCenterlines]] providing centerline computation of surface models
The actual VMTK functions for end users are provided as Python scripted modules.
 
  
After installing this module, these can be installed and used.
+
*[[Modules:VMTKEasyLevelSetSegmentation|VMTKEasyLevelSetSegmentation]] providing level-set segmentation of vessels, aneurysms and tubular structures using an easy interface
  
*[[Modules:VMTKLevelSetSegmentation|VMTKLevelSetSegmentation]] - providing level-set segmentation of vessels, aneurysms and tubular structures using different algorithms
+
*[[Modules:VMTKLevelSetSegmentation|VMTKLevelSetSegmentation]] providing level-set segmentation of vessels, aneurysms and tubular structures using different algorithms for initialization and evolution
  
*[[Modules:VMTKVesselEnhancement|VMTKVesselEnhancement]] - providing vessel enhancement filters to highlight vasculature or tubular structures
+
*[[Modules:VMTKVesselEnhancement|VMTKVesselEnhancement]] providing vessel enhancement filters to highlight vascular or tubular structures
  
 
== Development ==
 
== Development ==
  
 +
===Notes from the Developer(s)===
 +
The algorithms provided by VMTK and by this module are C++ classes implemented using VTK and ITK.
  
 
===Source code & Documentation===
 
===Source code & Documentation===
Line 68: Line 63:
  
 
* [http://www.nitrc.org/plugins/scmsvn/viewcvs.php/VmtkSlicerModule/vtkVmtkSlicerModuleLogic.cxx?root=slicervmtklvlst&view=markup vtkVmtkSlicerModuleLogic.cxx] to initialize the generated Tcl wrapper classes of the vtkVmtk libraries
 
* [http://www.nitrc.org/plugins/scmsvn/viewcvs.php/VmtkSlicerModule/vtkVmtkSlicerModuleLogic.cxx?root=slicervmtklvlst&view=markup vtkVmtkSlicerModuleLogic.cxx] to initialize the generated Tcl wrapper classes of the vtkVmtk libraries
 +
 +
During a SVN check out, the actual VMTK libraries are automatically checked out using a ''svn:external'' repository. Therefore always the latest version of VMTK is included as a subdirectory.
  
 
Since the Tcl initialization is performed, the vtkVmtk library can also be accessed from Python in 3D Slicer.
 
Since the Tcl initialization is performed, the vtkVmtk library can also be accessed from Python in 3D Slicer.
  
Information and documentation concerning the integration of VMTK can be found in this [http://www.slicer.org/slicerWiki/images/4/42/Slicer_VMTK_student_research_project.pdf student research project write-up].
+
Information and documentation concerning the integration of VMTK can be found in this [http://www.slicer.org/w/img_auth.php/4/42/Slicer_VMTK_student_research_project.pdf student research project write-up].
 +
 
 +
Documentation of the VMTK libraries is available [http://www.vmtk.org/doxygen/html/annotated.html here].
  
 
===Known bugs===
 
===Known bugs===
Line 80: Line 79:
  
 
===Acknowledgment===
 
===Acknowledgment===
This work was funded by a charitable grant of the Thomas­-Gessmann Foundation part of the Founder Federation for German Science.
+
This work was funded by a grant of the Thomas­-Gessmann Foundation part of the Founder Federation for German Science.
  
 
===References===
 
===References===
 +
* Antiga L, Piccinelli M, Botti L, Ene-Iordache B, Remuzzi A and Steinman DA. An image-based modeling framework for patient-specific computational hemodynamics. Medical and Biological Engineering and Computing, 46: 1097-1112, Nov 2008.
 +
* D. Hähn. Integration of the vascular modeling toolkit in 3d slicer. SPL, 04 2009. Available online at http://www.spl.harvard.edu/publications/item/view/1728.
 
* Piccinelli M, Veneziani A, Steinman DA, Remuzzi A, Antiga L (2009) A framework for geometric analysis of vascular structures: applications to cerebral aneurysms. IEEE Trans Med Imaging. In press.
 
* Piccinelli M, Veneziani A, Steinman DA, Remuzzi A, Antiga L (2009) A framework for geometric analysis of vascular structures: applications to cerebral aneurysms. IEEE Trans Med Imaging. In press.
* Antiga L, Piccinelli M, Botti L, Ene-Iordache B, Remuzzi A and Steinman DA. An image-based modeling framework for patient-specific computational hemodynamics. Medical and Biological Engineering and Computing, 46: 1097-1112, Nov 2008.
 

Latest revision as of 12:38, 27 November 2019

Home < Modules:VMTKSlicerModule

Return to Slicer 3.6 Documentation

Gallery of New Features


Module Name

VmtkSlicerModule

Part of the VMTK in 3D Slicer collection

General Information

Module Type & Category

Type: GUI-less loadable module

Category: Extension

Authors, Collaborators & Contact

  • Author: Daniel Haehn, University of Heidelberg
  • Acknowledgments: Luca Antiga, Mario Negri Institute; Steve Pieper, Isomics Inc.
  • Contact: Daniel Haehn, haehn@bwh.harvard.edu

Module Description

This GUI-less loadable module provides the libraries of the Vascular Modeling Toolkit (http://www.vmtk.org/) in 3D Slicer.

It is part of the NA-MIC VMTK Collaboration.

Official project page: http://www.vmtk.org/Main/VmtkIn3DSlicer

Usage

Installation

This module can be installed using the 3D Slicer extension wizard. The extension is called VmtkSlicerModule.

When the module was successfully installed, all VMTK extensions can be used.

Examples, Use Cases & Tutorials

The actual VMTK functions for end users are provided as Python scripted modules.

After installing this module, the following extensions can be installed and used.

  • VMTKLevelSetSegmentation providing level-set segmentation of vessels, aneurysms and tubular structures using different algorithms for initialization and evolution

Development

Notes from the Developer(s)

The algorithms provided by VMTK and by this module are C++ classes implemented using VTK and ITK.

Source code & Documentation

The complete source code is available at a NITRC SVN repository.

The most important files are the following:

During a SVN check out, the actual VMTK libraries are automatically checked out using a svn:external repository. Therefore always the latest version of VMTK is included as a subdirectory.

Since the Tcl initialization is performed, the vtkVmtk library can also be accessed from Python in 3D Slicer.

Information and documentation concerning the integration of VMTK can be found in this student research project write-up.

Documentation of the VMTK libraries is available here.

Known bugs

Follow this link to the VMTK in 3D Slicer bug tracker.

More Information

Acknowledgment

This work was funded by a grant of the Thomas­-Gessmann Foundation part of the Founder Federation for German Science.

References

  • Antiga L, Piccinelli M, Botti L, Ene-Iordache B, Remuzzi A and Steinman DA. An image-based modeling framework for patient-specific computational hemodynamics. Medical and Biological Engineering and Computing, 46: 1097-1112, Nov 2008.
  • D. Hähn. Integration of the vascular modeling toolkit in 3d slicer. SPL, 04 2009. Available online at http://www.spl.harvard.edu/publications/item/view/1728.
  • Piccinelli M, Veneziani A, Steinman DA, Remuzzi A, Antiga L (2009) A framework for geometric analysis of vascular structures: applications to cerebral aneurysms. IEEE Trans Med Imaging. In press.