Slicer 5.9
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
Loading...
Searching...
No Matches
qMRMLSegmentEditorWidget.h
Go to the documentation of this file.
1/*==============================================================================
2
3 Program: 3D Slicer
4
5 Copyright (c) Laboratory for Percutaneous Surgery (PerkLab)
6 Queen's University, Kingston, ON, Canada. All Rights Reserved.
7
8 See COPYRIGHT.txt
9 or http://www.slicer.org/copyright/copyright.txt for details.
10
11 Unless required by applicable law or agreed to in writing, software
12 distributed under the License is distributed on an "AS IS" BASIS,
13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 See the License for the specific language governing permissions and
15 limitations under the License.
16
17 This file was originally developed by Csaba Pinter, PerkLab, Queen's University
18 and was supported through the Applied Cancer Research Unit program of Cancer Care
19 Ontario with funds provided by the Ontario Ministry of Health and Long-Term Care
20
21==============================================================================*/
22
23#ifndef __qMRMLSegmentEditorWidget_h
24#define __qMRMLSegmentEditorWidget_h
25
26// Segmentations includes
27#include "qSlicerSegmentationsModuleWidgetsExport.h"
28
29// MRMLWidgets includes
30#include "qMRMLWidget.h"
31
32// Qt includes
33#include <QVariant>
34
35// CTK includes
36#include <ctkVTKObject.h>
37
38// STD includes
39#include <cstdlib>
40
41class vtkMRMLNode;
46class vtkObject;
47class QItemSelection;
48class QAbstractButton;
49class qMRMLSegmentEditorWidgetPrivate;
52
64class Q_SLICER_MODULE_SEGMENTATIONS_WIDGETS_EXPORT qMRMLSegmentEditorWidget : public qMRMLWidget
65{
66 Q_OBJECT
67 QVTK_OBJECT
78 Q_PROPERTY(bool undoEnabled READ undoEnabled WRITE setUndoEnabled)
80 Q_PROPERTY(bool readOnly READ readOnly WRITE setReadOnly)
81 Q_PROPERTY(Qt::ToolButtonStyle effectButtonStyle READ effectButtonStyle WRITE setEffectButtonStyle)
87
88public:
91 explicit qMRMLSegmentEditorWidget(QWidget* parent = nullptr);
94
97
99 Q_INVOKABLE vtkMRMLNode* segmentationNode() const;
101 Q_INVOKABLE QString segmentationNodeID() const;
103 Q_INVOKABLE vtkMRMLNode* sourceVolumeNode() const;
105 Q_INVOKABLE QString sourceVolumeNodeID() const;
106
108 Q_INVOKABLE vtkMRMLNode* masterVolumeNode() const
109 {
110 qWarning("qMRMLSegmentEditorWidget::masterVolumeNode is deprecated, use sourceVolumeNode() method instead.");
111 return this->sourceVolumeNode();
112 };
113
114 Q_INVOKABLE QString masterVolumeNodeID() const
115 {
116 qWarning("qMRMLSegmentEditorWidget::masterVolumeNodeID is deprecated, use sourceVolumeNodeID() method instead.");
117 return this->sourceVolumeNodeID();
118 };
119
120 Q_INVOKABLE QString currentSegmentID() const;
121
128
131 Q_INVOKABLE qSlicerSegmentEditorAbstractEffect* effectByName(const QString& name);
132
134 Q_INVOKABLE QStringList availableEffectNames();
135
138 Q_INVOKABLE void setEffectNameOrder(const QStringList& effectNames);
139
143 Q_INVOKABLE QStringList effectNameOrder() const;
144
148 void setUnorderedEffectsVisible(bool visible);
149
153
156 Q_INVOKABLE int effectCount();
157
161
166 Q_INVOKABLE void setupViewObservations();
167
171 Q_INVOKABLE void removeViewObservations();
172
181
184 {
185 qWarning("qMRMLSegmentEditorWidget::masterVolumeNodeSelectorVisible is deprecated, use sourceVolumeNodeSelectorVisible() method instead.");
186 return this->sourceVolumeNodeSelectorVisible();
187 };
188
190 {
191 qWarning("qMRMLSegmentEditorWidget::autoShowMasterVolumeNode is deprecated, use autoShowSourceVolumeNode() method instead.");
192 return this->autoShowSourceVolumeNode();
193 };
194
197
200
203
206
210 bool undoEnabled() const;
214 bool readOnly() const;
215
218 Qt::ToolButtonStyle effectButtonStyle() const;
219
222 int effectColumnCount() const;
223
226 Q_INVOKABLE void segmentationNodeSelectorAddAttribute(const QString& nodeType, const QString& attributeName, const QVariant& attributeValue = QVariant());
229 Q_INVOKABLE void segmentationNodeSelectorRemoveAttribute(const QString& nodeType, const QString& attributeName);
230
233 Q_INVOKABLE void sourceVolumeNodeSelectorAddAttribute(const QString& nodeType, const QString& attributeName, const QVariant& attributeValue = QVariant());
236 Q_INVOKABLE void sourceVolumeNodeSelectorRemoveAttribute(const QString& nodeType, const QString& attributeName);
237
239 Q_INVOKABLE void masterVolumeNodeSelectorAddAttribute(const QString& nodeType, const QString& attributeName, const QVariant& attributeValue = QVariant())
240 {
241 qWarning("qMRMLSegmentEditorWidget::masterVolumeNodeSelectorAddAttribute is deprecated, use sourceVolumeNodeSelectorAddAttribute method instead.");
242 this->sourceVolumeNodeSelectorAddAttribute(nodeType, attributeName, attributeValue);
243 }
244
245 Q_INVOKABLE void masterVolumeNodeSelectorRemoveAttribute(const QString& nodeType, const QString& attributeName)
246 {
247 qWarning("qMRMLSegmentEditorWidget::masterVolumeNodeSelectorRemoveAttribute is deprecated,"
248 " use sourceVolumeNodeSelectorRemoveAttribute instead.");
249 this->sourceVolumeNodeSelectorRemoveAttribute(nodeType, attributeName);
250 }
251
255
264 void setDefaultTerminologyEntrySettingsKey(const QString& terminologyEntrySettingsKey);
268
271 void setDefaultTerminologyEntry(const QString& terminologyEntry);
275
278
279public slots:
281 void setMRMLScene(vtkMRMLScene* newScene) override;
282
285
287 virtual void updateWidgetFromMRML();
288
292 void setSegmentationNodeID(const QString& nodeID);
298 void setSourceVolumeNodeID(const QString& nodeID);
299
302 {
303 qWarning("qMRMLSegmentEditorWidget::setMasterVolumeNode is deprecated, use setSourceVolumeNode method instead.");
304 this->setSourceVolumeNode(node);
305 }
306
307 void setMasterVolumeNodeID(const QString& nodeID)
308 {
309 qWarning("qMRMLSegmentEditorWidget::setMasterVolumeNodeID is deprecated, use setSourceVolumeNodeID method instead.");
310 this->setSourceVolumeNodeID(nodeID);
311 }
312
314 void setCurrentSegmentID(const QString& segmentID);
315
317 void setActiveEffectByName(const QString& effectName);
318
322
324 void updateVolume(void* volumePtr, bool& success);
325
349 void setUndoEnabled(bool);
353 void setReadOnly(bool aReadOnly);
356
359 {
360 qWarning("qMRMLSegmentEditorWidget::setMasterVolumeNodeSelectorVisible is deprecated, use setSourceVolumeNodeSelectorVisible method instead.");
362 }
363
364 void setAutoShowMasterVolumeNode(bool autoShow)
365 {
366 qWarning("qMRMLSegmentEditorWidget::setAutoShowMasterVolumeNode is deprecated, use setAutoShowSourceVolumeNode method instead.");
367 this->setAutoShowSourceVolumeNode(autoShow);
368 }
369
371 {
372 qWarning("qMRMLSegmentEditorWidget::toggleMasterVolumeIntensityMaskEnabled is deprecated, use toggleSourceVolumeIntensityMaskEnabled method instead.");
374 }
375
377 void undo();
378
380 void redo();
381
385 void installKeyboardShortcuts(QWidget* parent = nullptr);
386
389
394
397
400 void setEffectButtonStyle(Qt::ToolButtonStyle toolButtonStyle);
401
403 void setEffectColumnCount(int columnCount);
404
409
414 void showSourceVolumeInSliceViewers(bool forceShowInBackground = false, bool fitSlice = false);
415
416 // Deprecated. Use showSourceVolumeInSliceViewers method instead.
417 void showMasterVolumeInSliceViewers(bool forceShowInBackground = false, bool fitSlice = false)
418 {
419 qWarning("qMRMLSegmentEditorWidget::showMasterVolumeInSliceViewers is deprecated, use showSourceVolumeInSliceViewers method instead.");
420 this->showSourceVolumeInSliceViewers(forceShowInBackground, fitSlice);
421 }
422
426
430
433
436
440 void selectSegmentAtOffset(int offset);
441
445
448
449signals:
451 void currentSegmentIDChanged(const QString&);
452
456
459
463
464protected slots:
470 void onSegmentSelectionChanged(const QItemSelection& selected, const QItemSelection& deselected);
471
474
476 void onEffectButtonClicked(QAbstractButton* button);
477
482
485
499 void onLayoutChanged(int layoutIndex);
502
505
509 void onSourceVolumeIntensityMaskRangeChanged(double low, double high);
510
513
516
519
522
525
528
535
538
541
544
545 static void pauseRender();
546 static void resumeRender();
547
548protected:
550 static void processEvents(vtkObject* caller, unsigned long eid, void* clientData, void* callData);
551
555
559
562
563protected:
564 QScopedPointer<qMRMLSegmentEditorWidgetPrivate> d_ptr;
565
566private:
567 Q_DECLARE_PRIVATE(qMRMLSegmentEditorWidget);
568 Q_DISABLE_COPY(qMRMLSegmentEditorWidget);
569};
570
571#endif
Q_INVOKABLE qSlicerSegmentEditorAbstractEffect * effectByName(const QString &name)
void setMasterVolumeNodeID(const QString &nodeID)
Deprecated. Use setSourceVolumeNodeID method instead.
int maximumNumberOfUndoStates() const
Get maximum number of saved undo/redo states.
void setMRMLScene(vtkMRMLScene *newScene) override
Set the MRML scene associated with the widget.
void onOverwriteModeChanged(int)
Changed selected overwritable segments.
void initializeParameterSetNode()
Set default parameters in parameter set node (after setting or closing scene)
void onMRMLSceneEndBatchProcessEvent()
Updates needed after batch processing is done.
int effectColumnCount() const
bool switchToSegmentationsButtonVisible() const
Show/hide the switch to Segmentations module button.
void updateWidgetFromSegmentationNode()
QString defaultTerminologyEntry()
void updateVolume(void *volumePtr, bool &success)
Update modifierLabelmap, maskLabelmap, or alignedSourceVolumeNode.
bool maskingSectionVisible() const
Show/hide the masking section.
bool show3DButtonVisible() const
Show/hide the 3D button.
void setAddRemoveSegmentButtonsVisible(bool)
void setJumpToSelectedSegmentEnabled(bool enable)
Enables automatic jumping to current segment when selection is changed.
void toggleMasterVolumeIntensityMaskEnabled()
Deprecated. Use toggleSourceVolumeIntensityMaskEnabled method instead.
void setCurrentSegmentID(const QString &segmentID)
Set selected segment by its ID.
Q_INVOKABLE QString currentSegmentID() const
Get segment ID of selected segment.
bool specifyGeometryButtonVisible() const
Show/hide the specify geometry button.
void updateWidgetFromSourceVolumeNode()
void onSourceVolumeNodeChanged(vtkMRMLNode *node)
Handles changing of the current source volume MRML node.
void selectNextSegment()
Select the segment below the currently selected one in the table (skipping segments that are not visi...
Q_INVOKABLE QStringList effectNameOrder() const
void updateSliceRotateWarningButtonVisibility()
Show slice rotation warning button if slice views are rotated, hide otherwise.
void selectSegmentAtOffset(int offset)
QScopedPointer< qMRMLSegmentEditorWidgetPrivate > d_ptr
void setActiveEffectByName(const QString &effectName)
Set active effect by name.
bool readOnly() const
Get whether widget is read-only.
void hideLabelLayer()
Unselect labelmap layer in all slice views in the active layout.
Q_INVOKABLE vtkMRMLNode * masterVolumeNode() const
Deprecated. Use sourceVolumeNode() method instead.
void setEffectColumnCount(int columnCount)
Request displaying effects in the grid layout with the specified column count.
void onSourceVolumeIntensityMaskChecked(bool checked)
Enable/disable threshold when checkbox is toggled.
void onSwitchToSegmentations()
Edit segmentation properties in Segmentations module.
Q_INVOKABLE void masterVolumeNodeSelectorRemoveAttribute(const QString &nodeType, const QString &attributeName)
Deprecated use sourceVolumeNodeSelectorRemoveAttribute method instead.
void setSourceVolumeNodeSelectorVisible(bool)
Show/hide the source volume node selector widget.
void setSourceVolumeNodeID(const QString &nodeID)
Set source volume MRML node by its ID.
void undo()
Restores previous saved state of the segmentation.
void onExportToFilesActionClicked()
Open Export to files dialog.
void onInteractionNodeModified()
Handles mouse mode changes (view / place markups)
void setSegmentationNodeSelectorVisible(bool)
Show/hide the segmentation node selector widget.
void segmentationNodeChanged(vtkMRMLSegmentationNode *)
bool jumpToSelectedSegmentEnabled() const
Returns true if automatic jump to current segment is enabled.
void redo()
Restores next saved state of the segmentation.
Q_INVOKABLE QStringList availableEffectNames()
Get list of all registered effect names that can be displayed in the widget.
QVTK_OBJECTbool segmentationNodeSelectorVisible
void setMasterVolumeNode(vtkMRMLNode *node)
Deprecated. Use setSourceVolumeNode method instead.
void setMasterVolumeNodeSelectorVisible(bool visible)
Deprecated. Use setSourceVolumeNodeSelectorVisible method instead.
static qSlicerAbstractModuleWidget * switchToSegmentationsModule()
Switches to Segmentations module and returns the module widget.
void showSourceVolumeInSliceViewers(bool forceShowInBackground=false, bool fitSlice=false)
void onSegmentationHistoryChanged()
Update GUI if segmentation history is changed (e.g., undo/redo button states)
void setReadOnly(bool aReadOnly)
Set whether the widget is read-only.
void onExportToColorTableActionClicked()
Export segment color and terminology information to a new color table.
bool setSourceRepresentationToBinaryLabelmap()
void sourceVolumeNodeChanged(vtkMRMLVolumeNode *)
bool undoEnabled() const
Undo/redo enabled.
void setMaskingSectionVisible(bool)
void setShow3DButtonVisible(bool)
bool sourceVolumeNodeSelectorVisible() const
Show/hide the source volume node selector widget.
void setSpecifyGeometryButtonVisible(bool)
bool autoShowMasterVolumeNode() const
Deprecated. Use autoShowSourceVolumeNode() method instead.
void toggleSourceVolumeIntensityMaskEnabled()
Enable/disable masking using source volume intensity.
void onSelectSegmentShortcut()
Segment selection shortcut is activated.
void setUnorderedEffectsVisible(bool visible)
bool addRemoveSegmentButtonsVisible() const
Show/hide the add/remove segment buttons.
Q_INVOKABLE void sourceVolumeNodeSelectorAddAttribute(const QString &nodeType, const QString &attributeName, const QVariant &attributeValue=QVariant())
void onMRMLSceneEndCloseEvent()
Clean up when scene is closed.
bool segmentationNodeSelectorVisible() const
Show/hide the segmentation node selector widget.
Q_INVOKABLE void segmentationNodeSelectorAddAttribute(const QString &nodeType, const QString &attributeName, const QVariant &attributeValue=QVariant())
void onRemoveSegment()
Remove selected segment.
void onSourceVolumeImageDataModified()
Called if source volume image data is changed.
Q_INVOKABLE void setupViewObservations()
Q_INVOKABLE void segmentationNodeSelectorRemoveAttribute(const QString &nodeType, const QString &attributeName)
Q_INVOKABLE void removeViewObservations()
Q_INVOKABLE QString segmentationNodeID() const
Get ID of currently selected segmentation node.
void currentSegmentIDChanged(const QString &)
Emitted if different segment is selected in the segment list.
void setSwitchToSegmentationsButtonVisible(bool)
Show/hide the switch to Segmentations module button.
void updateMaskingSection()
Update masking section on the UI.
QString defaultTerminologyEntrySettingsKey() const
void onAddSegment()
Add empty segment.
Qt::ToolButtonStyle effectButtonStyle() const
bool autoShowSourceVolumeNode() const
void installKeyboardShortcuts(QWidget *parent=nullptr)
Q_INVOKABLE void sourceVolumeNodeSelectorRemoveAttribute(const QString &nodeType, const QString &attributeName)
void onEffectButtonClicked(QAbstractButton *button)
Activate effect on clicking its button.
Q_INVOKABLE vtkMRMLNode * segmentationNode() const
Get currently selected segmentation MRML node.
static void resumeRender()
void setMRMLSegmentEditorNode(vtkMRMLSegmentEditorNode *newSegmentEditorNode)
Set the segment editor parameter set node.
void updateUndoRedoButtonsState()
Update undo/redo button states.
void selectPreviousSegment()
Select the segment above the currently selected one in the table (skipping segments that are not visi...
void onCreateSurfaceToggled(bool on)
Create/remove closed surface model for the segmentation that is automatically updated when editing.
void setSourceVolumeNode(vtkMRMLNode *node)
void uninstallKeyboardShortcuts()
Uninstall previously installed keyboard shortcuts.
void onSegmentationNodeChanged(vtkMRMLNode *node)
Handles changing of current segmentation MRML node.
void setInteractionNode(vtkMRMLInteractionNode *interactionNode)
virtual void updateWidgetFromMRML()
Update widget state from the MRML scene.
static void pauseRender()
void setEffectButtonStyle(Qt::ToolButtonStyle toolButtonStyle)
bool masterVolumeNodeSelectorVisible() const
Deprecated. Use sourceVolumeNodeSelectorVisible() method instead.
Q_INVOKABLE QString masterVolumeNodeID() const
Deprecated. Use sourceVolumeNodeID() method instead.
bool unorderedEffectsVisible() const
void onLayoutChanged(int layoutIndex)
Handle layout changes.
void onSegmentSelectionChanged(const QItemSelection &selected, const QItemSelection &deselected)
Handles segment selection changes.
Q_INVOKABLE void setEffectNameOrder(const QStringList &effectNames)
void setAutoShowSourceVolumeNode(bool)
Q_INVOKABLE void masterVolumeNodeSelectorAddAttribute(const QString &nodeType, const QString &attributeName, const QVariant &attributeValue=QVariant())
Deprecated use sourceVolumeNodeSelectorAddAttribute method instead.
Q_INVOKABLE qSlicerSegmentEditorAbstractEffect * activeEffect() const
void setSegmentationNodeID(const QString &nodeID)
Set segmentation MRML node by its ID.
void setDefaultTerminologyEntrySettingsKey(const QString &terminologyEntrySettingsKey)
void onSegmentAddedRemoved()
Called if a segment or representation is added or removed.
void setMaximumNumberOfUndoStates(int)
Set maximum number of saved undo/redo states.
Q_INVOKABLE vtkMRMLSegmentEditorNode * mrmlSegmentEditorNode() const
Get the segment editor parameter set node.
Q_INVOKABLE qSlicerSegmentEditorAbstractEffect * effectByIndex(int index)
Q_INVOKABLE QString sourceVolumeNodeID() const
Get ID of currently selected source volume node.
void setUndoEnabled(bool)
Undo/redo enabled.
void setAutoShowMasterVolumeNode(bool autoShow)
Deprecated. Use setAutoShowSourceVolumeNode method instead.
void showSegmentationGeometryDialog()
Show segmentation geometry dialog to specify labelmap geometry.
void showMasterVolumeInSliceViewers(bool forceShowInBackground=false, bool fitSlice=false)
void onMaskModeChanged(int)
Changed selected editable segment area.
Q_INVOKABLE vtkMRMLInteractionNode * interactionNode() const
void setDefaultTerminologyEntry(const QString &terminologyEntry)
Q_INVOKABLE int effectCount()
Q_INVOKABLE void setActiveEffect(qSlicerSegmentEditorAbstractEffect *effect)
Qt::ToolButtonStyle effectButtonStyle
Q_INVOKABLE vtkMRMLNode * sourceVolumeNode() const
Get currently selected source volume MRML node.
void onSourceVolumeIntensityMaskRangeChanged(double low, double high)
Handles threshold values changed event.
void masterVolumeNodeChanged(vtkMRMLVolumeNode *)
Deprecated. Use sourceVolumeNodeChanged signal instead.
void onSegmentationDisplayModified()
Handle display node view ID changes.
static void processEvents(vtkObject *caller, unsigned long eid, void *clientData, void *callData)
Callback function invoked when interaction happens.
void setSegmentationNode(vtkMRMLNode *node)
Set segmentation MRML node.
void onImportExportActionClicked()
Switch to Segmentations module and jump to Import/Export section.
qMRMLSegmentEditorWidget(QWidget *parent=nullptr)
Constructor.
qMRMLWidget(QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
Abstract class for segment editor effects.
Abstract Superclass for all specific types of MRML nodes.
A set of MRML Nodes that supports serialization and undo/redo.
Parameter set node for the segment editor widget.
MRML node containing segmentations.
MRML node for representing a volume (image stack).