Difference between revisions of "Documentation/4.0/Modules/YOURMODULENAME"
Line 15: | Line 15: | ||
* Contributor2: Name, Affiliation | * Contributor2: Name, Affiliation | ||
* Contact: name, email: '''This is required''' | * Contact: name, email: '''This is required''' | ||
− | |[[image: | + | |[[image:Logo-isomics.png|100px|right|thumb|Replace this logo with yours]] |
|- | |- | ||
|} | |} |
Revision as of 13:07, 11 August 2011
Home < Documentation < 4.0 < Modules < YOURMODULENAMEReturn to the Slicer 4.0 Documentation
Module Name
MyModule
Introduction
|
Help
General Information
Module Description
The volume rendering module enables volume rendering of scalar volumes. Several "render engines" are available, each of which has a different combination of features. The hardware accelerated volume rendering engines depend that the machine, on which they are used, has proper hardware for graphics acceleration and enough graphics memory available for the size of the data being rendered. Transfer functions are available to modify the appearance of the data.
Similar Modules
- Point to other modules that have similar functionality
Module Type & Category
Type: Interactive or CLI
Category: Base or (Filtering, Registration, etc.)
Usage
Use Cases, Examples
This module is especially appropriate for these use cases:
- Use Case 1:
- Use Case 2:
Examples of the module in use:
- Example 1
- Example 2
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:
|
Interacting with Transfer Functions
- Press the middle mouse button to delete a control point in a transfer function.
- You can select multiple points with the right click and move them all at the same time with the left click
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.