Difference between revisions of "Modules:PythonSurfaceICPRegistration-Documentation-3.4"
From Slicer Wiki
(New page: Return to Slicer 3.4 Documentation __NOTOC__ ===Module Name=== MyModule {| |thumb|280px|Caption 1 |[[Image:screenshotBlank.png|thumb|2...) |
|||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | [[Documentation-3.4|Return to Slicer 3.4 Documentation]] | |
| + | |||
| + | [[Announcements:Slicer3.4#Highlights|Gallery of New Features]] | ||
__NOTOC__ | __NOTOC__ | ||
===Module Name=== | ===Module Name=== | ||
| − | + | Python ICP Registration | |
{| | {| | ||
| − | |[[Image: | + | |[[Image:PythonICP1.png|thumb|320px|Figure 1: Full model of aneurysm and (unregistered) aneurysm dome]] |
| − | |[[Image: | + | |[[Image:PythonICP2.png|thumb|320px|Figure 2: Aneurysm dome registered on the full model]] |
| − | |||
|} | |} | ||
| Line 13: | Line 14: | ||
===Module Type & Category=== | ===Module Type & Category=== | ||
| − | Type: | + | Type: CLI |
| − | Category: | + | Category: Surface Models |
===Authors, Collaborators & Contact=== | ===Authors, Collaborators & Contact=== | ||
| − | * | + | * Luca Antiga: Mario Negri Institute |
| − | + | * Daniel Blezek: Mayo Clinic | |
| − | * | + | * Contact: Luca Antiga, antiga@marionegri.it |
| − | * Contact: | ||
===Module Description=== | ===Module Description=== | ||
| − | + | This Python module registers an input surface to a target surface using the Iterative Closest Point algorithm using rigid, similarity and affine transforms. | |
== Usage == | == Usage == | ||
| Line 30: | Line 30: | ||
===Examples, Use Cases & Tutorials=== | ===Examples, Use Cases & Tutorials=== | ||
| − | * | + | * The module is appropriate when there is need for aligning surfaces, e.g. for comparison of surface features. |
| − | * | + | * Possible improvements are the generation of the registration transform in output (TO DO). |
| − | |||
===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: | ||
| − | * ''' | + | * '''Surface ICP Registration Parameters:''' |
| − | * ''' | + | ** ''Landmark transform mode'': choose between RigidBody, Similarity or Affine transforms for registration of the surfaces. |
| − | * ''' | + | ** ''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) |
| − | * ''' | + | ** ''Maximum number of iterations'': number of iterations beyond which the ICP algorithm won't proceed even if the maximum mean distance is above threshold. |
| + | ** ''Maximum number of landmarks'': maximum number of surface landmarks used to minimize distance between surfaces | ||
| + | ** ''Start by matching centroids'': initialize the transform by translating the input surface so that its centroid coincides the centroid of the target surface. | ||
| + | ** ''Check mean distance'': force checking distance between every two iterations (slower but more accurate) | ||
| + | ** ''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 | ||
| + | ** ''Input Surface'': the input (moving) surface | ||
| + | ** ''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). | ||
== Development == | == Development == | ||
| Line 46: | Line 55: | ||
===Dependencies=== | ===Dependencies=== | ||
| − | + | Python | |
===Known bugs=== | ===Known bugs=== | ||
| Line 60: | Line 69: | ||
===Source code & documentation=== | ===Source code & documentation=== | ||
| − | + | Follow this [http://viewvc.slicer.org/viewcvs.cgi/trunk/Modules/Python/ link] to the module. | |
| − | |||
| − | |||
| + | [http://www.na-mic.org/Slicer/Documentation/Slicer3-doc/html/ Links] to documentation generated by doxygen. | ||
== More Information == | == More Information == | ||
===Acknowledgment=== | ===Acknowledgment=== | ||
| − | |||
===References=== | ===References=== | ||
| − | + | ||
| + | [http://www.vtk.org/doc/nightly/html/classvtkIterativeClosestPointTransform.html vtkIterativeClosestPointTransform] | ||
Latest revision as of 22:22, 15 January 2010
Home < Modules:PythonSurfaceICPRegistration-Documentation-3.4Return to Slicer 3.4 Documentation
Module Name
Python ICP Registration
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 registers an input surface to a target surface using the Iterative Closest Point algorithm using rigid, similarity and affine transforms.
Usage
Examples, Use Cases & Tutorials
- The module is appropriate when there is need for aligning surfaces, e.g. for comparison of surface features.
- 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:
- Surface ICP Registration Parameters:
- Landmark transform mode: choose between RigidBody, Similarity or Affine transforms for registration of the surfaces.
- 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)
- Maximum number of iterations: number of iterations beyond which the ICP algorithm won't proceed even if the maximum mean distance is above threshold.
- Maximum number of landmarks: maximum number of surface landmarks used to minimize distance between surfaces
- Start by matching centroids: initialize the transform by translating the input surface so that its centroid coincides the centroid of the target surface.
- Check mean distance: force checking distance between every two iterations (slower but more accurate)
- 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
- Input Surface: the input (moving) surface
- 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).
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.
