Documentation/4.0/Modules/ResampleScalarVectorDWIVolume - Revision history

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

2013-06-14T07:28:15Z

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

Fbudin: /* More Information */

2012-06-19T14:56:08Z

More Information

Fbudin at 14:35, 19 June 2012

2012-06-19T14:35:02Z

JChris.FillionR at 10:58, 2 February 2012

2012-02-02T10:58:54Z

JChris.FillionR at 10:58, 2 February 2012

2012-02-02T10:58:13Z

Marianna at 17:14, 30 November 2011

2011-11-30T17:14:19Z

Marianna at 19:43, 11 November 2011

2011-11-11T19:43:27Z

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

2011-11-04T20:32:38Z

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]. 
Author: Francois Budin, NIRAL 
Contributor1: FIRSTNAME LASTNAME, AFFILIATION 
Contributor2: FIRSTNAME LASTNAME, AFFILIATION 
Contact: Ryan Eckbo, <email>reckbo@bwh.harvard.edu </email> 
{{documentation/{{documentation/version}}/module-introduction-row}}
{{documentation/{{documentation/version}}/module-introduction-logo-gallery
|Image:Logo-isomics.png|Isomics, Inc. <- Replace this logo with yours
|Image:Logo-splnew.jpg|Surgical Planning Laboratory <-Replace this logo with yours
}}
{{documentation/{{documentation/version}}/module-introduction-end}}




{{note}}The section above is generated using the following wiki code:
<pre>
{{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]. 
Author: FIRSTNAME LASTNAME, AFFILIATION 
Contributor1: FIRSTNAME LASTNAME, AFFILIATION 
Contributor2: FIRSTNAME LASTNAME, AFFILIATION 
Contact: FIRSTNAME LASTNAME, <email>john@doe.org</email> 
{{documentation/{{documentation/version}}/module-introduction-row}}
{{documentation/{{documentation/version}}/module-introduction-logo-gallery
|Image:Logo-isomics.png|Isomics, Inc. <- Replace this logo with yours
|Image:Logo-splnew.jpg|Surgical Planning Laboratory <-Replace this logo with yours
}}
{{documentation/{{documentation/version}}/module-introduction-end}}
</pre>





{{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:28, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	<!-- ---------------------------- -->		<!-- ---------------------------- -->
	{{documentation/{{documentation/version}}/module-header}}		{{documentation/{{documentation/version}}/module-header}}

@@ Line 47: / Line 47: @@
 * The transform can be passed as an ITK Transform file using the command line, or directly as a transform node in Slicer. In the latter case, the transform can only be rigid or affine.
 * '''Be careful''' when applying multiple transforms contained in one file. Pay attention to the order of the transforms in the file and if those transforms are applied serially or simultaneously (bulk).
 * '''Warning :''' When using this module in Microsoft Windows, the flag -c which centers the transform might cause problems. Please use the long flag --centered_transform instead in that case.
 * The Transform can be given through an ITK Transform file. An example is given below.

@@ Line 9: / Line 9: @@
 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: Francois Budin, NIRAL<br>
-Contributor1: FIRSTNAME LASTNAME, AFFILIATION<br>
+Contributor1: Sylvain Bouix, PNL<br>
 Contact: Ryan Eckbo, <email>reckbo@bwh.harvard.edu </email><br>
 {{documentation/{{documentation/version}}/module-introduction-row}}
@@ Line 23: / Line 22: @@
 {{documentation/{{documentation/version}}/module-section|Module Description}}
 {{documentation/{{documentation/version}}/module-description}}
 <!-- ---------------------------- -->
 {{documentation/{{documentation/version}}/module-section|Use Cases}}
-N/A
+Most frequently used for these scenarios:
+* This module is especially appropriate when one needs to resample an image and already knows the transform to apply to it. Its principal advantages resides in the fact that one can apply any kind of transform supported by ITK (rigid, affine and non-rigid) and can choose between the most commonly used interpolators. It is also able to resample scalar, vector and DWI under certain conditions) images
-<!-- ---------------------------- -->
+* It also allows changing the spacing, the orientation, the size and the origin of the image. In that case, the image will be modified in consequences.
-{{documentation/{{documentation/version}}/module-section|Tutorials}}
+* It can be used to convert the input image from one format to another (ie: image.nrrd to image.nii.gz)
 <!-- ---------------------------- -->
@@ Line 38: / Line 42: @@
 <!-- ---------------------------- -->
 {{documentation/{{documentation/version}}/module-section|Similar Modules}}
-N/A
+* Resample DTI Volume is the equivalent module for Diffusion Tensor Images
-<!-- ---------------------------- -->
+= More Information =
-{{documentation/{{documentation/version}}/module-section|References}}
+* The transform can be passed as an ITK Transform file using the command line, or directly as a transform node in Slicer. In the latter case, the transform can only be rigid or affine.
-N/A
+* '''Be careful''' when applying multiple transforms contained in one file. Pay attention to the order of the transforms in the file and if those transforms are applied serially or simultaneously (bulk).
 <!-- ---------------------------- -->

@@ Line 22: / Line 22: @@
 <!-- ---------------------------- -->
 {{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}}
 <!-- ---------------------------- -->
@@ Line 52: / Line 37: @@
 <!-- ---------------------------- -->
 {{documentation/{{documentation/version}}/module-section|Panels and their use}}
+{{documentation/{{documentation/version}}/module-parametersdescription}}
 <!-- ---------------------------- -->
@@ Line 96: / Line 50: @@
 <!-- ---------------------------- -->
 {{documentation/{{documentation/version}}/module-section|Information for Developers}}
-{{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Example}}
+{{documentation/{{documentation/version}}/module-developerinfo}}
 <!-- ---------------------------- -->
-{{documentation/{{documentation/version}}/module-footer|category=Example}}
+{{documentation/{{documentation/version}}/module-footer}}
 <!-- ---------------------------- -->

@@ Line 15: / Line 15: @@
 {{documentation/{{documentation/version}}/module-introduction-logo-gallery
 |Image:NAMIC 380x463.jpg|NA-MIC
 }}
 {{documentation/{{documentation/version}}/module-introduction-end}}