Scripted abstract effect for implementing label effects in python. More...

#include <Modules/Loadable/Segmentations/EditorEffects/qSlicerSegmentEditorScriptedLabelEffect.h>

Inheritance diagram for qSlicerSegmentEditorScriptedLabelEffect:

Collaboration diagram for qSlicerSegmentEditorScriptedLabelEffect:

Public Types
typedef qSlicerSegmentEditorAbstractLabelEffect	Superclass

Public Types inherited from qSlicerSegmentEditorAbstractLabelEffect
typedef qSlicerSegmentEditorAbstractEffect	Superclass

Public Types inherited from qSlicerSegmentEditorAbstractEffect
enum	ModificationMode { ModificationModeSet, ModificationModeAdd, ModificationModeRemove }

typedef QObject	Superclass

Public Slots
virtual void	updateGUIFromMRML ()
	Update user interface from parameter set node. More...

virtual void	updateMRMLFromGUI ()
	Update parameter set node from user interface. More...

Public Slots inherited from qSlicerSegmentEditorAbstractLabelEffect
virtual void	updateGUIFromMRML ()
	Update user interface from parameter set node. More...

virtual void	updateMRMLFromGUI ()
	Update parameter set node from user interface. More...

Public Slots inherited from qSlicerSegmentEditorAbstractEffect
virtual void	updateGUIFromMRML ()=0

virtual void	updateMRMLFromGUI ()=0

Public Member Functions
virtual void	activate ()
	Perform actions to activate the effect (show options frame, etc.) More...

virtual qSlicerSegmentEditorAbstractEffect *	clone ()
	Clone editor effect. Override to return a new instance of the effect sub-class. More...

virtual QCursor	createCursor (qMRMLWidget *viewWidget)
	Create a cursor customized for the given effect, potentially for each view. More...

virtual void	deactivate ()
	Perform actions to deactivate the effect (hide options frame, destroy actors, etc.) More...

virtual const QString	helpText () const
	Get help text for effect to be displayed in the help box. More...

virtual QIcon	icon ()
	Get icon for effect to be displayed in segment editor. More...

virtual void	interactionNodeModified (vtkMRMLInteractionNode *interactionNode)
	Let the effect know that the interaction node is modified. More...

virtual void	layoutChanged ()
	Simple mechanism to let the effects know that the layout has changed. More...

virtual void	masterVolumeNodeChanged ()
	Simple mechanism to let the effects know that master volume has changed. More...

virtual bool	processInteractionEvents (vtkRenderWindowInteractor callerInteractor, unsigned long eid, qMRMLWidget viewWidget)

virtual void	processViewNodeEvents (vtkMRMLAbstractViewNode callerViewNode, unsigned long eid, qMRMLWidget viewWidget)

Q_INVOKABLE QString	pythonSource () const

	qSlicerSegmentEditorScriptedLabelEffect (QObject *parent=NULL)

virtual void	referenceGeometryChanged ()
	Simple mechanism to let the effects know that reference geometry change has changed. More...

Q_INVOKABLE PyObject *	self () const
	Convenience method allowing to retrieve the associated scripted instance. More...

virtual void	setMRMLDefaults ()
	Set default parameters in the parameter MRML node. More...

virtual void	setName (QString name)

virtual void	setPerSegment (bool perSegment)
	Set flag indicating whether effect operates on segments (true) or the whole segmentation (false). More...

Q_INVOKABLE bool	setPythonSource (const QString newPythonSource)

virtual void	setupOptionsFrame ()
	Create options frame widgets, make connections, and add them to the main options frame using. More...

virtual	~qSlicerSegmentEditorScriptedLabelEffect ()

Public Member Functions inherited from qSlicerSegmentEditorAbstractLabelEffect
	qSlicerSegmentEditorAbstractLabelEffect (QObject *parent=NULL)

virtual	~qSlicerSegmentEditorAbstractLabelEffect ()

Public Member Functions inherited from qSlicerSegmentEditorAbstractEffect
virtual Q_INVOKABLE bool	active ()
	Returns true if the effect is currently active (activated and has not deactivated since then) More...

Q_INVOKABLE void	addActor2D (qMRMLWidget viewWidget, vtkActor2D actor)

Q_INVOKABLE void	addActor3D (qMRMLWidget viewWidget, vtkProp3D actor)

Q_INVOKABLE QWidget *	addLabeledOptionsWidget (QString label, QWidget *newOptionsWidget)

Q_INVOKABLE QWidget *	addLabeledOptionsWidget (QString label, QLayout *newOptionsWidget)

