Difference between revisions of "Modules:GrayscaleModelMaker-Documentation-3.6"

From Slicer Wiki
Jump to: navigation, search
Line 22: Line 22:
  
 
===Module Description===
 
===Module Description===
−
Create 3D surface models from grayscale data. This module
+
 
−
uses Marching Cubes to create an isosurface at a given threshold. The
+
{| style="color:green" border="1"
−
resulting surface consists of triangles that separate a volume into
+
 
−
regions below and above the threshold. The resulting surface can be
+
|Program title || Grayscale Model Maker
−
smoothed and decimated. This model works on continuous data while the
+
 
−
module Model Maker works on labeled (or discrete) data.
+
|-
 +
|Program description ||
 +
Create 3D surface models from grayscale data. This module uses Marching Cubes to create an isosurface at a given threshold. The resulting surface consists of triangles that separate a volume into regions below and above the threshold. The resulting surface can be smoothed and decimated. This module works on continuous data while the module Model Maker works on labeled (or discrete) data.
 +
 
 +
 
 +
|-
 +
|Program version || 3.0
 +
 
 +
|-
 +
|Program documentation-url || http://www.slicer.org/slicerWiki/index.php/Modules:GrayscaleModelMaker-Documentation-3.6
 +
 
 +
|-
 +
|}
  
 
== Usage ==
 
== Usage ==
−
<pre>
 
−
GrayscaleModelMaker
 
−
                  [--returnparameterfile
 
−
                  <std::string>]
 
−
                  [--processinformationaddress
 
−
                  <std::string>] [--xml] [--echo]
 
−
                  [--pointnormals] [--splitnormals]
 
−
                  [--decimate <float>] [--smooth
 
−
                  <int>] [-n <std::string>] [-t
 
−
                  <float>] [--] [--version] [-h]
 
−
                  <std::string> <std::string>
 
−
 
−
Where:
 
  
−
  --returnparameterfile <std::string>
+
===Use Cases, Examples===
−
    Filename in which to write simple return parameters (int, float,
 
−
    int-vector, etc.) as opposed to bulk return parameters (image,
 
−
    geometry, transform, measurement, table).
 
  
−
  --processinformationaddress <std::string>
+
This module is especially appropriate for these use cases:
−
    Address of a structure to store process information (progress, abort,
 
−
    etc.). (default: 0)
 
  
−
  --xml
+
* Use Case 1: when have a continuous data set as input (ie grey scale volume)
−
    Produce xml description of command line arguments (default: 0)
 
  
−
  --echo
+
Examples of the module in use:
−
    Echo the command line arguments (default: 0)
 
  
−
  --pointnormals
+
* Example 1: to
−
    Calculate the point normals? Calculated point normals make the surface
+
* Example 2
−
    appear smooth. Without point normals, the surface will appear faceted.
 
−
    (default: 0)
 
  
−
  --splitnormals
+
===Tutorials===
−
    Splitting normals is useful for visualizing sharp features. However it
 
−
    creates holes in surfaces which affect measurements (default: 0)
 
  
−
  --decimate <float>
+
* Tutorial 1
−
    Target reduction during decimation, as a decimal percentage reduction
+
** Data Set 1
−
    in the number of polygons. If 0, no decimation will be done. (default:
 
−
    0.25)
 
  
−
  --smooth <int>
+
===Quick Tour of Features and Use===
−
    Number of smoothing iterations. If 0, no smoothing will be done.
 
−
    (default: 15)
 
  
−
  -n <std::string>, --name <std::string>
+
A list panels in the interface, their features, what they mean, and how to use them.
−
    Name to use for this model. (default: Model)
 
  
−
  -t <float>,  --threshold <float>
