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

From Slicer Wiki
Jump to: navigation, search
Line 17: Line 17:
 
}}
 
}}
 
{{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
+
* Tutorial about [http://wiki.na-mic.org/Wiki/index.php/Slicer3:Training loading and viewing data].
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->

Revision as of 14:13, 22 November 2011

Home < Documentation < 4.0 < Modules < Transforms


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.  
NA-MIC  
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

A list of all the panels in the interface, their features, what they mean, and how to use them. For instance:

  • Input panel1:
    • First input
    • Second input
  • Parameters panel:
    • First parameter
    • Second parameter
  • Output panel:
    • First output
    • Second output
  • Viewing panel:
Name of panel 1
  • Input panel2:
    • First input
    • Second input
  • Parameters panel:
    • First parameter
    • Second parameter
  • Output panel:
    • First output
    • Second output
  • Viewing panel:
Name of panel 2

Similar Modules

  • Point to other modules that have similar functionality

References

Publications related to this module go here. Links to pdfs would be useful. For extensions: link to the source code repository and additional documentation

Information for Developers

Work in progress
 Section under construction.


Note The section above is generated using the following wiki code: 

{{documentation/{{documentation/version}}/module-section|Information for Developers}}
{{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Example}}

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:

{{documentation/{{documentation/version}}/module-category|xmlurl=http://path/to/YOURMODULENAME.xml }}

If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL: 

{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}

Using this later template, the final syntax would be: 

{{documentation/{{documentation/version}}/module-category|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}


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