Improve performance (#26)

* set debug false

* black

* only disable specific debug option

* add note about performance

Author: almarklein

dash_slicer/slicer.py

@@ -50,6 +50,10 @@ class VolumeSlicer:
 
     The value in the store must be an 3-element tuple (x, y, z) in scene coordinates.
     To apply the position for one position only, use e.g ``(None, None, x)``.
+
+    Some notes on performance: for a smooth experience, create the `Dash`
+    application with `update_title=None`, and when running the server in debug
+    mode, consider setting `dev_tools_props_check=False`.
     """
 
     _global_slicer_counter = 0

examples/bring_your_own_slider.py

@@ -51,4 +51,5 @@ def handle_dropdown_input(index):
 
 
 if __name__ == "__main__":
-    app.run_server(debug=True)
+    # Note: dev_tools_props_check negatively affects the performance of VolumeSlicer
+    app.run_server(debug=True, dev_tools_props_check=False)

examples/slicer_customized.py

@@ -76,4 +76,5 @@ def handle_button_input(press1, press2, index):
 
 
 if __name__ == "__main__":
-    app.run_server(debug=True)
+    # Note: dev_tools_props_check negatively affects the performance of VolumeSlicer
+    app.run_server(debug=True, dev_tools_props_check=False)

examples/slicer_with_1_plus_2_views.py

@@ -74,4 +74,5 @@
 
 
 if __name__ == "__main__":
-    app.run_server(debug=True)
+    # Note: dev_tools_props_check negatively affects the performance of VolumeSlicer
+    app.run_server(debug=True, dev_tools_props_check=False)

examples/slicer_with_1_view.py

@@ -8,7 +8,7 @@
 import imageio
 
 
-app = dash.Dash(__name__)
+app = dash.Dash(__name__, update_title=None)
 
 vol = imageio.volread("imageio:stent.npz")
 slicer = VolumeSlicer(app, vol)
@@ -17,4 +17,5 @@
 
 
 if __name__ == "__main__":
-    app.run_server(debug=True)
+    # Note: dev_tools_props_check negatively affects the performance of VolumeSlicer
+    app.run_server(debug=True, dev_tools_props_check=False)

examples/slicer_with_2_views.py

@@ -43,4 +43,5 @@
 
 
 if __name__ == "__main__":
-    app.run_server(debug=True)
+    # Note: dev_tools_props_check negatively affects the performance of VolumeSlicer
+    app.run_server(debug=True, dev_tools_props_check=False)

examples/slicer_with_3_views.py

@@ -69,4 +69,5 @@
 
 
 if __name__ == "__main__":
-    app.run_server(debug=True)
+    # Note: dev_tools_props_check negatively affects the performance of VolumeSlicer
+    app.run_server(debug=True, dev_tools_props_check=False)

examples/threshold_overlay.py

@@ -62,4 +62,5 @@ def apply_levels(level):
 
 
 if __name__ == "__main__":
-    app.run_server(debug=True)
+    # Note: dev_tools_props_check negatively affects the performance of VolumeSlicer
+    app.run_server(debug=True, dev_tools_props_check=False)

tests/performance1.py

@@ -146,4 +146,5 @@
 
 
 if __name__ == "__main__":
-    app.run_server(debug=True)
+    # Note that the dev_tools_props_check negatively affects performance
+    app.run_server(debug=True, dev_tools_props_check=False)

tests/peformance2.py renamed to tests/performance2.py

@@ -52,6 +52,7 @@
         html.Br(),
         dcc.Graph(id="graph", figure=fig),
         dcc.Store(id="index", data=0),
+        dcc.Store(id="trace", data=None),
         dcc.Store(id="data_png", data=slices_png),
     ]
 )
@@ -72,7 +73,19 @@
 
 app.clientside_callback(
     """
-function update_figure(index, ori_figure, data_png) {
+function update_trace(index, data_png) {
+    return {type: 'image', source: data_png[index]};
+}
+""",
+    Output("trace", "data"),
+    [Input("index", "data")],
+    [State("data_png", "data")],
+)
+
+
+app.clientside_callback(
+    """
+function update_figure(trace, ori_figure) {
 
     // Get FPS
     let fps_result = dash_clientside.no_update;
@@ -91,13 +104,11 @@
     let figure_result = dash_clientside.no_update;
 
     if (true) {
-        let trace = {type: 'image', source: data_png[index]};
         figure_result = {...ori_figure};
         figure_result.layout.yaxis.range = [128, 0];
         figure_result.data = [trace];
     } else {
         // unfavorable y-axis
-        let trace = {type: 'image', source: data_png[index]};
         figure_result = {...ori_figure};
         figure_result.layout.yaxis.range = [0, 128];
         figure_result.data = [trace];
@@ -106,16 +117,11 @@
 }
 """,
     [Output("graph", "figure"), Output("fps", "children")],
-    [
-        # Input("index", "data")],
-        Input("slider", "value")
-    ],
-    [
-        State("graph", "figure"),
-        State("data_png", "data"),
-    ],
+    [Input("trace", "data")],
+    [State("graph", "figure")],
 )
 
 
 if __name__ == "__main__":
-    app.run_server(debug=True)
+    # Note that the dev_tools_props_check negatively affects performance
+    app.run_server(debug=True, dev_tools_props_check=False)