+
{|
−
    Grayscale threshold of isosurface. The resulting surface of triangles
+
|
−
    separates the volume into voxels that lie above (inside) and below
+
* <span style="color:blue">'''''IO''''' </span>  
−
    (outside) the threshold. (default: 100)
+
** <span style="color:green">'''Input Volume'''</span>  : Volume containing the input grayscale data.
 +
** <span style="color:green">'''Output Geometry'''</span>  : Output that contains geometry model.
  
−
  --,  --ignore_rest
 
−
    Ignores the rest of the labeled arguments following this flag.
 
  
−
  --version
+
* <span style="color:blue">'''''Grayscale Model Maker Parameters''''' </span>
−
    Displays version information and exits.
+
** <span style="color:green">'''Threshold'''</span> [<span style="color:orange">----threshold</span>] [<span style="color:pink">--t</span>]: Grayscale threshold of isosurface. The resulting surface of triangles separates the volume into voxels that lie above (inside) and below (outside) the threshold. ''Default value: 100.0''
 +
** <span style="color:green">'''Model Name'''</span> [<span style="color:orange">----name</span>] [<span style="color:pink">--n</span>]: Name to use for this model. ''Default value: Model''
 +
** <span style="color:green">'''Smooth'''</span> [<span style="color:orange">----smooth</span>] : Number of smoothing iterations. If 0, no smoothing will be done. ''Default value: 15''
 +
** <span style="color:green">'''Decimate'''</span> [<span style="color:orange">----decimate</span>] : Target reduction during decimation, as a decimal percentage reduction in the number of polygons. If 0, no decimation will be done. ''Default value: 0.25''
 +
** <span style="color:green">'''Split Normals?'''</span> [<span style="color:orange">----splitnormals</span>] : Splitting normals is useful for visualizing sharp features. However it creates holes in surfaces which affect measurements ''Default value: true''
 +
** <span style="color:green">'''Compute Point Normals?'''</span> [<span style="color:orange">----pointnormals</span>] : Calculate the point normals? Calculated point normals make the surface appear smooth. Without point normals, the surface will appear faceted. ''Default value: true''
  
−
  -h,  --help
 
−
    Displays usage information and exits.
 
  
−
  <std::string>
+
|[[Image:screenshotBlankNotOptional.png|thumb|280px|User Interface]]
−
    (required)  Volume containing the input grayscale data.
+
|}
  
−
  <std::string>
 
−
    (required)  Output that contains geometry model.
 
−
</pre>
 
  
 
== Development ==
 
== Development ==

Revision as of 20:22, 10 June 2010

Home < Modules:GrayscaleModelMaker-Documentation-3.6

Return to Slicer 3.6 Documentation


Module Name

Grayscale Model Maker

CT Study, Skin. Threshold=-300 hounsfeld
CT Study, Bone. Threshold=200 hounsfeld

General Information

Module Type & Category

Type: CLI

Category: Surface Models

Authors, Collaborators & Contact

  • Authors: Bill Lorensen, Nicole Aucoin
  • Contact: bill.lorensen at gmail.com

Module Description

Program title Grayscale Model Maker
Program description

Create 3D surface models from grayscale data. This module uses Marching Cubes to create an isosurface at a given threshold. The resulting surface consists of triangles that separate a volume into regions below and above the threshold. The resulting surface can be smoothed and decimated. This module works on continuous data while the module Model Maker works on labeled (or discrete) data.


Program version 3.0
Program documentation-url http://www.slicer.org/slicerWiki/index.php/Modules:GrayscaleModelMaker-Documentation-3.6

Usage

Use Cases, Examples

This module is especially appropriate for these use cases:

  • Use Case 1: when have a continuous data set as input (ie grey scale volume)

Examples of the module in use:

  • Example 1: to
  • Example 2

Tutorials

  • Tutorial 1
    • Data Set 1

Quick Tour of Features and Use

A list panels in the interface, their features, what they mean, and how to use them.

  • IO
    • Input Volume : Volume containing the input grayscale data.
    • Output Geometry : Output that contains geometry model.


  • Grayscale Model Maker Parameters
    • Threshold [----threshold] [--t]: Grayscale threshold of isosurface. The resulting surface of triangles separates the volume into voxels that lie above (inside) and below (outside) the threshold. Default value: 100.0
    • Model Name [----name] [--n]: Name to use for this model. Default value: Model
    • Smooth [----smooth] : Number of smoothing iterations. If 0, no smoothing will be done. Default value: 15
    • Decimate [----decimate] : Target reduction during decimation, as a decimal percentage reduction in the number of polygons. If 0, no decimation will be done. Default value: 0.25
    • Split Normals? [----splitnormals] : Splitting normals is useful for visualizing sharp features. However it creates holes in surfaces which affect measurements Default value: true
    • Compute Point Normals? [----pointnormals] : Calculate the point normals? Calculated point normals make the surface appear smooth. Without point normals, the surface will appear faceted. Default value: true
User Interface


Development

Source code & documentation

Source Code: GrayscaleModelMaker.cxx

XML Description: GrayscaleModelMaker.xml

Test: GrayscaleModelMakerTest.cxx

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. Information on the National Centers for Biomedical Computing can be obtained from National Centers for Biomedical Computing.

References

Retrieved from "https://www.slicer.org/w/index.php?title=Modules:GrayscaleModelMaker-Documentation-3.6&oldid=16843"