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

From Slicer Wiki
Jump to: navigation, search
(Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887)
 
(45 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
[[Documentation-4.0|Return to the Slicer 4.0 Documentation]]
+
<noinclude>{{documentation/versioncheck}}</noinclude>
 +
<!-- ---------------------------- -->
 +
{{documentation/{{documentation/version}}/module-header}}
 +
<!-- ---------------------------- -->
  
−
[[Announcements:Slicer4-alpha#Highlights|Gallery of New Features]]
+
<!-- ---------------------------- -->
 +
{{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
 +
{{documentation/{{documentation/version}}/module-introduction-start|{{documentation/modulename}}}}
 +
{{documentation/{{documentation/version}}/module-introduction-row}}
 +
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 [http://www.na-mic.org/ NA-MIC website].<br>
 +
Author: FIRSTNAME LASTNAME, AFFILIATION<br>
 +
Contributor1: FIRSTNAME LASTNAME, AFFILIATION<br>
 +
Contributor2: FIRSTNAME LASTNAME, AFFILIATION<br>
 +
Contact: FIRSTNAME LASTNAME, <email>john@doe.org</email><br>
 +
{{documentation/{{documentation/version}}/module-introduction-row}}
 +
{{documentation/{{documentation/version}}/module-introduction-logo-gallery
 +
|{{collaborator|logo|isomics}}|{{collaborator|longname|isomics}} <- Replace this logo with yours
 +
|{{collaborator|logo|spl}}|{{collaborator|longname|spl}}  <-Replace this logo with yours
 +
}}
 +
{{documentation/{{documentation/version}}/module-introduction-end}}
  
−
__NOTOC__
+
<!-- ---------------------------- -->
−
===Module Name===
+
{{documentation/{{documentation/version}}/module-section|Module Description}}
−
MyModule
+
N/A
 +
<!--
 +
Here comes a description what the module is good for. Explain briefly how it works and point to the [[documentation/{{documentation/version}}/Modules/{{documentation/modulename}}#References|references]] giving more details on the algorithm.
  
−
=Introduction=
+
If you are documenting a CLI, the description should be extracted from the corresponding XML description. This could be done automatically using the following wiki template:<pre>{{documentation/{{documentation/version}}/module-description}}
−
{|
 
−
|[[Image:screenshotBlankNotOptional.png|thumb|280px|User Interface]]
 
−
|align="left"|
 
−
* Author1: Name, Affiliation
 
−
* Contributor1: Name, Affiliation
 
−
* Contributor2: Name, Affiliation
 
−
* Contact: name, email: '''This is required'''
 
−
|[[image:Your lab/institution Logo here.png|100px|right|thumb|Lab/Institution Name]]
 
−
|-
 
−
|}
 
  
−
=Help=
+
{{documentation/{{documentation/version}}/module-description}}
−
== 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
+
{{documentation/{{documentation/version}}/module-section|Use Cases}}
 +
N/A
  
−
===Module Type & Category===
+
<!-- ---------------------------- -->
 +
{{documentation/{{documentation/version}}/module-section|Tutorials}}
 +
N/A
  
−
Type: Interactive or CLI
+
<!-- ---------------------------- -->
 +
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
 +
N/A
 +
<!--
 +
{{documentation/{{documentation/version}}/module-parametersdescription}}
 +
-->
  
−
Category: Base or (Filtering, Registration, ''etc.'')
+
<!-- ---------------------------- -->
 +
{{documentation/{{documentation/version}}/module-section|Similar Modules}}
 +
N/A
  
−
== Usage ==
+
<!-- ---------------------------- -->
 +
{{documentation/{{documentation/version}}/module-section|References}}
 +
N/A
  
−
===Use Cases, Examples===
+
<!-- ---------------------------- -->
 +
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
 +
{{documentation/{{documentation/version}}/module-developerinfo}}
  
−
This module is especially appropriate for these use cases:
 
  
−
* Use Case 1:
+
<!-- ---------------------------- -->
−
* Use Case 2:
+
{{documentation/{{documentation/version}}/module-footer}}
−
 
+
<!-- ---------------------------- -->
−
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]]
 
−
|}
 
−
 
 
−
 
 
−
====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 [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.
 

Latest revision as of 07:28, 14 June 2013

Home < Documentation < 4.0 < Modules < YOURMODULENAME


For the latest Slicer documentation, visit the read-the-docs.



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: FIRSTNAME LASTNAME, AFFILIATION
Contributor1: FIRSTNAME LASTNAME, AFFILIATION
Contributor2: FIRSTNAME LASTNAME, AFFILIATION
Contact: FIRSTNAME LASTNAME, <email>john@doe.org</email>

Isomics, Inc. <- Replace this logo with yours  
Surgical Planning Laboratory (SPL) <-Replace this logo with yours  

Module Description

N/A

Use Cases

N/A

Tutorials

N/A

Panels and their use

N/A

Similar Modules

N/A

References

N/A

Information for Developers

Work in progress
 Section under construction.


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