-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add blit manager to manage overlay artists
The blit manager was modified from this example: https://matplotlib.org/stable/users/explain/animations/blitting.html It is being used to automatically manage things like updating the background image, updating the blit artists, etc. We are now using it to manage the overlay artists, including drawing them and removing them. Blitting the overlay artists provides a *significant* performance boost when we modify parameters that only require the overlay artists to be redrawn. Especially when we have a high resolution in any of the views (other than raw, which doesn't have a resolution). For example, the sliders for the Laue parameters are significantly more interactive now. And this provides a great opportunity for us to boost performance for the pressure sliders too. Signed-off-by: Patrick Avery <[email protected]>
- Loading branch information
Showing
2 changed files
with
131 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| from collections.abc import Sequence, ValuesView | ||
|
|
||
| from matplotlib.artist import Artist | ||
|
|
||
|
|
||
| class BlitManager: | ||
| def __init__(self, canvas): | ||
| """ | ||
| Parameters | ||
| ---------- | ||
| canvas : FigureCanvasAgg | ||
| The canvas to work with. The background will be cached when needed. | ||
| This class was modified from here: | ||
| https://matplotlib.org/stable/users/explain/animations/blitting.html | ||
| """ | ||
| self.canvas = canvas | ||
| self.bg = None | ||
|
|
||
| # This dict can contain nested dicts, lists, etc. | ||
| # But all non-container values must be artists. | ||
| # We will find them recursively. | ||
| self.artists = {} | ||
|
|
||
| # grab the background on every draw | ||
| self.cid = canvas.mpl_connect("draw_event", self.on_draw) | ||
|
|
||
| def disconnect(self): | ||
| self.remove_all_artists() | ||
|
|
||
| if self.cid is not None: | ||
| self.mpl_disconnect(self.cid) | ||
| self.cid = None | ||
|
|
||
| def on_draw(self, event): | ||
| """Callback to register with 'draw_event'.""" | ||
| cv = self.canvas | ||
| if event is not None: | ||
| if event.canvas != cv: | ||
| msg = ( | ||
| f'Event canvas "{event.canvas}" does not match the ' | ||
| f'manager canvas "{cv}"' | ||
| ) | ||
| raise RuntimeError(msg) | ||
|
|
||
| self.bg = cv.copy_from_bbox(cv.figure.bbox) | ||
| self.draw_all_artists() | ||
|
|
||
| def remove_artists(self, *path): | ||
| # The *path is an arbitrary path into the artist dict | ||
| parent = None | ||
| d = self.artists | ||
| for key in path: | ||
| if key not in d: | ||
| # It already doesn't exist. Just return. | ||
| return | ||
|
|
||
| parent = d | ||
| d = d[key] | ||
|
|
||
| for artist in _recursive_yield_artists(d): | ||
| artist.remove() | ||
|
|
||
| if parent: | ||
| del parent[key] | ||
| else: | ||
| self.artists.clear() | ||
|
|
||
| def draw_all_artists(self): | ||
| """Draw all of the animated artists.""" | ||
| fig = self.canvas.figure | ||
| for artist in _recursive_yield_artists(self.artists): | ||
| fig.draw_artist(artist) | ||
|
|
||
| def update(self): | ||
| """Update the screen with animated artists.""" | ||
| cv = self.canvas | ||
| fig = cv.figure | ||
|
|
||
| # paranoia in case we missed the draw event, | ||
| if self.bg is None: | ||
| self.on_draw(None) | ||
| else: | ||
| # restore the background | ||
| cv.restore_region(self.bg) | ||
| # draw all of the animated artists | ||
| self.draw_all_artists() | ||
| # update the GUI state | ||
| cv.blit(fig.bbox) | ||
|
|
||
| # let the GUI event loop process anything it has to do | ||
| cv.flush_events() | ||
|
|
||
|
|
||
| def _recursive_yield_artists(artists): | ||
| if isinstance(artists, dict): | ||
| yield from _recursive_yield_artists(artists.values()) | ||
| elif isinstance(artists, (Sequence, ValuesView)): | ||
| for v in artists: | ||
| if isinstance(v, Artist): | ||
| yield v | ||
| else: | ||
| yield from _recursive_yield_artists(v) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters