Documentation/Labs/Improving Markups - Revision history

Grundlett: Text replacement - "\[http:\/\/www\.slicer\.org\/slicerWiki\/index\.php\/([^ ]+) ([^]]+)]" to "$2"

2019-11-27T02:36:27Z

Text replacement - "\[http:\/\/www\.slicer\.org\/slicerWiki\/index\.php\/([^ ]+) ([^]]+)]" to "$2"

Lasso at 19:39, 4 March 2019

2019-03-04T19:39:41Z

Lasso at 19:18, 4 March 2019

2019-03-04T19:18:00Z

Show changes

JChris.FillionR at 09:53, 5 December 2018

2018-12-05T09:53:22Z

Lasso: /* Planned features */

2018-12-05T03:31:26Z

Planned features

Lasso at 03:31, 5 December 2018

2018-12-05T03:31:08Z

Magalab: /* Proposed Improvements */

2018-10-10T19:10:59Z

Proposed Improvements

Lasso: /* Proposed Improvements */

2018-10-10T04:26:57Z

Proposed Improvements

Magalab: /* References */

2018-10-10T02:59:06Z

References

Magalab: /* Proposed Improvements */

2018-10-10T02:47:20Z

Proposed Improvements

@@ Line 120: / Line 120: @@
 * [http://slicer-devel.65872.n3.nabble.com/interactive-contour-editing-td4032633i20.html#a4033779 Interactive Contour Editing thread on slicer-dev (2015)]
 * [http://www.na-mic.org/Wiki/index.php/Projects:ARRA:SlicerAM:vtkWidgets ARRA grant widget notes (2010)]
-* [http://www.slicer.org/slicerWiki/index.php/Documentation/Nightly/SlicerApplication/MouseandKeyboardShortcuts Mouse and Keyboard Shortcuts (nightly)]
+* [[Documentation/Nightly/SlicerApplication/MouseandKeyboardShortcuts|Mouse and Keyboard Shortcuts (nightly)]]
 * [http://viewvc.slicer.org/viewvc.cgi/Slicer3/trunk/Base/GUI/Tcl/ Slicer3 Tcl SWidget, SeedSWidget, FiducialsSWidget]

@@ Line 41: / Line 41: @@
 ** There is one widget representation per widget.
 ** There are different representation for 2D and 3D views.
 == Features ==
 Widget types:
-* point set: DONE
+* <del>point set: DONE</del>
-* angle: DONE
+* <del>angle: DONE</del>
-* curve (open and closed, with different interpolations): DONE
+* <del>curve (open and closed, with different interpolations): DONE</del>
 * line (arrow, ruler): partially done (it is still just a simple line, no length or arrow tip is displayed)
 * ROI (may be 2D only: ellipse, circle, rectangle)
@@ Line 56: / Line 71: @@
 * ROI-based image window width/level
-Functions:
+User features:
-* Highlight/display info when hovering over: DONE
+* <del>Highlight/display info when hovering over: DONE</del>
-* Delete using keyboard shortcut or right-click: DONE (hover over a point and click DEL key)
+* <del>Select entire markup or just a point: DONE</del>
 * Restricting placement and motion to other nodes (model surface, volume rendered image surface, etc.): partially done - point picking and movement in 3D view is restricted to visible surfaces (work well for volume rendered surfaces, too)
 * One click 3D angle, length measurements from landmarks (latter is already available)
@@ Line 66: / Line 80: @@
 * Improved scaling of 3D glyphs and 2D points. For example, fixed in screen size, fixed relative to voxel size of the data set, etc.
 * Projection display in slice views (similar to model projections, markup point projection)
-* Right-click menu (delete, jump to slice, fit slice views to main axes)
+* Right-click menu (delete, jump to slice, fit slice views to main axes - see also operations in the table widget in the Markups module GUI)
 * Compute metrics (length, surface, diameter, etc.), allow them to be exported into table or other standard annotation file formats
-* Undo modifications
+* Allow undoing modifications
 * Sensible behavior when non-linear transform is applied
 == Status ==
@@ Line 77: / Line 107: @@
 == References ==
 * https://discourse.slicer.org/t/a-users-proposal-for-markups-module-enhancements/3362
 * https://discourse.slicer.org/t/markups-module-enhancements/4335
@@ Line 86: / Line 117: @@
 * https://github.com/lassoan/Slicer/commit/cbd43fd2b8eb552e99f5dd29c0ed29b0d1af7e26
 * https://www.vtk.org/Wiki/VTK_Widget_Examples

@@ Line 10: / Line 10: @@
 Data synchronization between multiple classes (VTK and MRML nodes, instances for each viewer, widget and representation) has proven to be one of the fundamental issues. It would be nice to create generic VTK-only widgets and use them in Slicer, but this additional layer of abstraction would make implementation more complicated and degrade performance. Therefore, should be Slicer-specific, directly using information stored in MRML nodes.
-Separation between "widget" (behavior) and "representation" (appearance) in second-generation VTK widgets failed. Lots of data and state information had to be manually synchronized between many classes. When widget was present in multiple views then it made this manual synchronization extremely slow and complicated. Therefore, we need to split classes in a way that minimizes need for manual synchronization. Separation of "data" (shared globally in the whole scene, such as widget point positions) must be separated from "display" (properties that control how a widget should appear in each view) works very well for nodes and should be used for widgets as well. Data class should add thin wrapper over VTK data object (e.g., vtkPointSet), which would allow the same data object used in multiple renderers and alleviate any need for synchronizing point lists. Some state information can be shared (e.g., selected point) by storing it in the data node; while other state information (e.g., mouse is hovered over a point) could be specific to a view by storing it in the view's displayable manager class.
+Separation between "widget" (behavior) and "representation" (appearance) in second-generation VTK widgets failed. Lots of data and state information had to be manually synchronized between many classes. When widget was present in multiple views then it made this manual synchronization extremely slow and complicated. Therefore, we need to split classes in a way that minimizes need for manual synchronization. Separation of "data" (shared globally in the whole scene, such as widget point positions) must be separated from "display" (properties that control how a widget should appear in each view) works very well for nodes and should be used for widgets as well. Data class should add thin wrapper over VTK data object (e.g., vtkPointSet), which would allow the same data object used in multiple renderers and alleviate any need for synchronizing point lists. Some state information can be shared (e.g., selected point) by storing it in the data node; while other state information (e.g., mouse is hovered over a point) could be specific to a view by storing it in the view's [[Documentation/Nightly/Developers/DisplayableManagers|displayable manager]] class.
 Performance of markups module is very slow because each clickable point is implemented by a handle widget. Each handle widget requires instantiation of several classes per views (widget, representation, actors, pickers, etc.), many view observations, and trigger various expensive synchronization mechanisms when anything is changed. Instead, a single actor should be able to handle display, picking, visualization of points (using very efficient vtkGlyph3D filter).

@@ Line 39: / Line 39: @@
 == Planned features ==
-Potential widget types:
+Widget types:
 * point set
 * line (arrow, ruler)

@@ Line 1: / Line 1: @@
 == Overview ==
 The goal of this page is to support improvements to the Markups Module for fiducial placement. This page will document improvements suggested by users and developers and coordinate efforts to address them.
-== Proposed Improvements ==
-* Landmarks sticking and sliding on surface (this should work both with volume rendered datasets as well as surface models)
+== History ==
 * One click 3D angle, length measurements from landmarks (latter is already available)
 * Read a template for fiducial labels to be populated from
-* Generate blank fiducials.
+* Allow adding fiducials with undefined position
 * Fine control for fiducial placement/modifications by keyboard strokes
-* Scale 3D glyphs and 2D points properly with respect to the voxel size of the dataset
+* Improved scaling of 3D glyphs and 2D points. For example, fixed in screen size, fixed relative to voxel size of the data set, etc.
 == References ==
@@ Line 14: / Line 72: @@
 * https://issues.slicer.org/view.php?id=3849
 * https://issues.slicer.org/view.php?id=3713

← Older revision		Revision as of 02:59, 10 October 2018
Line 13:		Line 13:
	* https://discourse.slicer.org/t/markups-module-enhancements/4335		* https://discourse.slicer.org/t/markups-module-enhancements/4335
	* https://issues.slicer.org/view.php?id=3849		* https://issues.slicer.org/view.php?id=3849
		+	* https://issues.slicer.org/view.php?id=3713