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

From Slicer Wiki
Jump to: navigation, search
(Created page with 'Return to Slicer 3.5 Documentation Gallery of New Features __NOTOC__ ===Cast Image=== CastImage {| |[[Image:screen…')
 
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Documentation-3.5|Return to Slicer 3.5 Documentation]]
+
[[Documentation-3.4|Return to Slicer 3.4 Documentation]]
 
 
[[Announcements:Slicer3.5#Highlights|Gallery of New Features]]
 
  
 
__NOTOC__
 
__NOTOC__
 
===Cast Image===
 
===Cast Image===
CastImage
+
Cast Image
  
 
{|
 
{|
|[[Image:screenshotBlank.png|thumb|280px|Caption 1]]
+
|[[Image:Slicer3.5CastGUI.jpg|thumb|280px|Cast GUI]]
|[[Image:screenshotBlank.png|thumb|280px|Caption 2]]
 
|[[Image:screenshotBlank.png|thumb|280px|Caption 3]]
 
 
|}
 
|}
  
Line 27: Line 23:
 
===Module Description===
 
===Module Description===
  
Does a data type cast of a volume.
+
Cast a volume to a given data type.
  
 +
Use at your own risk when casting an input volume into a lower precision type! 
 +
 +
Allows casting to the same type as the input volume.
  
 
== Usage ==
 
== Usage ==
Line 34: Line 33:
 
===Examples, Use Cases & Tutorials===
 
===Examples, Use Cases & Tutorials===
  
* Note use cases for which this module is especially appropriate, and/or link to examples.
+
* Useful for when an algorithm requires a specific data type for an input volume.
* Link to examples of the module's use
 
* 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:'''
+
* '''Cast Image panel:'''
* '''Parameters panel:'''
+
**Select a parameter set
* '''Output panel:'''
+
**See the status of the module
* '''Viewing panel:'''
+
* '''IO panel:'''
 +
**Select an input volume to cast
 +
**Select an output volume in which to place the cast results, or create a new one.
 +
* '''Filter Settings panel:'''
 +
**Select the output type for the new volume:
 +
***Char: -128 to 128
 +
***Int: signed integer
 +
***Float: floating point
 +
***Unsigned Char (default): 0 to 255
 +
***Unsigned Int: positive integer
 +
***Double: double floating point
 +
***Short: short integer
 +
***Long: long integer
 +
***Unsigned Short: unsigned short integer
 +
***Unsigned Long: unsigned long integer
  
 
== Development ==
 
== Development ==
Line 50: Line 61:
 
===Dependencies===
 
===Dependencies===
  
Other modules or packages that are required for this module's use.
+
The Volumes module is required for this module's use.
 +
 
 +
''WARNING: This module is available in Slicer 3.4 release only after 3.4.1 version (builds of Dec 10, 2009 and on)!''
  
 
===Known bugs===
 
===Known bugs===
Line 63: Line 76:
 
===Source code & documentation===
 
===Source code & documentation===
  
Customize following [http://viewvc.slicer.org/viewcvs.cgi/ links] for your module.
+
* [http://viewvc.slicer.org/viewcvs.cgi/trunk/Applications/CLI/Cast.cxx?view=log Cast.cxx]
 +
* [http://viewvc.slicer.org/viewcvs.cgi/trunk/Applications/CLI/Cast.xml?view=log Cast.xml]
 +
 
 +
<!--
  
 
[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.
 
+
-->
  
 
== More Information ==  
 
== More Information ==  
  
 
===Acknowledgment===
 
===Acknowledgment===
Include funding and other support here.
+
 
 +
This work is part of the National Alliance for Medical Image Computing (NAMIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149.
  
 
===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 03:15, 13 December 2009

Home < Modules:CastImage-Documentation-3.4

Return to Slicer 3.4 Documentation


Cast Image

Cast Image

Cast GUI

General Information

Module Type & Category

Type: CLI

Category: Filtering, Arithmetic

Authors, Collaborators & Contact

  • Nicole Aucoin, Brigham and Women's Hospital
  • ported from Slicer2
  • Contact: Nicole Aucoin, nicole@bwh.harvard.edu

Module Description

Cast a volume to a given data type.

Use at your own risk when casting an input volume into a lower precision type!

Allows casting to the same type as the input volume.

Usage

Examples, Use Cases & Tutorials

  • Useful for when an algorithm requires a specific data type for an input volume.

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:

  • Cast Image panel:
    • Select a parameter set
    • See the status of the module
  • IO panel:
    • Select an input volume to cast
    • Select an output volume in which to place the cast results, or create a new one.
  • Filter Settings panel:
    • Select the output type for the new volume:
      • Char: -128 to 128
      • Int: signed integer
      • Float: floating point
      • Unsigned Char (default): 0 to 255
      • Unsigned Int: positive integer
      • Double: double floating point
      • Short: short integer
      • Long: long integer
      • Unsigned Short: unsigned short integer
      • Unsigned Long: unsigned long integer

Development

Dependencies

The Volumes module is required for this module's use.

WARNING: This module is available in Slicer 3.4 release only after 3.4.1 version (builds of Dec 10, 2009 and on)!

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


More Information

Acknowledgment

This work is part of the National Alliance for Medical Image Computing (NAMIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149.

References