[j.748] Plot statement bp.show_or_export() or plt.show() no longer implied by...

[j.748] Plot statement bp.show_or_export() or plt.show() no longer implied by high-level plot fcts (#748) (Closes #748)

Merging branch 'j.748'  into 'main'.

See merge request !1999

CHANGELOG

@@ -8,10 +8,11 @@ BornAgain-22.0, in preparation
     * SphericalDetector is obsolete. For 2D scattering, use FlatDetector as shown in examples.
     * Offspec analyzer is set for detector, not scan(#651)
     * FitObjective::addSimulationAndData has been replaced by function addFitPair,
-      which takes experimental data in form of a Datafield object instead of a NumPy array.
+      which takes experimental data in form of a Datafield object instead of a NumPy array
     * Function ba_plot.plot_histogram is replaced by plot_simulation_result.
     * Conversion of plot axes from default to other units now done by functions
-      FlatDetector::field2q, field2mm, field2angles.
+      FlatDetector::field2q, field2mm, field2angles
+    * Plot statement bp.show_or_export() or plt.show() no longer implied by high-level plot fcts
   > GUI changes:
     * Examples DepthProfile, Transmission: flattened DepthProbeSimulation
   > Examples and documentation:

Wrap/Python/ba_plot.py

@@ -440,6 +440,8 @@ def parse_args(**kwargs):
 
 
 def show_or_export():
+    if do_show or figfile: # skip in test mode, saves about 0.2 s
+        plt.tight_layout()
     if figfile:
         plt.savefig(figfile, format=saveformat, bbox_inches='tight')
     if do_show:
@@ -462,10 +464,6 @@ def plot_simulation_result(result):
         plot_specular_curve(result, **plotargs)
     else:
         plot_simres(result, **plotargs)
-    if do_show or figfile: # skip in test mode, saves about 0.2 s
-        plt.tight_layout()
-
-    show_or_export()
 
 
 def make_plot_row(results):
@@ -515,13 +513,14 @@ def make_plot(results, ncol):
 
     multiPlot.plot_colorlegend(im)
 
-    show_or_export()
 
+def plot_multicurve_specular(results):
+    raise Exception("Function bp.plot_multicurve_specular has become bp.plot_multicurve in BornAgain 22")
 
-def plot_multicurve(pfields, xlabel, ylabel):
-    """
-    Plots any number of xy curves into one frame.
-    """
+
+def plot_multicurve(results):
+    plt.yscale('log')
+    pfields = [result.plottableField() for result in results]
     if datfile:
         save_results(pfields, datfile)
 
@@ -534,20 +533,11 @@ def plot_multicurve(pfields, xlabel, ylabel):
 
     inside_ticks()
 
-    plt.xlabel(xlabel)
-    plt.ylabel(ylabel)
+    plt.xlabel(get_axes_labels(pfields[0])[0])
+    plt.ylabel(r'Intensity')
 
     plt.legend(legend, loc=plotargs.pop('legendloc', 'upper right'))
 
-    show_or_export()
-
-
-def plot_multicurve_specular(results):
-    plt.yscale('log')
-    pfields = [result.plottableField() for result in results]
-    xlabel = get_axes_labels(pfields[0])[0]
-    plot_multicurve(pfields, xlabel, r'Intensity')
-
 #  **************************************************************************  #
 #  global settings
 #  **************************************************************************  #

auto/Examples/ff/Sphere.py

@@ -22,3 +22,4 @@ if __name__ == '__main__':
     result = simulation.simulate()
 
     bp.plot_simulation_result(result)
+    bp.show_or_export()

auto/Examples/offspec/Offspec1.py

@@ -59,3 +59,4 @@ if __name__ == '__main__':
     simulation = get_simulation(sample)
     result = simulation.simulate()
     bp.plot_simulation_result(result)
+    bp.show_or_export()

auto/Examples/offspec/OffspecLambda.py

@@ -59,3 +59,4 @@ if __name__ == '__main__':
     simulation = get_simulation(sample)
     result = simulation.simulate()
     bp.plot_simulation_result(result)
+    bp.show_or_export()

auto/Examples/offspec/OffspecResolved.py

@@ -58,3 +58,4 @@ if __name__ == '__main__':
     sum = result.npArray().sum()
     print(f'sum = {sum/1e9}')
     bp.plot_simulation_result(result)
+    bp.show_or_export()

auto/Examples/scatter2d/ApproximationDA.py

@@ -63,3 +63,4 @@ if __name__ == '__main__':
     simulation = get_simulation(sample)
     result = simulation.simulate()
     bp.plot_simulation_result(result)
+    bp.show_or_export()

auto/Examples/scatter2d/ApproximationLMA.py

@@ -70,3 +70,4 @@ if __name__ == '__main__':
     simulation = get_simulation(sample)
     result = simulation.simulate()
     bp.plot_simulation_result(result)
+    bp.show_or_export()

auto/Examples/scatter2d/ApproximationSSCA.py

@@ -64,3 +64,4 @@ if __name__ == '__main__':
     simulation = get_simulation(sample)
     result = simulation.simulate()
     bp.plot_simulation_result(result)
+    bp.show_or_export()

auto/Examples/scatter2d/BeamDivergence.py

@@ -33,3 +33,4 @@ if __name__ == '__main__':
     simulation = get_simulation(sample)
     result = simulation.simulate()
     bp.plot_simulation_result(result)
+    bp.show_or_export()

auto/Examples/scatter2d/BiMaterialCylinders.py

@@ -67,3 +67,4 @@ if __name__ == '__main__':
     simulation = get_simulation(sample)
     result = simulation.simulate()
     bp.plot_simulation_result(result)
+    bp.show_or_export()

auto/Examples/scatter2d/BoxesWithSpecularPeak.py

@@ -60,3 +60,4 @@ if __name__ == '__main__':
     simulation = get_simulation(sample)
     result = simulation.simulate()
     bp.plot_simulation_result(result)
+    bp.show_or_export()

auto/Examples/scatter2d/ConstantBackground.py

@@ -26,3 +26,4 @@ if __name__ == '__main__':
     simulation = get_simulation(sample)
     result = simulation.simulate()
     bp.plot_simulation_result(result)
+    bp.show_or_export()

auto/Examples/scatter2d/CoreShellNanoparticles.py

@@ -40,3 +40,4 @@ if __name__ == '__main__':
     simulation = get_simulation(sample)
     result = simulation.simulate()
     bp.plot_simulation_result(result)
+    bp.show_or_export()

auto/Examples/scatter2d/CoreShellNanoparticles2.py

@@ -43,3 +43,4 @@ if __name__ == '__main__':
     simulation = get_simulation(sample)
     result = simulation.simulate()
     bp.plot_simulation_result(result)
+    bp.show_or_export()

auto/Examples/scatter2d/CorrelatedRoughness.py

@@ -54,3 +54,4 @@ if __name__ == '__main__':
     simulation = get_simulation(sample)
     result = simulation.simulate()
     bp.plot_simulation_result(result)
+    bp.show_or_export()

auto/Examples/scatter2d/CosineRipplesAtRectLattice.py

@@ -63,3 +63,4 @@ if __name__ == '__main__':
     simulation = get_simulation(sample)
     result = simulation.simulate()
     bp.plot_simulation_result(result)
+    bp.show_or_export()

auto/Examples/scatter2d/CustomFormFactor.py

@@ -88,3 +88,4 @@ if __name__ == '__main__':
     simulation = get_simulation(sample)
     result = simulation.simulate()
     bp.plot_simulation_result(result)
+    bp.show_or_export()

auto/Examples/scatter2d/Cylinders.py

@@ -33,3 +33,4 @@ if __name__ == '__main__':
     simulation = get_simulation(sample)
     result = simulation.simulate()
     bp.plot_simulation_result(result)
+    bp.show_or_export()

auto/Examples/scatter2d/CylindersAndPrisms.py

@@ -54,3 +54,4 @@ if __name__ == '__main__':
     sample = get_sample()
     simulation = get_simulation(sample)
     bp.plot_simulation_result(simulation.simulate())
+    bp.show_or_export()