Merge pull request #2947 from hakonanes/fix-show-progressbar-map

Respect `show_progressbar` parameter in `BaseSignal.map()`
hyperspy · May 26, 2022 · 90b0349 · 90b0349
2 parents dca10bd + 44fb3b0
commit 90b0349
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 4 deletions.
diff --git a/hyperspy/signal.py b/hyperspy/signal.py
@@ -30,6 +30,7 @@
 import warnings
 
 import dask.array as da
+from dask.diagnostics import ProgressBar
 from matplotlib import pyplot as plt
 import numpy as np
 from pint import UndefinedUnitError
@@ -52,7 +53,7 @@
     add_scalar_axis,
     DictionaryTreeBrowser,
     guess_output_signal_size,
-    is_binned, # remove in v2.0
+    is_binned,  # remove in v2.0
     is_cupy_array,
     isiterable,
     iterable_not_string,
@@ -66,9 +67,7 @@
 from hyperspy.drawing.utils import animate_legend
 from hyperspy.drawing.marker import markers_metadata_dict_to_markers
 from hyperspy.misc.slicing import SpecialSlicers, FancySlicing
-from hyperspy.misc.utils import (
-    _get_block_pattern
-    )
+from hyperspy.misc.utils import _get_block_pattern
 from hyperspy.docstrings.signal import (
     ONE_AXIS_PARAMETER, MANY_AXIS_PARAMETER, OUT_ARG, NAN_FUNC, OPTIMIZE_ARG,
     RECHUNK_ARG, SHOW_PROGRESSBAR_ARG, PARALLEL_ARG, MAX_WORKERS_ARG,
@@ -4898,6 +4897,9 @@ def map(
         else:
             kwargs["output_signal_size"] = output_signal_size
             kwargs["output_dtype"] = output_dtype
+            if show_progressbar is None:
+                from hyperspy.defaults_parser import preferences
+                show_progressbar = preferences.General.show_progressbar
             # Iteration over coordinates.
             result = self._map_iterate(
                 function,
@@ -5029,6 +5031,10 @@ def _map_iterate(
 
         data_stored = False
 
+        if show_progressbar:
+            pbar = ProgressBar()
+            pbar.register()
+
         if inplace:
             if (
                 not self._lazy
@@ -5075,6 +5081,9 @@ def _map_iterate(
         if not lazy_output and not data_stored:
             sig.data = sig.data.compute(num_workers=max_workers)
 
+        if show_progressbar:
+            pbar.unregister()
+
         return sig
 
     def _get_iterating_kwargs(self, iterating_kwargs):

diff --git a/upcoming_changes/2946.bugfix.rst b/upcoming_changes/2946.bugfix.rst
@@ -0,0 +1 @@
+Respect ``show_progressbar`` parameter in ``BaseSignal.map()``