Difference between revisions of "Documentation/4.0/Modules/Editor"

From Slicer Wiki
Jump to: navigation, search
Line 39: Line 39:
 
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
 
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
  
A list of all the panels in the interface, their features, what they mean, and how to use them. For instance:
 
  
{|style="width: 100%"
+
==== Single Label Map ====
|
+
 
* Input panel1:
+
[[image:SlicerQT-real 138.png|200px|right|Color Table Dialog]]
** First input
+
A typical straightforward Editor workflow for consists of the following steps:
** Second input
+
 
* Parameters panel:
+
* Load a volume.
** First parameter
+
* Enter the Editor module using either the toolbar or the Modules menu button.
** Second parameter
+
* You will be prompted to select a color table to use for editing (see Color Table Dialog image).
* Output panel:
+
** Pick a color node that contains the structures you wish to create.  If there are no appropriate tables available, you can create custom nodes in the [[Documentation/{{documentation/version}}/Modules/Colors|Colors Module]].
** First output
+
** Clicking apply in the Color Table Dialog will create a new label map volume based on the background volume in the Red slice view at the time you entered the Editor.  It will be the same dimensions, orientation, and spacing as the background volume.  But it will be initialize to all zeros and it will have the 'Label Map' property set.  (You can look at these in the "Info" tab of the [[Documentation/{{documentation/version}}/Modules/Volumes|Volumes Module]].
** Second output
+
** If your background was named 't1' the label will be called 't1-label'.
* Viewing panel:
+
** Note that if you already have a label map volume as the result of a previous editing step it will be automatically selected when you enter the Editor (i.e. after using the [[Documentation/{{documentation/version}}/Modules/Fast Marching|Fast Marching]] or other [[Documentation/{{documentation/version}}/Modules/Segmentation|Segmentation Modules]] you will be set up to perform manual edits of the selected label map).  You can use the Set option to pick this label map instead of the default.
| align="right" |
+
** Note that the background and label map settings in the Red slice viewer are used to determine the volumes to edit.  In the Editor Module the background grayscale volume is known as the "Master Volume" because it is used as input to tools such as Threshold Paint.  The map is known as the "Merge Volume" because it contains multiple structures (see below for information about splitting and re-merging the Merge Volume to edit individual structures).
[[Image:screenshotBlankNotOptional.png|thumb|280px|Name of panel 1]]
+
* When label map volume is selected, the edit tools frame will automatically expand and you can use the Editor Effects to define your structures.
|-
+
 
|
+
==== Per-Structure Volumes ====
* Input panel2:
+
(Please familiarize yourself with the Single Label Map approach before attempting to use the Multiple Label Map tools.)
** First input
+
 
** Second input
+
This approach can be used to independently work with a single structure using tools like the Threshold effect that operate on the entire volume.  To access this functionality, open the Per-Structure Volumes interface by clicking on the downward pointing triangle on the right side of the box.
* Parameters panel:
+
 
** First parameter
+
* Start with a Merge Volume that will contain all the structures of interest.
** Second parameter
+
** If you have already started defining the individual structures with different label values in the editor, or if you used something like [[Documentation/{{documentation/version}}/Modules/Otsu Segmentation|Otsu Segmentation]] to generate a label map, then you can use the Split Merge Volume button to create a new volume for each unique label value in the Merge Volume.
* Output panel:
+
** If you are starting from scratch, you can use the Add Structure button to define new label volumes. 
** First output
+
*** Add Structure will prompt you for a label value based on the Color Table selected when the Merge Volume was created.
** Second output
+
*** The new Structure Volume will be selected for editing.
* Viewing panel:
+
* You can click in the Per-Structure Volumes list box to select the current label map for editing (so that you can easily toggle between the Structure Volumes).
| align="right" |
+
* After defining the individual structures, you can use the Merge All button to put the volumes back into the Merge Volume.
[[Image:screenshotBlankNotOptional.png|thumb|280px|Name of panel 2]]
+
* Use Merge And Build to create a set of modules from the merged volume.
|}
+
** This uses the Joint Smoothing option of the [[Documentation/{{documentation/version}}/Modules/ModelMaker|Model Maker Module]] to create watertight models.
 +
** ''Hint: you can use the Model Maker module to manipulate other building parameters.''
 +
* The Delete Structures button will remove the Per-Structure Volumes from your scene.  If you want to delete a single volume, use the [[Documentation/{{documentation/version}}/Modules/Data|Data Module]].
 +
 
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Similar Modules}}
 
{{documentation/{{documentation/version}}/module-section|Similar Modules}}
* Point to other modules that have similar functionality
+
* See the [[Documentation/{{documentation/version}}#Segmentation|Segmentation section of the module documentation]] for more ways to create label maps.
 
 
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|References}}
 
