forked from matplotlib/matplotlib.github.com
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathanimation_api.html
More file actions
535 lines (497 loc) · 43.2 KB
/
animation_api.html
File metadata and controls
535 lines (497 loc) · 43.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>matplotlib.animation — Matplotlib 3.1.0 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../_static/gallery.css" type="text/css" />
<link rel="stylesheet" href="../_static/copybutton.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script>
<script type="text/javascript" src="../_static/copybutton.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.1.0 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html"
/>
<link rel="search" title="Search" href="../search.html"
/>
<link rel="top" title="Matplotlib 3.1.0 documentation" href="../index.html" />
<link rel="up" title="API Overview" href="index.html" />
<link rel="next" title="matplotlib.animation.Animation" href="_as_gen/matplotlib.animation.Animation.html" />
<link rel="prev" title="matplotlib.afm" href="afm_api.html" />
<link rel="canonical" href="https://matplotlib.org/3.1.0/api/animation_api.html" />
</head>
<body>
<div id="plotting-contest" style="padding: 6px; background-color: teal; color: white;">
<p style="margin: 0;">The 2019 SciPy John Hunter Excellence in Plotting Contest is accepting submissions!
<br />
<a href="https://docs.google.com/forms/d/e/1FAIpQLSe-_AnKvYSzeQWfNDRoXgW0vl7_8q6jj3QbLIac8eUcb9lSAA/viewform?usp=sf_link" style="font-weight: bold;">Apply by June 8th</a></p>
</div>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.1.0</span></div>
<img src="../_static/logo2.png" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="_as_gen/matplotlib.animation.Animation.html" title="matplotlib.animation.Animation"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="afm_api.html" title="matplotlib.afm"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../gallery/index.html">examples</a>| </li>
<li><a href="../tutorials/index.html">tutorials</a>| </li>
<li><a href="index.html">API</a>| </li>
<li><a href="../contents.html">contents</a> »</li>
<li><a href="index.html" accesskey="U">API Overview</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<h3><a href="../contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">matplotlib.animation</span></code></a><ul>
<li><a class="reference internal" href="#animation">Animation</a><ul>
<li><a class="reference internal" href="#funcanimation"><code class="docutils literal notranslate"><span class="pre">FuncAnimation</span></code></a><ul>
<li><a class="reference internal" href="#examples">Examples</a></li>
</ul>
</li>
<li><a class="reference internal" href="#artistanimation"><code class="docutils literal notranslate"><span class="pre">ArtistAnimation</span></code></a><ul>
<li><a class="reference internal" href="#id1">Examples</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#writer-classes">Writer Classes</a><ul>
<li><a class="reference internal" href="#id2">Examples</a></li>
</ul>
</li>
<li><a class="reference internal" href="#helper-classes">Helper Classes</a><ul>
<li><a class="reference internal" href="#animation-base-classes">Animation Base Classes</a></li>
<li><a class="reference internal" href="#writer-registry">Writer Registry</a></li>
<li><a class="reference internal" href="#writer-base-classes">Writer Base Classes</a><ul>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#inheritance-diagrams">Inheritance Diagrams</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">API Overview</a><ul>
<li>Previous: <a href="afm_api.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.afm</span></code></a></li>
<li>Next: <a href="_as_gen/matplotlib.animation.Animation.html" title="next chapter">matplotlib.animation.Animation</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="sidebar-pagesource" role="note" aria-label="source link"
style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">
<a href="../_sources/api/animation_api.rst.txt"
style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-matplotlib.animation">
<span id="matplotlib-animation"></span><h1><code class="docutils literal notranslate"><span class="pre">matplotlib.animation</span></code><a class="headerlink" href="#module-matplotlib.animation" title="Permalink to this headline">¶</a></h1>
<div class="contents local topic" id="table-of-contents">
<p class="topic-title first">Table of Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#animation" id="id3">Animation</a></li>
<li><a class="reference internal" href="#writer-classes" id="id4">Writer Classes</a></li>
<li><a class="reference internal" href="#helper-classes" id="id5">Helper Classes</a></li>
<li><a class="reference internal" href="#inheritance-diagrams" id="id6">Inheritance Diagrams</a></li>
</ul>
</div>
<div class="section" id="animation">
<h2><a class="toc-backref" href="#id3">Animation</a><a class="headerlink" href="#animation" title="Permalink to this headline">¶</a></h2>
<p>The easiest way to make a live animation in matplotlib is to use one of the
<a class="reference internal" href="_as_gen/matplotlib.animation.Animation.html#matplotlib.animation.Animation" title="matplotlib.animation.Animation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Animation</span></code></a> classes.</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.animation.Animation.html#matplotlib.animation.Animation" title="matplotlib.animation.Animation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Animation</span></code></a></td>
<td>This class wraps the creation of an animation using matplotlib.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.animation.FuncAnimation.html#matplotlib.animation.FuncAnimation" title="matplotlib.animation.FuncAnimation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FuncAnimation</span></code></a></td>
<td>Makes an animation by repeatedly calling a function <em>func</em>.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.animation.ArtistAnimation.html#matplotlib.animation.ArtistAnimation" title="matplotlib.animation.ArtistAnimation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ArtistAnimation</span></code></a></td>
<td>Animation using a fixed set of <code class="xref py py-obj docutils literal notranslate"><span class="pre">Artist</span></code> objects.</td>
</tr>
</tbody>
</table>
<p>In both cases it is critical to keep a reference to the instance
object. The animation is advanced by a timer (typically from the host
GUI framework) which the <a class="reference internal" href="_as_gen/matplotlib.animation.Animation.html#matplotlib.animation.Animation" title="matplotlib.animation.Animation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Animation</span></code></a> object holds the only reference
to. If you do not hold a reference to the <a class="reference internal" href="_as_gen/matplotlib.animation.Animation.html#matplotlib.animation.Animation" title="matplotlib.animation.Animation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Animation</span></code></a> object, it (and
hence the timers), will be garbage collected which will stop the
animation.</p>
<p>To save an animation to disk use <a class="reference internal" href="_as_gen/matplotlib.animation.Animation.html#matplotlib.animation.Animation.save" title="matplotlib.animation.Animation.save"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Animation.save</span></code></a> or <a class="reference internal" href="_as_gen/matplotlib.animation.Animation.html#matplotlib.animation.Animation.to_html5_video" title="matplotlib.animation.Animation.to_html5_video"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Animation.to_html5_video</span></code></a></p>
<p>See <a class="reference internal" href="#ani-writer-classes"><span class="std std-ref">Helper Classes</span></a> below for details about what movie formats are
supported.</p>
<div class="section" id="funcanimation">
<span id="func-animation"></span><h3><code class="docutils literal notranslate"><span class="pre">FuncAnimation</span></code><a class="headerlink" href="#funcanimation" title="Permalink to this headline">¶</a></h3>
<p>The inner workings of <a class="reference internal" href="_as_gen/matplotlib.animation.FuncAnimation.html#matplotlib.animation.FuncAnimation" title="matplotlib.animation.FuncAnimation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FuncAnimation</span></code></a> is more-or-less:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">for</span> <span class="n">d</span> <span class="ow">in</span> <span class="n">frames</span><span class="p">:</span>
<span class="n">artists</span> <span class="o">=</span> <span class="n">func</span><span class="p">(</span><span class="n">d</span><span class="p">,</span> <span class="o">*</span><span class="n">fargs</span><span class="p">)</span>
<span class="n">fig</span><span class="o">.</span><span class="n">canvas</span><span class="o">.</span><span class="n">draw_idle</span><span class="p">()</span>
<span class="n">fig</span><span class="o">.</span><span class="n">canvas</span><span class="o">.</span><span class="n">start_event_loop</span><span class="p">(</span><span class="n">interval</span><span class="p">)</span>
</pre></div>
</div>
<p>with details to handle 'blitting' (to dramatically improve the live
performance), to be non-blocking, not repeatedly start/stop the GUI
event loop, handle repeats, multiple animated axes, and easily save
the animation to a movie file.</p>
<p>'Blitting' is a <a class="reference external" href="https://en.wikipedia.org/wiki/Bit_blit">old technique</a> in computer graphics. The
general gist is to take an existing bit map (in our case a mostly
rasterized figure) and then 'blit' one more artist on top. Thus, by
managing a saved 'clean' bitmap, we can only re-draw the few artists
that are changing at each frame and possibly save significant amounts of
time. When we use blitting (by passing <code class="docutils literal notranslate"><span class="pre">blit=True</span></code>), the core loop of
<a class="reference internal" href="_as_gen/matplotlib.animation.FuncAnimation.html#matplotlib.animation.FuncAnimation" title="matplotlib.animation.FuncAnimation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FuncAnimation</span></code></a> gets a bit more complicated:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ax</span> <span class="o">=</span> <span class="n">fig</span><span class="o">.</span><span class="n">gca</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">update_blit</span><span class="p">(</span><span class="n">artists</span><span class="p">):</span>
<span class="n">fig</span><span class="o">.</span><span class="n">canvas</span><span class="o">.</span><span class="n">restore_region</span><span class="p">(</span><span class="n">bg_cache</span><span class="p">)</span>
<span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">artists</span><span class="p">:</span>
<span class="n">a</span><span class="o">.</span><span class="n">axes</span><span class="o">.</span><span class="n">draw_artist</span><span class="p">(</span><span class="n">a</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">figure</span><span class="o">.</span><span class="n">canvas</span><span class="o">.</span><span class="n">blit</span><span class="p">(</span><span class="n">ax</span><span class="o">.</span><span class="n">bbox</span><span class="p">)</span>
<span class="n">artists</span> <span class="o">=</span> <span class="n">init_func</span><span class="p">()</span>
<span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">artists</span><span class="p">:</span>
<span class="n">a</span><span class="o">.</span><span class="n">set_animated</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
<span class="n">fig</span><span class="o">.</span><span class="n">canvas</span><span class="o">.</span><span class="n">draw</span><span class="p">()</span>
<span class="n">bg_cache</span> <span class="o">=</span> <span class="n">fig</span><span class="o">.</span><span class="n">canvas</span><span class="o">.</span><span class="n">copy_from_bbox</span><span class="p">(</span><span class="n">ax</span><span class="o">.</span><span class="n">bbox</span><span class="p">)</span>
<span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">frames</span><span class="p">:</span>
<span class="n">artists</span> <span class="o">=</span> <span class="n">func</span><span class="p">(</span><span class="n">f</span><span class="p">,</span> <span class="o">*</span><span class="n">fargs</span><span class="p">)</span>
<span class="n">update_blit</span><span class="p">(</span><span class="n">artists</span><span class="p">)</span>
<span class="n">fig</span><span class="o">.</span><span class="n">canvas</span><span class="o">.</span><span class="n">start_event_loop</span><span class="p">(</span><span class="n">interval</span><span class="p">)</span>
</pre></div>
</div>
<p>This is of course leaving out many details (such as updating the
background when the figure is resized or fully re-drawn). However,
this hopefully minimalist example gives a sense of how <code class="docutils literal notranslate"><span class="pre">init_func</span></code>
and <code class="docutils literal notranslate"><span class="pre">func</span></code> are used inside of <a class="reference internal" href="_as_gen/matplotlib.animation.FuncAnimation.html#matplotlib.animation.FuncAnimation" title="matplotlib.animation.FuncAnimation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FuncAnimation</span></code></a> and the theory of how
'blitting' works.</p>
<p>The expected signature on <code class="docutils literal notranslate"><span class="pre">func</span></code> and <code class="docutils literal notranslate"><span class="pre">init_func</span></code> is very simple to
keep <a class="reference internal" href="_as_gen/matplotlib.animation.FuncAnimation.html#matplotlib.animation.FuncAnimation" title="matplotlib.animation.FuncAnimation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FuncAnimation</span></code></a> out of your book keeping and plotting logic, but
this means that the callable objects you pass in must know what
artists they should be working on. There are several approaches to
handling this, of varying complexity and encapsulation. The simplest
approach, which works quite well in the case of a script, is to define the
artist at a global scope and let Python sort things out. For example</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="kn">from</span> <span class="nn">matplotlib.animation</span> <span class="k">import</span> <span class="n">FuncAnimation</span>
<span class="n">fig</span><span class="p">,</span> <span class="n">ax</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">subplots</span><span class="p">()</span>
<span class="n">xdata</span><span class="p">,</span> <span class="n">ydata</span> <span class="o">=</span> <span class="p">[],</span> <span class="p">[]</span>
<span class="n">ln</span><span class="p">,</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">plot</span><span class="p">([],</span> <span class="p">[],</span> <span class="s1">'ro'</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">init</span><span class="p">():</span>
<span class="n">ax</span><span class="o">.</span><span class="n">set_xlim</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">2</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">pi</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">set_ylim</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="k">return</span> <span class="n">ln</span><span class="p">,</span>
<span class="k">def</span> <span class="nf">update</span><span class="p">(</span><span class="n">frame</span><span class="p">):</span>
<span class="n">xdata</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">frame</span><span class="p">)</span>
<span class="n">ydata</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">sin</span><span class="p">(</span><span class="n">frame</span><span class="p">))</span>
<span class="n">ln</span><span class="o">.</span><span class="n">set_data</span><span class="p">(</span><span class="n">xdata</span><span class="p">,</span> <span class="n">ydata</span><span class="p">)</span>
<span class="k">return</span> <span class="n">ln</span><span class="p">,</span>
<span class="n">ani</span> <span class="o">=</span> <span class="n">FuncAnimation</span><span class="p">(</span><span class="n">fig</span><span class="p">,</span> <span class="n">update</span><span class="p">,</span> <span class="n">frames</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">linspace</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">2</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">pi</span><span class="p">,</span> <span class="mi">128</span><span class="p">),</span>
<span class="n">init_func</span><span class="o">=</span><span class="n">init</span><span class="p">,</span> <span class="n">blit</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
</pre></div>
</div>
<p>The second method is to use <a class="reference external" href="https://docs.python.org/3/library/functools.html#functools.partial" title="(in Python v3.7)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">functools.partial</span></code></a> to 'bind' artists to
function. A third method is to use closures to build up the required
artists and functions. A fourth method is to create a class.</p>
<div class="section" id="examples">
<h4>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h4>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../gallery/animation/animate_decay.html">Decay</a></li>
<li class="toctree-l1"><a class="reference internal" href="../gallery/animation/bayes_update.html">The Bayes update</a></li>
<li class="toctree-l1"><a class="reference internal" href="../gallery/animation/double_pendulum_sgskip.html">The double pendulum problem</a></li>
<li class="toctree-l1"><a class="reference internal" href="../gallery/animation/animated_histogram.html">Animated histogram</a></li>
<li class="toctree-l1"><a class="reference internal" href="../gallery/animation/rain.html">Rain simulation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../gallery/animation/random_walk.html">Animated 3D random walk</a></li>
<li class="toctree-l1"><a class="reference internal" href="../gallery/animation/simple_anim.html">Animated line plot</a></li>
<li class="toctree-l1"><a class="reference internal" href="../gallery/animation/strip_chart.html">Oscilloscope</a></li>
<li class="toctree-l1"><a class="reference internal" href="../gallery/animation/unchained.html">MATPLOTLIB <strong>UNCHAINED</strong></a></li>
</ul>
</div>
</div>
</div>
<div class="section" id="artistanimation">
<h3><code class="docutils literal notranslate"><span class="pre">ArtistAnimation</span></code><a class="headerlink" href="#artistanimation" title="Permalink to this headline">¶</a></h3>
<div class="section" id="id1">
<h4>Examples<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h4>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../gallery/animation/dynamic_image.html">Animated image using a precomputed list of images</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="section" id="writer-classes">
<h2><a class="toc-backref" href="#id4">Writer Classes</a><a class="headerlink" href="#writer-classes" title="Permalink to this headline">¶</a></h2>
<p>The provided writers fall into a few broad categories.</p>
<p>The Pillow writer relies on the Pillow library to write the animation, keeping
all data in memory.</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.animation.PillowWriter.html#matplotlib.animation.PillowWriter" title="matplotlib.animation.PillowWriter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PillowWriter</span></code></a></td>
<td></td>
</tr>
</tbody>
</table>
<p>The pipe-based writers stream the captured frames over a pipe to an external
process. The pipe-based variants tend to be more performant, but may not work
on all systems.</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.animation.FFMpegWriter.html#matplotlib.animation.FFMpegWriter" title="matplotlib.animation.FFMpegWriter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FFMpegWriter</span></code></a></td>
<td>Pipe-based ffmpeg writer.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.animation.ImageMagickWriter.html#matplotlib.animation.ImageMagickWriter" title="matplotlib.animation.ImageMagickWriter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ImageMagickWriter</span></code></a></td>
<td>Pipe-based animated gif.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.animation.AVConvWriter.html#matplotlib.animation.AVConvWriter" title="matplotlib.animation.AVConvWriter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AVConvWriter</span></code></a></td>
<td>Pipe-based avconv writer.</td>
</tr>
</tbody>
</table>
<p>The file-based writers save temporary files for each frame which are stitched
into a single file at the end. Although slower, these writers can be easier to
debug.</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.animation.FFMpegFileWriter.html#matplotlib.animation.FFMpegFileWriter" title="matplotlib.animation.FFMpegFileWriter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FFMpegFileWriter</span></code></a></td>
<td>File-based ffmpeg writer.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.animation.ImageMagickFileWriter.html#matplotlib.animation.ImageMagickFileWriter" title="matplotlib.animation.ImageMagickFileWriter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ImageMagickFileWriter</span></code></a></td>
<td>File-based animated gif writer.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.animation.AVConvFileWriter.html#matplotlib.animation.AVConvFileWriter" title="matplotlib.animation.AVConvFileWriter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AVConvFileWriter</span></code></a></td>
<td>File-based avconv writer.</td>
</tr>
</tbody>
</table>
<p>Fundamentally, a <a class="reference internal" href="_as_gen/matplotlib.animation.MovieWriter.html#matplotlib.animation.MovieWriter" title="matplotlib.animation.MovieWriter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MovieWriter</span></code></a> provides a way to grab sequential frames
from the same underlying <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a> object. The base
class <a class="reference internal" href="_as_gen/matplotlib.animation.MovieWriter.html#matplotlib.animation.MovieWriter" title="matplotlib.animation.MovieWriter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MovieWriter</span></code></a> implements 3 methods and a context manager. The
only difference between the pipe-based and file-based writers is in the
arguments to their respective <code class="docutils literal notranslate"><span class="pre">setup</span></code> methods.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">setup()</span></code> method is used to prepare the writer (possibly opening
a pipe), successive calls to <code class="docutils literal notranslate"><span class="pre">grab_frame()</span></code> capture a single frame
at a time and <code class="docutils literal notranslate"><span class="pre">finish()</span></code> finalizes the movie and writes the output
file to disk. For example</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">moviewriter</span> <span class="o">=</span> <span class="n">MovieWriter</span><span class="p">(</span><span class="o">...</span><span class="p">)</span>
<span class="n">moviewriter</span><span class="o">.</span><span class="n">setup</span><span class="p">(</span><span class="n">fig</span><span class="o">=</span><span class="n">fig</span><span class="p">,</span> <span class="s1">'my_movie.ext'</span><span class="p">,</span> <span class="n">dpi</span><span class="o">=</span><span class="mi">100</span><span class="p">)</span>
<span class="k">for</span> <span class="n">j</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">n</span><span class="p">):</span>
<span class="n">update_figure</span><span class="p">(</span><span class="n">n</span><span class="p">)</span>
<span class="n">moviewriter</span><span class="o">.</span><span class="n">grab_frame</span><span class="p">()</span>
<span class="n">moviewriter</span><span class="o">.</span><span class="n">finish</span><span class="p">()</span>
</pre></div>
</div>
<p>If using the writer classes directly (not through <a class="reference internal" href="_as_gen/matplotlib.animation.Animation.html#matplotlib.animation.Animation.save" title="matplotlib.animation.Animation.save"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Animation.save</span></code></a>), it is
strongly encouraged to use the <code class="xref py py-obj docutils literal notranslate"><span class="pre">saving</span></code> context manager</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">moviewriter</span><span class="o">.</span><span class="n">saving</span><span class="p">(</span><span class="n">fig</span><span class="p">,</span> <span class="s1">'myfile.mp4'</span><span class="p">,</span> <span class="n">dpi</span><span class="o">=</span><span class="mi">100</span><span class="p">):</span>
<span class="k">for</span> <span class="n">j</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">n</span><span class="p">):</span>
<span class="n">update_figure</span><span class="p">(</span><span class="n">n</span><span class="p">)</span>
<span class="n">moviewriter</span><span class="o">.</span><span class="n">grab_frame</span><span class="p">()</span>
</pre></div>
</div>
<p>to ensures that setup and cleanup are performed as necessary.</p>
<div class="section" id="id2">
<h3>Examples<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../gallery/animation/frame_grabbing_sgskip.html">Frame grabbing</a></li>
</ul>
</div>
</div>
</div>
<div class="section" id="helper-classes">
<span id="ani-writer-classes"></span><h2><a class="toc-backref" href="#id5">Helper Classes</a><a class="headerlink" href="#helper-classes" title="Permalink to this headline">¶</a></h2>
<div class="section" id="animation-base-classes">
<h3>Animation Base Classes<a class="headerlink" href="#animation-base-classes" title="Permalink to this headline">¶</a></h3>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.animation.Animation.html#matplotlib.animation.Animation" title="matplotlib.animation.Animation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Animation</span></code></a></td>
<td>This class wraps the creation of an animation using matplotlib.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.animation.TimedAnimation.html#matplotlib.animation.TimedAnimation" title="matplotlib.animation.TimedAnimation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TimedAnimation</span></code></a></td>
<td><a class="reference internal" href="_as_gen/matplotlib.animation.Animation.html#matplotlib.animation.Animation" title="matplotlib.animation.Animation"><code class="xref py py-class docutils literal notranslate"><span class="pre">Animation</span></code></a> subclass for time-based animation.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="writer-registry">
<h3>Writer Registry<a class="headerlink" href="#writer-registry" title="Permalink to this headline">¶</a></h3>
<p>A module-level registry is provided to map between the name of the
writer and the class to allow a string to be passed to
<a class="reference internal" href="_as_gen/matplotlib.animation.Animation.html#matplotlib.animation.Animation.save" title="matplotlib.animation.Animation.save"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Animation.save</span></code></a> instead of a writer instance.</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.animation.MovieWriterRegistry.html#matplotlib.animation.MovieWriterRegistry" title="matplotlib.animation.MovieWriterRegistry"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MovieWriterRegistry</span></code></a></td>
<td>Registry of available writer classes by human readable name.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="writer-base-classes">
<h3>Writer Base Classes<a class="headerlink" href="#writer-base-classes" title="Permalink to this headline">¶</a></h3>
<p>To reduce code duplication base classes</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.animation.AbstractMovieWriter.html#matplotlib.animation.AbstractMovieWriter" title="matplotlib.animation.AbstractMovieWriter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AbstractMovieWriter</span></code></a></td>
<td>Abstract base class for writing movies.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.animation.MovieWriter.html#matplotlib.animation.MovieWriter" title="matplotlib.animation.MovieWriter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MovieWriter</span></code></a></td>
<td>Base class for writing movies.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.animation.FileMovieWriter.html#matplotlib.animation.FileMovieWriter" title="matplotlib.animation.FileMovieWriter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FileMovieWriter</span></code></a></td>
<td><a class="reference internal" href="_as_gen/matplotlib.animation.MovieWriter.html#matplotlib.animation.MovieWriter" title="matplotlib.animation.MovieWriter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MovieWriter</span></code></a> for writing to individual files and stitching at the end.</td>
</tr>
</tbody>
</table>
<p>and mixins</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.animation.AVConvBase.html#matplotlib.animation.AVConvBase" title="matplotlib.animation.AVConvBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AVConvBase</span></code></a></td>
<td>Mixin class for avconv output.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.animation.FFMpegBase.html#matplotlib.animation.FFMpegBase" title="matplotlib.animation.FFMpegBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FFMpegBase</span></code></a></td>
<td>Mixin class for FFMpeg output.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.animation.ImageMagickBase.html#matplotlib.animation.ImageMagickBase" title="matplotlib.animation.ImageMagickBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ImageMagickBase</span></code></a></td>
<td>Mixin class for ImageMagick output.</td>
</tr>
</tbody>
</table>
<p>are provided.</p>
<p>See the source code for how to easily implement new <a class="reference internal" href="_as_gen/matplotlib.animation.MovieWriter.html#matplotlib.animation.MovieWriter" title="matplotlib.animation.MovieWriter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MovieWriter</span></code></a> classes.</p>
</div>
</div>
<div class="section" id="inheritance-diagrams">
<h2><a class="toc-backref" href="#id6">Inheritance Diagrams</a><a class="headerlink" href="#inheritance-diagrams" title="Permalink to this headline">¶</a></h2>
<div class="graphviz"><img src="../_images/inheritance-d4f075ad14d938daeb82d81d975c5544a4027949.png" alt="Inheritance diagram of matplotlib.animation.FuncAnimation, matplotlib.animation.ArtistAnimation" usemap="#inheritancece9d8276cb" class="inheritance graphviz" /></div>
<map id="inheritancece9d8276cb" name="inheritancece9d8276cb">
<area shape="rect" id="node1" href="_as_gen/matplotlib.animation.Animation.html#matplotlib.animation.Animation" target="_top" title="This class wraps the creation of an animation using matplotlib." alt="" coords="5,31,95,56"/>
<area shape="rect" id="node3" href="_as_gen/matplotlib.animation.TimedAnimation.html#matplotlib.animation.TimedAnimation" target="_top" title=":class:`Animation` subclass for time-based animation." alt="" coords="143,31,273,56"/>
<area shape="rect" id="node2" href="_as_gen/matplotlib.animation.ArtistAnimation.html#matplotlib.animation.ArtistAnimation" target="_top" title="Animation using a fixed set of `Artist` objects." alt="" coords="321,5,445,31"/>
<area shape="rect" id="node4" href="_as_gen/matplotlib.animation.FuncAnimation.html#matplotlib.animation.FuncAnimation" target="_top" title="Makes an animation by repeatedly calling a function *func*." alt="" coords="324,55,443,80"/>
</map><div class="graphviz"><img src="../_images/inheritance-ad605e356ce7ba073658bf7a805a892ab02923de.png" alt="Inheritance diagram of matplotlib.animation.AVConvFileWriter, matplotlib.animation.AVConvWriter, matplotlib.animation.FFMpegFileWriter, matplotlib.animation.FFMpegWriter, matplotlib.animation.ImageMagickFileWriter, matplotlib.animation.ImageMagickWriter" usemap="#inheritance8c8e6f1f96" class="inheritance graphviz" /></div>
<map id="inheritance8c8e6f1f96" name="inheritance8c8e6f1f96">
<area shape="rect" id="node8" href="_as_gen/matplotlib.animation.AbstractMovieWriter.html#matplotlib.animation.AbstractMovieWriter" target="_top" title="Abstract base class for writing movies. Fundamentally, what a MovieWriter" alt="" coords="90,57,201,76"/>
<area shape="rect" id="node2" href="_as_gen/matplotlib.animation.AVConvBase.html#matplotlib.animation.AVConvBase" target="_top" title="Mixin class for avconv output." alt="" coords="536,93,610,111"/>
<area shape="rect" id="node4" href="_as_gen/matplotlib.animation.AVConvFileWriter.html#matplotlib.animation.AVConvFileWriter" target="_top" title="File-based avconv writer." alt="" coords="669,67,764,85"/>
<area shape="rect" id="node6" href="_as_gen/matplotlib.animation.AVConvWriter.html#matplotlib.animation.AVConvWriter" target="_top" title="Pipe-based avconv writer." alt="" coords="677,111,756,129"/>
<area shape="rect" id="node3" href="_as_gen/matplotlib.animation.FFMpegBase.html#matplotlib.animation.FFMpegBase" target="_top" title="Mixin class for FFMpeg output." alt="" coords="387,93,461,111"/>
<area shape="rect" id="node5" href="_as_gen/matplotlib.animation.FFMpegFileWriter.html#matplotlib.animation.FFMpegFileWriter" target="_top" title="File-based ffmpeg writer." alt="" coords="526,57,620,76"/>
<area shape="rect" id="node7" href="_as_gen/matplotlib.animation.FFMpegWriter.html#matplotlib.animation.FFMpegWriter" target="_top" title="Pipe-based ffmpeg writer." alt="" coords="533,128,613,146"/>
<area shape="rect" id="node10" href="_as_gen/matplotlib.animation.MovieWriter.html#matplotlib.animation.MovieWriter" target="_top" title="Base class for writing movies." alt="" coords="250,57,322,76"/>
<area shape="rect" id="node9" href="_as_gen/matplotlib.animation.FileMovieWriter.html#matplotlib.animation.FileMovieWriter" target="_top" title="`MovieWriter` for writing to individual files and stitching at the end." alt="" coords="380,57,468,76"/>
<area shape="rect" id="node12" href="_as_gen/matplotlib.animation.ImageMagickFileWriter.html#matplotlib.animation.ImageMagickFileWriter" target="_top" title="File-based animated gif writer." alt="" coords="512,4,634,22"/>
<area shape="rect" id="node13" href="_as_gen/matplotlib.animation.ImageMagickWriter.html#matplotlib.animation.ImageMagickWriter" target="_top" title="Pipe-based animated gif." alt="" coords="371,22,477,40"/>
<area shape="rect" id="node11" href="_as_gen/matplotlib.animation.ImageMagickBase.html#matplotlib.animation.ImageMagickBase" target="_top" title="Mixin class for ImageMagick output." alt="" coords="235,4,337,22"/>
</map></div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2018 The Matplotlib development team.
<br />
Last updated on May 18, 2019.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
Doc version v3.1.0-4-g0078324e4.
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-55954603-1', 'auto');
ga('send', 'pageview');
</script>
</body>
<footer>
</footer>
</html>