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

From Slicer Wiki
Jump to: navigation, search
(Initial template)
 
(Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
<noinclude>{{documentation/versioncheck}}</noinclude>
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-header}}
 
{{documentation/{{documentation/version}}/module-header}}
Line 9: Line 10:
 
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>
 
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: Hans Johnson, UIOWA<br>
 
Author: Hans Johnson, UIOWA<br>
−
Contributor1: FIRSTNAME LASTNAME, AFFILIATION<br>
 
−
Contributor2: FIRSTNAME LASTNAME, AFFILIATION<br>
 
 
Contact: Hans Johnson, <email>(hans-johnson@uiowa.edu</email><br>
 
Contact: Hans Johnson, <email>(hans-johnson@uiowa.edu</email><br>
 
{{documentation/{{documentation/version}}/module-introduction-row}}
 
{{documentation/{{documentation/version}}/module-introduction-row}}
Line 21: Line 20:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{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.
+
{{documentation/{{documentation/version}}/module-description}}
−
 
 
−
<!-- ----------------------------------------------------------------- -->
 
−
<!-- 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>
 
−
<!-- ----------------------------------------------------------------- -->
 
−
<!-- ----------------------------------------------------------------- -->
 
−
<!-- ----------------------------------------------------------------- -->
 
−
 
 
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
Line 42: Line 26:
 
Most frequently used for these scenarios:
 
Most frequently used for these scenarios:
  
−
* Use Case 1:
+
* Use Case 1: Creating a rough brain mask.
 
* Use Case 2:
 
* Use Case 2:
  
Line 51: Line 35:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
 
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
−
 
+
{{documentation/{{documentation/version}}/module-parametersdescription}}
−
A list of all the panels in the interface, their features, what they mean, and how to use them. For instance:
 
−
 
 
−
{|style="width: 100%"
 
−
|
 
−
* 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
 
−
** 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 2]]
 
−
|}
 
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
Line 95: Line 48:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{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}}
−
 
 
−
 
 
−
<!-- ----------------------------------------------------------------- -->
 
−
<!-- 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}}
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->

Latest revision as of 07:31, 14 June 2013

Home < Documentation < 4.0 < Modules < ForegroundMasking


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: Hans Johnson, UIOWA
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: Creating a rough brain mask.
  • Use Case 2:

Tutorials

Links to tutorials that use this module

Panels and their use

Parameters: 





     * '
     
       ** ':


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