Difference between revisions of "Modules:PythonExplodeVolumeTransform-Documentation-3.4"

From Slicer Wiki
Jump to: navigation, search
(New page: Return to Slicer 3.4 Documentation __NOTOC__ ===Module Name=== MyModule {| |thumb|280px|Caption 1 |[[Image:screenshotBlank.png|thumb|2...)
 
Line 1: Line 1:
[[Documentation-3.4|Return to Slicer 3.4 Documentation]]
+
[[Documentation-3.4|Return to Slicer 3.4 Documentation]]
 
__NOTOC__
 
__NOTOC__
 
===Module Name===
 
===Module Name===
MyModule
+
Python Explode Volume Transform
 
 
{|
 
|[[Image:screenshotBlank.png|thumb|280px|Caption 1]]
 
|[[Image:screenshotBlank.png|thumb|280px|Caption 2]]
 
|[[Image:screenshotBlank.png|thumb|280px|Caption 3]]
 
|}
 
  
 
== General Information ==
 
== General Information ==
 
===Module Type & Category===
 
===Module Type & Category===
  
Type: Interactive or CLI
+
Type: CLI
  
Category: Base or (Filtering, Registration, ''etc.'')
+
Category: Python Modules
  
 
===Authors, Collaborators & Contact===
 
===Authors, Collaborators & Contact===
* Author1: Affiliation & logo, if desired
+
* Luca Antiga: Mario Negri Institute
* Contributor1: Affiliation & logo, if desired
+
* Daniel Blezek: Mayo Clinic
* Contributor2: Affiliation & logo, if desired
+
* Contact: Luca Antiga, antiga@marionegri.it
* Contact: name, email
 
  
 
===Module Description===
 
===Module Description===
Overview of what the module does goes here.
+
This Python module takes a volume in input, computes its XYZToRAS transform by matrix manipulation, where XYZ is the local (VTK-compatible) coordinate system, and generate a XYZ-oriented volume in the MRML scene as a child of the XYZToRASTransform.
  
 
== Usage ==
 
== Usage ==
Line 30: Line 23:
 
===Examples, Use Cases & Tutorials===
 
===Examples, Use Cases & Tutorials===
  
* Note use cases for which this module is especially appropriate, and/or link to examples.
+
* The module is appropriate when a CLI module can only handle non-oriented images (i.e. images oriented as the XYZ axes), like pure-VTK modules.
* Link to examples of the module's use
+
* The typical use is as follows: run a volume through this filter, use the output volume as input for the non-orientation-aware CLI module and place the output of this latter module under the XYZToRAS transform generated by the present module by using the MRML tree widget.
* Link to any existing tutorials
 
  
 
===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:
  
* '''Input panel:'''
+
* '''IO:'''
* '''Parameters panel:'''
+
** ''Input Volume'': the input volume
* '''Output panel:'''
+
** ''Output Volume'': the output volume, the input volume with its IJKToRAS transform aligned with the XYZ axes, set as the child of the corresponding XYZToRAS transform.
* '''Viewing panel:'''
 
  
 
== Development ==
 
== Development ==
Line 46: Line 37:
 
===Dependencies===
 
===Dependencies===
  
Other modules or packages that are required for this module's use.
+
Python
  
 
===Known bugs===
 
===Known bugs===
Line 60: Line 51:
 
===Source code & documentation===
 
===Source code & documentation===
  
Customize following [http://www.na-mic.org/ViewVC/index.cgi/ links] for your module.
+
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 59:
  
 
===Acknowledgment===
 
===Acknowledgment===
Include funding and other support here.
 
  
 
===References===
 
===References===
Publications related to this module go here. Links to pdfs would be useful.
 

Revision as of 10:42, 11 February 2009

Home < Modules:PythonExplodeVolumeTransform-Documentation-3.4

Return to Slicer 3.4 Documentation

Module Name

Python Explode Volume Transform

General Information

Module Type & Category

Type: CLI

Category: Python Modules

Authors, Collaborators & Contact

  • Luca Antiga: Mario Negri Institute
  • Daniel Blezek: Mayo Clinic
  • Contact: Luca Antiga, antiga@marionegri.it

Module Description

This Python module takes a volume in input, computes its XYZToRAS transform by matrix manipulation, where XYZ is the local (VTK-compatible) coordinate system, and generate a XYZ-oriented volume in the MRML scene as a child of the XYZToRASTransform.

Usage

Examples, Use Cases & Tutorials

  • The module is appropriate when a CLI module can only handle non-oriented images (i.e. images oriented as the XYZ axes), like pure-VTK modules.
  • The typical use is as follows: run a volume through this filter, use the output volume as input for the non-orientation-aware CLI module and place the output of this latter module under the XYZToRAS transform generated by the present module by using the MRML tree widget.

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:

  • IO:
    • Input Volume: the input volume
    • Output Volume: the output volume, the input volume with its IJKToRAS transform aligned with the XYZ axes, set as the child of the corresponding XYZToRAS transform.

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.


More Information

Acknowledgment

References