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

From Slicer Wiki
Jump to: navigation, search
Line 21: Line 21:
 
|}
 
|}
  
−
=Help=
+
=Module Description=
−
== General Information ==
+
Here comes a description what the module is good for
−
===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===
+
==References==
−
* Point to other modules that have similar functionality
+
Publications related to this module go here. Links to pdfs would be useful.
−
 
 
−
===Module Type & Category===
 
−
 
 
−
Type: Interactive or CLI
 
  
−
Category: Base or (Filtering, Registration, ''etc.'')
+
==Use Cases==
−
 
 
−
== Usage ==
 
−
 
 
−
===Use Cases, Examples===
 
  
 
This module is especially appropriate for these use cases:
 
This module is especially appropriate for these use cases:
Line 49: Line 39:
 
* Example 2
 
* Example 2
  
−
===Tutorials===
+
==Tutorials==
−
 
 
 
Links to tutorials explaining how to use this module:
 
Links to tutorials explaining how to use this module:
  
−
* Tutorial 1
+
==Panels and their use==
−
** Data Set 1
 
  
−
===Quick Tour of Features and Use===
+
A list of all the panels in the interface, their features, what they mean, and how to use them. For instance:
−
 
 
−
A list panels in the interface, their features, what they mean, and how to use them. For instance:
 
  
 
{|
 
{|
 
|
 
|
−
* '''Input panel:'''
+
* '''Input panel1:'''
 +
** '''First input'''
 +
** '''Second input'''
 +
* '''Parameters panel:'''
 +
** '''First parameter'''
 +
** '''Second parameter'''
 +
* '''Output panel:'''
 +
** '''First output'''
 +
** '''Second output'''
 +
* '''Viewing panel:'''
 +
|align="right"|[[Image:screenshotBlankNotOptional.png|thumb|280px|Name of panel 1]]
 +
|-
 +
|
 +
* '''Input panel2:'''
 
** '''First input'''
 
** '''First input'''
 
** '''Second input'''
 
** '''Second input'''
Line 72: Line 71:
 
** '''Second output'''
 
** '''Second output'''
 
* '''Viewing panel:'''
 
* '''Viewing panel:'''
−
|[[Image:screenshotBlankNotOptional.png|thumb|280px|User Interface]]
+
|align="right"|[[Image:screenshotBlankNotOptional.png|thumb|280px|Name of panel 2]]
 
|}
 
|}
  
  
−
====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 ==
+
==Similar Modules==
 +
* Point to other modules that have similar functionality
 +
 
 +
 
 +
= Development =
 +
===Module Type & Category===
 +
 
 +
Type: Interactive or CLI
  
 +
Category: Base or (Filtering, Registration, ''etc.'')
 
===Notes from the Developer(s)===
 
===Notes from the Developer(s)===
  
Line 93: Line 97:
 
===Tests===
 
===Tests===
  
−
On the [http://www.cdash.org/CDash/index.php?project=Slicer3 Dashboard], these tests verify that the module is working on various platforms:
+
On the [http://cdash.org/slicer4 Slicer4 Dashboard], these tests verify that the module is working on various platforms:
  
 
* MyModuleTest1 [http://viewvc.slicer.org/viewcvs.cgi/trunk MyModuleTest1.cxx]
 
* MyModuleTest1 [http://viewvc.slicer.org/viewcvs.cgi/trunk MyModuleTest1.cxx]
 
* MyModuleTest2 [http://viewvc.slicer.org/viewcvs.cgi/trunk MyModuleTest2.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===
 
===Source code & documentation===
Line 119: Line 112:
 
Doxygen documentation:
 
Doxygen documentation:
 
*[http://www.na-mic.org/Slicer/Documentation/Slicer3-doc/html/classes.html class1]
 
*[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.
 

Revision as of 13:27, 11 August 2011

Home < Documentation < 4.0 < Modules < YOURMODULENAME

Return to the Slicer 4.0 Documentation

Gallery of New Features


Module Name

MyModule

Introduction

Snapshot of the Module
  • Author1: Steve Pieper, Isomics (replace this with your name and affiliation)
  • Contributor1: Nicole Aucoin, Surgical Planning Laboratory, BWH, HMS (replace this with your name and affiliation)
  • Contributor2: Name, Affiliation
  • Contact: name, email: This is required
Replace this logo with yours
Replace this logo with yours

Module Description

Here comes a description what the module is good for

References

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

Use Cases

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:

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:

  • Input panel1:
    • First input
    • Second input
  • Parameters panel:
    • First parameter
    • Second parameter
  • Output panel:
    • First output
    • Second output
  • Viewing panel:
Name of panel 1
  • Input panel2:
    • First input
    • Second input
  • Parameters panel:
    • First parameter
    • Second parameter
  • Output panel:
    • First output
    • Second output
  • Viewing panel:
Name of panel 2



Similar Modules

  • Point to other modules that have similar functionality


Development

Module Type & Category

Type: Interactive or CLI

Category: Base or (Filtering, Registration, etc.)

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 Slicer4 Dashboard, these tests verify that the module is working on various platforms:

Source code & documentation

Links to the module's source code:

Source code:

Doxygen documentation:

Retrieved from "https://www.slicer.org/w/index.php?title=Documentation/4.0/Modules/YOURMODULENAME&oldid=20685"