Modules:PythonSurfaceICPRegistration-Documentation-3.4 - Revision history

Nicole: /* Source code & documentation */

2010-01-15T22:22:12Z

Source code & documentation

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

2009-08-11T12:25:57Z

Quick Tour of Features and Use

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

2009-08-11T12:25:38Z

Quick Tour of Features and Use

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

2009-08-11T12:25:17Z

Quick Tour of Features and Use

Marianna at 20:17, 26 May 2009

2009-05-26T20:17:50Z

Lantiga at 15:57, 9 April 2009

2009-04-09T15:57:13Z

Lantiga at 10:08, 11 February 2009

2009-02-11T10:08:04Z

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

2009-02-10T16:52:40Z

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

@@ Line 45: / Line 45: @@
 ** ''Maximum mean distance'': distance threshold, the algorithm stops when the mean distance between the surfaces is below this threshold
 * '''IO:'''
-** "Initial Transform": the (optional) initial transform that is applied to the input surface prior to registration
+** ''Initial Transform'': the (optional) initial transform that is applied to the input surface prior to registration
 ** ''Input Surface'': the input (moving) surface
 ** ''Target Surface'': the target (not moving) surface

@@ Line 49: / Line 49: @@
 ** ''Target Surface'': the target (not moving) surface
 ** ''Output Surface'': the output surface, i.e. the input surface registered on the target surface. Optional.
-** "Output Transform": the computed ICP transform MRML node. Optional (if both Output Surface and Output Transform are specified, the output surface is placed as a child of the output transform).
+** ''Output Transform'': the computed ICP transform MRML node. Optional (if both Output Surface and Output Transform are specified, the output surface is placed as a child of the output transform).
 == Development ==

@@ Line 45: / Line 45: @@
 ** ''Maximum mean distance'': distance threshold, the algorithm stops when the mean distance between the surfaces is below this threshold
 * '''IO:'''
 ** ''Input Surface'': the input (moving) surface
 ** ''Target Surface'': the target (not moving) surface
-** ''Output Surface'': the input surface registered on the target surface
+** ''Output Surface'': the output surface, i.e. the input surface registered on the target surface. Optional.
 == Development ==

@@ Line 1: / Line 1: @@
 [[Documentation-3.4|Return to Slicer 3.4 Documentation]]
 __NOTOC__
 ===Module Name===

@@ Line 3: / Line 3: @@
 ===Module Name===
 Python ICP Registration
 == General Information ==

@@ 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===
-MyModule
+Python ICP Registration
 == 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 registers an input surface to a target surface using the Iterative Closest Point algorithm using rigid, similarity and affine transforms.
 == 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 for aligning surfaces, e.g. for comparison of surface features.
-* Link to examples of the module's use
+* Possible improvements are the generation of the registration transform in output (TO DO).
 ===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 ICP Registration Parameters:'''
-* '''Parameters panel:'''
+** ''Landmark transform mode'': choose between RigidBody, Similarity or Affine transforms for registration of the surfaces.
-* '''Output panel:'''
+** ''Mean distance mode'': choose between square root of the average of the sum of squares of the closest point distances (RMS) or mean of the sum of absolute values of the closest point distances (Absolute)
-* '''Viewing panel:'''
+** ''Maximum number of iterations'': number of iterations beyond which the ICP algorithm won't proceed even if the maximum mean distance is above threshold.
 == Development ==
@@ Line 46: / Line 46: @@
 ===Dependencies===
-Other modules or packages that are required for this module's use.
+Python
 ===Known bugs===
@@ Line 60: / Line 60: @@
 ===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 68: @@
 ===Acknowledgment===
 ===References===
-Publications related to this module go here. Links to pdfs would be useful.

Modules:PythonSurfaceICPRegistration-Documentation-3.4 - Revision history

Nicole: /* Source code & documentation */

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

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

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

Marianna at 20:17, 26 May 2009

Lantiga at 15:57, 9 April 2009

Lantiga at 10:08, 11 February 2009

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

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