Difference between revisions of "Modules:PythonSurfaceConnectivity-Documentation-3.4"

From Slicer Wiki
Jump to: navigation, search
(New page: Return to Slicer 3.4 Documentation __NOTOC__ ===Module Name=== MyModule {| |thumb|280px|Caption 1 |[[Image:screenshotBlank.png|thumb|2...)
 
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Documentation-3.4|Return to Slicer 3.4 Documentation]]
+
[[Documentation-3.4|Return to Slicer 3.4 Documentation]]
 +
 
 +
[[Announcements:Slicer3.4#Highlights|Gallery of New Features]]
 
__NOTOC__
 
__NOTOC__
 
===Module Name===
 
===Module Name===
MyModule
+
Python Surface Connectivity
  
 
{|
 
{|
|[[Image:screenshotBlank.png|thumb|280px|Caption 1]]
+
|[[Image:PythonSurfaceConnectivity1.png|thumb|320px|Figure 1: Clipped model of ICA aneurysm]]
|[[Image:screenshotBlank.png|thumb|280px|Caption 2]]
+
|[[Image:PythonSurfaceConnectivity2.png|thumb|320px|Figure 2: Connnected region closest to user-specified seed is extracted]]
|[[Image:screenshotBlank.png|thumb|280px|Caption 3]]
+
|[[Image:PythonSurfaceConnectivity3.png|thumb|320px|Figure 2: All connected regions are extracted and one seed is generated for every region]]
 
|}
 
|}
  
Line 13: Line 15:
 
===Module Type & Category===
 
===Module Type & Category===
  
Type: Interactive or CLI
+
Type: CLI
  
Category: Base or (Filtering, Registration, ''etc.'')
+
Category: Surface Models
  
 
===Authors, Collaborators & Contact===
 
===Authors, Collaborators & Contact===
* Author1: Affiliation & logo, if desired
+
* Luca Antiga: Mario Negri Institute
* Contributor1: Affiliation & logo, if desired
+
* Daniel Blezek: Mayo Clinic
* Contributor2: Affiliation & logo, if desired
+
* Contact: Luca Antiga, antiga@marionegri.it
* Contact: name, email
 
  
 
===Module Description===
 
===Module Description===
Overview of what the module does goes here.
+
This Python module takes in input a surface and labels it according to surface connectivity. The module either labels the surface with a different RegionId for each connected region, or it extracts the connected region closest to an input fiducial. Optionally, the module produces a list of fiducials positioned on each connected region and labeled with its RegionId.
  
 
== Usage ==
 
== Usage ==
Line 30: Line 31:
 
===Examples, Use Cases & Tutorials===
 
===Examples, Use Cases & Tutorials===
  
* Note use cases for which this module is especially appropriate, and/or link to examples.
+
* The module is appropriate when there is need of extracting different disconnected components of a model or label them.
* Link to examples of the module's use
+
* For developers: the module is a good example on how Python CLI modules can access and modify the MRML scene (unlike executable and shared library CLI modules)
* Link to any existing tutorials
 
  
 
===Quick Tour of Features and Use===
 
===Quick Tour of Features and Use===
 
List all the panels in your interface, their features, what they mean, and how to use them. For instance:
 
List all the panels in your interface, their features, what they mean, and how to use them. For instance:
  
* '''Input panel:'''
+
* '''Surface Connectivity Parameters:'''
* '''Parameters panel:'''
+
** ''Connectivity mode'': choose between assigning a RegionId to each connected region (AllRegions) or extract the connected region closest to a seed fiducial (ClosestToSeed).
* '''Output panel:'''
+
** ''Enable output fiducials'': enable output of a fiducial list containing one fiducial per connected region labeled with the corresponding RegionId
* '''Viewing panel:'''
+
* '''IO:'''
 +
** ''Input Surface'': the input surface
 +
** ''Output Surface'': the labeled surface (for AllRegions mode) or the labeled portion of the surface closest to the seed (for ClosestToSeed)
  
 
== Development ==
 
== Development ==
Line 46: Line 48:
 
===Dependencies===
 
===Dependencies===
  
Other modules or packages that are required for this module's use.
+
Python
  
 
===Known bugs===
 
===Known bugs===
Line 60: Line 62:
 
===Source code & documentation===
 
===Source code & documentation===
  
Customize following [http://www.na-mic.org/ViewVC/index.cgi/ links] for your module.
+
Follow this [http://viewvc.slicer.org/viewcvs.cgi/trunk/Modules/Python/ link] to the module.
 
 
[http://www.na-mic.org/Slicer/Documentation/Slicer3/html/ Links] to documentation generated by doxygen.
 
  
 +
[http://www.na-mic.org/Slicer/Documentation/Slicer3-doc/html/ Links] to documentation generated by doxygen.
  
 
== More Information ==  
 
== More Information ==  
  
 
===Acknowledgment===
 
===Acknowledgment===
Include funding and other support here.
 
  
 
===References===
 
===References===
Publications related to this module go here. Links to pdfs would be useful.
+
 
 +
[http://www.vtk.org/doc/nightly/html/classvtkPolyDataConnectivityFilter.html vtkPolyDataConnectivityFilter]

Latest revision as of 22:22, 15 January 2010

Home < Modules:PythonSurfaceConnectivity-Documentation-3.4

Return to Slicer 3.4 Documentation

Gallery of New Features

Module Name

Python Surface Connectivity

Figure 1: Clipped model of ICA aneurysm
Figure 2: Connnected region closest to user-specified seed is extracted
Figure 2: All connected regions are extracted and one seed is generated for every region

General Information

Module Type & Category

Type: CLI

Category: Surface Models

Authors, Collaborators & Contact

  • Luca Antiga: Mario Negri Institute
  • Daniel Blezek: Mayo Clinic
  • Contact: Luca Antiga, antiga@marionegri.it

Module Description

This Python module takes in input a surface and labels it according to surface connectivity. The module either labels the surface with a different RegionId for each connected region, or it extracts the connected region closest to an input fiducial. Optionally, the module produces a list of fiducials positioned on each connected region and labeled with its RegionId.

Usage

Examples, Use Cases & Tutorials

  • The module is appropriate when there is need of extracting different disconnected components of a model or label them.
  • For developers: the module is a good example on how Python CLI modules can access and modify the MRML scene (unlike executable and shared library CLI modules)

Quick Tour of Features and Use

List all the panels in your interface, their features, what they mean, and how to use them. For instance:

  • Surface Connectivity Parameters:
    • Connectivity mode: choose between assigning a RegionId to each connected region (AllRegions) or extract the connected region closest to a seed fiducial (ClosestToSeed).
    • Enable output fiducials: enable output of a fiducial list containing one fiducial per connected region labeled with the corresponding RegionId
  • IO:
    • Input Surface: the input surface
    • Output Surface: the labeled surface (for AllRegions mode) or the labeled portion of the surface closest to the seed (for ClosestToSeed)

Development

Dependencies

Python

Known bugs

Follow this link to the Slicer3 bug tracker.


Usability issues

Follow this link to the Slicer3 bug tracker. Please select the usability issue category when browsing or contributing.

Source code & documentation

Follow this link to the module.

Links to documentation generated by doxygen.

More Information

Acknowledgment

References

vtkPolyDataConnectivityFilter