Modules:Editor-Documentation-3.6
http://www.slicer.org/slicerWiki/index.php/Modules:Editor-Documentation
Return to Slicer 3.6 Documentation
Module Name
MyModule
General Information
Module Type & Category
Type: Interactive Scripted
Category: Base
Authors, Collaborators & Contact
- Developer: Steve Pieper: Isomics, Inc.
- Patron: Ron Kikinis: BWH
- Designer: Wendy Plesniak
- Contact: Steve Pieper, pieper at bwh dot harvard dot edu
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. 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).
Usage
Use Cases, Examples
Single Label Map
A typical straightforward Editor workflow for consists of the following steps:
- Load a volume using File->Add Volume interface.
- 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).
- Note that the background and label map settings in the Red slice viewer are used to determine the volumes to edit.
- When label map volume is selected, the edit tools frame will automatically expand and you can use the Editor Effects to define your structures.
Multiple Structures in Multiple Label Maps
Using the Editor Effects
Tutorials
Links to tutorials explaining how to use this module:
- 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. For instance:
|
Development
Notes from the Developer(s)
Algorithms used, library classes depended upon, use cases, etc.
Dependencies
Other modules or packages that are required for this module's use.
Tests
On the Dashboard, these tests verify that the module is working on various platforms:
- MyModuleTest1 MyModuleTest1.cxx
- MyModuleTest2 MyModuleTest2.cxx
Known bugs
Links to known bugs in 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
Links to the module's source code:
Source code:
Doxygen documentation:
More Information
Acknowledgment
Include funding and other support here.
References
Publications related to this module go here. Links to pdfs would be useful.