slicer Package

This module loads the Slicer library modules into its namespace.

cli Module

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

slicer.cli.cancel(node)

slicer.cli.createNode(cliModule, parameters=None)

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

slicer.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)

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

logic Module

This module loads all the classes from the vtkSlicerBaseLogic library into its namespace.

slicerqt Module

slicer.slicerqt.loadSlicerRCFile()

If it exists, execute slicer resource script ‘~/.slicerrc.py’

testing Module

slicer.testing.exitFailure(message='')

slicer.testing.exitSuccess()

slicer.testing.runUnitTest(path, testname)

util Module

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.

slicer.util.exit(status=0)

slicer.util.findChildren(widget=None, name='', text='', title='', className='')

return a list of child widgets that match the passed name

slicer.util.getModule(moduleName)

slicer.util.getModuleGui(module)

slicer.util.getNewModuleGui(module)

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.

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.

slicer.util.importClassesFromDirectory(directory, dest_module_name, type_name, filematch='*')

slicer.util.importModuleObjects(from_module_name, dest_module_name, type_name)

Import object of type ‘type_name’ from module identified by ‘from_module_name’ into the module identified by ‘dest_module_name’.

slicer.util.importQtClassesFromDirectory(directory, dest_module_name, filematch='*')

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

slicer.util.loadAnnotationFiducial(filename, returnNode=False)

slicer.util.loadColorTable(filename, returnNode=False)

slicer.util.loadFiberBundle(filename, returnNode=False)

slicer.util.loadFiducialList(filename, returnNode=False)

slicer.util.loadLabelVolume(filename, properties, returnNode=False)

slicer.util.loadMarkupsFiducialList(filename, returnNode=False)

slicer.util.loadModel(filename, returnNode=False)

slicer.util.loadNodeFromFile(filename, filetype, properties={}, returnNode=False)

slicer.util.loadScalarOverlay(filename, returnNode=False)

slicer.util.loadScene(filename, properties={})

slicer.util.loadTransform(filename, returnNode=False)

slicer.util.loadVolume(filename, properties={}, returnNode=False)

slicer.util.lookupTopLevelWidget(objectName, verbose=True)

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

slicer.util.mainWindow(verbose=True)

slicer.util.moduleNames()

slicer.util.openAddColorTableDialog()

slicer.util.openAddDataDialog()

slicer.util.openAddFiberBundleDialog()

slicer.util.openAddFiducialDialog()

slicer.util.openAddModelDialog()

slicer.util.openAddScalarOverlayDialog()

slicer.util.openAddTransformDialog()

slicer.util.openAddVolumeDialog()

slicer.util.openSaveDataDialog()

slicer.util.pythonShell(verbose=True)

slicer.util.quit()

slicer.util.reloadScriptedModule(moduleName)

Generic reload method for any scripted module.

slicer.util.restart()

slicer.util.saveNode(node, filename, properties={})

Save ‘node’ data into ‘filename’.

It is the user responsability to provide the appropriate file extension.

User has also the possibility to overwrite the fileType internally retrieved using method ‘qSlicerCoreIOManager::fileWriterFileType(vtkObject*)’. This can be done by specifiying a ‘fileType’attribute to the optional ‘properties’ dictionary.

slicer.util.saveScene(filename, properties={})

Save the current scene.

Based on the value of ‘filename’, the current scene is saved either as a MRML file, MRB file or directory.

If filename ends with ‘.mrml’, the scene is saved as a single file without associated data.

If filename ends with ‘.mrb’, the scene is saved as a MRML bundle (Zip archive with scene and data files).

In every other case, the scene is saved in the directory specified by ‘filename’. Both MRML scene file and data will be written to disk. If needed, directories and sub-directories will be created.

slicer.util.selectModule(module)

slicer.util.showStatusMessage(message, duration=0)