Documentation/4.0/Modules/ProbeVolumeWithModel - Revision history

UpdateBot: Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

2013-06-14T07:33:05Z

Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

JChris.FillionR at 11:20, 2 February 2012

2012-02-02T11:20:36Z

Lauren at 22:02, 22 November 2011

2011-11-22T22:02:44Z

Lauren at 21:58, 22 November 2011

2011-11-22T21:58:55Z

Lauren: Created page with ' {{documentation/{{documentation/version}}/module-header}} {{doc…'

2011-11-22T21:55:57Z

Created page with ' {{documentation/{{documentation/version}}/module-header}}   {{doc…'

New page

{{documentation/{{documentation/version}}/module-header}}



{{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: Nicole Aucoin, SPL<br>
Contact: Nicole Aucoin, <email>nicole@bwh.harvard.edu</email><br>
{{documentation/{{documentation/version}}/module-introduction-row}}
{{documentation/{{documentation/version}}/module-introduction-logo-gallery
|Image:Logo-splnew.jpg|Surgical Planning Laboratory
|Image:NAMIC 380x463.jpg|NA-MIC
|Image:NAC-logo.png|NAC
}}
{{documentation/{{documentation/version}}/module-introduction-end}}


{{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.




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-section|Use Cases}}
Most frequently used for these scenarios:

* Use Case 1:
* Use Case 2:


{{documentation/{{documentation/version}}/module-section|Tutorials}}
Links to tutorials that use this module


{{documentation/{{documentation/version}}/module-section|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:

{|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]]
|}


{{documentation/{{documentation/version}}/module-section|Similar Modules}}
* Point to other modules that have similar functionality


{{documentation/{{documentation/version}}/module-section|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


{{documentation/{{documentation/version}}/module-section|Information for Developers}}
{{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Example}}




{{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}}

← Older revision		Revision as of 07:33, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	<!-- ---------------------------- -->		<!-- ---------------------------- -->
	{{documentation/{{documentation/version}}/module-header}}		{{documentation/{{documentation/version}}/module-header}}

@@ Line 28: / Line 28: @@
 * Use Case 1: Visualize data from any volume (e.g. T2 MRI) on the surface of a model (e.g. a tumor surface)
 * Use Case 2: Sample data onto a model for later quantitative analysis, perhaps in another program, such as sampling FA/T2/etc. onto a model of fiber tracts
 <!-- ---------------------------- -->
-{{documentation/{{documentation/version}}/module-footer|category=Example}}
+{{documentation/{{documentation/version}}/module-footer}}
 <!-- ---------------------------- -->

@@ Line 8: / Line 8: @@
 {{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: Nicole Aucoin, SPL<br>
+Author: Lauren O'Donnell, SPL<br>
-Contact: Nicole Aucoin, <email>nicole@bwh.harvard.edu</email><br>
+Contact: Lauren O'Donnell, <email>odonnell@bwh.harvard.edu</email><br>
 {{documentation/{{documentation/version}}/module-introduction-row}}
 {{documentation/{{documentation/version}}/module-introduction-logo-gallery
@@ Line 20: / Line 20: @@
 <!-- ---------------------------- -->
 {{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.
+This module is used to "paint" a model with data from an image volume in Slicer.  This calls vtkProbeFilter internally, which will probe (interpolate) a value from the image volume at every point location (vertex) of the model.  This module works in "world space" so it handles the coordinate systems of the model (known as RAS) and volume (internally stored in an array with "ijk" coordinates in Slicer terminology).
 <!-- ----------------------------------------------------------------- -->