Q_INVOKABLE void	addOptionsWidget (QWidget *newOptionsWidget)

Q_INVOKABLE void	addOptionsWidget (QLayout *newOptionsWidget)

Q_INVOKABLE bool	commonParameterDefined (QString name)
	Returns true if the common parameter is already defined. More...

Q_INVOKABLE void	cursorOff (qMRMLWidget *viewWidget)
	Turn off cursor and save cursor to restore later. More...

Q_INVOKABLE void	cursorOn (qMRMLWidget *viewWidget)
	Restore saved cursor. More...

Q_INVOKABLE vtkOrientedImageData *	defaultModifierLabelmap ()

Q_INVOKABLE double	doubleParameter (QString name)
	Convenience function to get double parameter. More...

Q_INVOKABLE int	integerParameter (QString name)
	Convenience function to get integer parameter. More...

Q_INVOKABLE vtkOrientedImageData *	maskLabelmap ()

Q_INVOKABLE vtkOrientedImageData *	masterVolumeImageData ()

Q_INVOKABLE vtkOrientedImageData *	modifierLabelmap ()

virtual Q_INVOKABLE void	modifySelectedSegmentByLabelmap (vtkOrientedImageData *modifierLabelmap, ModificationMode modificationMode, const int modificationExtent[6])

virtual Q_INVOKABLE void	modifySelectedSegmentByLabelmap (vtkOrientedImageData *modifierLabelmap, ModificationMode modificationMode)

virtual Q_INVOKABLE void	modifySelectedSegmentByLabelmap (vtkOrientedImageData *modifierLabelmap, ModificationMode modificationMode, QList< int > extent)

virtual QString	name () const
	Get name of effect. More...

Q_INVOKABLE QFrame *	optionsFrame ()
	Get effect options frame. More...

Q_INVOKABLE QFormLayout *	optionsLayout ()
	Get layout of options frame. More...

Q_INVOKABLE QString	parameter (QString name)
	Get effect or common parameter from effect parameter set node. More...

Q_INVOKABLE bool	parameterDefined (QString name)
	Returns true if the effect-specific parameter is already defined. More...

Q_INVOKABLE vtkMRMLSegmentEditorNode *	parameterSetNode ()
	Get segment editor parameter set node. More...

virtual bool	perSegment () const
	Get flag indicating whether effect operates on segments (true) or the whole segmentation (false). More...

	qSlicerSegmentEditorAbstractEffect (QObject *parent=NULL)

Q_INVOKABLE vtkOrientedImageData *	referenceGeometryImage ()

Q_INVOKABLE void	removeActor2D (qMRMLWidget viewWidget, vtkActor2D actor)
	Remove actor from the renderer of the widget. More...

Q_INVOKABLE void	removeActor3D (qMRMLWidget viewWidget, vtkProp3D actor)
	Remove actor from the renderer of the widget. More...

Q_INVOKABLE void	saveStateForUndo ()

Q_INVOKABLE vtkMRMLScene *	scene ()
	Get MRML scene (from parameter set node) More...

Q_INVOKABLE bool	segmentationDisplayableInView (vtkMRMLAbstractViewNode *viewNode)

Q_INVOKABLE vtkOrientedImageData *	selectedSegmentLabelmap ()

Q_INVOKABLE void	selectEffect (QString effectName)

void	setCallbackSlots (QObject receiver, const char selectEffectSlot, const char updateVolumeSlot, const char saveStateForUndoSlot)

Q_INVOKABLE void	setCommonParameter (QString name, QString value)

Q_INVOKABLE void	setCommonParameter (QString name, int value)
	Convenience function to set integer common parameter. More...

Q_INVOKABLE void	setCommonParameter (QString name, double value)
	Convenience function to set double common parameter. More...

Q_INVOKABLE void	setCommonParameterDefault (QString name, QString value)

Q_INVOKABLE void	setCommonParameterDefault (QString name, int value)

Q_INVOKABLE void	setCommonParameterDefault (QString name, double value)

Q_INVOKABLE void	setParameter (QString name, QString value)

Q_INVOKABLE void	setParameter (QString name, int value)

Q_INVOKABLE void	setParameter (QString name, double value)

Q_INVOKABLE void	setParameterDefault (QString name, QString value)

Q_INVOKABLE void	setParameterDefault (QString name, int value)

Q_INVOKABLE void	setParameterDefault (QString name, double value)

Q_INVOKABLE void	setParameterSetNode (vtkMRMLSegmentEditorNode *node)
	Set segment editor parameter set node. More...

