Merge pull request #21 from NVIDIA/update_multi_res_notebook

Update multi resolution notebook with documentation fixes.
NVIDIA · Mar 30, 2022 · ff02d27 · ff02d27
2 parents 4e39fd0 + edbe41e
commit ff02d27
Showing 1 changed file with 19 additions and 8 deletions.
diff --git a/notebooks/Multi_level_image.ipynb → notebooks/Multi_resolution_image.ipynb b/notebooks/Multi_level_image.ipynb → notebooks/Multi_resolution_image.ipynb
@@ -5,10 +5,17 @@
    "id": "6d2047f5",
    "metadata": {},
    "source": [
-    "# Clara Viz Interactive Rendering of Multi Level Images\n",
-    "This notebook shows how to load a volume dataset using the DataDefinition class append method. The append method uses ITK to load the dataset from disk.\n",
-    "The rendering settings are loaded from a JSON file.\n",
-    "Then the Clara Viz widget is used to display an interactive view of the data."
+    "# Clara Viz Interactive Rendering of Multi Resolution Images\n",
+    "This notebook shows how to view a multi resolution image like those found in Digital Pathology. The `DataDefintion` class is using cuCIM to load the required region of the image on demand.\n",
+    "The Clara Viz widget is used to display an interactive view of the image."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "e8beb26e",
+   "metadata": {},
+   "source": [
+    "## Download the data"
    ]
   },
   {
@@ -18,9 +25,6 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# The DataDefinition class is using cuCIM to load the data files, make sure cuCim is available\n",
-    "!python3 -c \"import cucim\" || python3 -m pip install cucim\n",
-    "\n",
     "from os.path import exists\n",
     "from urllib.request import urlretrieve\n",
     "\n",
@@ -36,7 +40,11 @@
    "metadata": {},
    "source": [
     "## Create and display the widget\n",
-    "The data to be rendered needs to be defined. Clara Viz provides a support class called `DataDefinition` which supports loading medical data formats and serves as a container for the data."
+    "The data to be rendered needs to be defined. Clara Viz provides a support class called `DataDefinition` which supports loading medical data formats and serves as a container for the data.\n",
+    "\n",
+    "Usage\n",
+    "* use the mouse wheel to zoom in and out\n",
+    "* press and hold the mouse wheel and move mouse to move around\n"
    ]
   },
   {
@@ -46,6 +54,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "# The DataDefinition class is using cuCIM to load the data files, make sure cuCIM is available\n",
+    "!python3 -c \"import cucim\" || python3 -m pip install cucim\n",
+    "\n",
     "from clara.viz.core import DataDefinition\n",
     "from clara.viz.widgets import Widget\n",
     "\n",