slicer::util Namespace Reference

Functions
def	array
def	exit
def	findChildren
def	getModule
def	getModuleGui
def	getNode
def	getNodes
def	importVTKClasses
def	importVTKClassesFromDirectory
def	loadColorTable
def	loadFiberBundle
def	loadFiducialList
def	loadModel
def	loadNodeFromFile
def	loadScalarOverlay
def	loadScene
def	loadTransform
def	loadVolume
def	lookupTopLevelWidget
def	mainWindow
def	moduleNames
def	openAddColorTableDialog
def	openAddDataDialog
def	openAddFiberBundleDialog
def	openAddFiducialDialog
def	openAddModelDialog
def	openAddScalarOverlayDialog
def	openAddTransformDialog
def	openAddVolumeDialog
def	openSaveDataDialog
def	pythonShell
def	quit
def	restart
def	selectModule
def	showStatusMessage
Variables
int	EXIT_FAILURE = 1
int	EXIT_SUCCESS = 0

---

Function Documentation

def slicer::util::array	(		pattern = "",
			index = 0
	)

Return the array you are "most likely to want" from the indexth
MRML node that matches the pattern.  Meant to be used in the python
console for quick debugging/testing.  More specific API should be
used in scripts to be sure you get exactly what you want.

Definition at line 270 of file util.py.

def slicer::util::exit

(

status = EXIT_SUCCESS

)

Definition at line 12 of file util.py.

def slicer::util::findChildren	(		widget = None,
			name = "",
			text = ""
	)

return a list of child widgets that match the passed name 

Definition at line 83 of file util.py.

def slicer::util::getModule

(

moduleName

)

Definition at line 216 of file util.py.

def slicer::util::getModuleGui

(

module

)

Definition at line 224 of file util.py.

def slicer::util::getNode	(		pattern = "",
			index = 0
	)

Return the indexth node where name or id matches 'pattern'.
Providing an empty 'pattern' string will return all nodes.

Definition at line 255 of file util.py.

def slicer::util::getNodes

(

pattern = ""

)

Return a dictionary of nodes where the name or id matches the 'pattern'.
Providing an empty 'pattern' string will return all nodes.

Definition at line 239 of file util.py.

def slicer::util::importVTKClasses	(		vtk_module_name,
			dest_module_name
	)

Import VTK classes from module identified by vtk_module_name into
the module identified by 'dest_module_name'.

Definition at line 34 of file util.py.

def slicer::util::importVTKClassesFromDirectory	(		directory,
			dest_module_name,
			filematch = '*'
	)

Definition at line 24 of file util.py.

def slicer::util::loadColorTable	(		filename,
			returnNode = False
	)

Definition at line 122 of file util.py.

def slicer::util::loadFiberBundle	(		filename,
			returnNode = False
	)

Definition at line 127 of file util.py.

def slicer::util::loadFiducialList	(		filename,
			returnNode = False
	)

Definition at line 132 of file util.py.

def slicer::util::loadModel	(		filename,
			returnNode = False
	)

Definition at line 137 of file util.py.

def slicer::util::loadNodeFromFile	(		filename,
			filetype,
			returnNode = False
	)

Definition at line 109 of file util.py.

def slicer::util::loadScalarOverlay	(		filename,
			returnNode = False
	)

Definition at line 142 of file util.py.

def slicer::util::loadScene	(		filename,
			clear = True
	)

Definition at line 158 of file util.py.

def slicer::util::loadTransform	(		filename,
			returnNode = False
	)

Definition at line 147 of file util.py.

def slicer::util::loadVolume	(		filename,
			returnNode = False
	)

Definition at line 152 of file util.py.

def slicer::util::lookupTopLevelWidget	(		objectName,
			verbose = True
	)

Loop over all top level widget associated with 'slicer.app' and 
return the one matching 'objectName'

Definition at line 62 of file util.py.

def slicer::util::mainWindow

(

verbose = True

)

Definition at line 72 of file util.py.

def slicer::util::moduleNames

(

)

Definition at line 212 of file util.py.

def slicer::util::openAddColorTableDialog

(

)

Definition at line 184 of file util.py.

def slicer::util::openAddDataDialog

(

)

Definition at line 164 of file util.py.

def slicer::util::openAddFiberBundleDialog

(

)

Definition at line 192 of file util.py.

def slicer::util::openAddFiducialDialog

(

)

Definition at line 188 of file util.py.

def slicer::util::openAddModelDialog

(

)

Definition at line 172 of file util.py.

def slicer::util::openAddScalarOverlayDialog

(

)

Definition at line 176 of file util.py.

def slicer::util::openAddTransformDialog

(

)

Definition at line 180 of file util.py.

def slicer::util::openAddVolumeDialog

(

)

Definition at line 168 of file util.py.

def slicer::util::openSaveDataDialog

(

)

Definition at line 196 of file util.py.

def slicer::util::pythonShell

(

verbose = True

)

Definition at line 75 of file util.py.

def slicer::util::quit

(

)

Definition at line 9 of file util.py.

def slicer::util::restart

(

)

Definition at line 16 of file util.py.

def slicer::util::selectModule

(

module

)

Definition at line 204 of file util.py.

def slicer::util::showStatusMessage	(		message,
			duration = 0
	)

Definition at line 78 of file util.py.

---

Variable Documentation

int slicer::util::EXIT_FAILURE = 1

Definition at line 7 of file util.py.

int slicer::util::EXIT_SUCCESS = 0

Definition at line 6 of file util.py.