hyperspy.external.progressbar module

hyperspy.external.progressbar.progressbar(*args, **kwargs)

Uses tqdm progressbar. This function exists for wrapping purposes only. Original docstring follows: —————————————-

Decorate an iterable object, returning an iterator which acts exactly like the original iterable, but prints a dynamically updating progressbar every time a value is requested.

iterable : iterable, optional

Iterable to decorate with a progressbar. Leave blank to manually manage the updates.

desc : str, optional

Prefix for the progressbar.

total : int, optional

The number of expected iterations. If unspecified, len(iterable) is used if possible. As a last resort, only basic progress statistics are displayed (no ETA, no progressbar). If gui is True and this parameter needs subsequent updating, specify an initial arbitrary large positive integer, e.g. int(9e9).

leave : bool, optional

If [default: True], keeps all traces of the progressbar upon termination of iteration.

file : io.TextIOWrapper or io.StringIO, optional

Specifies where to output the progress messages (default: sys.stderr). Uses file.write(str) and file.flush() methods.

ncols : int, optional

The width of the entire output message. If specified, dynamically resizes the progressbar to stay within this bound. If unspecified, attempts to use environment width. The fallback is a meter width of 10 and no limit for the counter and statistics. If 0, will not print any meter (only stats).

mininterval : float, optional

Minimum progress display update interval, in seconds [default: 0.1].

maxinterval : float, optional

Maximum progress display update interval, in seconds [default: 10]. Automatically adjusts miniters to correspond to mininterval after long display update lag. Only works if dynamic_miniters or monitor thread is enabled.

miniters : int, optional

Minimum progress display update interval, in iterations. If 0 and dynamic_miniters, will automatically adjust to equal mininterval (more CPU efficient, good for tight loops). If > 0, will skip display of specified number of iterations. Tweak this and mininterval to get very efficient loops. If your progress is erratic with both fast and slow iterations (network, skipping items, etc) you should set miniters=1.

ascii : bool, optional

If unspecified or False, use unicode (smooth blocks) to fill the meter. The fallback is to use ASCII characters 1-9 #.

disable : bool, optional

Whether to disable the entire progressbar wrapper [default: False]. If set to None, disable on non-TTY.

unit : str, optional

String that will be used to define the unit of each iteration [default: it].

unit_scale : bool or int or float, optional

If 1 or True, the number of iterations will be reduced/scaled automatically and a metric prefix following the International System of Units standard will be added (kilo, mega, etc.) [default: False]. If any other non-zero number, will scale total and n.

dynamic_ncols : bool, optional

If set, constantly alters ncols to the environment (allowing for window resizes) [default: False].

smoothing : float, optional

Exponential moving average smoothing factor for speed estimates (ignored in GUI mode). Ranges from 0 (average speed) to 1 (current/instantaneous speed) [default: 0.3].

bar_format : str, optional

Specify a custom bar string formatting. May impact performance. [default: ‘{l_bar}{bar}{r_bar}’], where l_bar=’{desc}: {percentage:3.0f}%|’ and r_bar=’| {n_fmt}/{total_fmt} [{elapsed}<{remaining}, ‘

‘{rate_fmt}{postfix}]’

Possible vars: l_bar, bar, r_bar, n, n_fmt, total, total_fmt,

percentage, rate, rate_fmt, rate_noinv, rate_noinv_fmt, rate_inv, rate_inv_fmt, elapsed, remaining, desc, postfix.

Note that a trailing “: ” is automatically removed after {desc} if the latter is empty.

initial : int, optional

The initial counter value. Useful when restarting a progress bar [default: 0].

position : int, optional

Specify the line offset to print this bar (starting from 0) Automatic if unspecified. Useful to manage multiple bars at once (eg, from threads).

postfix : dict or *, optional

Specify additional stats to display at the end of the bar. Calls set_postfix(**postfix) if possible (dict).

unit_divisor : float, optional

[default: 1000], ignored unless unit_scale is True.

gui : bool, optional

WARNING: internal parameter - do not use. Use tqdm_gui(…) instead. If set, will attempt to use matplotlib animations for a graphical output [default: False].

out : decorated iterator.