DicomPlugin Class Reference

Inheritance diagram for DicomPlugin:

Collaboration diagram for DicomPlugin:

Public Member Functions
def	__init__ (self)
def	init (self, plugid, win, mgr)
def	getHelp (self)
def	getDatasets (self)
def	enumSeries (self)
def	loadSeriesImages (self, series, selection, crop=None, task=None)
def	loadSeries (self, series, name=None, selection=None, loadSequential=False, isTimeDependent=None, crop=None)
def	loadDigestFile (self, dirpath, task)
def	loadDirDataset (self, dirpath, task=None)
def	acceptFile (self, filename)
def	loadObject (self, filename, name=None, args, kwargs)
def	loadDicomVolume (self, filename, name=None, interval=1.0, toffset=0.0, position=vec3(), rot=rotator(), task=None)
def	saveImage (self, dirpath, obj, datasetTags={}, fileMetaTags={})
def	saveObject (self, obj, path, overwrite=False, setFilenames=False, datasetTags={}, fileMetaTags={}, task=None, args, kwargs)
def	getScriptCode (self, obj, kwargs)
def	showChooseSeriesDialog (self, dirpath=None, allowMultiple=True, params=None, subject=None)
def	showTimeMultiSeriesDialog (self, series)
def	loadDicomDir (self, dirpath=None, allowMultiple=True, params=None, subject=None)
Public Member Functions inherited from ImageScenePlugin
def	__init__ (self, name)
def	getIcon (self, obj)
def	getObjFiles (self, obj)
def	getReprTypes (self, obj)
def	getReprParams (self, obj, reprtype)
def	createObjPropBox (self, obj)
def	setCTImageRange (self, obj, isCT)
def	getMenu (self, obj)
def	objectMenuItem (self, obj, item)
def	updateObjPropBox (self, obj, prop)
def	updateReprPropBox (self, rep, prop)
def	createReprPropBox (self, rep)
def	applyMaterial (self, rep, mat, kwargs)
def	createRepr (self, obj, reprtype, kwargs)
def	createSceneObject (self, name, images, source=None, isTimeDependent=None)
def	clone (self, obj, name)
def	cropXY (self, obj, name, minx, miny, maxx, maxy)
def	extractTimesteps (self, obj, name, indices=None, timesteps=None, setTimestep=False)
def	createImageStackObject (self, name, width, height, slices, timesteps=1, pos=vec3(), rot=rotator(), spacing=vec3(1))
def	createRespacedObject (self, obj, name, spacing=vec3(1))
def	createIntersectObject (self, name, objs, timesteps=1, spacing=vec3(1))
def	createTestImage (self, w, h, d, timesteps=1, pos=vec3(), rot=rotator(), spacing=vec3(1))
def	createSequence (self, name, objs, timesteps=None)
def	createObjectFromArray (self, name, array, interval=1.0, toffset=0, pos=vec3(), rot=rotator(), spacing=vec3(1), task=None)
def	getImageObjectArray (self, obj, datatype=float)
Public Member Functions inherited from ScenePlugin
def	__init__ (self, name)
def	init (self, plugid, win, mgr)
def	cleanup (self)
def	findObject (self, name, assertFound=True)
def	removeFilesTask (self, fileglob)
def	getScriptCode (self, obj, kwargs)
def	getIcon (self, obj)
def	getMenu (self, obj)
def	getHelp (self)
def	acceptFile (self, filename)
def	loadObject (self, filename, name=None, kwargs)
def	saveObject (self, obj, path, overwrite=False, setFilenames=False, kwargs)
def	checkFileOverwrite (self, obj, dirpath, name=None)
def	getObjFiles (self, obj)
def	renameObjFiles (self, obj, oldname, overwrite=False)
def	copyObjFiles (self, obj, sdir, overwrite=False)
def	removeObject (self, obj)
def	createRepr (self, obj, reprtype, kwargs)
def	getReprParams (self, obj, reprtype)
def	getReprParamHelp (self, obj, reprtype)
def	getReprTypes (self, obj)
def	createHandles (self, rep, kwargs)
def	updateObjPropBox (self, obj, prop)
def	updateReprPropBox (self, rep, prop)
def	createObjPropBox (self, obj)
def	createReprPropBox (self, rep)
def	addSceneObject (self, obj)
def	addSceneObjectRepr (self, rep)
def	applyMaterial (self, rep, mat, kwargs)
def	objectMenuItem (self, obj, item)

Public Attributes
	dirobjs
	loadedNames
	selectCropMap
Public Attributes inherited from ScenePlugin
	plugid
	win
	mgr
	name

Private Member Functions
def	_openDicomDirMenuItem (self)
def	_openVolumeMenuItem (self)
def	_updateSeriesPropBox (self, series, prop)
def	_loadSeriesButton (self, prop, series)
def	_exportMenuItem (self)

Constructor & Destructor Documentation

__init__()

def __init__

(

self

)

Member Function Documentation

_exportMenuItem()

def _exportMenuItem (   self )

private

