Documentation/4.1/Developers/Python scripting - Revision history

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

2013-06-14T07:25:48Z

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

2013-01-11T21:21:29Z

2012-07-05T16:32:00Z

Accessing slice vtkRenderWindows from slice views

2012-07-05T16:31:03Z

Examples

2012-07-03T20:36:09Z

Running a CLI from Python

2012-07-03T20:34:27Z

Running a CLI from Python

2012-06-19T20:49:29Z

2012-06-12T18:44:42Z

Packaging/Saving Scenes

2012-06-12T18:42:40Z

Packaging/Saving Scenes

2012-06-12T18:35:44Z

Loading DICOM Sets

← Older revision		Revision as of 07:25, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	= Background =		= Background =

← Older revision		Revision as of 21:21, 11 January 2013
Line 55:		Line 55:

	Note that the CLI module runs in a background thread, so the call to grayModel will return right away. But the slicer.cli.run call returns a cliNode (an instance of [http://slicer.org/doc/html/classvtkMRMLCommandLineModuleNode.html vtkMRMLCommandLineModuleNode]) which can be used to monitor the progress of the module.		Note that the CLI module runs in a background thread, so the call to grayModel will return right away. But the slicer.cli.run call returns a cliNode (an instance of [http://slicer.org/doc/html/classvtkMRMLCommandLineModuleNode.html vtkMRMLCommandLineModuleNode]) which can be used to monitor the progress of the module.
		+
		+	In order to view the names of the parameters required by a CLI module, consider this example on the Grayscale Model Maker:
		+	<pre>
		+	>>> gm = slicer.modules.grayscalemodelmaker
		+	>>> gmlogic = gm.cliModuleLogic()
		+	>>> node = gmLogic.CreateNode()
		+	>>> print node.GetParameterName(0,0)
		+	InputVolume
		+	>>> print node.GetParameterName(0,1)
		+	OutputGeometry
		+	</pre>

	In this example we create a simple callback that will be called whenever the cliNode is modified. The status will tell you if the nodes is Pending, Running, or Completed.		In this example we create a simple callback that will be called whenever the cliNode is modified. The status will tell you if the nodes is Pending, Running, or Completed.

← Older revision		Revision as of 16:32, 5 July 2012
Line 68:		Line 68:

	==== Accessing slice vtkRenderWindows from slice views ====		==== Accessing slice vtkRenderWindows from slice views ====
		+
		+	The example below shows how to get the rendered slice window.

	<pre>		<pre>

@@ Line 66: / Line 66: @@
 cliNode.AddObserver('ModifiedEvent', printStatus)
 </pre>
 ''TODO: some more samples of the Qt console''

@@ Line 54: / Line 54: @@
 </pre>
-Note that the CLI module runs in a background thread, so the call to grayModel will return right away.  But the slicer.cli.run call returns a cliNode (an instance of vtkMRMLCommandLineModuleNode) which can be used to monitor the progress of the module.
+Note that the CLI module runs in a background thread, so the call to grayModel will return right away.  But the slicer.cli.run call returns a cliNode (an instance of [http://slicer.org/doc/html/classvtkMRMLCommandLineModuleNode.html vtkMRMLCommandLineModuleNode]) which can be used to monitor the progress of the module.
 In this example we create a simple callback that will be called whenever the cliNode is modified.  The status will tell you if the nodes is Pending, Running, or Completed.

@@ Line 45: / Line 45: @@
    parameters["OutputGeometry"] = outModel.GetID()
    grayMaker = slicer.modules.grayscalemodelmaker
-   slicer.cli.run(grayMaker, None, parameters)
+   return (slicer.cli.run(grayMaker, None, parameters))
 </pre>
@@ Line 51: / Line 51: @@
 <pre>
 v = getNode('MRHead')
-grayModel(v)
+cliNode = grayModel(v)
 </pre>
 ''TODO: some more samples of the Qt console''

← Older revision	Revision as of 20:49, 19 June 2012
(No difference)

@@ Line 155: / Line 155: @@
 === Packaging/Saving Scenes ===
-A basic example of how you can use Python to package/save a scene.  This command packages all of the referenced files in the scene into one specified folder.  All images, csvs, etc. are copied into the folder "<package dir>/data."
+A basic example.  The following packages all of the scene's referenced files into one specified folder.  All images, csvs, volumes, etc. (everything except the scene .mrml) are copied into the folder "<package dir>/data."  The scene .mrml is in the "<package dir>" directory.
   import os
@@ Line 161: / Line 161: @@
   tempDir = os.path.join(slicer.app.slicerHome, ‘testScene’)
-  # os.path.join takes care of slash issues that you may encounter with UNIX-Windows compatibility.
+  # Put our temp scene directory into the slicer directory.  os.path.join takes care of slash issues that you may encounter with UNIX-Windows compatibility.
   l = slicer.app.applicationLogic()
   l.SaveSceneToSlicerDataBundleDirectory(tempDir, None)

@@ Line 172: / Line 172: @@
 The approach is to point Slicer's DICOM database to the directory of the new files.  The command appends the existing database with the files found in the inputted directory.
   i = ctk.ctkDICOMIndexer()
-  i.addDirectory(slicer.dicomDatabase, cachedPath)
+  i.addDirectory(slicer.dicomDatabase, '/yourDICOMdir/')
 One approach to begin the load process is to call on the DICOM module, which will automatically open the "DICOM Details" popup.  However, if the popup has been used already in the current Slicer session, a refresh may not occur and a restart may be required.