Difference between revisions of "Modules:PythonSurfaceConnectivity-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...) |
|||
| Line 2: | Line 2: | ||
__NOTOC__ | __NOTOC__ | ||
===Module Name=== | ===Module Name=== | ||
| − | + | Python Surface Connectivity | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== General Information == | == General Information == | ||
===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 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 23: | ||
===Examples, Use Cases & Tutorials=== | ===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=== | ===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 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 == | == Development == | ||
| Line 46: | Line 40: | ||
===Dependencies=== | ===Dependencies=== | ||
| − | + | Python | |
===Known bugs=== | ===Known bugs=== | ||
| Line 60: | Line 54: | ||
===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/html/ Links] to documentation generated by doxygen. | [http://www.na-mic.org/Slicer/Documentation/Slicer3/html/ Links] to documentation generated by doxygen. | ||
| Line 68: | Line 62: | ||
===Acknowledgment=== | ===Acknowledgment=== | ||
| − | |||
===References=== | ===References=== | ||
| − | |||
Revision as of 09:54, 11 February 2009
Home < Modules:PythonSurfaceConnectivity-Documentation-3.4Return to Slicer 3.4 Documentation
Module Name
Python Surface Connectivity
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.
