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

From Slicer Wiki
Jump to: navigation, search
(Initial template)
 
(xml urls now point to github)
Line 21: Line 21:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
−
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.
 
−
 
−
<!-- ----------------------------------------------------------------- -->
 
−
<!-- THE FOLLOWING SHOULD BE REMOVED FOR YOUR OWN MODULE DOCUMENTATION -->
 
−
<!-- ----------------------------------------------------------------- -->
 
−
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|xmlurl=http://path/to/YOURMODULE.xml }}</pre>
 
−
 
−
If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL:
 
−
<pre>{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}</pre>
 
−
 
−
Using this later template, the final syntax would be:
 
−
<pre>{{documentation/{{documentation/version}}/module-description|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}</pre>
 
−
<!-- ----------------------------------------------------------------- -->
 
−
<!-- ----------------------------------------------------------------- -->
 
−
<!-- ----------------------------------------------------------------- -->
 
  
 +
{{documentation/{{documentation/version}}/module-description|xmlurl=https://raw.github.com/BRAINSia/BRAINSStandAlone/master/BRAINSROIAuto/BRAINSROIAuto.xml }}
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
Line 95: Line 81:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
 
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
−
{{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Example}}
+
{{documentation/{{documentation/version}}/module-developerinfo|{{documentation/modulename}}|type=Interactive|category=
−
 
+
  {{
−
 
+
  documentation/{{documentation/version}}/module-category|xmlurl=https://raw.github.com/BRAINSia/BRAINSStandAlone/master/BRAINSROIAuto/BRAINSROIAuto.xml
−
<!-- ----------------------------------------------------------------- -->
+
  }}
−
<!-- THE FOLLOWING SHOULD BE REMOVED FOR YOUR OWN MODULE DOCUMENTATION -->
+
}}
−
<!-- ----------------------------------------------------------------- -->
 
−
{{note}}The section above is generated using the following wiki code:
 
−
<pre>
 
−
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
 
−
{{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Example}}
 
−
</pre>
 
−
 
 
−
If you are documenting a CLI, the category should be extracted from the corresponding XML description. This could be done automatically using the following wiki template:<pre>{{documentation/{{documentation/version}}/module-category|xmlurl=http://path/to/YOURMODULENAME.xml }}</pre>
 
−
 
 
−
If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL:
 
−
<pre>{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}</pre>
 
−
 
 
−
Using this later template, the final syntax would be:
 
−
<pre>{{documentation/{{documentation/version}}/module-category|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}</pre>
 
−
<!-- ----------------------------------------------------------------- -->
 
−
<!-- ----------------------------------------------------------------- -->
 
−
<!-- ----------------------------------------------------------------- -->
 
−
 
 
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
−
{{documentation/{{documentation/version}}/module-footer|category=Example}}
+
{{documentation/{{documentation/version}}/module-footer|category=
 +
  {{
 +
  documentation/{{documentation/version}}/module-category|xmlurl=https://raw.github.com/BRAINSia/BRAINSStandAlone/master/BRAINSROIAuto/BRAINSROIAuto.xml
 +
  }}
 +
}}
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->

Revision as of 17:34, 21 November 2011

Home < Documentation < 4.0 < Modules < ForegroundMasking


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: Hans Johnson, UIOWA
Contributor1: FIRSTNAME LASTNAME, AFFILIATION
Contributor2: FIRSTNAME LASTNAME, AFFILIATION
Contact: Hans Johnson, <email>(hans-johnson@uiowa.edu</email>

University of Iowa  
Surgical Planning Laboratory  

Module Description

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. For extensions: link to the source code repository and additional documentation

Information for Developers

Work in progress
 Section under construction.


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