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

From Slicer Wiki
Jump to: navigation, search
(Created page with 'Return to Slicer 3.6 Documentation __NOTOC__ ===Module Name=== PolyData to LabelMap {| |thumb|280px|GUI panel |[[Im…')
 
 
(8 intermediate revisions by the same user not shown)
Line 6: Line 6:
 
{|
 
{|
 
|[[Image:PolyDataToLabelMap-UI-3-6.png|thumb|280px|GUI panel]]
 
|[[Image:PolyDataToLabelMap-UI-3-6.png|thumb|280px|GUI panel]]
−
|[[Image:PolyDataToLabelMap-ViewingPanel-3-6.png|thumb|280px|Surface model and label map]]
+
|[[Image:PolyDataToLabelMap-ViewingPanel-3-6.png|thumb|280px|Surface model overlaid on ref image]]
 +
|[[Image:PolyDataToLabelMap-ViewingPanelResult-3-6.png|thumb|280px|Label map generated from surface]]
 
|}
 
|}
  
Line 30: Line 31:
 
* This module may be thought of as the inverse of Marching Cubes.  
 
* This module may be thought of as the inverse of Marching Cubes.  
  
−
* A command line example:  
+
* A command line example:
 +
<pre>
 +
./PolyDataToLabelmap --distance 1.0
 +
    InputReferenceVolume.nrrd
 +
    InputSurfaceModel.vtp
 +
    OutputLabelMap.nrrd
 +
</pre>
  
 
===Quick Tour of Features and Use===
 
===Quick Tour of Features and Use===
 
* '''Input/Output panels:'''
 
* '''Input/Output panels:'''
  
−
[[Image:CreateaDicomSeries-IOPanels-3-6.png|thumb|right|280px|Input/Output panels]]
+
[[Image:PolyDatToLabelMap-IOPanels-3-6.png|thumb|right|280px|Input/Output panels]]
 +
This module takes three input: '''Input Volume''' is the reference volume. '''Model''' is the surface model from whose interior is to be labeled as foreground, and '''Output Volume''' is the output label map. Output Volume has the same image parameters (size, resolution, orientation, etc) as Input Volume.
  
 
* '''Parameters panel:'''
 
* '''Parameters panel:'''
−
[[Image:CreateaDicomSeries-PatientPanels-3-6.png|thumb|right|280px|Patient Parameters]]
+
[[Image:PolyDataToLabelMap-ParametersPanels-3-6.png|thumb|right|280px|Parameters Parameters]]
 +
Since surface can be very sparsely triangulated, this module first resample the input surface model in an appropriate resolution. The parameter '''Sample Distance''' controls how fine the surface is sampled. The ballpark value for this parameter is the smallest size of voxels in Input Volume.
  
 
== Development ==
 
== Development ==
Line 52: Line 61:
 
===Usability issues===
 
===Usability issues===
  
−
None.
+
When the object has a geometry such that the centroid of all vertices lie outside of the object, the module will fail to generate the correct label for the object.
  
 
===Source code & documentation===
 
===Source code & documentation===
  