void	setShowEffectCursorInSliceView (bool show)

void	setShowEffectCursorInThreeDView (bool show)

void	setVolumes (vtkOrientedImageData alignedMasterVolume, vtkOrientedImageData modifierLabelmap, vtkOrientedImageData maskLabelmap, vtkOrientedImageData selectedSegmentLabelmap, vtkOrientedImageData *referenceGeometryImage)
	Called by the editor widget. More...

bool	showEffectCursorInSliceView ()

bool	showEffectCursorInThreeDView ()

virtual	~qSlicerSegmentEditorAbstractEffect ()

Protected Attributes
QScopedPointer< qSlicerSegmentEditorScriptedLabelEffectPrivate >	d_ptr

Protected Attributes inherited from qSlicerSegmentEditorAbstractLabelEffect
QScopedPointer< qSlicerSegmentEditorAbstractLabelEffectPrivate >	d_ptr

Protected Attributes inherited from qSlicerSegmentEditorAbstractEffect
QScopedPointer< qSlicerSegmentEditorAbstractEffectPrivate >	d_ptr

bool	m_Active

double	m_EraseValue

double	m_FillValue

QString	m_Name
	Name of the effect. More...

bool	m_PerSegment

bool	m_ShowEffectCursorInSliceView

bool	m_ShowEffectCursorInThreeDView

Additional Inherited Members
Properties inherited from qSlicerSegmentEditorAbstractEffect
QString	name

bool	perSegment

bool	showEffectCursorInSliceView

bool	showEffectCursorInThreeDView

Static Public Member Functions inherited from qSlicerSegmentEditorAbstractLabelEffect
static Q_INVOKABLE void	appendImage (vtkOrientedImageData inputImage, vtkOrientedImageData appendedImage)
	Append image onto image. Resamples appended image and saves result in input image. More...

static Q_INVOKABLE void	appendPolyMask (vtkOrientedImageData input, vtkPolyData polyData, qMRMLSliceWidget *sliceWidget)
	Rasterize a poly data onto the input image into the slice view. More...

static Q_INVOKABLE void	createMaskImageFromPolyData (vtkPolyData polyData, vtkOrientedImageData outputMask, qMRMLSliceWidget *sliceWidget)
	Create a slice view screen space (2D) mask image for the given polydata. More...

static Q_INVOKABLE void	imageToWorldMatrix (vtkMRMLVolumeNode node, vtkMatrix4x4 ijkToRas)

static Q_INVOKABLE void	imageToWorldMatrix (vtkOrientedImageData image, vtkMRMLSegmentationNode node, vtkMatrix4x4 *ijkToRas)

Static Public Member Functions inherited from qSlicerSegmentEditorAbstractEffect
static Q_INVOKABLE void	applyImageMask (vtkOrientedImageData input, vtkOrientedImageData mask, double fillValue, bool notMask=false)

static Q_INVOKABLE void	forceRender (qMRMLWidget *viewWidget)

static QPoint	rasToXy (double ras[3], qMRMLSliceWidget *sliceWidget)
	Convert RAS position to XY in-slice position. More...

static Q_INVOKABLE QPoint	rasToXy (QVector3D ras, qMRMLSliceWidget *sliceWidget)
	Convert RAS position to XY in-slice position, python accessor method. More...

static Q_INVOKABLE vtkRenderer *	renderer (qMRMLWidget *viewWidget)
	Get renderer for view widget. More...

static Q_INVOKABLE vtkRenderWindow *	renderWindow (qMRMLWidget *viewWidget)
	Get render window for view widget. More...

static Q_INVOKABLE void	scheduleRender (qMRMLWidget *viewWidget)

static Q_INVOKABLE double	sliceSpacing (qMRMLSliceWidget *sliceWidget)

static Q_INVOKABLE vtkMRMLAbstractViewNode *	viewNode (qMRMLWidget *viewWidget)
	Get node for view widget. More...

static void	xyToIjk (QPoint xy, int outputIjk[3], qMRMLSliceWidget sliceWidget, vtkOrientedImageData image)
	Convert XY in-slice position to image IJK position. More...

static void	xyToIjk (double xy[2], int outputIjk[3], qMRMLSliceWidget sliceWidget, vtkOrientedImageData image)
	Convert XY in-slice position to image IJK position. More...

static Q_INVOKABLE QVector3D	xyToIjk (QPoint xy, qMRMLSliceWidget sliceWidget, vtkOrientedImageData image)
	Convert XY in-slice position to image IJK position, python accessor method. More...

