Documentation/4.0/Modules/ACPCTransform - Revision history

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

2013-06-14T07:28:20Z

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

JChris.FillionR at 07:56, 2 February 2012

2012-02-02T07:56:52Z

Finetjul: Use template for logos

2012-01-30T20:53:13Z

Use template for logos

Nicole at 01:06, 26 November 2011

2011-11-26T01:06:18Z

Nicole at 00:45, 26 November 2011

2011-11-26T00:45:52Z

Marianna at 20:43, 11 November 2011

2011-11-11T20:43:39Z

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

2011-11-03T22:38:16Z

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:NAMIC 380x463.jpg|NA-MIC
|Image:Logo-splnew.jpg|Surgical Planning Laboratory
}}
{{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}}
<gallery>
Image:SlicerACPCTransformGUI-3.4.jpg|GUI]]
Image:SlicerACPCTransformAfter-3.4.jpg|After calculating the transform
</gallery>
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 22: / Line 22: @@
 {{documentation/{{documentation/version}}/module-section|Module Description}}
-{{documentation/{{documentation/version}}/module-description|xmlurl=http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Applications/CLI/Realign/Realign.xml?revision=18774&view=co}}
+{{documentation/{{documentation/version}}/module-description}}
@@ Line 47: / Line 47: @@
 </gallery>
-{{documentation/{{documentation/version}}/module-parametersdescription|xmlurl=http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Applications/CLI/Realign/Realign.xml?revision=18774&view=co}}
+{{documentation/{{documentation/version}}/module-parametersdescription}}
 <!-- ---------------------------- -->
@@ Line 58: / Line 58: @@
 <!-- ---------------------------- -->
 {{documentation/{{documentation/version}}/module-section|Information for Developers}}
-{{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Registration}}
+{{documentation/{{documentation/version}}/module-developerinfo}}
 <!-- ---------------------------- -->
-{{documentation/{{documentation/version}}/module-footer|category=Registration}}
+{{documentation/{{documentation/version}}/module-footer}}
 <!-- ---------------------------- -->

@@ Line 13: / Line 13: @@
 {{documentation/{{documentation/version}}/module-introduction-row}}
 {{documentation/{{documentation/version}}/module-introduction-logo-gallery
-|Image:Logo-splnew.jpg|Surgical Planning Laboratory
+|{{collaborator|logo|spl}}|{{collaborator|longname|spl}}
-|Image:NAMIC 380x463.jpg|NA-MIC
+|{{collaborator|logo|namic}}|{{collaborator|longname|namic}}
-|Image:NAC-logo.png|NAC
+|{{collaborator|logo|nac}}|{{collaborator|longname|nac}}
 }}
 {{documentation/{{documentation/version}}/module-introduction-end}}

@@ 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: Nicole Aucoin, BWH<br>
 Contact: Nicole Aucoin, <email>nicole@bwh.harvard.edu</email><br>
 {{documentation/{{documentation/version}}/module-introduction-row}}
@@ Line 21: / Line 22: @@
 {{documentation/{{documentation/version}}/module-section|Module Description}}
-{{documentation/{{documentation/version}}/module-description|xmlurl=http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Applications/CLI/Realign/Realign.xml?view=co&revision=18752&content-type=text%2Fplain }}
+{{documentation/{{documentation/version}}/module-description|xmlurl=http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Applications/CLI/Realign/Realign.xml?revision=18774&view=co}}
@@ Line 28: / Line 29: @@
 {{documentation/{{documentation/version}}/module-section|Use Cases}}
 <gallery>
-Image:SlicerACPCTransformGUI-3.4.jpg|GUI
+Image:Slicer4-ACPC.jpeg|GUI
 </gallery>
 Most frequently used for these scenarios:
@@ Line 42: / Line 42: @@
 A list of all the panels in the interface, their features, what they mean, and how to use them.
-{{documentation/{{documentation/version}}/module-parametersdescription|xmlurl=http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Applications/CLI/Realign/Realign.xml?view=co&revision=18752&content-type=text%2Fplain}}
+<gallery>
 <!-- ---------------------------- -->
@@ Line 61: / Line 62: @@
-{{documentation/{{documentation/version}}/module-category|xmlurl=http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Applications/CLI/Realign/Realign.xml?view=co&revision=18752&content-type=text%2Fplain}}
+{{documentation/{{documentation/version}}/module-category|xmlurl=http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Applications/CLI/Realign/Realign.xml?revision=18774&view=co}}
 <!-- ---------------------------- -->
-{{documentation/{{documentation/version}}/module-footer|category=Example}}
+{{documentation/{{documentation/version}}/module-footer|category=Registration}}
 <!-- ---------------------------- -->