Slicer3:Execution Model Documentation:Programmatic Invocation - Revision history

Grundlett: Text replacement - "http://www.slicer.org/slicerWiki/index.php/" to "https://www.slicer.org/wiki/"

2017-07-10T17:21:58Z

Text replacement - "http://www.slicer.org/slicerWiki/index.php/" to "https://www.slicer.org/wiki/"

Marianna: Protected "Slicer3:Execution Model Documentation:Programmatic Invocation" [edit=sysop:move=sysop]

2008-05-22T16:27:36Z

Protected "Slicer3:Execution Model Documentation:Programmatic Invocation" [edit=sysop:move=sysop]

Marianna: Unprotected "Slicer3:Execution Model Documentation:Programmatic Invocation"

2008-05-19T19:44:39Z

Unprotected "Slicer3:Execution Model Documentation:Programmatic Invocation"

Marianna: Replacing page with ''''Note:''' We are migrating this content to the slicer.org domain - The newer page is [http://www.slicer.org/slicerWiki/index.php/Slicer3:Execution_M...'

2008-05-19T19:44:30Z

Replacing page with '<big>'''Note:''' We are migrating this content to the slicer.org domain - <font color="orange">The newer page is [http://www.slicer.org/slicerWiki/index.php/Slicer3:Execution_M...'

Kerstin: /* Implementation Example */

2008-03-10T18:19:30Z

Implementation Example

Kerstin: /* Implementation Example */

2008-03-07T19:28:34Z

Implementation Example

Pieper: /* Implementation Example */

2008-03-06T21:44:34Z

Implementation Example

Pieper: New page: == Goal == A large amount of functionality is available in command line modules for processing images and models. Some applications would like to use several modules together in a workfl...

2008-03-03T13:35:03Z

New page: == Goal == A large amount of functionality is available in command line modules for processing images and models. Some applications would like to use several modules together in a workfl...

New page

== Goal ==

A large amount of functionality is available in command line modules for processing images and models. Some applications would like to use several modules together in a workflow or as a background processing task.

== Implementation Example ==

This example shows calling the Model Maker (from the Editor). This example is in Tcl, but the same API can be used from C++ or Python. The idea is to query for the Model Maker module (and bail out if it is not loaded). Then to create a MRMLNode with the parameters you want for the model maker. These would be the same parameters you would set interactively. The model maker logic and gui classes are then told about the node and told to start processing. The processing then goes on in the background.

<pre>

#
# create a model using the command line module
# based on the current editor parameters
#

#
# get the image data for the label layer
#
set sliceLogic [lindex [vtkSlicerSliceLogic ListInstances] 0]
set layerLogic [$sliceLogic GetLabelLayer]
set volumeNode [$layerLogic GetVolumeNode]
if { $volumeNode == "" } {
errorDialog "Cannot make model - no volume node for $layerLogic in $sliceLogic."
return
}

#
# find the Model Maker
# - call Enter to be sure GUI has been built
#
set modelMaker ""
foreach gui [vtkCommandLineModuleGUI ListInstances] {
if { [$gui GetGUIName] == "Model Maker" } {
set modelMaker $gui
}
}

if { $modelMaker == "" } {
errorDialog "Cannot make model: no Model Maker Module found."
}

$modelMaker Enter

#
# set up the model maker node
#
set moduleNode [$::slicer3::MRMLScene CreateNodeByClass "vtkMRMLCommandLineModuleNode"]
$::slicer3::MRMLScene AddNode $moduleNode
$moduleNode SetModuleDescription "Model Maker"

$moduleNode SetParameterAsString "Name" "Quick Model"
$moduleNode SetParameterAsString "FilterType" "Sinc"
$moduleNode SetParameterAsBool "GenerateAll" "0"
$moduleNode SetParameterAsString "Labels" [EditorGetPaintLabel]
$moduleNode SetParameterAsBool "JointSmooth" 1
$moduleNode SetParameterAsBool "SplitNormals" 1
$moduleNode SetParameterAsBool "PointNormals" 1
$moduleNode SetParameterAsBool "SkipUnNamed" 1
$moduleNode SetParameterAsInt "Start" -1
$moduleNode SetParameterAsInt "End" -1
if { [[$o(smooth) GetWidget] GetSelectedState] } {
$moduleNode SetParameterAsDouble "Decimate" 0.25
$moduleNode SetParameterAsDouble "Smooth" 10
} else {
$moduleNode SetParameterAsDouble "Decimate" 0
$moduleNode SetParameterAsDouble "Smooth" 0
}

$moduleNode SetParameterAsString "InputVolume" [$volumeNode GetID]

#
# output
# - make a new hierarchy node if needed
#
set outHierarchy [[$::slicer3::MRMLScene GetNodesByClassByName "vtkMRMLModelHierarchyNode" "Editor Models"] GetItemAsObject 0]
if { $outHierarchy == "" } {
set outHierarchy [$::slicer3::MRMLScene CreateNodeByClass "vtkMRMLModelHierarchyNode"]
$outHierarchy SetScene $::slicer3::MRMLScene
$outHierarchy SetName "Editor Models"
$::slicer3::MRMLScene AddNode $outHierarchy
}

$moduleNode SetParameterAsString "ModelSceneFile" [$outHierarchy GetID]

#
# run the task (in the background)
# - use the GUI to provide progress feedback
# - use the GUI's Logic to invoke the task
# - model will show up when the processing is finished
#
$modelMaker SetCommandLineModuleNode $moduleNode
[$modelMaker GetLogic] SetCommandLineModuleNode $moduleNode
$modelMaker SetCommandLineModuleNode $moduleNode
[$modelMaker GetLogic] Apply $moduleNode

$this statusText "Model Making Started..."

#
# clean up our references
#
$moduleNode Delete
$outHierarchy Delete
$modelMaker Enter

</pre>

← Older revision		Revision as of 17:21, 10 July 2017
Line 1:		Line 1:
−	<big>'''Note:''' We are migrating this content to the slicer.org domain - <font color="orange">The newer page is [~~http~~://www.slicer.org/~~slicerWiki/index.php~~/Slicer3:Execution_Model_Documentation:Programmatic_Invocation here]</font></big>a	+	<big>'''Note:''' We are migrating this content to the slicer.org domain - <font color="orange">The newer page is [https://www.slicer.org/wiki/Slicer3:Execution_Model_Documentation:Programmatic_Invocation here]</font></big>a

← Older revision		Revision as of 19:44, 19 May 2008
Line 1:		Line 1:
−	~~== Goal ==~~	+	<big>'''Note:''' We are migrating this content to the slicer.org domain - <font color="orange">The newer page is [http://www.slicer.org/slicerWiki/index.php/Slicer3:Execution_Model_Documentation:Programmatic_Invocation here]</font></big>a
−
−	A large amount of functionality is available in command line modules for processing images and models. Some applications would like to use several modules together in a workflow or as a background processing task.
−
−	~~== Implementation Example ==~~
−
−	This example shows calling the Model Maker (from the Editor). This example is in Tcl, but the same API can be used from C++ or Python. The idea is to query for the Model Maker module (and bail out if it is not loaded). Then to create a MRMLNode with the parameters you want for the model maker. These would be the same parameters you would set interactively. The model maker logic and gui classes are ~~then told about the node and told~~ to ~~start processing. The processing then goes on in~~ the ~~background~~.
−
−	<~~pre>~~
−
−	#
−	~~# create a model using the command line module~~
−	~~# based on the current editor parameters~~
−	#
−
−	#
−	~~# get the image data for the label layer~~
−	#
−	~~set sliceLogic [lindex [vtkSlicerSliceLogic ListInstances] 0]~~
−	~~set layerLogic [$sliceLogic GetLabelLayer]~~
−	~~set volumeNode [$layerLogic GetVolumeNode]~~
−	~~if { $volumeNode =~~= "" ~~} {~~
−	~~errorDialog "Cannot make model - no volume node for $layerLogic in $sliceLogic."~~
−	~~return~~
−	}
−
−	#
−	~~# find the Model Maker~~
−	~~# - call Enter to be sure GUI has been built~~
−	~~# - find the GUI - for non-tcl use, try vtkSlicerApplication::GetModuleGUIByName~~
−	~~set modelMaker ""~~
−	~~foreach gui [vtkCommandLineModuleGUI ListInstances] {~~
−	~~if {~~ [~~$gui GetGUIName] == "Model Maker" } {~~
−	~~set modelMaker $gui~~
−	}
−	}
−
−	~~if { $modelMaker == "" } {~~
−	~~errorDialog "Cannot make model~~: ~~no Model Maker Module found~~."
−	}
−
−	~~$modelMaker Enter~~
−
−	#
−	~~# set up the model maker node~~
−	#
−	~~set moduleNode [$::slicer3::MRMLScene CreateNodeByClass "vtkMRMLCommandLineModuleNode"]~~
−	~~$::slicer3::MRMLScene AddNode $moduleNode~~
−	~~$moduleNode SetModuleDescription "Model Maker"~~
−
−	~~$moduleNode SetParameterAsString "Name" "Quick Model"~~
−	~~$moduleNode SetParameterAsString "FilterType" "Sinc"~~
−	~~$moduleNode SetParameterAsBool "GenerateAll" "0"~~
−	~~$moduleNode SetParameterAsString "Labels" [EditorGetPaintLabel]~~
−	~~$moduleNode SetParameterAsBool "JointSmooth" 1~~
−	~~$moduleNode SetParameterAsBool "SplitNormals" 1~~
−	~~$moduleNode SetParameterAsBool "PointNormals" 1~~
−	~~$moduleNode SetParameterAsBool "SkipUnNamed" 1~~
−	~~$moduleNode SetParameterAsInt "Start" -1~~
−	~~$moduleNode SetParameterAsInt "End" -1~~
−	~~if { [[$o(smooth) GetWidget] GetSelectedState] } {~~
−	~~$moduleNode SetParameterAsDouble "Decimate" 0~~.25
−	~~$moduleNode SetParameterAsDouble "Smooth" 10~~
−	~~} else {~~
−	~~$moduleNode SetParameterAsDouble "Decimate" 0~~
−	~~$moduleNode SetParameterAsDouble "Smooth" 0~~
−	}
−
−	~~$moduleNode SetParameterAsString "InputVolume" [$volumeNode GetID]~~
−
−	#
−	~~# output~~
−	~~# - make a new hierarchy node if needed~~
−	#
−	~~set outHierarchy [[$~~::~~slicer3::MRMLScene GetNodesByClassByName "vtkMRMLModelHierarchyNode" "Editor Models"~~] ~~GetItemAsObject 0]~~
−	~~if { $outHierarchy == "" } {~~
−	~~set outHierarchy [$::slicer3::MRMLScene CreateNodeByClass "vtkMRMLModelHierarchyNode"]~~
−	~~$outHierarchy SetScene $::slicer3::MRMLScene~~
−	~~$outHierarchy SetName "Editor Models"~~
−	~~$::slicer3::MRMLScene AddNode $outHierarchy~~
−	}
−
−	~~$moduleNode SetParameterAsString "ModelSceneFile" [$outHierarchy GetID]~~
−
−
−
−	#
−	~~# run the task (in the background)~~
−	~~# - use the GUI to provide progress feedback~~
−	~~# - use the GUI's Logic to invoke the task~~
−	~~# - model will show up when the processing is finished~~
−	#
−	~~$modelMaker SetCommandLineModuleNode $moduleNode~~
−	~~[$modelMaker GetLogic] SetCommandLineModuleNode $moduleNode~~
−	~~[$modelMaker GetLogic] Apply $moduleNode~~
−
−	~~$this statusText "Model Making Started..."~~
−
−	#
−	~~# clean up our references~~
−	#
−	~~$moduleNode Delete~~
−	~~$outHierarchy Delete~~
−	~~$modelMaker Enter~~
−
−
−	</~~pre~~>

← Older revision	Revision as of 16:27, 22 May 2008
(No difference)

@@ Line 28: / Line 28: @@
    # find the Model Maker
    # - call Enter to be sure GUI has been built
-   # - find the GUI - for non-tcl use, try vtkSlicerApplication::GetModuleByName
+   # - find the GUI - for non-tcl use, try vtkSlicerApplication::GetModuleGUIByName
    set modelMaker ""
    foreach gui [vtkCommandLineModuleGUI ListInstances] {

@@ Line 93: / Line 93: @@
    $modelMaker SetCommandLineModuleNode $moduleNode
    [$modelMaker GetLogic] SetCommandLineModuleNode $moduleNode
    [$modelMaker GetLogic] Apply $moduleNode