此MATLAB类在命令窗口中提供了像tqdm这样的智能进度条，并针对简单itera中的进度信息进行了优化….zip

[](https://de.mathworks.com/matlabcentral/fileexchange/57895-matlabprogressbar) # MatlabProgressBar - [MatlabProgressBar](#matlabprogressbar) - [Dependencies](#dependencies) - [Installation](#installation) - [Usage](#usage) - [Proposed Usage for Simple Loops](#proposed-usage-for-simple-loops) - [Extended Usage with all Features](#extended-usage-with-all-features) - [Parallel Toolbox Support](#parallel-toolbox-support) - [Known Issues](#known-issues) - [Flickering Bar or Flooding of the Command Window](#flickering-bar-or-flooding-of-the-command-window) - [The Bar Gets Longer With Each Iteration](#the-bar-gets-longer-with-each-iteration) - [Strange Symbols in the Progress Bar](#strange-symbols-in-the-progress-bar) - [Remaining Timer Objects in MATLAB's Background](#remaining-timer-objects-in-matlabs-background) - [Issues Concerning Parallel Processing](#issues-concerning-parallel-processing) - [Unit Tests](#unit-tests) - [License](#license) This project hosts the source code to the [original MATLAB FileExchange project](https://de.mathworks.com/matlabcentral/fileexchange/57895-matlabprogressbar) and is place of active development. A drawback in MATLAB's own `waitbar()` function is the lack of some functionalities and the loss of speed due to the rather laggy GUI updating process. Therefore, this MATLAB class aims to provide a smart progress bar in the command window and is optimized for progress information in simple iterations or large frameworks with full support of parallel *parfor* loops and asynchronous processing via *parfeval()* provided by the MATLAB Parallel Computing Toolbox. A design target was to mimic the best features of the progress bar [tqdm](https://github.com/tqdm/tqdm) for Python. Thus, this project features a Unicode-based bar and some numeric information about the current progress and the average iterations per second. Several projects exist on MATLAB's [File Exchange](https://www.mathworks.com/matlabcentral/fileexchange/?term=progress+bar) but none incorporates the feature set shown below. That's why I decided to start this project.  **Supported features include (or are planned)**: - [x] proper unit testing - [x] display the bar name as a ticker. That way, a fixed bar width could be used - [x] inherit from MATLAB System Object to gain benefits from the setup method - [ ] use [this new functionality](https://de.mathworks.com/help/distcomp/send.html) for the parallel implementation. Introduced in R2017a. - [x] TQDM Unicode blocks - [x] optional constructor switch for ASCII number signs (hashes) - those will be used if `ProgressBar()` is used in deploy mode (MATLAB Compiler) - [x] optional bar title - [x] optional visual update interval in Hz [defaults to 10 Hz] - [x] when no total number of iterations is passed the bar shows the elapsed time, the number of (elapsed) iterations and iterations/s - [x] nested bars (at the moment only one nested bar is supported [one parent, one child]) - [x] `printMessage()` method for debug printing (or the like) - [x] print an info when a run was not successful - [x] support another meaningful 'total of something' measure where the number of items is less meaningful (for example non-uniform processing time) such as total file size (processing multiple files with different file size). At the moment, the only alternative supported unit is `Bytes` - [x] when the internal updating process is faster than the actual updates via `update()`, the internal counter and printing of the process bar stops until the next update to save processing time - [x] linear ETA estimate over all last iterations - [x] support parfor loops provided by the Parallel Computing Toolbox - [x] show s/it if it/sec < 1 - [x] override MATLAB's default non-UTF font if `OverrideDefaultFont` is `true`. This will switch the font for the command line to `Courier New` for the lifetime of the bar. Default is `false` - [x] disable the progress bar if `IsActive` is `false`. This will disable the functionality completely and can be used in situations in which the bar is not beneficial (e.g. if the bar is used in a sub-application of a processing cluster). Default is `true`. **Note**: Be sure to have a look at the [Known Issues](#known-issues) section for current known bugs and possible work-arounds. ## Dependencies No dependencies to toolboxes. The code has been tested with MATLAB R2016a, R2016b and R2020b on Windows 10, Xubuntu 16.04.2 LTS and Linux Mint 20. ## Installation Put the files `ProgressBar.m`, `progress.m` and `updateParallel.m` into your MATLAB path or the directory of your MATLAB project. ## Usage Detailed information and examples about all features of `ProgressBar` are stated in the demo scripts in the `./demos/` directory. ### Proposed Usage for Simple Loops The simplest use in `for`-loops is to use the `progress()` function. It wraps the main `ProgressBar` class and is intended to only support the usual progress bar. Be aware that functionalities like `printMessage()`, printing success information or a step size different to 1 are not supported with `progress.m`. Also, this only works for **non-parallel** loops. See the example below: ```matlab numIterations = 10e3; % create the loop using the progress() class for iIteration = progress(1:numIterations) % do some processing end ```  ### Extended Usage with all Features The basic work flow is to instantiate a `ProgressBar` object and use either the `step()` method to update the progress state (MATLAB <= R2015b) or use the instantiated object directly as seen below. Refer to the method's help for information about input parameters. The shown call is the *default* call and sufficient. If you want to pass information about the step size, the iteration's success or if a new bar should be printed immediately (e.g. when iterations take long time) you can pass these information instead of empty matrices. All settings are done using *name-value* pairs in the constructor. It is **strongly encouraged** to call the object's `release()` method after the loop is finished to clean up the internal state and avoid possibly unrobust behavior of following progress bars. *Usage* `obj = ProgressBar(totalIterations, varargin)` A simple but quite common example looks like this: ```matlab numIterations = 10e3; % instantiate an object with an optional title and an update % rate of 5 Hz, i.e. 5 bar updates per seconds, to save % printing load. progBar = ProgressBar(... numIterations, ... 'Title', 'Awesome Computation' ... ); % begin the actual loop and update the object's progress % state for iIteration = 1:numIterations %%% do some processing here % ... progBar([], [], []); % or in releases <= R2015b % progBar.step([], [], []); end % call the 'release()' method to clean up progBar.release(); ```  ### Parallel Toolbox Support If you use MATLAB's Parallel Computing Toolbox, refer to the following example or the demo file `k_parallelSetup.m`. Tested parallel functionalities are `parfor` and `parfeval()` for asynchronous processing. ```matlab numIterations = 10e3; % Instantiate the object with the 'IsParallel' switch set to true progBar = ProgressBar(numIterations, ... 'IsParallel', true, ... 'Title', 'Parallel Processing' ... ); % ALWAYS CALL THE SETUP() METHOD FIRST!!! progBar.setup([], [], []); parfor iIteration = 1:numIterations pause(0.1); % USE THIS FUNCTION AND NOT THE STEP() METHOD OF THE OBJECT!!! updateParallel([], pwd); end progBar.release(); ``` As of `v3.4.0`, you can also nest the loops so that the inner one uses a `parfor` loop. ## Known Issues ### Flick