Difference between revisions of "Modules:ResampleVolume2-Documentation"

From Slicer Wiki
Jump to: navigation, search
Line 36: Line 36:
 
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/Output:''' Defines input and output files. '''Input volume''' is the volume to resample, '''Reference Volume''' (optional) is the volume used to set the sampling parameters (spacing, orientation and dimensions), '''output volume''' is the name of the output.
+
* '''Input/Output:''' Defines input and output files.  
 +
** ''Input volume'' is the volume to resample,  
 +
** ''Reference Volume'' (optional) is the volume used to set the sampling parameters (spacing, orientation and dimensions),  
 +
** ''output volume'' is the name of the output.
 
* '''Resampling Parameters:''' Sets the number of threads used to perform the resmapling.
 
* '''Resampling Parameters:''' Sets the number of threads used to perform the resmapling.
 
* '''Transform Parameters:''' if the transform to be applied is in the slicer mrml tree, on can select it here.
 
* '''Transform Parameters:''' if the transform to be applied is in the slicer mrml tree, on can select it here.
* '''Manual Transform:'''
+
* '''Manual Transform:''' if no tranform is set in previous panel, one can enter his own transform
** ''Transform Matrix:'' if no tranform is set in previous panel, one can enter a 12 parameter affine transformation manually. The first 9 numbers represent a linear transformation matrix, the last 3 are a translation.
+
** ''Transform Matrix:'' a 12 parameter affine transformation manually. The first 9 numbers represent a linear transformation matrix, the last 3 are a translation.
 
** ''Transform:'' forces the transform to be of rigid or affine type (affine is default)
 
** ''Transform:'' forces the transform to be of rigid or affine type (affine is default)
 
** ''Space:'' specifies whether the matrix is expressed in LPS or RAS coordinate space.
 
** ''Space:'' specifies whether the matrix is expressed in LPS or RAS coordinate space.

Revision as of 14:40, 15 September 2008

Home < Modules:ResampleVolume2-Documentation

Return to Slicer Documentation

Module Name

MyModule

Module with panels expanded
Caption 2
Caption 3

General Information

Module Type & Category

Type: CLI

Category: Filtering

Authors, Collaborators & Contact

  • Francois Budin
  • Sylvain Bouix, PNL
  • Contact: Francois Budin , budin[at]bwh[dot]harvard[dot]edu

Module Description

This module implements image and vector-image resampling through the use of itk Transforms.It can also handle diffusion weighted MRI image resampling. 'Resampling' is performed in space coordinates, not pixel/grid coordinates. It is quite important to ensure that image spacing is properly set on the images involved. The interpolator is required since the mapping from one space to the other will often require evaluation of the intensity of the image at non-grid positions.

Usage

Examples, Use Cases & Tutorials

  • Note use cases for which this module is especially appropriate, and/or link to examples.
  • Link to examples of the module's use
  • Link to any existing tutorials

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:

  • Input/Output: Defines input and output files.
    • Input volume is the volume to resample,
    • Reference Volume (optional) is the volume used to set the sampling parameters (spacing, orientation and dimensions),
    • output volume is the name of the output.
  • Resampling Parameters: Sets the number of threads used to perform the resmapling.
  • Transform Parameters: if the transform to be applied is in the slicer mrml tree, on can select it here.
  • Manual Transform: if no tranform is set in previous panel, one can enter his own transform
    • Transform Matrix: a 12 parameter affine transformation manually. The first 9 numbers represent a linear transformation matrix, the last 3 are a translation.
    • Transform: forces the transform to be of rigid or affine type (affine is default)
    • Space: specifies whether the matrix is expressed in LPS or RAS coordinate space.

Development

Dependencies

Other modules or packages that are required for this module's use.

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

Customize following links for your module.

Links to documentation generated by doxygen.


More Information

Acknowledgment

Include funding and other support here.

References

Publications related to this module go here. Links to pdfs would be useful.