Scripted abstract effect for implementing segment editor effects in python. More...

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

Inheritance diagram for qSlicerSegmentEditorScriptedEffect:

Collaboration diagram for qSlicerSegmentEditorScriptedEffect:

Public Types
typedef qSlicerSegmentEditorAbstractEffect	Superclass

Public Types inherited from qSlicerSegmentEditorAbstractEffect
enum	ConfirmationResult { NotConfirmed, ConfirmedWithoutDialog, ConfirmedWithDialog }

enum	ModificationMode { ModificationModeSet, ModificationModeAdd, ModificationModeRemove, ModificationModeRemoveAll }

typedef QObject	Superclass

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

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

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

virtual void	updateMRMLFromGUI ()=0

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

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

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

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

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

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

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

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

void	masterVolumeNodeChanged () override
	Deprecated. Use sourceVolumeNodeChanged() method instead. More...

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

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

Q_INVOKABLE QString	pythonSource () const

	qSlicerSegmentEditorScriptedEffect (QObject *parent=nullptr)

void	referenceGeometryChanged () override
	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...

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

void	setName (QString name) override

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

Q_INVOKABLE bool	setPythonSource (const QString newPythonSource)

void	setRequireSegments (bool requireSegments) override
	If this property is set to true then this effect is enabled only when the segmentation has segment(s) in it. More...

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

void	sourceVolumeNodeChanged () override
	Simple mechanism to let the effects know that reference volume has changed. More...

	~qSlicerSegmentEditorScriptedEffect () override

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 int	confirmCurrentSegmentVisible ()

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 ()
	Deprecated. Use sourceVolumeImageData method instead. More...

Q_INVOKABLE vtkOrientedImageData *	modifierLabelmap ()

virtual Q_INVOKABLE void	modifySegmentByLabelmap (vtkMRMLSegmentationNode segmentationNode, const char segmentID, vtkOrientedImageData *modifierLabelmap, ModificationMode modificationMode, bool bypassMasking=false)

virtual Q_INVOKABLE void	modifySegmentByLabelmap (vtkMRMLSegmentationNode segmentationNode, const char segmentID, vtkOrientedImageData *modifierLabelmap, ModificationMode modificationMode, const int modificationExtent[6], bool bypassMasking=false)

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

virtual Q_INVOKABLE void	modifySelectedSegmentByLabelmap (vtkOrientedImageData *modifierLabelmap, ModificationMode modificationMode, bool bypassMasking=false)

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

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=nullptr)

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...

virtual bool	requireSegments () const
	If this property is set to true then this effect is enabled only when the segmentation has segment(s) in it. 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 alignedSourceVolume, vtkOrientedImageData modifierLabelmap, vtkOrientedImageData maskLabelmap, vtkOrientedImageData selectedSegmentLabelmap, vtkOrientedImageData *referenceGeometryImage)
	Called by the editor widget. More...

bool	showEffectCursorInSliceView ()

bool	showEffectCursorInThreeDView ()

Q_INVOKABLE vtkOrientedImageData *	sourceVolumeImageData ()

	~qSlicerSegmentEditorAbstractEffect () override

Protected Attributes
QScopedPointer< qSlicerSegmentEditorScriptedEffectPrivate >	d_ptr

Protected Attributes inherited from qSlicerSegmentEditorAbstractEffect
QScopedPointer< qSlicerSegmentEditorAbstractEffectPrivate >	d_ptr

bool	m_Active {false}

vtkWeakPointer< vtkSegment >	m_AlreadyConfirmedSegmentVisible

double	m_EraseValue {0.0}

double	m_FillValue {1.0}

QString	m_Name
	Name of the effect. More...

bool	m_PerSegment {true}

bool	m_RequireSegments {true}

bool	m_ShowEffectCursorInSliceView {true}

bool	m_ShowEffectCursorInThreeDView {false}

Additional Inherited Members
Properties inherited from qSlicerSegmentEditorAbstractEffect
QString	name

bool	perSegment

bool	requireSegments

bool	showEffectCursorInSliceView

bool	showEffectCursorInThreeDView

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, vtkMRMLTransformNode *parentTransform=nullptr)
	Convert XY in-slice position to image IJK position. More...

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

static Q_INVOKABLE QVector3D	xyToIjk (QPoint xy, qMRMLSliceWidget sliceWidget, vtkOrientedImageData image, vtkMRMLTransformNode *parentTransform=nullptr)
	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, vtkMRMLTransformNode *parentTransform=nullptr)
	Convert XYZ slice view position to image IJK position,. More...

static Q_INVOKABLE QVector3D	xyzToIjk (QVector3D inputXyz, qMRMLSliceWidget sliceWidget, vtkOrientedImageData image, vtkMRMLTransformNode *parentTransform=nullptr)
	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 segment editor effects in python.

This class provides an interface to effects implemented in python. USAGE: Subclass AbstractScriptedSegmentEditorEffect in EditorEffects/Python subfolder, and register effect by creating this class and setting python source to implemented effect subclass. One example is the ThresholdEffect.

Definition at line 46 of file qSlicerSegmentEditorScriptedEffect.h.

Member Typedef Documentation

◆ Superclass

typedef qSlicerSegmentEditorAbstractEffect qSlicerSegmentEditorScriptedEffect::Superclass

