rename to dash_slicer and VolumeSlicer (#10)

Author: almarklein

README.md

@@ -1,6 +1,7 @@
-# dash-3d-viewer
+# dash_slicer
+
+A volume slicer for Dash
 
-A tool to make it easy to build slice-views on 3D image data, in Dash apps.
 
 The API is currently a WIP.
 
@@ -10,9 +11,23 @@ The API is currently a WIP.
 Eventually, this would be pip-installable. For now, use the developer workflow.
 
 
-## Usage
+## Usage example
+
+```py
+import dash
+import dash_html_components as html
+from dash_slicer import VolumeSlicer
+import imageio
+
+app = dash.Dash(__name__)
+
+vol = imageio.volread("imageio:stent.npz")
+slicer = VolumeSlicer(app, vol)
+app.layout = html.Div([slicer.graph, slicer.slider, *slicer.stores])
 
-TODO, see the examples.
+if __name__ == "__main__":
+    app.run_server()
+```
 
 
 ## License

dash_3d_viewer/__init__.py

@@ -0,0 +1,10 @@
+"""
+dash_slicer - a volume slicer for Dash
+"""
+
+
+from .slicer import VolumeSlicer  # noqa: F401
+
+
+__version__ = "0.0.1"
+version_info = tuple(map(int, __version__.split(".")))

dash_slicer/__init__.py

@@ -7,7 +7,7 @@
 from .utils import img_array_to_uri, get_thumbnail_size_from_shape, shape3d_to_size2d
 
 
-class DashVolumeSlicer:
+class VolumeSlicer:
     """A slicer to show 3D image data in Dash.
 
     Parameters:
@@ -81,8 +81,8 @@ def __init__(
             raise TypeError("scene_id must be a string")
         self.scene_id = scene_id
         # Get unique id scoped to this slicer object
-        DashVolumeSlicer._global_slicer_counter += 1
-        self.context_id = "slicer_" + str(DashVolumeSlicer._global_slicer_counter)
+        VolumeSlicer._global_slicer_counter += 1
+        self.context_id = "slicer_" + str(VolumeSlicer._global_slicer_counter)
 
         # Prepare slice info
         info = {

dash_3d_viewer/slicer.py renamed to dash_slicer/slicer.py

@@ -15,7 +15,7 @@
 
 import dash
 import dash_html_components as html
-from dash_3d_viewer import DashVolumeSlicer
+from dash_slicer import VolumeSlicer
 import imageio
 
 
@@ -28,13 +28,13 @@
 ori = 110, 120, 140
 
 
-slicer1 = DashVolumeSlicer(
+slicer1 = VolumeSlicer(
     app, vol1, axis=1, origin=ori, reverse_y=False, scene_id="scene1"
 )
-slicer2 = DashVolumeSlicer(
+slicer2 = VolumeSlicer(
     app, vol1, axis=0, origin=ori, reverse_y=False, scene_id="scene1"
 )
-slicer3 = DashVolumeSlicer(
+slicer3 = VolumeSlicer(
     app, vol2, axis=0, origin=ori, spacing=spacing, reverse_y=False, scene_id="scene1"
 )
 

dash_3d_viewer/utils.py renamed to dash_slicer/utils.py

@@ -4,17 +4,17 @@
 
 import dash
 import dash_html_components as html
-from dash_3d_viewer import DashVolumeSlicer
+from dash_slicer import VolumeSlicer
 import imageio
 
 
 app = dash.Dash(__name__)
 
 vol = imageio.volread("imageio:stent.npz")
-slicer = DashVolumeSlicer(app, vol)
+slicer = VolumeSlicer(app, vol)
 
 app.layout = html.Div([slicer.graph, slicer.slider, *slicer.stores])
 
 
 if __name__ == "__main__":
-    app.run_server(debug=False)
+    app.run_server(debug=True)

examples/slicer_with_1_plus_2_views.py

@@ -4,15 +4,15 @@
 
 import dash
 import dash_html_components as html
-from dash_3d_viewer import DashVolumeSlicer
+from dash_slicer import VolumeSlicer
 import imageio
 
 
 app = dash.Dash(__name__)
 
 vol = imageio.volread("imageio:stent.npz")
-slicer1 = DashVolumeSlicer(app, vol, axis=1)
-slicer2 = DashVolumeSlicer(app, vol, axis=2)
+slicer1 = VolumeSlicer(app, vol, axis=1)
+slicer2 = VolumeSlicer(app, vol, axis=2)
 
 app.layout = html.Div(
     style={

examples/slicer_with_1_view.py

@@ -7,17 +7,17 @@
 import dash
 import dash_html_components as html
 import dash_core_components as dcc
-from dash_3d_viewer import DashVolumeSlicer
+from dash_slicer import VolumeSlicer
 from skimage.measure import marching_cubes
 import imageio
 
 app = dash.Dash(__name__)
 
 # Read volumes and create slicer objects
 vol = imageio.volread("imageio:stent.npz")
-slicer1 = DashVolumeSlicer(app, vol, reverse_y=False, axis=0)
-slicer2 = DashVolumeSlicer(app, vol, reverse_y=False, axis=1)
-slicer3 = DashVolumeSlicer(app, vol, reverse_y=False, axis=2)
+slicer1 = VolumeSlicer(app, vol, reverse_y=False, axis=0)
+slicer2 = VolumeSlicer(app, vol, reverse_y=False, axis=1)
+slicer3 = VolumeSlicer(app, vol, reverse_y=False, axis=2)
 
 # Calculate isosurface and create a figure with a mesh object
 verts, faces, _, _ = marching_cubes(vol, 300, step_size=2)
@@ -68,4 +68,4 @@
 
 
 if __name__ == "__main__":
-    app.run_server(debug=False)
+    app.run_server(debug=True)

examples/slicer_with_2_views.py

@@ -6,14 +6,14 @@
 import dash
 import dash_html_components as html
 from dash.dependencies import Input, Output, State
-from dash_3d_viewer import DashVolumeSlicer
+from dash_slicer import VolumeSlicer
 import imageio
 
 
 app = dash.Dash(__name__)
 
 vol = imageio.volread("imageio:stent.npz")
-slicer = DashVolumeSlicer(app, vol)
+slicer = VolumeSlicer(app, vol)
 
 # We can access the components, and modify them
 slicer.slider.value = 0