Return figure and dataframe after dose vis

pyplati · Jan 22, 2023 · 437d8ab · 437d8ab
1 parent 9e3b64c
commit 437d8ab
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 227 deletions.
diff --git a/examples/dvh_analysis.ipynb b/examples/dvh_analysis.ipynb
diff --git a/platipy/imaging/visualisation/dose.py b/platipy/imaging/visualisation/dose.py
@@ -91,6 +91,10 @@ def visualise_dose(
             Defaults to None.
         img_vis_kw (dict, optional): Dictionary of keyword arguments to pass to ImageVisualiser.
             Defaults to None.
+
+    Returns:
+        matplotlib.figure: The figure, can be saved as usual (fig.savefig(...)).
+        pd.DataFrame: The dose metrics computed for display in the table.
     """
 
     if img_vis_kw is None:
@@ -243,3 +247,6 @@ def visualise_dose(
         wrap=True,
         weight="bold",
     )
+
+    # Return the figure
+    return fig, df_metrics