Definition at line 52 of file qSlicerSegmentEditorScriptedEffect.h.

Constructor & Destructor Documentation

◆ qSlicerSegmentEditorScriptedEffect()

qSlicerSegmentEditorScriptedEffect::qSlicerSegmentEditorScriptedEffect ( QObject * parent = nullptr )

◆ ~qSlicerSegmentEditorScriptedEffect()

qSlicerSegmentEditorScriptedEffect::~qSlicerSegmentEditorScriptedEffect ( )

override

Member Function Documentation

◆ activate()

void qSlicerSegmentEditorScriptedEffect::activate ( )

overridevirtual

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

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ clone()

qSlicerSegmentEditorAbstractEffect* qSlicerSegmentEditorScriptedEffect::clone ( )

overridevirtual

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

Implements qSlicerSegmentEditorAbstractEffect.

◆ createCursor()

QCursor qSlicerSegmentEditorScriptedEffect::createCursor ( qMRMLWidget * viewWidget )

overridevirtual

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

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ deactivate()

void qSlicerSegmentEditorScriptedEffect::deactivate ( )

overridevirtual

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

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ helpText()

const QString qSlicerSegmentEditorScriptedEffect::helpText ( ) const

overridevirtual

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

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ icon()

QIcon qSlicerSegmentEditorScriptedEffect::icon ( )

overridevirtual

Get icon for effect to be displayed in segment editor.

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ interactionNodeModified()

void qSlicerSegmentEditorScriptedEffect::interactionNodeModified ( vtkMRMLInteractionNode * interactionNode )

overridevirtual

Let the effect know that the interaction node is modified.

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ layoutChanged()

void qSlicerSegmentEditorScriptedEffect::layoutChanged ( )

overridevirtual

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

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ masterVolumeNodeChanged()

void qSlicerSegmentEditorScriptedEffect::masterVolumeNodeChanged ( )

overridevirtual

Deprecated. Use sourceVolumeNodeChanged() method instead.

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ processInteractionEvents()

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

overridevirtual

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()

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

overridevirtual

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 qSlicerSegmentEditorScriptedEffect::pythonSource ( ) const

◆ referenceGeometryChanged()

void qSlicerSegmentEditorScriptedEffect::referenceGeometryChanged ( )

overridevirtual

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

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ self()

Q_INVOKABLE PyObject* qSlicerSegmentEditorScriptedEffect::self ( ) const

Convenience method allowing to retrieve the associated scripted instance.

◆ setMRMLDefaults()

void qSlicerSegmentEditorScriptedEffect::setMRMLDefaults ( )

overridevirtual

Set default parameters in the parameter MRML node.

Implements qSlicerSegmentEditorAbstractEffect.

◆ setName()

void qSlicerSegmentEditorScriptedEffect::setName ( QString name )

overridevirtual

Set the name property value.

See also: name

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ setPerSegment()

void qSlicerSegmentEditorScriptedEffect::setPerSegment ( bool perSegment )

overridevirtual

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

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ setPythonSource()

Q_INVOKABLE bool qSlicerSegmentEditorScriptedEffect::setPythonSource ( const QString newPythonSource )

Set python source for the implemented effect

Parameters

newPythonSource Python file path

◆ setRequireSegments()

void qSlicerSegmentEditorScriptedEffect::setRequireSegments ( bool requireSegments )

overridevirtual

If this property is set to true then this effect is enabled only when the segmentation has segment(s) in it.

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ setupOptionsFrame()

void qSlicerSegmentEditorScriptedEffect::setupOptionsFrame ( )

overridevirtual

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

See also: addOptionsWidget

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ sourceVolumeNodeChanged()

void qSlicerSegmentEditorScriptedEffect::sourceVolumeNodeChanged ( )

overridevirtual

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

Reimplemented from qSlicerSegmentEditorAbstractEffect.

◆ updateGUIFromMRML

void qSlicerSegmentEditorScriptedEffect::updateGUIFromMRML ( )

overrideslot

Update user interface from parameter set node.

◆ updateMRMLFromGUI

void qSlicerSegmentEditorScriptedEffect::updateMRMLFromGUI ( )

overrideslot

Update parameter set node from user interface.

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerSegmentEditorScriptedEffectPrivate> qSlicerSegmentEditorScriptedEffect::d_ptr

protected

Definition at line 132 of file qSlicerSegmentEditorScriptedEffect.h.

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

Modules/Loadable/Segmentations/EditorEffects/qSlicerSegmentEditorScriptedEffect.h

Public Types

Public Slots

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ qSlicerSegmentEditorScriptedEffect()

◆ ~qSlicerSegmentEditorScriptedEffect()

Member Function Documentation

◆ activate()

◆ clone()

◆ createCursor()

◆ deactivate()

◆ helpText()

◆ icon()

◆ interactionNodeModified()

◆ layoutChanged()

◆ masterVolumeNodeChanged()

◆ processInteractionEvents()

◆ processViewNodeEvents()

◆ pythonSource()

◆ referenceGeometryChanged()

◆ self()

◆ setMRMLDefaults()

◆ setName()

◆ setPerSegment()

◆ setPythonSource()

◆ setRequireSegments()

◆ setupOptionsFrame()

◆ sourceVolumeNodeChanged()

◆ updateGUIFromMRML

◆ updateMRMLFromGUI

Member Data Documentation

◆ d_ptr