AbstractScriptedSegmentEditorLabelEffect.AbstractScriptedSegmentEditorLabelEffect Class Reference

Inheritance diagram for AbstractScriptedSegmentEditorLabelEffect.AbstractScriptedSegmentEditorLabelEffect:

Collaboration diagram for AbstractScriptedSegmentEditorLabelEffect.AbstractScriptedSegmentEditorLabelEffect:

Public Member Functions
def	__init__ (self, scriptedEffect)
Public Member Functions inherited from AbstractScriptedSegmentEditorEffect.AbstractScriptedSegmentEditorEffect
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)

Additional Inherited Members
Public Attributes inherited from AbstractScriptedSegmentEditorEffect.AbstractScriptedSegmentEditorEffect
	scriptedEffect

Detailed Description

Abstract scripted segment editor label effects for effects implemented in python

    USAGE:
    1. Instantiation and registration
      Instantiate segment editor label effect adaptor class from
      module (e.g. from setup function), and set python source:
      > import qSlicerSegmentationsEditorEffectsPythonQt as effects
      > scriptedEffect = effects.qSlicerSegmentEditorScriptedLabelEffect(None)
      > scriptedEffect.setPythonSource(MyLabelEffect.filePath)
      Registration is automatic

    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
      Geometry getters: imageToWorldMatrix (for volume node and for oriented image data with segmentation)

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

    An example for a generic effect is the DrawEffect

Definition at line 14 of file AbstractScriptedSegmentEditorLabelEffect.py.

Constructor & Destructor Documentation

__init__()

def AbstractScriptedSegmentEditorLabelEffect.AbstractScriptedSegmentEditorLabelEffect.__init__	(		self,
			scriptedEffect
	)

Definition at line 44 of file AbstractScriptedSegmentEditorLabelEffect.py.

---

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

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