Difference between revisions of "Modules:BRAINSResample"

From Slicer Wiki
Jump to: navigation, search
m (Text replacement - "https?:\/\/(?:www|wiki)\.slicer\.org\/slicerWiki\/index\.php\/([^ ]+) " to "https://www.slicer.org/wiki/$1 ")
 
(One intermediate revision by one other user not shown)
Line 17: Line 17:
  
 
Category: Registration
 
Category: Registration
 +
 +
  
 
===Authors, Collaborators & Contact===
 
===Authors, Collaborators & Contact===
−
* Author1: Hans Johnson, University of Iowa
+
 
−
* Contributor1: Kent WIlliams, University of Iowa
+
Author: This tool was developed by Vincent Magnotta, Greg Harris, and Hans Johnson.
−
* Contact: Hans Johnson, hans-johson at uiowa.edu
+
 
 +
Contributors: The development of this tool was supported by funding from grants NS050568 and NS40068 from the National Institute of Neurological Disorders and Stroke and grants MH31593, MH40856, from the National Institute of Mental Health. 
 +
 
 +
 
  
 
===Module Description===
 
===Module Description===
−
BRAINSResample is a program whose purpose is to resample image volumes to a new resolution, optionally applying a transformation.
+
 
 +
{| style="color:green" border="1"
 +
 
 +
|Program title || BRAINSResample
 +
 
 +
|-
 +
|Program version || 3.0.0
 +
 
 +
|-
 +
|Program documentation-url || https://www.slicer.org/wiki/Modules:BRAINSResample |-
 +
|}
 +
 
 +
BRAINSResample is a program whose purpose is to resample image volumes to a new resolution, optionally applying a transformation.
 +
 
 
== Usage ==
 
== Usage ==
 
BRAINSResample collects together three common image processing tasks that all involve resampling an image volume: Resampling to a new resolution and spacing, applying a transformation (using an ITK transform IO mechanisms) and Warping (using a vector image deformation field).
 
BRAINSResample collects together three common image processing tasks that all involve resampling an image volume: Resampling to a new resolution and spacing, applying a transformation (using an ITK transform IO mechanisms) and Warping (using a vector image deformation field).
Line 51: Line 69:
 
{|
 
{|
 
|
 
|
 +
* <span style="color:blue">'''''Inputs''''' </span> Parameters for specifying the image to warp and resulting image space
 +
** <span style="color:green">'''Image To Warp'''</span> [<span style="color:orange">--inputVolume</span>]: Image To Warp
 +
** <span style="color:green">'''Reference Image'''</span> [<span style="color:orange">--referenceVolume</span>]: Reference image used only to define the output space. If not specified, the warping is done in the same space as the image to warp.
 +
* <span style="color:blue">'''''Outputs''''' </span> Resulting deformed image parameters
 +
** <span style="color:green">'''Output Image'''</span> [<span style="color:orange">--outputVolume</span>]: Resulting deformed image
 +
** <span style="color:green">'''Pixel Type'''</span> [<span style="color:orange">--pixelType</span>]: Specifies the pixel type for the input/output images.  The "binary" pixel type uses a modified algorithm whereby the image is read in as unsigned char, a signed distance map is created, signed distance map is resampled, and then a thresholded image of type unsigned char is written to disk.
 +
* <span style="color:blue">'''''Warping Parameters''''' </span> Parameters used to define home the image is warped
 +
** <span style="color:green">'''Deformation Field'''</span> [<span style="color:orange">--deformationVolume</span>]: Deformation Field to be used to warp the image
 +
** <span style="color:green">'''Warp By Transform'''</span> [<span style="color:orange">--warpTransform</span>]: Filename for the BRAINSFit transform used in place of the deformation field
 +
** <span style="color:green">'''Interpolation Mode'''</span> [<span style="color:orange">--interpolationMode</span>]: Type of interpolation to be used when applying transform to moving volume.  Options are Linear, NearestNeighbor, BSpline, or WindowedSinc
 +
** <span style="color:green">'''Default Value'''</span> [<span style="color:orange">--defaultValue</span>]: Default voxel value
 +
* <span style="color:blue">'''''Advanced Options''''' </span> Add warped grid to output image to help show the deformation that occured with specified spacing.  A spacing of 0 in a dimension indicates that grid lines should be rendered to fall exactly (i.e. do not allow displacements off that plane).  This is useful for makeing a 2D image of grid lines from the 3D space
 +
** <span style="color:green">'''Add Grids'''</span> [<span style="color:orange">--gridSpacing</span>]: Add warped grid to output image to help show the deformation that occured with specified spacing.  A spacing of 0 in a dimension indicates that grid lines should be rendered to fall exactly (i.e. do not allow displacements off that plane).  This is useful for makeing a 2D image of grid lines from the 3D space
  
−
*Input Image Files
 
−
**Image To Warp: Input Image to transform/warp
 
−
**Reference Image: Defines the output space into which Image will be warped
 
−
**Deformation Field: Vector volume defining voxel transformation
 
−
*Warping Parameters
 
−
**Warp By Transform: Filename of BRAINSFit Transfrom file to use in place of deformation field
 
−
**Pixel Type: Specifies pixel type for input & output image. "binary" pixel type uses a modified algorithm whereby the image is read as unsigned char voxels, a signed distance map is created, te signed distance map is resampled, and the thresholded image is written to disk.
 
−
**Interpolation Mode: Specifies which interpolator is used.
 
−
**Invert Linear Transform: Perform transform inversion in ITK physical space before applying linear transform to the image.
 
−
*Result File
 
−
**Output Image: the input image, transformed/warped and then resampled into the reference image space.
 
 
|[[Image:BRAINSResampleUI.png|thumb|280px|User Interface]]
 
|[[Image:BRAINSResampleUI.png|thumb|280px|User Interface]]
 
|}
 
|}
Line 71: Line 91:
  
 
===Dependencies===
 
