Difference between revisions of "Documentation/4.0/Modules/Transforms"

From Slicer Wiki
Jump to: navigation, search
(Created page with '<!-- ---------------------------- --> {{documentation/{{documentation/version}}/module-header}} <!-- ---------------------------- --> <!-- ---------------------------- --> {{doc…')
 
m (Text replacement - "slicerWiki/index.php" to "wiki")
 
(12 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
<noinclude>{{documentation/versioncheck}}</noinclude>
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-header}}
 
{{documentation/{{documentation/version}}/module-header}}
Line 12: Line 13:
 
{{documentation/{{documentation/version}}/module-introduction-row}}
 
{{documentation/{{documentation/version}}/module-introduction-row}}
 
{{documentation/{{documentation/version}}/module-introduction-logo-gallery
 
{{documentation/{{documentation/version}}/module-introduction-logo-gallery
−
|Image:Logo-isomics.png|Isomics, Inc.
+
|{{collaborator|logo|isomics}}|{{collaborator|longname|isomics}}
−
|Image:Logo-splnew.jpg|Surgical Planning Laboratory
+
|{{collaborator|logo|namic}}|{{collaborator|longname|namic}}
 +
|{{collaborator|logo|nac}}|{{collaborator|longname|nac}}
 
}}
 
}}
 
{{documentation/{{documentation/version}}/module-introduction-end}}
 
{{documentation/{{documentation/version}}/module-introduction-end}}
−
 
−
<!-- ----------------------------------------------------------------- -->
 
−
<!-- THE FOLLOWING SHOULD BE REMOVED FOR YOUR OWN MODULE DOCUMENTATION -->
 
−
<!-- ----------------------------------------------------------------- -->
 
  
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
−
Here comes a description what the module is good for. Explain briefly how it works and point to the [[documentation/{{documentation/version}}/Modules/{{documentation/modulename}}#References|references]] giving more details on the algorithm.
+
Transform module is used for creating and editing transformation matrices.  
−
 
 
−
<!-- ----------------------------------------------------------------- -->
 
−
<!-- THE FOLLOWING SHOULD BE REMOVED FOR YOUR OWN MODULE DOCUMENTATION -->
 
−
<!-- ----------------------------------------------------------------- -->
 
−
If you are documenting a CLI, the description should be extracted from the corresponding XML description. This could be done automatically using the following wiki template:<pre>{{documentation/{{documentation/version}}/module-description|xmlurl=http://path/to/YOURMODULE.xml }}</pre>
 
−
 
 
−
If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL:
 
−
<pre>{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}</pre>
 
−
 
 
−
Using this later template, the final syntax would be:
 
−
<pre>{{documentation/{{documentation/version}}/module-description|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}</pre>
 
−
<!-- ----------------------------------------------------------------- -->
 
−
<!-- ----------------------------------------------------------------- -->
 
−
<!-- ----------------------------------------------------------------- -->
 
  
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Use Cases}}
 
{{documentation/{{documentation/version}}/module-section|Use Cases}}
−
Most frequently used for these scenarios:
+
Most frequently Transform module is used for these scenarios:
 +
 
 +
* Manual Registration: You can insert a transformation node into your scene, and in the Data module drag a volume or a model under it,
 +
making them children of the transformation node. After that any changes to the transformation matrix of this node will be applied to the display of children volumes and models.
  
−
* Use Case 1:
 
−
* Use Case 2:
 
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Tutorials}}
 
{{documentation/{{documentation/version}}/module-section|Tutorials}}
−
Links to tutorials that use this module
+
* Please use tutorial about [http://www.slicer.org/wiki/Documentation/4.0/Training loading and viewing data].
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
 
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
−
 
−
A list of all the panels in the interface, their features, what they mean, and how to use them. For instance:
 
  
 
{|style="width: 100%"
 
{|style="width: 100%"
 
|
 
|
−
* Input panel1:
+
* Load panel:
−
** First input
+
** Load Transfrom button: brings a file browser allowing user to load a previously saved transformations from ITK style .tfm file. The .tfm files are also created by slicer when saving a scene containing transformation nodes.
−
** Second input
+
* Display and Edit panel:
−
* Parameters panel:
+
** Transform node selector: selects an existing transformation node or creates a new one and adds it to the scene.
−
** First parameter
+
** Transform Matrix: displays values and allows editing of individual components of 4x4 transformation matrix.
−
** Second parameter
+
** Translation panel: allows editing of LR, PA, and IS translational components of the transformation matrix in the RAS space. Also, allows changing the min/max range of the slider in order to accommodate larger or smaller measurements.
−
* Output panel:
+
** Rotaion panel: allows editing of LR, PA, and IS rotation angles in the RAS space.
−
** First output
+
** Coordinate Reference toggle: switches between global RAS space transformation and a local one, relative to the current position and orientation.
−
** Second output
+
** Identity button: resets transformation matrix to identity.
−
* Viewing panel:
+
** Revert button: inverts the transformation matrix.
 
| align="right" |
 
| align="right" |
−
[[Image:screenshotBlankNotOptional.png|thumb|280px|Name of panel 1]]
+
[[Image:TransfromModule.PNG|thumb|280px|Transfrom module panel]]
 
|-
 
|-
 
|
 
|
−
* Input panel2:
 
−
** First input
 
−
** Second input
 
−
* Parameters panel:
 
−
** First parameter
 
−
** Second parameter
 
−
* Output panel:
 
−
** First output
 
−
** Second output
 
−
* Viewing panel:
 
−
| align="right" |
 
−
[[Image:screenshotBlankNotOptional.png|thumb|280px|Name of panel 2]]
 
 
|}
 
|}
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Similar Modules}}
 
