SegmentEditorEffects.AbstractScriptedSegmentEditorPaintEffect.AbstractScriptedSegmentEditorPaintEffect Class Reference

Inheritance diagram for SegmentEditorEffects.AbstractScriptedSegmentEditorPaintEffect.AbstractScriptedSegmentEditorPaintEffect:

Collaboration diagram for SegmentEditorEffects.AbstractScriptedSegmentEditorPaintEffect.AbstractScriptedSegmentEditorPaintEffect:

Public Member Functions
	__init__ (self, scriptedEffect)
Public Member Functions inherited from SegmentEditorEffects.AbstractScriptedSegmentEditorEffect.AbstractScriptedSegmentEditorEffect
	__init__ (self, scriptedEffect)
	cleanup (self)
	rasToXy (self, ras, viewWidget)
	register (self)
	setWidgetMinMaxStepFromImageSpacing (self, spinbox, imageData)
	xyToIjk (self, xy, viewWidget, image, parentTransformNode=None)
	xyToRas (self, xy, viewWidget)
	xyzToIjk (self, xyz, viewWidget, image, parentTransformNode=None)
	xyzToRas (self, xyz, viewWidget)

Additional Inherited Members
Public Attributes inherited from SegmentEditorEffects.AbstractScriptedSegmentEditorEffect.AbstractScriptedSegmentEditorEffect
	scriptedEffect = scriptedEffect

Detailed Description

Abstract scripted segment editor Paint effects for effects implemented in python

Paint effects are a subtype of general effects that operate on a subregion of the segment
defined by brush strokes.

An example of paint effect is ``SmoothingEffect``.

To use the effect, follow these steps:

1. Instantiation and registration

  Instantiate segment editor paint effect adaptor class from
  module (e.g. from setup function), and set python source::

    import qSlicerSegmentationsEditorEffectsPythonQt as effects
    scriptedEffect = effects.qSlicerSegmentEditorScriptedPaintEffect(None)
    scriptedEffect.setPythonSource(MyPaintEffect.filePath)

  Registration is automatic

2. Call host C++ implementation using::

    self.scriptedEffect.functionName()

2.a. Most frequently used 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 ``qSlicerSegmentEditorScriptedPaintEffect``) using the adaptor accessor ``self.scriptedEffect``.

  For example::

    self.scriptedEffect.updateGUIFromMRML()

Definition at line 6 of file AbstractScriptedSegmentEditorPaintEffect.py.

Constructor & Destructor Documentation

__init__()

SegmentEditorEffects.AbstractScriptedSegmentEditorPaintEffect.AbstractScriptedSegmentEditorPaintEffect.__init__	(		self,
			scriptedEffect )

Definition at line 47 of file AbstractScriptedSegmentEditorPaintEffect.py.

---

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

• Modules/Loadable/Segmentations/EditorEffects/Python/SegmentEditorEffects/AbstractScriptedSegmentEditorPaintEffect.py