Merge pull request #371 from thewtex/axes

ENH: Add axes viewer trait

Author: thewtex

examples/3DImage.ipynb

@@ -2,9 +2,20 @@
  "cells": [
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 1,
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Requirement already satisfied: itk-io in /home/matt/bin/miniconda3/envs/itkwidgets/lib/python3.7/site-packages (5.1.0.post3)\n",
+      "Requirement already satisfied: itk-core==5.1.0.post3 in /home/matt/bin/miniconda3/envs/itkwidgets/lib/python3.7/site-packages (from itk-io) (5.1.0.post3)\n",
+      "\u001b[33mWARNING: You are using pip version 20.1.1; however, version 20.2 is available.\n",
+      "You should consider upgrading via the '/home/matt/bin/miniconda3/envs/itkwidgets/bin/python -m pip install --upgrade pip' command.\u001b[0m\n"
+     ]
+    }
+   ],
    "source": [
     "# Install dependencies for this example\n",
     "# Note: This does not include itkwidgets, itself\n",
@@ -14,7 +25,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": 2,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -28,7 +39,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 3,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -41,18 +52,18 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 13,
    "metadata": {},
    "outputs": [
     {
      "data": {
       "application/vnd.jupyter.widget-view+json": {
-       "model_id": "57448261fbe849c4bacc9af9a83f9f14",
+       "model_id": "87d82520fc054f12911be983a07bbabd",
        "version_major": 2,
        "version_minor": 0
       },
       "text/plain": [
-       "Viewer(geometries=[], gradient_opacity=0.9, point_sets=[], rendered_image=<itkImagePython.itkImageSS3; proxy o…"
+       "Viewer(axes=True, geometries=[], gradient_opacity=0.9, point_sets=[], rendered_image=<itk.itkImagePython.itkIm…"
       ]
      },
      "metadata": {},
@@ -61,7 +72,7 @@
    ],
    "source": [
     "image = itk.imread(file_name)\n",
-    "view(image, rotate=True, vmin=4000, vmax=17000, gradient_opacity=0.9)"
+    "view(image, rotate=True, axes=True, vmin=4000, vmax=17000, gradient_opacity=0.9)"
    ]
   },
   {

itkwidgets/widget_viewer.py

@@ -305,6 +305,10 @@ class Viewer(ViewerParent):
         default_value=True,
         help="Show annotations.").tag(
         sync=True)
+    axes = CBool(
+        default_value=False,
+        help="Display axes.").tag(
+        sync=True)
     mode = CaselessStrEnum(
         ('x',
          'y',
@@ -788,7 +792,7 @@ def view(image=None,  # noqa: C901
          point_set_representations=[], point_set_sizes=[],
          geometries=[],
          geometry_colors=[], geometry_opacities=[],
-         ui_collapsed=False, rotate=False, annotations=True, mode='v',
+         ui_collapsed=False, rotate=False, annotations=True, axes=False, mode='v',
          **kwargs):
     """View the image and/or point sets and/or geometries.
 
@@ -825,6 +829,9 @@ def view(image=None,  # noqa: C901
         Display annotations describing orientation and the value of a
         mouse-position-based data probe.
 
+    axes : bool, default: False
+        Display axes.
+
     mode: 'x', 'y', 'z', or 'v', default: 'v'
         Only relevant for 3D scenes.
         Viewing mode:
@@ -1074,6 +1081,7 @@ def view(image=None,  # noqa: C901
                     point_set_representations=point_set_representations,
                     point_set_sizes=point_set_sizes,
                     geometries=geometries, geometry_colors=geometry_colors, geometry_opacities=geometry_opacities,
-                    rotate=rotate, ui_collapsed=ui_collapsed, annotations=annotations, mode=mode,
+                    rotate=rotate, ui_collapsed=ui_collapsed,
+                    annotations=annotations, axes=axes, mode=mode,
                     **kwargs)
     return viewer

js/lib/viewer.js

@@ -154,6 +154,7 @@ const ViewerModel = widgets.DOMWidgetModel.extend(
         ui_collapsed: false,
         rotate: false,
         annotations: true,
+        axes: true,
         mode: 'v',
         camera: new Float32Array(9),
         background: null
@@ -712,6 +713,7 @@ const ViewerView = widgets.DOMWidgetView.extend({
     const rendered_image = this.model.get('rendered_image')
     const rendered_label_image = this.model.get('rendered_label_image')
     this.annotations_changed()
+    this.axes_changed()
 
     const onBackgroundChanged = (background) => {
       this.model.set('background', background)
@@ -781,6 +783,14 @@ const ViewerView = widgets.DOMWidgetView.extend({
     }
     this.model.itkVtkViewer.on('toggleAnnotations', onAnnotationsToggle)
 
+    const onAxesToggle = (enabled) => {
+      if (enabled !== this.model.get('axes')) {
+        this.model.set('axes', enabled)
+        this.model.save_changes()
+      }
+    }
+    this.model.itkVtkViewer.on('toggleAxes', onAxesToggle)
+
     const onInterpolationToggle = (enabled) => {
       if (enabled !== this.model.get('interpolation')) {
         this.model.set('interpolation', enabled)
@@ -1214,6 +1224,7 @@ const ViewerView = widgets.DOMWidgetView.extend({
     this.model.on('change:ui_collapsed', this.ui_collapsed_changed, this)
     this.model.on('change:rotate', this.rotate_changed, this)
     this.model.on('change:annotations', this.annotations_changed, this)
+    this.model.on('change:axes', this.axes_changed, this)
     this.model.on('change:mode', this.mode_changed, this)
     this.model.on('change:units', this.units_changed, this)
     this.model.on('change:camera', this.camera_changed, this)
@@ -1547,6 +1558,13 @@ const ViewerView = widgets.DOMWidgetView.extend({
     }
   },
 
+  axes_changed: function () {
+    const axes = this.model.get('axes')
+    if (this.model.hasOwnProperty('itkVtkViewer')) {
+      this.model.itkVtkViewer.setAxesEnabled(axes)
+    }
+  },
+
   mode_changed: function () {
     const mode = this.model.get('mode')
     if (this.model.hasOwnProperty('itkVtkViewer') && !this.model.use2D) {

js/package-lock.json

@@ -63,11 +63,11 @@
     "copy-webpack-plugin": "^5.1.1",
     "css-element-queries": "^1.2.3",
     "itk": "^13.1.1",
-    "itk-vtk-viewer": "^10.6.0",
+    "itk-vtk-viewer": "^10.7.2",
     "jupyter-dataserializers": "^2.2.0",
     "mobx": "^5.15.4",
     "regenerator-runtime": "^0.13.5",
-    "vtk.js": "^14.10.4"
+    "vtk.js": "^14.12.0"
   },
   "jupyterlab": {
     "extension": "dist/labextension"