Difference between revisions of "Documentation/Nightly/Extensions/AnglePlanes"

From Slicer Wiki
Jump to: navigation, search
(Created page with '<noinclude>{{documentation/versioncheck}}</noinclude> <!-- ---------------------------- --> {{documentation/{{documentation/version}}/module-header}} <!-- ----------------------…')
 
 
(4 intermediate revisions by the same user not shown)
Line 11: Line 11:
 
Contributors: <br>
 
Contributors: <br>
 
- Francois Budin (NIRAL, University of North Carolina), <br>
 
- Francois Budin (NIRAL, University of North Carolina), <br>
−
- Beatriz Paniagua (NIRAL, University Of North Carolina), <br>
+
- Beatriz Paniagua (NIRAL, University of North Carolina), <br>
 
- Lucia Cevidanes (University of Michigan - School of Dentistry)<br>
 
- Lucia Cevidanes (University of Michigan - School of Dentistry)<br>
−
Contact: Julia Lopinto, <email>lopinto.julia@gmail.com</email><br>
+
- Jean-Baptiste Vimort (University of Michigan - School of Dentistry)<br>
 +
Contact: Jean-Baptiste Vimort, <email>jb.vimort@gmail.com</email><br>
 
License: [http://www.apache.org/licenses/LICENSE-2.0.html Apache License, Version 2.0]
 
License: [http://www.apache.org/licenses/LICENSE-2.0.html Apache License, Version 2.0]
 
<gallery>
 
<gallery>
Line 23: Line 24:
 
{{documentation/{{documentation/version}}/extension-section|Extension Description}}
 
{{documentation/{{documentation/version}}/extension-section|Extension Description}}
  
−
This Module is used to calculate the angle between two planes by using the normals. The user gets the choice to use two planes which are already implemented on Slicer or they can define a plane by using landmarks (at least 3 landmarks).  Plane can also be saved to be reused for other models.
+
This Module is used to calculate the angle between two plans by using the normals. The user gets the choice to use two plans which are already implemented on Slicer or they can define a plan by using landmarks (at least 3 landmarks).  Plans can also be saved to be reused for other models.
  
 +
<!-- ---------------------------- -->
 +
{{documentation/{{documentation/version}}/extension-section|Interface}}
 +
 +
{|
 +
|[[Image:AnglePlanes_Logo.png‎|thumb|340px|Logo for AnglePlanes]]
 +
|[[Image:Interface_AnglePlanes.png|thumb|240px|User Interface of AnglePlanes]]
 +
|[[Image:FullView_AnglePlanes.png|thumb|700px|AnglePlanes in Slicer]]
 +
|}
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/extension-section|Tutorials}}
 
{{documentation/{{documentation/version}}/extension-section|Tutorials}}
−
N/A
+
===Scene===
−
 
+
{|
−
<!-- ---------------------------- -->
+
|[[Image:CMFSceneTab.png|500px]]
−
{{documentation/{{documentation/version}}/extension-section|Use Cases}}
+
|This tab allows the user to display and hide all the models contained in Slicer's scene. <br>
−
 
+
There is an option to automatically set the view in Slicer to 3D only each time that the user is using this module. <br>
 +
The "compute around bounding box" button will adjust the bounding box around all the displayed models in Slicer.
 +
|}
 +
===Manage plans===
 +
*Create a plan:
 +
{|
 +
|[[Image:CMFMangePlaneTab1.png|500px]]
 +
|To create a plan, the user will need to select a model (on which each landmark will be projected) and a list of landmarks. <br>
 +
This list of Landmarks can already contain landmarks, if that is the case the "on surface" option will project all the landmarks that are not defined as a middle point. <br>
 +
Only one landmark can be moved at the time, the one that is selected in the "landmark modification" part. This landmark can be kept on the surface or not.
 +
|}
 +
*Modify a plan:
 +
{|
 +
|[[Image:CMFMangePlaneTab2.png|500px]]
 +
|Once the plan created, there is a possibility to add landmarks to the list. <br>
 +
Each plan will be defined by three different landmarks. <br>
 +
There is also some options to select the opacity of each plan, hide it, or adapt it to the bounding box. <br>
 +
The remove plan option will erase the plan from Angle Plans, but the landmarks list will remain intact.
 +
|}
 +
===Define a middle point===
 +
{|
 +
|[[Image:CMFDefineMiddlePointTab.png|500px]]
 +
|In this tab, the user will have to define a middle point defined with two landmarks from the same list. <br>
 +
Angle plan won't allow the modification of any middle point, therefore all the middle points will be updated when one of the landmarks that define its is moved.
 +
|}
 +
