AbstractScriptedSegmentEditorEffect.AbstractScriptedSegmentEditorEffect Class Reference

Inheritance diagram for AbstractScriptedSegmentEditorEffect.AbstractScriptedSegmentEditorEffect:

Public Member Functions
def	__init__ (self, scriptedEffect)
def	rasToXy (self, ras, viewWidget)
def	register (self)
def	xyToIjk (self, xy, viewWidget, image)
def	xyToRas (self, xy, viewWidget)
def	xyzToIjk (self, xyz, viewWidget, image)
def	xyzToRas (self, xyz, viewWidget)

Public Attributes
	scriptedEffect

Detailed Description

Abstract scripted segment editor effects for effects implemented in python

    USAGE:
    1. Instantiation and registration
      Instantiate segment editor effect adaptor class from
      module (e.g. from setup function), and set python source:
      > import qSlicerSegmentationsEditorEffectsPythonQt as effects
      > scriptedEffect = effects.qSlicerSegmentEditorScriptedEffect(None)
      > scriptedEffect.setPythonSource(MyEffect.filePath)
      > scriptedEffect.self().register()
      If effect name is added to slicer.modules.segmenteditorscriptedeffectnames
      list then the above instantiation and registration steps are not necessary,
      as the SegmentEditor module do all these.

    2. Call host C++ implementation using
      > self.scriptedEffect.functionName()

    2.a. Most frequently used such methods are:
      Parameter get/set: parameter, integerParameter, doubleParameter, setParameter
      Add options widget: addOptionsWidget
      Coordinate transforms: rasToXy, xyzToRas, xyToRas, xyzToIjk, xyToIjk
      Convenience getters: renderWindow, renderer, viewNode

    2.b. Always call API functions (the ones that are defined in the adaptor
      class qSlicerSegmentEditorScriptedEffect) using the adaptor accessor:
      > self.scriptedEffect.updateGUIFromMRML()

    3. To prevent deactivation of an effect by clicking place fiducial toolbar button,
       override interactionNodeModified(self, interactionNode)

    An example for a generic effect is the ThresholdEffect

Definition at line 8 of file AbstractScriptedSegmentEditorEffect.py.

Constructor & Destructor Documentation

__init__()

def AbstractScriptedSegmentEditorEffect.AbstractScriptedSegmentEditorEffect.__init__	(		self,
			scriptedEffect
	)

Definition at line 43 of file AbstractScriptedSegmentEditorEffect.py.

Member Function Documentation

rasToXy()

def AbstractScriptedSegmentEditorEffect.AbstractScriptedSegmentEditorEffect.rasToXy	(		self,
			ras,
			viewWidget
	)

Definition at line 56 of file AbstractScriptedSegmentEditorEffect.py.

register()

def AbstractScriptedSegmentEditorEffect.AbstractScriptedSegmentEditorEffect.register

(

self

)

Definition at line 46 of file AbstractScriptedSegmentEditorEffect.py.

xyToIjk()

def AbstractScriptedSegmentEditorEffect.AbstractScriptedSegmentEditorEffect.xyToIjk	(		self,
			xy,
			viewWidget,
			image
	)

Definition at line 77 of file AbstractScriptedSegmentEditorEffect.py.

xyToRas()

def AbstractScriptedSegmentEditorEffect.AbstractScriptedSegmentEditorEffect.xyToRas	(		self,
			xy,
			viewWidget
	)

Definition at line 66 of file AbstractScriptedSegmentEditorEffect.py.

xyzToIjk()

def AbstractScriptedSegmentEditorEffect.AbstractScriptedSegmentEditorEffect.xyzToIjk	(		self,
			xyz,
			viewWidget,
			image
	)

Definition at line 71 of file AbstractScriptedSegmentEditorEffect.py.

xyzToRas()

def AbstractScriptedSegmentEditorEffect.AbstractScriptedSegmentEditorEffect.xyzToRas	(		self,
			xyz,
			viewWidget
	)

Definition at line 61 of file AbstractScriptedSegmentEditorEffect.py.

Member Data Documentation

scriptedEffect

AbstractScriptedSegmentEditorEffect.AbstractScriptedSegmentEditorEffect.scriptedEffect

Definition at line 44 of file AbstractScriptedSegmentEditorEffect.py.

---

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

• Modules/Loadable/Segmentations/EditorEffects/Python/AbstractScriptedSegmentEditorEffect.py