View source for Modules:PythonSurfaceConnectivity-Documentation-3.6

[[Documentation-3.6|Return to Slicer 3.6 Documentation]]

[[Announcements:Slicer3.6#Highlights|Gallery of New Features]]

__NOTOC__
===Module Name===
Python Surface Connectivity

{|
|[[Image:screenshotBlankNotOptional.png|thumb|280px|User Interface]]
|[[Image:PythonSurfaceConnectivity1.png|thumb|280px|Figure 1: Clipped model of ICA aneurysm]]
|[[Image:PythonSurfaceConnectivity2.png|thumb|280px|Figure 2: Connnected region closest to user-specified seed is extracted]]
|[[Image:PythonSurfaceConnectivity3.png|thumb|280px|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: Orobix Srl, Mario Negri Institute
* Daniel Blezek: Mayo Clinic
* Contact: Luca Antiga, luca.antiga@orobix.com

===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 ==

===Use Cases, Examples===

* 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)

===Tutorials===

NA

===Quick Tour of Features and Use===

{|
|
* '''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)
|[[Image:screenshotBlankNotOptional.png|thumb|280px|User Interface]]
|}

== Development ==

===Notes from the Developer(s)===

The module internally uses [http://www.vtk.org/doc/nightly/html/classvtkPolyDataConnectivityFilter.html vtkPolyDataConnectivityFilter].

===Dependencies===

Python

===Tests===

NA

===Known bugs===

Follow this [http://na-mic.org/Mantis/main_page.php link] to the Slicer3 bug tracker. 


===Usability issues===

Follow this [http://na-mic.org/Mantis/main_page.php link] to the Slicer3 bug tracker. Please select the '''usability issue category''' when browsing or contributing.

===Source code & documentation===

Links to the module's source code:

Source code:
*[http://viewvc.slicer.org/viewcvs.cgi/trunk/Modules/Python/SurfaceConnectivity.py SurfaceConnectivity.py]
 
== More Information == 

===Acknowledgment===
NA

===References===
NA