cli Namespace Reference

Functions
def	cancel
def	createNode
def	run
def	setNodeParameters

---

Detailed Description

This module is a place holder for convenient functions allowing to interact with CLI.

---

Function Documentation

def cli::cancel

(

node

)

Definition at line 81 of file cli.py.

def cli::createNode	(		cliModule,
			parameters = None
	)

Creates a new vtkMRMLCommandLineModuleNode for a specific module, with
optional parameters

Definition at line 3 of file cli.py.

def cli::run	(		module,
			node = None,
			parameters = None,
			wait_for_completion = False,
			delete_temporary_files = True
	)

Runs a CLI, optionally given a node with optional parameters, returning
back the node (or the new one if created)
node: existing parameter node (None by default)
parameters: dictionary of parameters for cli (None by default)
wait_for_completion: block if True (False by default)
delete_temporary_files: remove temp files created during exectuion (True by default)

Definition at line 49 of file cli.py.

def cli::setNodeParameters	(		node,
			parameters
	)

Sets parameters for a vtkMRMLCommandLineModuleNode given a dictionary
of (parameterName, parameterValue) pairs
For vectors: provide a list, tuple or comma-separated string
For enumerations, provide the single enumeration value
For files and directories, provide a string
For images, geometry, points and regions, provide a vtkMRMLNode

Definition at line 17 of file cli.py.