convergence and residuum plot titles

Author: otvam

examples/config/plotter.yaml

@@ -57,16 +57,18 @@
 #       - arrow_scale: relative arrow length (with respect to the voxel size)
 #
 #   - "convergence": plot the convergence of the iterative matrix solver (matplotlib)
+#       - title: title located at the top of the plot (null for hiding)
 #       - color_active: color of the plot for the active power
 #       - color_reactive: color of the plot for the reactive power
 #       - marker: plot marker size
 #       - width: line line width
 #
 #   - "convergence": plot the solver residuum histogram (matplotlib)
-#       - n_bins: number of bins
-#       - tol_bins: relative tolerance for the bin boundaries
+#       - title: title located at the top of the plot (null for hiding)
 #       - bar_color: fill color of the bins
 #       - edge_color: "edge color of the bins
+#       - tol_bins: relative tolerance for the bin boundaries
+#       - n_bins: number of bins for the residuum histogram
 #
 # Thomas Guillod - Dartmouth College
 # Mozilla Public License Version 2.0
@@ -246,6 +248,7 @@
     "data_window": !include cfg_data_window.yaml
     "data_options": !include cfg_data_matplotlib.yaml
     "data_plot":
+        "title": "Convergence"
         "color_active": "red"
         "color_reactive": "blue"
         "marker": 8.0
@@ -256,7 +259,8 @@
     "data_window": !include cfg_data_window.yaml
     "data_options": !include cfg_data_matplotlib.yaml
     "data_plot":
-        "n_bins": 10
-        "tol_bins": 0.05
+        "title": "Residuum"
         "bar_color": "blue"
         "edge_color": "black"
+        "tol_bins": 0.05
+        "n_bins": 10

pypeec/data/schema_list_plotter.yaml

@@ -35,11 +35,17 @@
 "data_plot_convergence": &data_plot_convergence
     "type": "object"
     "required":
+        - "title"
         - "color_active"
         - "color_reactive"
         - "marker"
         - "width"
     properties:
+        "title":
+            "type":
+                - "null"
+                - "string"
+            "minLength": 1
         "color_active":
             "type": "string"
             "minLength": 1
@@ -57,11 +63,17 @@
 "data_plot_residuum": &data_plot_residuum
     "type": "object"
     "required":
+        - "title"
         - "bar_color"
         - "edge_color"
         - "tol_bins"
         - "n_bins"
     properties:
+        "title":
+            "type":
+                - "null"
+                - "string"
+            "minLength": 1
         "bar_color":
             "type": "string"
             "minLength": 1

pypeec/lib_plot/manage_matplotlib.py

@@ -20,6 +20,7 @@ def _get_plot_residuum(fig, res, data_plot):
     """
 
     # extract the data
+    title = data_plot["title"]
     n_bins = data_plot["n_bins"]
     tol_bins = data_plot["tol_bins"]
     bar_color = data_plot["bar_color"]
@@ -28,10 +29,6 @@ def _get_plot_residuum(fig, res, data_plot):
     # activate the figure
     plt.figure(fig)
 
-    # get rms
-    n_dof = len(res)
-    res_rms = np.sqrt(np.mean(np.abs(res) ** 2))
-
     # get absolute value
     res_abs = np.abs(res)
 
@@ -56,7 +53,8 @@ def _get_plot_residuum(fig, res, data_plot):
     plt.grid()
     plt.xlabel("residuum (a.u.)")
     plt.ylabel("counts (a.u.)")
-    plt.title("Residuum / n_dof = %d / res_rms = %.2e" % (n_dof, res_rms))
+    if title is not None:
+        plt.title(title)
 
 
 def _get_plot_convergence(fig, conv, data_plot):
@@ -65,6 +63,7 @@ def _get_plot_convergence(fig, conv, data_plot):
     """
 
     # extract the data
+    title = data_plot["title"]
     color_active = data_plot["color_active"]
     color_reactive = data_plot["color_reactive"]
     marker = data_plot["marker"]
@@ -102,7 +101,8 @@ def _get_plot_convergence(fig, conv, data_plot):
     plt.legend()
     plt.xlabel("iterations (#)")
     plt.ylabel("convergence (a.u.)")
-    plt.title(f"Convergence: S = {power_final:.2e} VA")
+    if title is not None:
+        plt.title(title)
 
 
 def get_plot_plotter(fig, res, conv, layout, data_plot, data_options):