Merge pull request #673 from edwinsupple/fix-scalebar-bug

Adjust scalebar logic to combine any specified parameters with defaults

py4DSTEM/visualize/show.py

@@ -186,7 +186,7 @@ def show(
         and
 
             >>> show(dp, calibration=calibration, scalebar={'length':0.5,'width':2,
-                                                       'position':'ul','label':True'})
+                                                       'position':'ul','label':True})
 
         will display a more customized scalebar.
 
@@ -316,7 +316,7 @@ def show(
         if returnfig==False (default), the figure is plotted and nothing is returned.
         if returnfig==True, return the figure and the axis.
     """
-    if scalebar is True:
+    if scalebar is True or scalebar is None:
         scalebar = {}
 
     # Alias dep
@@ -428,25 +428,31 @@ def show(
             er = ".calibration attribute must be a Calibration instance"
             assert isinstance(cal, Calibration), er
             if isinstance(ar, DiffractionSlice):
-                scalebar = {
+                defaultscalebar = {
                     "Nx": ar.data.shape[0],
                     "Ny": ar.data.shape[1],
                     "pixelsize": cal.get_Q_pixel_size(),
                     "pixelunits": cal.get_Q_pixel_units(),
                     "space": "Q",
                     "position": "br",
                 }
+                for key, value in defaultscalebar.items():
+                    if key not in scalebar.keys():
+                        scalebar[key] = value
                 pixelsize = cal.get_Q_pixel_size()
                 pixelunits = cal.get_Q_pixel_units()
             elif isinstance(ar, RealSlice):
-                scalebar = {
+                defaultscalebar = {
                     "Nx": ar.data.shape[0],
                     "Ny": ar.data.shape[1],
                     "pixelsize": cal.get_R_pixel_size(),
                     "pixelunits": cal.get_R_pixel_units(),
                     "space": "Q",
                     "position": "br",
                 }
+                for key, value in defaultscalebar.items():
+                    if key not in scalebar.keys():
+                        scalebar[key] = value
                 pixelsize = cal.get_R_pixel_size()
                 pixelunits = cal.get_R_pixel_units()
         # get the data