slicer::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 slicer::cli::cancel

(

node

)

Definition at line 75 of file cli.py.

def slicer::cli::createNode	(		module,
			parameters = None
	)

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

Definition at line 3 of file cli.py.

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

Runs a CLI, optionally given a node with optional parameters, returning
back the node (or the new one if created)

Definition at line 50 of file cli.py.

def slicer::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 18 of file cli.py.