−
Source Code: [http://www.na-mic.org/ViewVC/index.cgi/trunk/Applications/CLI/PolyDataToLabelMap.cxx?view=annotate PolyDataToLabelmap.cxx]
+
Source Code: [http://viewvc.slicer.org/viewcvs.cgi/trunk/Applications/CLI/PolyDataToLabelmap.cxx?rev=12452&view=log PolyDataToLabelmap.cxx]
  
−
XML Description: [http://www.na-mic.org/ViewVC/index.cgi/trunk/Applications/CLI/PolyDataToLabelmap.xml?view=co PolyDataToLabelmap.xml]
+
XML Description: [http://viewvc.slicer.org/viewcvs.cgi/trunk/Applications/CLI/PolyDataToLabelmap.xml?rev=9268&view=log PolyDataToLabelmap.xml]
  
 
Test: [http://viewvc.na-mic.org/viewcvs.cgi/trunk/Applications/CLI/Testing/PolyDataToLabelmapTest.cxx?rev=11537&view=log PolyDataToLabelmapTest.cxx]
 
Test: [http://viewvc.na-mic.org/viewcvs.cgi/trunk/Applications/CLI/Testing/PolyDataToLabelmapTest.cxx?rev=11537&view=log PolyDataToLabelmapTest.cxx]
Line 64: Line 73:
 
Usage:
 
Usage:
 
<pre>
 
<pre>
 +
./PolyDataToLabelmap --help
 +
 +
USAGE:
 +
 +
  ./PolyDataToLabelmap  [--returnparameterfile <std::string>]
 +
                        [--processinformationaddress <std::string>]
 +
                        [--xml] [--echo] [--distance <float>] [--]
 +
                        [--version] [-h] <std::string> <std::string>
 +
                        <std::string>
 +
 +
 +
Where:
 +
 +
  --returnparameterfile <std::string>
 +
    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>
 +
    Address of a structure to store process information (progress, abort,
 +
    etc.). (default: 0)
 +
 +
  --xml
 +
    Produce xml description of command line arguments (default: 0)
 +
 +
  --echo
 +
    Echo the command line arguments (default: 0)
 +
 +
  --distance <float>
 +
    Sample distance (default: 1)
 +
 +
  --,  --ignore_rest
 +
    Ignores the rest of the labeled arguments following this flag.
 +
 +
  --version
 +
    Displays version information and exits.
 +
 +
  -h,  --help
 +
    Displays usage information and exits.
 +
 +
  <std::string>
 +
    (required)  Input volume
 +
 +
  <std::string>
 +
    (required)  Model
 +
 +
  <std::string>
 +
    (required)  The label volume
 +
 +
 +
  Description: Intersects an input model with an reference volume and
 +
  produces an output label map.
 +
 +
  Author(s): Nicole Aucoin BWH, Xiaodong Tao, GE
 +
 +
  Acknowledgements: 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.
 
</pre>
 
</pre>
  
Line 74: Line 141:
 
Information on the National Centers for Biomedical Computing
 
Information on the National Centers for Biomedical Computing
 
can be obtained from [http://www.ncbcs.org/ National Centers for Biomedical Computing].
 
can be obtained from [http://www.ncbcs.org/ National Centers for Biomedical Computing].
 +
 +
[http://www.oasis-brains.org/ OASIS datasets] were used to generate images on this page.
  
 
===References===
 
===References===

Latest revision as of 15:11, 30 April 2010

Home < Modules:PolyDatToLabelMap-Documentation-3.6

Return to Slicer 3.6 Documentation

Module Name

PolyData to LabelMap

GUI panel
Surface model overlaid on ref image
Label map generated from surface

General Information

Module Type & Category

Type: CLI

Category: Surface Models

Authors, Collaborators & Contact

  • Author: Xiaodong Tao and Nicole Aucoin
  • Contact: taox at research.ge.com

Module Description

This module creates a label map of the interior of an input model within a reference volume. The module first label voxels that intersects the surface as foreground, then use a flood fill to label all interior.

Usage

Examples, Use Cases & Tutorials

  • This module may be thought of as the inverse of Marching Cubes.
  • A command line example:
./PolyDataToLabelmap --distance 1.0
    InputReferenceVolume.nrrd
    InputSurfaceModel.vtp
    OutputLabelMap.nrrd

Quick Tour of Features and Use

  • Input/Output panels:
Input/Output panels

This module takes three input: Input Volume is the reference volume. Model is the surface model from whose interior is to be labeled as foreground, and Output Volume is the output label map. Output Volume has the same image parameters (size, resolution, orientation, etc) as Input Volume.

  • Parameters panel:
Parameters Parameters

Since surface can be very sparsely triangulated, this module first resample the input surface model in an appropriate resolution. The parameter Sample Distance controls how fine the surface is sampled. The ballpark value for this parameter is the smallest size of voxels in Input Volume.

Development

Dependencies

This module depends only on the core "Volumes" module of slice for data IO.

Known bugs

None.

Usability issues

When the object has a geometry such that the centroid of all vertices lie outside of the object, the module will fail to generate the correct label for the object.

Source code & documentation

Source Code: PolyDataToLabelmap.cxx

XML Description: PolyDataToLabelmap.xml

Test: PolyDataToLabelmapTest.cxx

Usage: 

./PolyDataToLabelmap --help

USAGE: 

   ./PolyDataToLabelmap  [--returnparameterfile <std::string>]
                         [--processinformationaddress <std::string>]
                         [--xml] [--echo] [--distance <float>] [--]
                         [--version] [-h] <std::string> <std::string>
                         <std::string>


Where: 

   --returnparameterfile <std::string>
     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>
     Address of a structure to store process information (progress, abort,
     etc.). (default: 0)

   --xml
     Produce xml description of command line arguments (default: 0)

   --echo
     Echo the command line arguments (default: 0)

   --distance <float>
     Sample distance (default: 1)

   --,  --ignore_rest
     Ignores the rest of the labeled arguments following this flag.

   --version
     Displays version information and exits.

   -h,  --help
     Displays usage information and exits.

   <std::string>
     (required)  Input volume

   <std::string>
     (required)  Model

   <std::string>
     (required)  The label volume


   Description: Intersects an input model with an reference volume and
   produces an output label map.

   Author(s): Nicole Aucoin BWH, Xiaodong Tao, GE

   Acknowledgements: 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.

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.

OASIS datasets were used to generate images on this page.

References

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