Difference between revisions of "Modules:ModelMirror-Documentation-3.6"

From Slicer Wiki
Jump to: navigation, search
 
(24 intermediate revisions by the same user not shown)
Line 6: Line 6:
  
 
{|
 
{|
−
|[[Image:screenshotBlankNotOptional.png|thumb|280px|User Interface]]
+
|[[Image:SlicerModelMirrorGUI.png|thumb|280px|User Interface]]
−
|[[Image:screenshotBlank.png|thumb|280px|Output]]
+
|[[Image:SlicerModelMirror1.png|thumb|280px|Input]]
−
|[[Image:screenshotBlank.png|thumb|280px|Caption]]
+
|[[Image:SlicerModelMirror2.png|thumb|280px|Result]]
 
|}
 
|}
  
Line 23: Line 23:
  
 
===Module Description===
 
===Module Description===
−
The ModelMirror Module allows a user to select a model in the scene and create a new model by mirroring the selected one around one of the principle axes (R-L, A-P, S-I).
+
The ModelMirror Module allows a user to select a model in the scene and create a new model by mirroring the selected one around the plane dividing a principle axis in RAS space. The following mirror types are options:
 +
<gallery widths="80px" perrow="3">
 +
Image:SlicerModelMirrorRL.png | Right-Left
 +
Image:SlicerModelMirrorAP.png | Anterior-Posterior
 +
Image:SlicerModelMirrorSI.png | Superior-Inferior
 +
</gallery>
  
−
== Usage ==
+
===Quick Tour of Features and Use===
−
 
 
−
===Use Cases, Examples===
 
−
 
 
−
This module is especially appropriate for these use cases:
 
−
 
 
−
* Use Case 1:
 
−
* Use Case 2:
 
−
 
 
−
Examples of the module in use:
 
−
 
 
−
* Example 1
 
−
* Example 2
 
  
−
===Tutorials===
+
* '''Mirror Surface Models Panel:'''
  
−
Links to tutorials explaining how to use this module:
+
In this simple GUI panel, a surface model is selected from the pull-down menu. A mirror axis is selected and a new name is given to the model that will be created.
  
−
* Tutorial 1
+
[[Image:SlicerModelMirrorGUI.png]]
−
** Data Set 1
 
  
−
===Quick Tour of Features and Use===
+
When the "Create Mirror" button is pressed, a new model is created and displayed in the 3D viewer.
  
−
A list panels in the interface, their features, what they mean, and how to use them. For instance:
+
[[Image:SlicerModelMirrorModels.png]]
−
 
 
−
{|
 
−
|
 
−
* '''Input panel:'''
 
−
** '''First input'''
 
−
** '''Second input'''
 
−
* '''Parameters panel:'''
 
−
** '''First parameter'''
 
−
** '''Second parameter'''
 
−
* '''Output panel:'''
 
−
** '''First output'''
 
−
** '''Second output'''
 
−
* '''Viewing panel:'''
 
−
|[[Image:screenshotBlankNotOptional.png|thumb|280px|User Interface]]
 
−
|}
 
  
 
== Development ==
 
== Development ==
Line 69: Line 46:
 
===Notes from the Developer(s)===
 
===Notes from the Developer(s)===
  
−
Algorithms used, library classes depended upon, use cases, etc.
+
none
  
 
===Dependencies===
 
===Dependencies===
  
−
Other modules or packages that are required for this module's use.
+
Models Module
−
 
 
−
===Tests===
 
−
 
 
−
On the [http://www.cdash.org/CDash/index.php?project=Slicer3 Dashboard], these tests verify that the module is working on various platforms:
 
−
 
 
−
* MyModuleTest1 [http://viewvc.slicer.org/viewcvs.cgi/trunk MyModuleTest1.cxx]
 
−
* MyModuleTest2 [http://viewvc.slicer.org/viewcvs.cgi/trunk MyModuleTest2.cxx]
 
  
 
===Known bugs===
 
===Known bugs===
  
−
Links to known bugs in the Slicer3 bug tracker
+
(None reported at this time)
−
 
 
−
* [http://www.na-mic.org/Bug/view.php?id=000 Bug 000: description]
 
−
 
 
  
 
===Usability issues===
 
===Usability issues===
Line 107: Line 74:
  
 
===Acknowledgment===
 
===Acknowledgment===
−
Include funding and other support here.
+
[[image:SlicerModelMirrorAcknowledgement.png]]
 +
 
 +
This work is supported by NA-MIC, NAC, BIRN, NCIGT, Harvard CTSC, and the Slicer Community. See http://www.slicer.org for details. Module implemented by Wendy Plesniak.
  
 
===References===
 
===References===
−
Publications related to this module go here. Links to pdfs would be useful.
+
None.

Latest revision as of 12:50, 8 May 2010

Home < Modules:ModelMirror-Documentation-3.6

Return to Slicer 3.6 Documentation


ModelMirror

ModelMirror

User Interface
Input
Result

General Information

Module Type & Category

Type: Interactive

Category: Surface Models

Authors, Collaborators & Contact

  • Author1: Wendy Plesniak, BWH
  • Contact: Wendy Plesniak, wjp@bwh.harvard.edu

Module Description

The ModelMirror Module allows a user to select a model in the scene and create a new model by mirroring the selected one around the plane dividing a principle axis in RAS space. The following mirror types are options:

  • Right-Left

  • Anterior-Posterior

  • Superior-Inferior

Quick Tour of Features and Use

  • Mirror Surface Models Panel:

In this simple GUI panel, a surface model is selected from the pull-down menu. A mirror axis is selected and a new name is given to the model that will be created.

SlicerModelMirrorGUI.png

When the "Create Mirror" button is pressed, a new model is created and displayed in the 3D viewer.

SlicerModelMirrorModels.png

Development

Notes from the Developer(s)

none

Dependencies

Models Module

Known bugs

(None reported at this time)

Usability issues

Follow this 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:

Doxygen documentation:

More Information

Acknowledgment

SlicerModelMirrorAcknowledgement.png

This work is supported by NA-MIC, NAC, BIRN, NCIGT, Harvard CTSC, and the Slicer Community. See http://www.slicer.org for details. Module implemented by Wendy Plesniak.

References

None.

Retrieved from "https://www.slicer.org/w/index.php?title=Modules:ModelMirror-Documentation-3.6&oldid=15529"