===Dependencies===
−
BRAINSFit depends on Slicer3 (for the SlicerExecutionModel support) and ITK.
+
BRAINSResample depends on Slicer3 (for the SlicerExecutionModel support) and ITK.
−
===Tests===
+
BRAINSResample depends on BRAINSCommonLib
−
TODO: Link to BRAINS3 and/or Slicer3 dashboard tests.
 
−
===Known bugs===
 
  
−
Links to known bugs in the Slicer3 bug tracker
 
  
−
* [http://www.na-mic.org/Bug/view.php?id=000 Bug 000: description]
+
===Tests===
 +
http://testing.psychiatry.uiowa.edu
  
  
Line 84: Line 102:
  
 
Follow this [http://na-mic.org/Mantis/main_page.php link] to the Slicer3 bug tracker. Please select the '''usability issue category''' when browsing or contributing.
 
Follow this [http://na-mic.org/Mantis/main_page.php link] to the Slicer3 bug tracker. Please select the '''usability issue category''' when browsing or contributing.
−
 
−
<!== ===Source code & documentation===
 
−
 
−
Links to the module's source code:
 
−
 
−
Source code:
 
−
*[http://viewvc.slicer.org/viewcvs.cgi/trunk file.cxx ]
 
−
*[http://viewvc.slicer.org/viewcvs.cgi/trunk file.h ]
 
−
 
−
Doxygen documentation:
 
−
*[http://www.na-mic.org/Slicer/Documentation/Slicer3-doc/html/classes.html class1]
 
  
 
== More Information ==  
 
== More Information ==  
−
List of all parameters
 
  
−
  --outputVolume <std::string>
+
===Acknowledgment===
−
    Resulting deformed image
+
The development of this tool was supported by funding from grants NS050568 and NS40068 from the National Institute of Neurological Disorders and Stroke and grants MH31593, MH40856, from the National Institute of Mental Health.   
−
 
 
−
  --useTransformMode <std::string>
 
−
    This defunct parameter is no longer in service.  Now ApplyWarp infers
 
−
    the transform type from the contents of the .mat file.
 
−
 
 
−
  --defaultValue <float>
 
−
    Default voxel value (default: 0)
 
−
 
 
−
  --invertTransform
 
−
    Perform transform inversion in itk physical space before applying the
 
−
    linear transform to the image. (default: 0)
 
−
 
 
−
  --interpolationMode <NearestNeighbor|Linear|BSpline|WindowedSinc>
 
−
    Type of interpolation used (default: Linear)
 
−
 
 
−
  --pixelType <uchar|short|ushort|int|uint|float|binary>
 
−
    Specifies the pixel type for the input/output images.  The 'binary'
 
−
    pixel type uses a modified algorithm whereby the image is read in as
 
−
    unsigned char, a signed distance map is created, signed distance map
 
−
    is resampled, and then a thresholded image of type unsigned char is
 
−
    written to disk. (default: uchar)
 
−
 
 
−
  --warpTransform <std::string>
 
−
    Filename for the BRAINSFit transform used in place of the deformation
 
−
    field
 
  
−
  --deformationVolume <std::string>
 
−
    Deformation Field
 
−
 
−
  --referenceVolume <std::string>
 
−
    Reference image defining the output space
 
−
 
−
  --inputVolume <std::string>
 
−
    Image To Warp
 
−
 
−
===Acknowledgment===
 
−
Include funding and other support here.
 
  
 
===References===
 
===References===
 
Publications related to this module go here. Links to pdfs would be useful.
 
Publications related to this module go here. Links to pdfs would be useful.
 
-->
 
-->

Latest revision as of 13:18, 27 November 2019

Home < Modules:BRAINSResample

Return to Slicer 3.6 Documentation

Gallery of New Features


Module Name

BRAINSResample

User Interface

General Information

Module Type & Category

Type: CLI

Category: Registration


Authors, Collaborators & Contact

Author: This tool was developed by Vincent Magnotta, Greg Harris, and Hans Johnson.

Contributors: The development of this tool was supported by funding from grants NS050568 and NS40068 from the National Institute of Neurological Disorders and Stroke and grants MH31593, MH40856, from the National Institute of Mental Health.


Module Description

Program title BRAINSResample
Program version 3.0.0
Program documentation-url -

BRAINSResample is a program whose purpose is to resample image volumes to a new resolution, optionally applying a transformation.

Usage

BRAINSResample collects together three common image processing tasks that all involve resampling an image volume: Resampling to a new resolution and spacing, applying a transformation (using an ITK transform IO mechanisms) and Warping (using a vector image deformation field).

Quick Tour of Features and Use

  • Inputs Parameters for specifying the image to warp and resulting image space
    • Image To Warp [--inputVolume]: Image To Warp
    • Reference Image [--referenceVolume]: Reference image used only to define the output space. If not specified, the warping is done in the same space as the image to warp.
  • Outputs Resulting deformed image parameters
    • Output Image [--outputVolume]: Resulting deformed image
    • Pixel Type [--pixelType]: Specifies the pixel type for the input/output images. The "binary" pixel type uses a modified algorithm whereby the image is read in as unsigned char, a signed distance map is created, signed distance map is resampled, and then a thresholded image of type unsigned char is written to disk.
  • Warping Parameters Parameters used to define home the image is warped
    • Deformation Field [--deformationVolume]: Deformation Field to be used to warp the image
    • Warp By Transform [--warpTransform]: Filename for the BRAINSFit transform used in place of the deformation field
    • Interpolation Mode [--interpolationMode]: Type of interpolation to be used when applying transform to moving volume. Options are Linear, NearestNeighbor, BSpline, or WindowedSinc
    • Default Value [--defaultValue]: Default voxel value
  • Advanced Options Add warped grid to output image to help show the deformation that occured with specified spacing. A spacing of 0 in a dimension indicates that grid lines should be rendered to fall exactly (i.e. do not allow displacements off that plane). This is useful for makeing a 2D image of grid lines from the 3D space
    • Add Grids [--gridSpacing]: Add warped grid to output image to help show the deformation that occured with specified spacing. A spacing of 0 in a dimension indicates that grid lines should be rendered to fall exactly (i.e. do not allow displacements off that plane). This is useful for makeing a 2D image of grid lines from the 3D space
User Interface

Development

Notes from the Developer(s)

Dependencies

BRAINSResample depends on Slicer3 (for the SlicerExecutionModel support) and ITK. BRAINSResample depends on BRAINSCommonLib


Tests

http://testing.psychiatry.uiowa.edu


Usability issues

Follow this link to the Slicer3 bug tracker. Please select the usability issue category when browsing or contributing.

More Information

Acknowledgment

The development of this tool was supported by funding from grants NS050568 and NS40068 from the National Institute of Neurological Disorders and Stroke and grants MH31593, MH40856, from the National Institute of Mental Health.


References

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

Retrieved from "https://www.slicer.org/w/index.php?title=Modules:BRAINSResample&oldid=62603"