static void	xyToRas (QPoint xy, double outputRas[3], qMRMLSliceWidget *sliceWidget)
	Convert XY in-slice position to RAS position. More...

static void	xyToRas (double xy[2], double outputRas[3], qMRMLSliceWidget *sliceWidget)
	Convert XY in-slice position to RAS position. More...

static Q_INVOKABLE QVector3D	xyToRas (QPoint xy, qMRMLSliceWidget *sliceWidget)
	Convert XY in-slice position to RAS position, python accessor method. More...

static void	xyzToIjk (double inputXyz[3], int outputIjk[3], qMRMLSliceWidget sliceWidget, vtkOrientedImageData image)
	Convert XYZ slice view position to image IJK position,. More...

static Q_INVOKABLE QVector3D	xyzToIjk (QVector3D inputXyz, qMRMLSliceWidget sliceWidget, vtkOrientedImageData image)
	Convert XYZ slice view position to image IJK position, python accessor method,. More...

static void	xyzToRas (double inputXyz[3], double outputRas[3], qMRMLSliceWidget *sliceWidget)

static Q_INVOKABLE QVector3D	xyzToRas (QVector3D inputXyz, qMRMLSliceWidget *sliceWidget)
	Convert XYZ slice view position to RAS position, python accessor method. More...

Detailed Description

Scripted abstract effect for implementing label effects in python.

This class provides an interface to label effects implemented in python. Label effects are a subtype of general effects that edit the currently selected segment (i.e. for things like paint or draw, but not for things like threshold) USAGE: Subclass AbstractScriptedSegmentEditorLabelEffect in EditorEffects/Python subfolder, and register effect by creating this class and setting python source to implemented effect subclass. One example is the DrawEffect.

Definition at line 48 of file qSlicerSegmentEditorScriptedLabelEffect.h.

Member Typedef Documentation

◆ Superclass

typedef qSlicerSegmentEditorAbstractLabelEffect qSlicerSegmentEditorScriptedLabelEffect::Superclass

Definition at line 54 of file qSlicerSegmentEditorScriptedLabelEffect.h.

Constructor & Destructor Documentation

◆ qSlicerSegmentEditorScriptedLabelEffect()

qSlicerSegmentEditorScriptedLabelEffect::qSlicerSegmentEditorScriptedLabelEffect ( QObject * parent = NULL )

◆ ~qSlicerSegmentEditorScriptedLabelEffect()

virtual qSlicerSegmentEditorScriptedLabelEffect::~qSlicerSegmentEditorScriptedLabelEffect ( )

virtual

Member Function Documentation

◆ activate()

virtual void qSlicerSegmentEditorScriptedLabelEffect::activate ( )

virtual

Perform actions to activate the effect (show options frame, etc.)

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ clone()

virtual qSlicerSegmentEditorAbstractEffect* qSlicerSegmentEditorScriptedLabelEffect::clone ( )

virtual

Clone editor effect. Override to return a new instance of the effect sub-class.

Implements qSlicerSegmentEditorAbstractLabelEffect.

◆ createCursor()

virtual QCursor qSlicerSegmentEditorScriptedLabelEffect::createCursor ( qMRMLWidget * viewWidget )

virtual

Create a cursor customized for the given effect, potentially for each view.

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ deactivate()

virtual void qSlicerSegmentEditorScriptedLabelEffect::deactivate ( )

virtual

Perform actions to deactivate the effect (hide options frame, destroy actors, etc.)

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ helpText()

virtual const QString qSlicerSegmentEditorScriptedLabelEffect::helpText ( ) const

virtual

Get help text for effect to be displayed in the help box.

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ icon()

virtual QIcon qSlicerSegmentEditorScriptedLabelEffect::icon ( )

virtual

Get icon for effect to be displayed in segment editor.

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ interactionNodeModified()

virtual void qSlicerSegmentEditorScriptedLabelEffect::interactionNodeModified ( vtkMRMLInteractionNode * interactionNode )

virtual

Let the effect know that the interaction node is modified.

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ layoutChanged()

virtual void qSlicerSegmentEditorScriptedLabelEffect::layoutChanged ( )

virtual

Simple mechanism to let the effects know that the layout has changed.

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ masterVolumeNodeChanged()

virtual void qSlicerSegmentEditorScriptedLabelEffect::masterVolumeNodeChanged ( )

virtual

Simple mechanism to let the effects know that master volume has changed.

Reimplemented from qSlicerSegmentEditorAbstractLabelEffect.

