-
Notifications
You must be signed in to change notification settings - Fork 59
Expand file tree
/
Copy pathanimation_api.html
More file actions
577 lines (541 loc) · 45.2 KB
/
animation_api.html
File metadata and controls
577 lines (541 loc) · 45.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
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
<!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>animation module — Matplotlib 2.0.0 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.0.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 2.0.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 2.0.0 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="matplotlib.animation.FuncAnimation" href="_as_gen/matplotlib.animation.FuncAnimation.html" />
<link rel="prev" title="afm (Adobe Font Metrics interface)" href="afm_api.html" />
<link rel="canonical" href="https://matplotlib.org/stable/api/animation_api.html" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head>
<body>
<div id="unreleased-message"> You are reading an old version of the documentation (v2.0.0). For the latest version see <a href="https://matplotlib.org/stable/api/animation_api.html">https://matplotlib.org/stable/api/animation_api.html</a></div>
<!-- The "Fork me on github" ribbon -->
<img style="float: right; margin-bottom: -40px; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" usemap="#ribbonmap"/>
<map name="ribbonmap">
<area shape="poly" coords="15,0,148,-1,148,135" href="https://github.com/matplotlib/matplotlib" title="Fork me on GitHub" />
</map>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="../index.html"><img src="../_static/logo2.svg" width="540px" border="0" alt="matplotlib"/></a>
</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.FuncAnimation.html" title="matplotlib.animation.FuncAnimation"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="afm_api.html" title="afm (Adobe Font Metrics interface)"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../examples/index.html">examples</a>| </li>
<li><a href="../gallery.html">gallery</a>| </li>
<li><a href="pyplot_summary.html">pyplot</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" accesskey="U">The Matplotlib API</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<a href="http://depsy.org/package/python/matplotlib">
<img src="http://depsy.org/api/package/pypi/matplotlib/badge.svg">
</a>
<br/>
Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">
<img src="https://travis-ci.org/matplotlib/matplotlib.svg?branch=master"/>
</a>
<br/>
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#"><code class="docutils literal"><span class="pre">animation</span></code> module</a><ul>
<li><a class="reference internal" href="#animation">Animation</a><ul>
<li><a class="reference internal" href="#funcanimation"><code class="docutils literal"><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"><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>
</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="#custom-animation-classes">Custom Animation 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>
<li><a class="reference internal" href="#deprecated">Deprecated</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">The Matplotlib API</a><ul>
<li>Previous: <a href="afm_api.html" title="previous chapter">afm (Adobe Font Metrics interface)</a></li>
<li>Next: <a href="_as_gen/matplotlib.animation.FuncAnimation.html" title="next chapter">matplotlib.animation.FuncAnimation</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/animation_api.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-matplotlib.animation">
<span id="animation-module"></span><h1><code class="docutils literal"><span class="pre">animation</span></code> module<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="id2">Animation</a></li>
<li><a class="reference internal" href="#writer-classes" id="id3">Writer Classes</a></li>
<li><a class="reference internal" href="#helper-classes" id="id4">Helper Classes</a></li>
<li><a class="reference internal" href="#inheritance-diagrams" id="id5">Inheritance Diagrams</a></li>
<li><a class="reference internal" href="#deprecated" id="id6">Deprecated</a></li>
</ul>
</div>
<div class="section" id="animation">
<h2><a class="toc-backref" href="#id2">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"><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.FuncAnimation.html#matplotlib.animation.FuncAnimation" title="matplotlib.animation.FuncAnimation"><code class="xref py py-obj docutils literal"><span class="pre">FuncAnimation</span></code></a></td>
<td>Makes an animation by repeatedly calling a function <code class="docutils literal"><span class="pre">func</span></code>.</td>
</tr>
<tr class="row-even"><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"><span class="pre">ArtistAnimation</span></code></a></td>
<td>Animation using a fixed set of <code class="xref py py-obj docutils literal"><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"><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"><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</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.save.html#matplotlib.animation.Animation.save" title="matplotlib.animation.Animation.save"><code class="xref py py-obj docutils literal"><span class="pre">Animation.save</span></code></a></td>
<td>Saves a movie file by drawing every frame.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.animation.Animation.to_html5_video.html#matplotlib.animation.Animation.to_html5_video" title="matplotlib.animation.Animation.to_html5_video"><code class="xref py py-obj docutils literal"><span class="pre">Animation.to_html5_video</span></code></a></td>
<td>Returns animation as an HTML5 video tag.</td>
</tr>
</tbody>
</table>
<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">
<h3><code class="docutils literal"><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"><span class="pre">FuncAnimation</span></code></a> is more-or-less:</p>
<div class="highlight-default"><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">plt</span><span class="o">.</span><span class="n">pause</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, 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 using blitting (by passing <code class="docutils literal"><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"><span class="pre">FuncAnimation</span></code></a> gets a bit more complicated</p>
<div class="highlight-default"><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">plt</span><span class="o">.</span><span class="n">pause</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"><span class="pre">init_func</span></code>
and <code class="docutils literal"><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"><span class="pre">FuncAnimation</span></code></a> and the theory of how
‘blitting’ works.</p>
<p>The expected signature on <code class="docutils literal"><span class="pre">func</span></code> and <code class="docutils literal"><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"><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"><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="n">animated</span><span class="o">=</span><span class="kc">True</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 us <code class="xref py py-obj docutils literal"><span class="pre">functools.partial</span></code> 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="../examples/animation/animate_decay.html">animation example code: animate_decay.py</a></li>
<li class="toctree-l1"><a class="reference internal" href="../examples/animation/bayes_update.html">animation example code: bayes_update.py</a></li>
<li class="toctree-l1"><a class="reference internal" href="../examples/animation/double_pendulum_animated.html">animation example code: double_pendulum_animated.py</a></li>
<li class="toctree-l1"><a class="reference internal" href="../examples/animation/dynamic_image.html">animation example code: dynamic_image.py</a></li>
<li class="toctree-l1"><a class="reference internal" href="../examples/animation/histogram.html">animation example code: histogram.py</a></li>
<li class="toctree-l1"><a class="reference internal" href="../examples/animation/rain.html">animation example code: rain.py</a></li>
<li class="toctree-l1"><a class="reference internal" href="../examples/animation/random_data.html">animation example code: random_data.py</a></li>
<li class="toctree-l1"><a class="reference internal" href="../examples/animation/simple_3danim.html">animation example code: simple_3danim.py</a></li>
<li class="toctree-l1"><a class="reference internal" href="../examples/animation/simple_anim.html">animation example code: simple_anim.py</a></li>
<li class="toctree-l1"><a class="reference internal" href="../examples/animation/strip_chart_demo.html">animation example code: strip_chart_demo.py</a></li>
<li class="toctree-l1"><a class="reference internal" href="../examples/animation/unchained.html">animation example code: unchained.py</a></li>
</ul>
</div>
</div>
</div>
<div class="section" id="artistanimation">
<h3><code class="docutils literal"><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="../examples/animation/basic_example.html">animation example code: basic_example.py</a></li>
<li class="toctree-l1"><a class="reference internal" href="../examples/animation/basic_example_writer.html">animation example code: basic_example_writer.py</a></li>
<li class="toctree-l1"><a class="reference internal" href="../examples/animation/dynamic_image2.html">animation example code: dynamic_image2.py</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="section" id="writer-classes">
<h2><a class="toc-backref" href="#id3">Writer Classes</a><a class="headerlink" href="#writer-classes" title="Permalink to this headline">¶</a></h2>
<p>The provided writers fall into two broad categories: pipe-based and
file-based. 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"><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.ImageMagickFileWriter.html#matplotlib.animation.ImageMagickFileWriter" title="matplotlib.animation.ImageMagickFileWriter"><code class="xref py py-obj docutils literal"><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.AVConvWriter.html#matplotlib.animation.AVConvWriter" title="matplotlib.animation.AVConvWriter"><code class="xref py py-obj docutils literal"><span class="pre">AVConvWriter</span></code></a></td>
<td>Pipe-based avconv writer.</td>
</tr>
</tbody>
</table>
<p>Alternatively 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"><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.ImageMagickWriter.html#matplotlib.animation.ImageMagickWriter" title="matplotlib.animation.ImageMagickWriter"><code class="xref py py-obj docutils literal"><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.AVConvFileWriter.html#matplotlib.animation.AVConvFileWriter" title="matplotlib.animation.AVConvFileWriter"><code class="xref py py-obj docutils literal"><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"><span class="pre">MovieWriter</span></code></a> provides a way to grab sequential frames
from the same underlying <a class="reference internal" href="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal"><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"><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"><span class="pre">setup</span></code> methods.</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.MovieWriter.setup.html#matplotlib.animation.MovieWriter.setup" title="matplotlib.animation.MovieWriter.setup"><code class="xref py py-obj docutils literal"><span class="pre">MovieWriter.setup</span></code></a></td>
<td>Perform setup for writing the movie file.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.animation.FileMovieWriter.setup.html#matplotlib.animation.FileMovieWriter.setup" title="matplotlib.animation.FileMovieWriter.setup"><code class="xref py py-obj docutils literal"><span class="pre">FileMovieWriter.setup</span></code></a></td>
<td>Perform setup for writing the movie file.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.animation.MovieWriter.grab_frame.html#matplotlib.animation.MovieWriter.grab_frame" title="matplotlib.animation.MovieWriter.grab_frame"><code class="xref py py-obj docutils literal"><span class="pre">MovieWriter.grab_frame</span></code></a></td>
<td>Grab the image information from the figure and save as a movie frame.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.animation.MovieWriter.finish.html#matplotlib.animation.MovieWriter.finish" title="matplotlib.animation.MovieWriter.finish"><code class="xref py py-obj docutils literal"><span class="pre">MovieWriter.finish</span></code></a></td>
<td>Finish any processing for writing the movie.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.animation.MovieWriter.saving.html#matplotlib.animation.MovieWriter.saving" title="matplotlib.animation.MovieWriter.saving"><code class="xref py py-obj docutils literal"><span class="pre">MovieWriter.saving</span></code></a></td>
<td>Context manager to facilitate writing the movie file.</td>
</tr>
</tbody>
</table>
<p>The <code class="docutils literal"><span class="pre">setup()</span></code> method is used to prepare the writer (possibly opening
a pipe), successive calls to <code class="docutils literal"><span class="pre">grab_frame()</span></code> capture a single frame
at a time and <code class="docutils literal"><span class="pre">finish()</span></code> finalizes the movie and writes the output
file to disk. For example</p>
<div class="highlight-default"><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.save.html#matplotlib.animation.Animation.save" title="matplotlib.animation.Animation.save"><code class="xref py py-obj docutils literal"><span class="pre">Animation.save</span></code></a>), it is strongly encouraged
to use the <a class="reference internal" href="_as_gen/matplotlib.animation.MovieWriter.saving.html#matplotlib.animation.MovieWriter.saving" title="matplotlib.animation.MovieWriter.saving"><code class="xref py py-obj docutils literal"><span class="pre">saving</span></code></a> context manager</p>
<div class="highlight-default"><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>
<p><a class="reference internal" href="../examples/animation/moviewriter.html#animation-moviewriter"><span class="std std-ref">animation example code: moviewriter.py</span></a></p>
</div>
<div class="section" id="helper-classes">
<span id="ani-writer-classes"></span><h2><a class="toc-backref" href="#id4">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"><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"><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"><span class="pre">Animation</span></code></a> subclass for time-based animation.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="custom-animation-classes">
<h3>Custom Animation classes<a class="headerlink" href="#custom-animation-classes" title="Permalink to this headline">¶</a></h3>
<p><a class="reference internal" href="../examples/animation/subplots.html#animation-subplots"><span class="std std-ref">animation example code: subplots.py</span></a></p>
</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.save.html#matplotlib.animation.Animation.save" title="matplotlib.animation.Animation.save"><code class="xref py py-obj docutils literal"><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"><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.MovieWriter.html#matplotlib.animation.MovieWriter" title="matplotlib.animation.MovieWriter"><code class="xref py py-obj docutils literal"><span class="pre">MovieWriter</span></code></a></td>
<td>Base class for writing movies.</td>
</tr>
<tr class="row-even"><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"><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"><span class="pre">MovieWriter</span></code></a> for writing to individual files and stitching at the end.</td>
</tr>
</tbody>
</table>
<p>and mixins are provided</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"><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"><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"><span class="pre">ImageMagickBase</span></code></a></td>
<td>Mixin class for ImageMagick output.</td>
</tr>
</tbody>
</table>
<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"><span class="pre">MovieWriter</span></code></a>
classes.</p>
</div>
</div>
<div class="section" id="inheritance-diagrams">
<h2><a class="toc-backref" href="#id5">Inheritance Diagrams</a><a class="headerlink" href="#inheritance-diagrams" title="Permalink to this headline">¶</a></h2>
<img src="../_images/inheritance-3d770d91db12b7ba71313f03e0382aa6506036be.png" alt="Inheritance diagram of matplotlib.animation.FuncAnimation, matplotlib.animation.ArtistAnimation" usemap="#inheritance95f52c58c5" class="inheritance"/>
<map id="inheritance95f52c58c5" name="inheritance95f52c58c5">
<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,27,208,49"/>
<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="250,27,488,49"/>
<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="530,5,763,27"/>
<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="533,48,760,70"/>
</map>
<img src="../_images/inheritance-53b4331e203e70850e6a83c65bc3a3b70298d0f7.png" alt="Inheritance diagram of matplotlib.animation.AVConvFileWriter, matplotlib.animation.AVConvWriter, matplotlib.animation.FFMpegFileWriter, matplotlib.animation.FFMpegWriter, matplotlib.animation.ImageMagickFileWriter, matplotlib.animation.ImageMagickWriter" usemap="#inheritance7d9f599b8e" class="inheritance"/>
<map id="inheritance7d9f599b8e" name="inheritance7d9f599b8e">
<area shape="rect" id="node1" href="_as_gen/matplotlib.animation.AVConvBase.html#matplotlib.animation.AVConvBase" target="_top" title="Mixin class for avconv output." alt="" coords="413,32,557,47"/>
<area shape="rect" id="node3" href="_as_gen/matplotlib.animation.AVConvFileWriter.html#matplotlib.animation.AVConvFileWriter" target="_top" title="File-based avconv writer." alt="" coords="604,47,765,62"/>
<area shape="rect" id="node5" href="_as_gen/matplotlib.animation.AVConvWriter.html#matplotlib.animation.AVConvWriter" target="_top" title="Pipe-based avconv writer." alt="" coords="611,11,758,26"/>
<area shape="rect" id="node2" href="_as_gen/matplotlib.animation.FFMpegBase.html#matplotlib.animation.FFMpegBase" target="_top" title="Mixin class for FFMpeg output." alt="" coords="210,32,353,47"/>
<area shape="rect" id="node4" href="_as_gen/matplotlib.animation.FFMpegFileWriter.html#matplotlib.animation.FFMpegFileWriter" target="_top" title="File-based ffmpeg writer." alt="" coords="405,61,565,76"/>
<area shape="rect" id="node6" href="_as_gen/matplotlib.animation.FFMpegWriter.html#matplotlib.animation.FFMpegWriter" target="_top" title="Pipe-based ffmpeg writer." alt="" coords="412,3,558,18"/>
<area shape="rect" id="node7" 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="204,61,358,76"/>
<area shape="rect" id="node10" href="_as_gen/matplotlib.animation.ImageMagickFileWriter.html#matplotlib.animation.ImageMagickFileWriter" target="_top" title="File-based animated gif writer." alt="" coords="394,105,576,119"/>
<area shape="rect" id="node8" href="_as_gen/matplotlib.animation.MovieWriter.html#matplotlib.animation.MovieWriter" target="_top" title="Base class for writing movies." alt="" coords="15,61,156,76"/>
<area shape="rect" id="node11" href="_as_gen/matplotlib.animation.ImageMagickWriter.html#matplotlib.animation.ImageMagickWriter" target="_top" title="Pipe-based animated gif." alt="" coords="197,90,366,105"/>
<area shape="rect" id="node9" href="_as_gen/matplotlib.animation.ImageMagickBase.html#matplotlib.animation.ImageMagickBase" target="_top" title="Mixin class for ImageMagick output." alt="" coords="3,105,169,119"/>
</map>
</div>
<div class="section" id="deprecated">
<h2><a class="toc-backref" href="#id6">Deprecated</a><a class="headerlink" href="#deprecated" title="Permalink to this headline">¶</a></h2>
<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.MencoderBase.html#matplotlib.animation.MencoderBase" title="matplotlib.animation.MencoderBase"><code class="xref py py-obj docutils literal"><span class="pre">MencoderBase</span></code></a></td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.animation.MencoderFileWriter.html#matplotlib.animation.MencoderFileWriter" title="matplotlib.animation.MencoderFileWriter"><code class="xref py py-obj docutils literal"><span class="pre">MencoderFileWriter</span></code></a></td>
<td><div class="deprecated">
<p><span class="versionmodified">Deprecated since version 2.0.</span></p>
</div>
</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.animation.MencoderWriter.html#matplotlib.animation.MencoderWriter" title="matplotlib.animation.MencoderWriter"><code class="xref py py-obj docutils literal"><span class="pre">MencoderWriter</span></code></a></td>
<td><div class="deprecated">
<p><span class="versionmodified">Deprecated since version 2.0.</span></p>
</div>
</td>
</tr>
</tbody>
</table>
</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 - 2016 The Matplotlib development team.
Last updated on Feb 20, 2017.
Created using <a
href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
</div>
</body>
<footer>
</footer>
</html>