Modules:VolumeRendering-Documentation-4.0 - Revision history

Kikinis at 20:04, 21 July 2011

2011-07-21T20:04:43Z

Kikinis: /* Module Description */

2011-06-13T19:00:11Z

Module Description

Kikinis at 18:21, 13 June 2011

2011-06-13T18:21:54Z

Kikinis: /* Quick Tour of Features and Use */

2011-06-13T18:21:12Z

Quick Tour of Features and Use

Kikinis: Created page with 'Return to Slicer 4 alpha Documentation Gallery of New Features NOTOC ===Module Name=== MyModule {| |[[…'

2011-06-13T18:17:21Z

Created page with 'Return to Slicer 4 alpha Documentation Gallery of New Features __NOTOC__ ===Module Name=== MyModule {| |[[…'

New page

[[Documentation-4-alpha|Return to Slicer 4 alpha Documentation]]

[[Announcements:Slicer4-alpha#Highlights|Gallery of New Features]]

__NOTOC__
===Module Name===
MyModule

{|
|[[Image:screenshotBlankNotOptional.png|thumb|280px|User Interface]]
|[[Image:screenshotBlank.png|thumb|280px|Output]]
|[[Image:screenshotBlank.png|thumb|280px|Caption]]
|}

== General Information ==
===Module Description===
Overview of what the module does goes here.

===Authors, Collaborators & Contact===
* Author1: Affiliation & logo, if desired
* Contributor1: Affiliation & logo, if desired
* Contributor2: Affiliation & logo, if desired
* Contact: name, email

===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:

{|
|
* '''Input panel:'''
** '''First input'''
** '''Second input'''
* '''Parameters panel:'''
** '''First parameter'''
** '''Second parameter'''
* '''Output panel:'''
** '''First output'''
** '''Second output'''
* '''Viewing panel:'''
|[[Image:screenshotBlankNotOptional.png|thumb|280px|User Interface]]
|}

== 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 [http://www.cdash.org/CDash/index.php?project=Slicer3 Dashboard], these tests verify that the module is working on various platforms:

* MyModuleTest1 [http://viewvc.slicer.org/viewcvs.cgi/trunk MyModuleTest1.cxx]
* MyModuleTest2 [http://viewvc.slicer.org/viewcvs.cgi/trunk MyModuleTest2.cxx]

===Known bugs===

Links to known bugs in the Slicer3 bug tracker

* [http://www.na-mic.org/Bug/view.php?id=000 Bug 000: description]

===Usability issues===

Follow this [http://na-mic.org/Mantis/main_page.php 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:
*[http://viewvc.slicer.org/viewcvs.cgi/trunk file.cxx ]
*[http://viewvc.slicer.org/viewcvs.cgi/trunk file.h ]

Doxygen documentation:
*[http://www.na-mic.org/Slicer/Documentation/Slicer3-doc/html/classes.html class1]

== More Information ==

===Acknowledgment===
Include funding and other support here.

===References===
Publications related to this module go here. Links to pdfs would be useful.

← Older revision		Revision as of 18:21, 13 June 2011
Line 1:		Line 1:
−	[[Documentation-4~~-alpha~~\|Return to Slicer 4 ~~alpha~~ Documentation]]	+	[[Documentation-4.0\|Return to the Slicer 4.0 Documentation]]

	[[Announcements:Slicer4-alpha#Highlights\|Gallery of New Features]]		[[Announcements:Slicer4-alpha#Highlights\|Gallery of New Features]]

@@ Line 13: / Line 13: @@
 |}
-== General Information ==
+=Acknowledgment=
 ===Authors, Collaborators & Contact===
 * Author1: Affiliation & logo, if desired
@@ Line 22: / Line 19: @@
 * Contributor2: Affiliation & logo, if desired
 * Contact: name, email
 ===Similar Modules===

@@ Line 15: / Line 15: @@
 == General Information ==
 ===Module Description===
-Overview of what the module does goes here.
+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.
 ===Authors, Collaborators & Contact===