===Choose plans===
 +
{|
 +
|[[Image:CMFChoosePlanesTab.png|500px]]
 +
|This tab is fore the selection of the two plans that will be used for the measurement, the user can also choose two use one of the three fundamental plans.
 +
|}
 +
===Results===
 +
{|
 +
|[[Image:CMFResultsTab.png|500px]]
 +
|The result tab will display the Pitch, Yaw and Roll between the to plans selected in the previous tab.
 +
|}
 +
===Save===
 
{|
 
{|
−
|[[Image:AnglePlanes_Logo.png‎|thumb|340px|Logo for AnglePlanes]]
+
|[[Image:CMFSaveTab.png|500px]]
−
|[[Image:Interface_AnglePlanes.png|thumb|240px|Interface of AnglePlanes]]
+
|The positions of the red, green and yellow plans can be saved and reloaded thanks to this tab.
 
|}
 
|}
  
Line 44: Line 88:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/extension-section|Information for Developers}}
 
{{documentation/{{documentation/version}}/extension-section|Information for Developers}}
 +
The source code is available on [https://github.com/DCBIA-OrthoLab/AnglePlanes-Extension github]
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/extension-footer}}
 
{{documentation/{{documentation/version}}/extension-footer}}
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->

Latest revision as of 20:59, 29 February 2016

Home < Documentation < Nightly < Extensions < AnglePlanes


For the latest Slicer documentation, visit the read-the-docs.


Introduction and Acknowledgements

Extension: AnglePlanes
Acknowledgments: This work was supported by the National Institues of Dental and Craniofacial Research and Biomedical Imaging and Bioengineering of the National Institutes of Health under Award Number R01DE024450
Author: Julia Lopinto, University of Michigan
Contributors:
- Francois Budin (NIRAL, University of North Carolina),
- Beatriz Paniagua (NIRAL, University of North Carolina),
- Lucia Cevidanes (University of Michigan - School of Dentistry)
- Jean-Baptiste Vimort (University of Michigan - School of Dentistry)
Contact: Jean-Baptiste Vimort, <email>jb.vimort@gmail.com</email>
License: Apache License, Version 2.0

  • University of Michigan

  • UNC

  • NAMIC

Extension Description

This Module is used to calculate the angle between two plans by using the normals. The user gets the choice to use two plans which are already implemented on Slicer or they can define a plan by using landmarks (at least 3 landmarks). Plans can also be saved to be reused for other models.

Interface

Logo for AnglePlanes
User Interface of AnglePlanes
AnglePlanes in Slicer

Tutorials

Scene

CMFSceneTab.png This tab allows the user to display and hide all the models contained in Slicer's scene.

There is an option to automatically set the view in Slicer to 3D only each time that the user is using this module.
The "compute around bounding box" button will adjust the bounding box around all the displayed models in Slicer.

Manage plans

  • Create a plan:
CMFMangePlaneTab1.png To create a plan, the user will need to select a model (on which each landmark will be projected) and a list of landmarks.

This list of Landmarks can already contain landmarks, if that is the case the "on surface" option will project all the landmarks that are not defined as a middle point.
Only one landmark can be moved at the time, the one that is selected in the "landmark modification" part. This landmark can be kept on the surface or not.

  • Modify a plan:
CMFMangePlaneTab2.png Once the plan created, there is a possibility to add landmarks to the list.

Each plan will be defined by three different landmarks.
There is also some options to select the opacity of each plan, hide it, or adapt it to the bounding box.
The remove plan option will erase the plan from Angle Plans, but the landmarks list will remain intact.

Define a middle point

CMFDefineMiddlePointTab.png In this tab, the user will have to define a middle point defined with two landmarks from the same list.

Angle plan won't allow the modification of any middle point, therefore all the middle points will be updated when one of the landmarks that define its is moved.

Choose plans

CMFChoosePlanesTab.png This tab is fore the selection of the two plans that will be used for the measurement, the user can also choose two use one of the three fundamental plans.

Results

CMFResultsTab.png The result tab will display the Pitch, Yaw and Roll between the to plans selected in the previous tab.

Save

CMFSaveTab.png The positions of the red, green and yellow plans can be saved and reloaded thanks to this tab.

Similar Extensions

N/A

Information for Developers

The source code is available on github

Retrieved from "https://www.slicer.org/w/index.php?title=Documentation/Nightly/Extensions/AnglePlanes&oldid=44993"