◆ processInteractionEvents()

virtual bool qSlicerSegmentEditorScriptedLabelEffect::processInteractionEvents	(	vtkRenderWindowInteractor *	callerInteractor,
		unsigned long	eid,
		qMRMLWidget *	viewWidget
	)

virtual

Callback function invoked when interaction happens

Parameters

callerInteractor	Interactor object that was observed to catch the event
eid	Event identifier
viewWidget	Widget of the Slicer layout view. Can be

See also: qMRMLSliceWidget or; qMRMLThreeDWidget

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ processViewNodeEvents()

virtual void qSlicerSegmentEditorScriptedLabelEffect::processViewNodeEvents	(	vtkMRMLAbstractViewNode *	callerViewNode,
		unsigned long	eid,
		qMRMLWidget *	viewWidget
	)

virtual

Callback function invoked when view node is modified

Parameters

callerViewNode View node that was observed to catch the event. Can be either

See also: vtkMRMLSliceNode or; vtkMRMLViewNode

Parameters

eid	Event identifier
viewWidget	Widget of the Slicer layout view. Can be

See also: qMRMLSliceWidget or; qMRMLThreeDWidget

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ pythonSource()

Q_INVOKABLE QString qSlicerSegmentEditorScriptedLabelEffect::pythonSource ( ) const

◆ referenceGeometryChanged()

virtual void qSlicerSegmentEditorScriptedLabelEffect::referenceGeometryChanged ( )

virtual

Simple mechanism to let the effects know that reference geometry change has changed.

Reimplemented from qSlicerSegmentEditorAbstractLabelEffect.

◆ self()

Q_INVOKABLE PyObject* qSlicerSegmentEditorScriptedLabelEffect::self ( ) const

Convenience method allowing to retrieve the associated scripted instance.

◆ setMRMLDefaults()

virtual void qSlicerSegmentEditorScriptedLabelEffect::setMRMLDefaults ( )

virtual

Set default parameters in the parameter MRML node.

Reimplemented from qSlicerSegmentEditorAbstractLabelEffect.

◆ setName()

virtual void qSlicerSegmentEditorScriptedLabelEffect::setName ( QString name )

virtual

Set the name property value.

See also: name

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ setPerSegment()

virtual void qSlicerSegmentEditorScriptedLabelEffect::setPerSegment ( bool perSegment )

virtual

Set flag indicating whether effect operates on segments (true) or the whole segmentation (false).

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ setPythonSource()

Q_INVOKABLE bool qSlicerSegmentEditorScriptedLabelEffect::setPythonSource ( const QString newPythonSource )

Set python source for the implemented effect

Parameters

newPythonSource Python file path

◆ setupOptionsFrame()

virtual void qSlicerSegmentEditorScriptedLabelEffect::setupOptionsFrame ( )

virtual

Create options frame widgets, make connections, and add them to the main options frame using.

See also: addOptionsWidget

Reimplemented from qSlicerSegmentEditorAbstractLabelEffect.

◆ updateGUIFromMRML

virtual void qSlicerSegmentEditorScriptedLabelEffect::updateGUIFromMRML ( )

virtualslot

Update user interface from parameter set node.

◆ updateMRMLFromGUI

virtual void qSlicerSegmentEditorScriptedLabelEffect::updateMRMLFromGUI ( )

virtualslot

Update parameter set node from user interface.

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerSegmentEditorScriptedLabelEffectPrivate> qSlicerSegmentEditorScriptedLabelEffect::d_ptr

protected

Definition at line 129 of file qSlicerSegmentEditorScriptedLabelEffect.h.

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

Modules/Loadable/Segmentations/EditorEffects/qSlicerSegmentEditorScriptedLabelEffect.h

Public Types

Public Slots

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ qSlicerSegmentEditorScriptedLabelEffect()

◆ ~qSlicerSegmentEditorScriptedLabelEffect()

Member Function Documentation

◆ activate()

◆ clone()

◆ createCursor()

◆ deactivate()

◆ helpText()

◆ icon()

◆ interactionNodeModified()

◆ layoutChanged()

◆ masterVolumeNodeChanged()

◆ processInteractionEvents()

◆ processViewNodeEvents()

◆ pythonSource()

◆ referenceGeometryChanged()

◆ self()

◆ setMRMLDefaults()

◆ setName()

◆ setPerSegment()

◆ setPythonSource()

◆ setupOptionsFrame()

◆ updateGUIFromMRML

◆ updateMRMLFromGUI

Member Data Documentation

◆ d_ptr