{{documentation/{{documentation/version}}/module-section|Similar Modules}}
−
* Point to other modules that have similar functionality
+
* Related modules: Data module, Registration modules.
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|References}}
 
{{documentation/{{documentation/version}}/module-section|References}}
−
Publications related to this module go here. Links to pdfs would be useful.
+
N/A
−
For extensions: link to the source code repository and additional documentation
 
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
 
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
−
{{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Base}}
+
{{documentation/{{documentation/version}}/module-developerinfo}}
−
 
 
−
 
 
−
<!-- ----------------------------------------------------------------- -->
 
−
<!-- THE FOLLOWING SHOULD BE REMOVED FOR YOUR OWN MODULE DOCUMENTATION -->
 
−
<!-- ----------------------------------------------------------------- -->
 
−
{{note}}The section above is generated using the following wiki code:
 
−
<pre>
 
−
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
 
−
{{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Example}}
 
−
</pre>
 
−
 
 
−
If you are documenting a CLI, the category should be extracted from the corresponding XML description. This could be done automatically using the following wiki template:<pre>{{documentation/{{documentation/version}}/module-category|xmlurl=http://path/to/YOURMODULENAME.xml }}</pre>
 
−
 
 
−
If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL:
 
−
<pre>{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}</pre>
 
−
 
 
−
Using this later template, the final syntax would be:
 
−
<pre>{{documentation/{{documentation/version}}/module-category|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}</pre>
 
−
<!-- ----------------------------------------------------------------- -->
 
−
<!-- ----------------------------------------------------------------- -->
 
−
<!-- ----------------------------------------------------------------- -->
 
  
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
−
{{documentation/{{documentation/version}}/module-footer|category=Example}}
+
{{documentation/{{documentation/version}}/module-footer}}
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->

Latest revision as of 17:05, 21 November 2019

Home < Documentation < 4.0 < Modules < Transforms


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



Introduction and Acknowledgements

This work is part of the National Alliance for Medical Image Computing (NA-MIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149. Information on NA-MIC can be obtained from the NA-MIC website.
Author: Alex Yarmarkovich, Isomics, SPL
Contact: Alex Yarmarkovich, alexy@bwh.harvard.edu

Isomics, Inc.  
National Alliance for Medical Image Computing (NA-MIC)  
Neuroimage Analysis Center (NAC)  


Module Description

Transform module is used for creating and editing transformation matrices.


Use Cases

Most frequently Transform module is used for these scenarios:

  • Manual Registration: You can insert a transformation node into your scene, and in the Data module drag a volume or a model under it,

making them children of the transformation node. After that any changes to the transformation matrix of this node will be applied to the display of children volumes and models.


Tutorials

Panels and their use

  • Load panel:
    • Load Transfrom button: brings a file browser allowing user to load a previously saved transformations from ITK style .tfm file. The .tfm files are also created by slicer when saving a scene containing transformation nodes.
  • Display and Edit panel:
    • Transform node selector: selects an existing transformation node or creates a new one and adds it to the scene.
    • Transform Matrix: displays values and allows editing of individual components of 4x4 transformation matrix.
    • Translation panel: allows editing of LR, PA, and IS translational components of the transformation matrix in the RAS space. Also, allows changing the min/max range of the slider in order to accommodate larger or smaller measurements.
    • Rotaion panel: allows editing of LR, PA, and IS rotation angles in the RAS space.
    • Coordinate Reference toggle: switches between global RAS space transformation and a local one, relative to the current position and orientation.
    • Identity button: resets transformation matrix to identity.
    • Revert button: inverts the transformation matrix.
Transfrom module panel

Similar Modules

  • Related modules: Data module, Registration modules.

References

N/A

Information for Developers

Work in progress
 Section under construction.


Retrieved from "https://www.slicer.org/w/index.php?title=Documentation/4.0/Modules/Transforms&oldid=61796"