{{documentation/{{documentation/version}}/module-section|References}}
Publications related to this module go here. Links to pdfs would be useful.
+
[[Slicer_3.6:Training |Training materials and tutorials from earlier versions of slicer]] may help give ideas about how to use these tools.
For extensions: link to the source code repository and additional documentation
 
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->

Revision as of 17:34, 20 October 2011

Home < Documentation < 4.0 < Modules < Editor


Introduction and Acknowledgements

  • This work is part of the National Alliance for Medical Image Computing (NA-MIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149. Information on NA-MIC can be obtained from the NA-MIC website.
  • Author: Steve Pieper, Isomics, Inc.
  • Contributor1: Wendy Plesniak, BWH
  • Contributor2: Ron Kikinis, BWH
  • Contributor3: Jim Miller, GE
  • Contact: Steve Pieper, <email>pieper@bwh.harvard.edu</email>
Template:Documentation/4.0/module-introduction-logoTemplate:Documentation/4.0/module-introduction-logoTemplate:Documentation/4.0/module-introduction-logo


Module Description

This is a module for manual segmentation of volumes. Some of the tools mimic a painting interface like photoshop or gimp, but work on 3D arrays of voxels rather than on 2D pixels.


Use Cases

The overall goal is to allow users to efficiently and precisely define structures within their volumes as label map volumes. These label maps can be used for building models, or further processing (using, for example, the Label Statistics module).

The label maps can either be defined from within the Editor module itself, or you can use the output of other modules and the basis for editing.


Tutorials

The Slicer 4.0 Training page provides several use cases that rely on Editor functionality.

Panels and their use

Single Label Map

Color Table Dialog

A typical straightforward Editor workflow for consists of the following steps:

  • Load a volume.
  • Enter the Editor module using either the toolbar or the Modules menu button.
  • You will be prompted to select a color table to use for editing (see Color Table Dialog image).
    • Pick a color node that contains the structures you wish to create. If there are no appropriate tables available, you can create custom nodes in the Colors Module.
    • Clicking apply in the Color Table Dialog will create a new label map volume based on the background volume in the Red slice view at the time you entered the Editor. It will be the same dimensions, orientation, and spacing as the background volume. But it will be initialize to all zeros and it will have the 'Label Map' property set. (You can look at these in the "Info" tab of the Volumes Module.
    • If your background was named 't1' the label will be called 't1-label'.
    • Note that if you already have a label map volume as the result of a previous editing step it will be automatically selected when you enter the Editor (i.e. after using the Fast Marching or other Segmentation Modules you will be set up to perform manual edits of the selected label map). You can use the Set option to pick this label map instead of the default.
    • Note that the background and label map settings in the Red slice viewer are used to determine the volumes to edit. In the Editor Module the background grayscale volume is known as the "Master Volume" because it is used as input to tools such as Threshold Paint. The map is known as the "Merge Volume" because it contains multiple structures (see below for information about splitting and re-merging the Merge Volume to edit individual structures).
  • When label map volume is selected, the edit tools frame will automatically expand and you can use the Editor Effects to define your structures.

Per-Structure Volumes

(Please familiarize yourself with the Single Label Map approach before attempting to use the Multiple Label Map tools.)

This approach can be used to independently work with a single structure using tools like the Threshold effect that operate on the entire volume. To access this functionality, open the Per-Structure Volumes interface by clicking on the downward pointing triangle on the right side of the box.

  • Start with a Merge Volume that will contain all the structures of interest.
    • If you have already started defining the individual structures with different label values in the editor, or if you used something like Otsu Segmentation to generate a label map, then you can use the Split Merge Volume button to create a new volume for each unique label value in the Merge Volume.
    • If you are starting from scratch, you can use the Add Structure button to define new label volumes.
      • Add Structure will prompt you for a label value based on the Color Table selected when the Merge Volume was created.
      • The new Structure Volume will be selected for editing.
  • You can click in the Per-Structure Volumes list box to select the current label map for editing (so that you can easily toggle between the Structure Volumes).
  • After defining the individual structures, you can use the Merge All button to put the volumes back into the Merge Volume.
  • Use Merge And Build to create a set of modules from the merged volume.
    • This uses the Joint Smoothing option of the Model Maker Module to create watertight models.
    • Hint: you can use the Model Maker module to manipulate other building parameters.
  • The Delete Structures button will remove the Per-Structure Volumes from your scene. If you want to delete a single volume, use the Data Module.


Similar Modules

References

Training materials and tutorials from earlier versions of slicer may help give ideas about how to use these tools.

Information for Developers