Here is the call graph for this function:

Here is the caller graph for this function:

_loadSeriesButton()

def _loadSeriesButton (   self,   prop,   series  )

private

Here is the call graph for this function:

Here is the caller graph for this function:

_openDicomDirMenuItem()

def _openDicomDirMenuItem (   self )

private

Here is the call graph for this function:

Here is the caller graph for this function:

_openVolumeMenuItem()

def _openVolumeMenuItem (   self )

private

Here is the call graph for this function:

Here is the caller graph for this function:

_updateSeriesPropBox()

def _updateSeriesPropBox (   self,   series,   prop  )

private

Here is the caller graph for this function:

acceptFile()

def acceptFile	(		self,
			filename
	)

enumSeries()

def enumSeries

(

self

)

Here is the call graph for this function:

getDatasets()

def getDatasets

(

self

)

Here is the caller graph for this function:

getHelp()

def getHelp

(

self

)

getScriptCode()

def getScriptCode	(		self,
			obj,
			kwargs
	)

init()

def init	(		self,
			plugid,
			win,
			mgr
	)

Here is the call graph for this function:

loadDicomDir()

def loadDicomDir	(		self,
			dirpath = None,
			allowMultiple = True,
			params = None,
			subject = None
	)

Shows the choose series dialog using the same arguments as showChooseSeriesDialog() then loads any selected
series as ImageSceneObject instances. This will block so long as the dialog is open but otherwise will use
tasks to load the data. It is thread-safe.

Here is the call graph for this function:

Here is the caller graph for this function:

loadDicomVolume()

def loadDicomVolume	(		self,
			filename,
			name = None,
			interval = 1.0,
			toffset = 0.0,
			position = vec3(),
			rot = rotator(),
			task = None
	)

Load a single DICOM file containing a 3D or 4D image volume (ie. ultrasound) using nonstandard tags.

Here is the call graph for this function:

Here is the caller graph for this function:

loadDigestFile()

def loadDigestFile	(		self,
			dirpath,
			task
	)

Loads the directory digest ini file in 'dirpath' if it exists, or creates it otherwise. Returns the loaded
or created DicomDataset object.

Here is the call graph for this function:

Here is the caller graph for this function:

loadDirDataset()

def loadDirDataset	(		self,
			dirpath,
			task = None
	)

Loads the dataset directory as an asset and creates the DicomDataset object keyed to `dirpath' in self.dirobjs.

Here is the call graph for this function:

Here is the caller graph for this function:

loadObject()

def loadObject	(		self,
			filename,
			name = None,
			args,
			kwargs
	)

Here is the call graph for this function:

Here is the caller graph for this function:

loadSeries()

def loadSeries	(		self,
			series,
			name = None,
			selection = None,
			loadSequential = False,
			isTimeDependent = None,
			crop = None
	)

Loads the Dicom files for the given series object or series ID string `series' into a SceneObject subtype.

Here is the call graph for this function:

Here is the caller graph for this function:

loadSeriesImages()

def loadSeriesImages	(		self,
			series,
			selection,
			crop = None,
			task = None
	)

Load the actual image data from the files in `series' and store them as SharedImage objects in series.simgs.

Here is the call graph for this function:

Here is the caller graph for this function:

saveImage()

def saveImage	(		self,
			dirpath,
			obj,
			datasetTags = {},
			fileMetaTags = {}
	)

Deprecated, for compatibility only.

Here is the call graph for this function:

Here is the caller graph for this function:

saveObject()

def saveObject	(		self,
			obj,
			path,
			overwrite = False,
			setFilenames = False,
			datasetTags = {},
			fileMetaTags = {},
			task = None,
			args,
			kwargs
	)

Here is the caller graph for this function:

showChooseSeriesDialog()

def showChooseSeriesDialog	(		self,
			dirpath = None,
			allowMultiple = True,
			params = None,
			subject = None
	)

Opens a dialog for choosing a series to load. The starting directory is given by `dirpath', this path is used
in the dialog, but if left as None an open directory dialog is presented for choosing one. If `allowMultiple'
is true then multiple series can be returned. If `params' is a pair containing a list of ParamDef objects and
a callable accepting 2 arguments, then a ParamPanel is created in the series choose dialog using the given
callable as the callback for changed values. The `subject' parameter, if given, should be a string describing
what is being chosen which is used in the dialog title. The method blocks so long as the dialog is open, and
returns an iterable of zero or more DicomSeries objects once it is closed. Internally a task is create so this
must not be called within a task but in a separate thread.

Here is the caller graph for this function:

showTimeMultiSeriesDialog()

def showTimeMultiSeriesDialog	(		self,
			series
	)

Shows the multi-series dialog box for the given series list, returning the Future object which will contain the
results from the user cropping and ordering the images of the series. This does block and is thread-safe.

Member Data Documentation

dirobjs

dirobjs

loadedNames

loadedNames

selectCropMap

selectCropMap

---

The documentation for this class was generated from the following file:

• eidolon/plugins/DicomPlugin.py