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

From Slicer Wiki
Jump to: navigation, search
Line 25: Line 25:
 
==Use Cases==
 
==Use Cases==
  
−
This module is especially appropriate for these use cases:
+
Most frequently used for these scenarios:
  
 
* Use Case 1:
 
* Use Case 1:
 
* Use Case 2:
 
* Use Case 2:
−
 
−
Examples of the module in use:
 
−
 
−
* Example 1
 
−
* Example 2
 
  
 
==Tutorials==
 
==Tutorials==

Revision as of 13:49, 11 August 2011

Home < Documentation < 4.0 < Modules < YOURMODULENAME

Return to the Slicer 4.0 Documentation

Gallery of New Features


Introduction and Acknowledgements

MyModule: Put the name of the module here
  • 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. Explain briefly how it works and point to the references giving more details on the algorithm.


Use Cases

Most frequently used for these scenarios:

  • Use Case 1:
  • Use Case 2:

Tutorials

Links to tutorials that 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

References

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

Information for Developers

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=20691"