Modules:PythonNumpyScript-Documentation-3.4 - Revision history

Nicole: /* Source code & documentation */

2010-01-15T22:25:27Z

Source code & documentation

Marianna at 20:23, 26 May 2009

2009-05-26T20:23:11Z

Lantiga at 10:53, 11 February 2009

2009-02-11T10:53:54Z

Lantiga: New page: Return to Slicer 3.4 Documentation NOTOC ===Module Name=== MyModule {| |Caption 1 |[[Image:screenshotBlank.png|thumb|2...

2009-02-10T16:52:56Z

New page: Return to Slicer 3.4 Documentation __NOTOC__ ===Module Name=== MyModule {| |thumb|280px|Caption 1 |[[Image:screenshotBlank.png|thumb|2...

New page

[[Documentation-3.4|Return to Slicer 3.4 Documentation]]
__NOTOC__
===Module Name===
MyModule

{|
|[[Image:screenshotBlank.png|thumb|280px|Caption 1]]
|[[Image:screenshotBlank.png|thumb|280px|Caption 2]]
|[[Image:screenshotBlank.png|thumb|280px|Caption 3]]
|}

== General Information ==
===Module Type & Category===

Type: Interactive or CLI

Category: Base or (Filtering, Registration, ''etc.'')

===Authors, Collaborators & Contact===
* Author1: Affiliation & logo, if desired
* Contributor1: Affiliation & logo, if desired
* Contributor2: Affiliation & logo, if desired
* Contact: name, email

===Module Description===
Overview of what the module does goes here.

== Usage ==

===Examples, Use Cases & Tutorials===

* Note use cases for which this module is especially appropriate, and/or link to examples.
* Link to examples of the module's use
* Link to any existing tutorials

===Quick Tour of Features and Use===
List all the panels in your interface, their features, what they mean, and how to use them. For instance:

* '''Input panel:'''
* '''Parameters panel:'''
* '''Output panel:'''
* '''Viewing panel:'''

== Development ==

===Dependencies===

Other modules or packages that are required for this module's use.

===Known bugs===

Follow this [http://na-mic.org/Mantis/main_page.php link] to the Slicer3 bug tracker.

===Usability issues===

Follow this [http://na-mic.org/Mantis/main_page.php link] to the Slicer3 bug tracker. Please select the '''usability issue category''' when browsing or contributing.

===Source code & documentation===

Customize following [http://www.na-mic.org/ViewVC/index.cgi/ links] for your module.

[http://www.na-mic.org/Slicer/Documentation/Slicer3/html/ Links] to documentation generated by doxygen.

== More Information ==

===Acknowledgment===
Include funding and other support here.

===References===
Publications related to this module go here. Links to pdfs would be useful.

@@ Line 62: / Line 62: @@
 Follow this [http://viewvc.slicer.org/viewcvs.cgi/trunk/Modules/Python/ link] to the module.
-[http://www.na-mic.org/Slicer/Documentation/Slicer3/html/ Links] to documentation generated by doxygen.
+[http://www.na-mic.org/Slicer/Documentation/Slicer3-doc/html/ Links] to documentation generated by doxygen.
 == More Information ==

@@ Line 1: / Line 1: @@
 [[Documentation-3.4|Return to Slicer 3.4 Documentation]]
 __NOTOC__
 ===Module Name===

@@ Line 1: / Line 1: @@
- [[Documentation-3.4|Return to Slicer 3.4 Documentation]]
+[[Documentation-3.4|Return to Slicer 3.4 Documentation]]
 __NOTOC__
 ===Module Name===
-MyModule
+Python Numpy Script
 == General Information ==
 ===Module Type & Category===
-Type: Interactive or CLI
+Type: CLI
-Category: Base or (Filtering, Registration, ''etc.'')
+Category: Python Modules
 ===Authors, Collaborators & Contact===
-* Author1: Affiliation & logo, if desired
+* Luca Antiga: Mario Negri Institute
-* Contributor1: Affiliation & logo, if desired
+* Daniel Blezek: Mayo Clinic
-* Contributor2: Affiliation & logo, if desired
+* Contact: Luca Antiga, antiga@marionegri.it
 ===Module Description===
-Overview of what the module does goes here.
+This Python module makes it easy to experiment with Numpy in Slicer without interacting with the console and without restarting Slicer when working on the code. The module is meant for experimentation and fast prototyping, and it is not recommended for deployment of full-fledged Python Numpy modules.
 == Usage ==
@@ Line 30: / Line 23: @@
 ===Examples, Use Cases & Tutorials===
-* Note use cases for which this module is especially appropriate, and/or link to examples.
+* The module is appropriate when a user wants to try out or rapidly prototype Python code in Slicer, prior to writing full-fledged modules and without need of restarting slicer in-between modifications.
-* Link to examples of the module's use
+* The recent availability of an iPython console in Slicer has made it more convenient to use the interactive console for the same tasks.
 ===Quick Tour of Features and Use===
 List all the panels in your interface, their features, what they mean, and how to use them. For instance:
-* '''Input panel:'''
+* '''Python Script Parameters:'''
-* '''Parameters panel:'''
+** ''Script file'': the (text) file where the Python Numpy code is located
-* '''Output panel:'''
+* '''IO:'''
-* '''Viewing panel:'''
+** ''Input Volume'': the input volume, to be referenced as variable "iarray" in the Python Numpy code contained in the Script file.
 == Development ==
@@ Line 46: / Line 44: @@
 ===Dependencies===
-Other modules or packages that are required for this module's use.
+Python
 ===Known bugs===
@@ Line 60: / Line 58: @@
 ===Source code & documentation===
-Customize following [http://www.na-mic.org/ViewVC/index.cgi/ links] for your module.
+Follow this [http://viewvc.slicer.org/viewcvs.cgi/trunk/Modules/Python/ link] to the module.
 [http://www.na-mic.org/Slicer/Documentation/Slicer3/html/ Links] to documentation generated by doxygen.
@@ Line 68: / Line 66: @@
 ===Acknowledgment===
 ===References===

Modules:PythonNumpyScript-Documentation-3.4 - Revision history

Nicole: /* Source code & documentation */

Marianna at 20:23, 26 May 2009

Lantiga at 10:53, 11 February 2009

Lantiga: New page: Return to Slicer 3.4 Documentation __NOTOC__ ===Module Name=== MyModule {| |Caption 1 |[[Image:screenshotBlank.png|thumb|2...

Lantiga: New page: Return to Slicer 3.4 Documentation NOTOC ===Module Name=== MyModule {| |Caption 1 |[[Image:screenshotBlank.png|thumb|2...