Modules:PythonSurfaceConnectivity-Documentation-3.4 - Revision history

Nicole: /* Source code & documentation */

2010-01-15T22:22:00Z

Source code & documentation

Marianna at 20:17, 26 May 2009

2009-05-26T20:17:35Z

Lantiga at 15:44, 9 April 2009

2009-04-09T15:44:42Z

Lantiga: /* References */

2009-02-11T10:00:31Z

References

Lantiga at 10:00, 11 February 2009

2009-02-11T10:00:20Z

Lantiga at 09:55, 11 February 2009

2009-02-11T09:55:40Z

Lantiga: /* Quick Tour of Features and Use */

2009-02-11T09:55:04Z

Quick Tour of Features and Use

Lantiga at 09:54, 11 February 2009

2009-02-11T09:54:28Z

Lantiga: New page: Return to Slicer 3.4 Documentation NOTOC ===Module Name=== MyModule {| |Caption 1 |[[Image:screenshotBlank.png|thumb|2...

2009-02-10T16:52:35Z

New page: Return to Slicer 3.4 Documentation __NOTOC__ ===Module Name=== MyModule {| |thumb|280px|Caption 1 |[[Image:screenshotBlank.png|thumb|2...

New page

[[Documentation-3.4|Return to Slicer 3.4 Documentation]]
__NOTOC__
===Module Name===
MyModule

{|
|[[Image:screenshotBlank.png|thumb|280px|Caption 1]]
|[[Image:screenshotBlank.png|thumb|280px|Caption 2]]
|[[Image:screenshotBlank.png|thumb|280px|Caption 3]]
|}

== General Information ==
===Module Type & Category===

Type: Interactive or CLI

Category: Base or (Filtering, Registration, ''etc.'')

===Authors, Collaborators & Contact===
* Author1: Affiliation & logo, if desired
* Contributor1: Affiliation & logo, if desired
* Contributor2: Affiliation & logo, if desired
* Contact: name, email

===Module Description===
Overview of what the module does goes here.

== Usage ==

===Examples, Use Cases & Tutorials===

* Note use cases for which this module is especially appropriate, and/or link to examples.
* Link to examples of the module's use
* Link to any existing tutorials

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

* '''Input panel:'''
* '''Parameters panel:'''
* '''Output panel:'''
* '''Viewing panel:'''

== Development ==

===Dependencies===

Other modules or packages that are required for this module's use.

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

Customize following [http://www.na-mic.org/ViewVC/index.cgi/ links] for your module.

[http://www.na-mic.org/Slicer/Documentation/Slicer3/html/ Links] to documentation generated by doxygen.

== More Information ==

===Acknowledgment===
Include funding and other support here.

===References===
Publications related to this module go here. Links to pdfs would be useful.

@@ Line 64: / Line 64: @@
 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 ==

← Older revision		Revision as of 10:00, 11 February 2009
Line 65:		Line 65:
	===References===		===References===

−	[http://www.vtk.org/doc/nightly/html/classvtkPolyDataConnectivityFilter.html \| vtkPolyDataConnectivityFilter]	+	[http://www.vtk.org/doc/nightly/html/classvtkPolyDataConnectivityFilter.html vtkPolyDataConnectivityFilter]

← Older revision		Revision as of 10:00, 11 February 2009
Line 64:		Line 64:

	===References===		===References===
		+
		+	[http://www.vtk.org/doc/nightly/html/classvtkPolyDataConnectivityFilter.html \| vtkPolyDataConnectivityFilter]

@@ Line 9: / Line 9: @@
 Type: CLI
-Category: Surface Models)
+Category: Surface Models
 ===Authors, Collaborators & Contact===

@@ Line 1: / Line 1: @@
- [[Documentation-3.4|Return to Slicer 3.4 Documentation]]
+[[Documentation-3.4|Return to Slicer 3.4 Documentation]]
 __NOTOC__
 ===Module Name===
@@ Line 30: / Line 30: @@
 * '''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).
+** ''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
+** ''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
+** ''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)
+** ''Output Surface'': the labeled surface (for AllRegions mode) or the labeled portion of the surface closest to the seed (for ClosestToSeed)
 == Development ==

@@ Line 3: / Line 3: @@
 ===Module Name===
 Python Surface Connectivity
 == General Information ==

@@ Line 2: / Line 2: @@
 __NOTOC__
 ===Module Name===
-MyModule
+Python Surface Connectivity
 == General Information ==
 ===Module Type & Category===
-Type: Interactive or CLI
+Type: CLI
-Category: Base or (Filtering, Registration, ''etc.'')
+Category: Surface Models)
 ===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
 ===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 ==
@@ Line 30: / Line 23: @@
 ===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)
 ===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:
-* '''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:'''
 == Development ==
@@ Line 46: / Line 40: @@
 ===Dependencies===
-Other modules or packages that are required for this module's use.
+Python
 ===Known bugs===
@@ Line 60: / Line 54: @@
 ===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.
@@ Line 68: / Line 62: @@
 ===Acknowledgment===
 ===References===