-
Notifications
You must be signed in to change notification settings - Fork 59
Expand file tree
/
Copy pathanimation_api.html
More file actions
581 lines (523 loc) · 36.4 KB
/
animation_api.html
File metadata and controls
581 lines (523 loc) · 36.4 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
578
579
580
581
<!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 — Matplotlib 1.2.1 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: '1.2.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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 1.2.1 documentation"
href="../_static/opensearch.xml"/>
<link rel="top" title="Matplotlib 1.2.1 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="artists" href="artist_api.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 (v1.2.1). 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>
<!-- Piwik -->
<script type="text/javascript">
if ("matplotlib.sourceforge.net" == document.location.hostname ||
"matplotlib.sf.net" == document.location.hostname) {
var pkBaseURL = (("https:" == document.location.protocol) ? "https://apps.sourceforge.net/piwik/matplotlib/" : "http://apps.sourceforge.net/piwik/matplotlib/");
document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
}
</script>
<script type="text/javascript">
if ("matplotlib.sourceforge.net" == document.location.hostname ||
"matplotlib.sf.net" == document.location.hostname) {
piwik_action_name = '';
piwik_idsite = 1;
piwik_url = pkBaseURL + "piwik.php";
piwik_log(piwik_action_name, piwik_idsite, piwik_url);
document.write(unescape('%3Cobject%3E%3Cnoscript%3E%3Cp%3E%3Cimg src="http://apps.sourceforge.net/piwik/matplotlib/piwik.php?idsite=1" alt="piwik"/%3E%3C/p%3E%3C/noscript%3E%3C/object%3E'));
}
</script>
<!-- End Piwik Tag -->
<link rel="shortcut icon" href="_static/favicon.ico">
<!-- 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.png" 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="artist_api.html" title="artists"
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="http://www.matplotlib.org/downloads.html">downloads</a>| </li>
<li><a href="../search.html">search</a>| </li>
<li><a href="../examples/index.html">examples</a>| </li>
<li><a href="../gallery.html">gallery</a>| </li>
<li><a href="../citing.html">citation</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">
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">animation</a><ul>
<li><a class="reference internal" href="#module-matplotlib.animation"><tt class="docutils literal"><span class="pre">matplotlib.animation</span></tt></a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="afm_api.html"
title="previous chapter">afm (Adobe Font Metrics interface)</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="artist_api.html"
title="next chapter">artists</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/animation_api.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<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>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</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="animation">
<h1>animation<a class="headerlink" href="#animation" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-matplotlib.animation">
<span id="matplotlib-animation"></span><h2><a class="reference internal" href="#module-matplotlib.animation" title="matplotlib.animation"><tt class="xref py py-mod docutils literal"><span class="pre">matplotlib.animation</span></tt></a><a class="headerlink" href="#module-matplotlib.animation" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="matplotlib.animation.Animation">
<em class="property">class </em><tt class="descclassname">matplotlib.animation.</tt><tt class="descname">Animation</tt><big>(</big><em>fig</em>, <em>event_source=None</em>, <em>blit=False</em><big>)</big><a class="headerlink" href="#matplotlib.animation.Animation" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
<p>This class wraps the creation of an animation using matplotlib. It is
only a base class which should be subclassed to provide needed behavior.</p>
<p><em>fig</em> is the figure object that is used to get draw, resize, and any
other needed events.</p>
<p><em>event_source</em> is a class that can run a callback when desired events
are generated, as well as be stopped and started. Examples include timers
(see <a class="reference internal" href="#matplotlib.animation.TimedAnimation" title="matplotlib.animation.TimedAnimation"><tt class="xref py py-class docutils literal"><span class="pre">TimedAnimation</span></tt></a>) and file system notifications.</p>
<p><em>blit</em> is a boolean that controls whether blitting is used to optimize
drawing.</p>
<dl class="method">
<dt id="matplotlib.animation.Animation.new_frame_seq">
<tt class="descname">new_frame_seq</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.animation.Animation.new_frame_seq" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a new sequence of frame information.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.animation.Animation.new_saved_frame_seq">
<tt class="descname">new_saved_frame_seq</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.animation.Animation.new_saved_frame_seq" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a new sequence of saved/cached frame information.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.animation.Animation.save">
<tt class="descname">save</tt><big>(</big><em>filename</em>, <em>writer=None</em>, <em>fps=None</em>, <em>dpi=None</em>, <em>codec=None</em>, <em>bitrate=None</em>, <em>extra_args=None</em>, <em>metadata=None</em>, <em>extra_anim=None</em><big>)</big><a class="headerlink" href="#matplotlib.animation.Animation.save" title="Permalink to this definition">¶</a></dt>
<dd><p>Saves a movie file by drawing every frame.</p>
<p><em>filename</em> is the output filename, eg <tt class="file docutils literal"><span class="pre">mymovie.mp4</span></tt></p>
<p><em>writer</em> is either an instance of <a class="reference internal" href="#matplotlib.animation.MovieWriter" title="matplotlib.animation.MovieWriter"><tt class="xref py py-class docutils literal"><span class="pre">MovieWriter</span></tt></a> or a string
key that identifies a class to use, such as ‘ffmpeg’ or ‘mencoder’.
If nothing is passed, the value of the rcparam <tt class="xref py py-obj docutils literal"><span class="pre">animation.writer</span></tt> is
used.</p>
<p><em>fps</em> is the frames per second in the movie. Defaults to None,
which will use the animation’s specified interval to set the frames
per second.</p>
<p><em>dpi</em> controls the dots per inch for the movie frames. This combined
with the figure’s size in inches controls the size of the movie.</p>
<p><em>codec</em> is the video codec to be used. Not all codecs are supported
by a given <a class="reference internal" href="#matplotlib.animation.MovieWriter" title="matplotlib.animation.MovieWriter"><tt class="xref py py-class docutils literal"><span class="pre">MovieWriter</span></tt></a>. If none is given, this defaults to the
value specified by the rcparam <tt class="xref py py-obj docutils literal"><span class="pre">animation.codec</span></tt>.</p>
<p><em>bitrate</em> specifies the amount of bits used per second in the
compressed movie, in kilobits per second. A higher number means a
higher quality movie, but at the cost of increased file size. If no
value is given, this defaults to the value given by the rcparam
<tt class="xref py py-obj docutils literal"><span class="pre">animation.bitrate</span></tt>.</p>
<p><em>extra_args</em> is a list of extra string arguments to be passed to the
underlying movie utiltiy. The default is None, which passes the
additional argurments in the ‘animation.extra_args’ rcParam.</p>
<p><em>metadata</em> is a dictionary of keys and values for metadata to include
in the output file. Some keys that may be of use include:
title, artist, genre, subject, copyright, srcform, comment.</p>
<p><em>extra_anim</em> is a list of additional <a class="reference internal" href="#matplotlib.animation.Animation" title="matplotlib.animation.Animation"><tt class="xref py py-obj docutils literal"><span class="pre">Animation</span></tt></a> objects that should
be included in the saved movie file. These need to be from the same
<tt class="xref py py-obj docutils literal"><span class="pre">matplotlib.Figure</span></tt> instance. Also, animation frames will just be
simply combined, so there should be a 1:1 correspondence between
the frames from the different animations.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.animation.ArtistAnimation">
<em class="property">class </em><tt class="descclassname">matplotlib.animation.</tt><tt class="descname">ArtistAnimation</tt><big>(</big><em>fig</em>, <em>artists</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.animation.ArtistAnimation" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.animation.TimedAnimation" title="matplotlib.animation.TimedAnimation"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.animation.TimedAnimation</span></tt></a></p>
<p>Before calling this function, all plotting should have taken place
and the relevant artists saved.</p>
<p>frame_info is a list, with each list entry a collection of artists that
represent what needs to be enabled on each frame. These will be disabled
for other frames.</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.animation.FFMpegBase">
<em class="property">class </em><tt class="descclassname">matplotlib.animation.</tt><tt class="descname">FFMpegBase</tt><a class="headerlink" href="#matplotlib.animation.FFMpegBase" title="Permalink to this definition">¶</a></dt>
<dd><dl class="attribute">
<dt id="matplotlib.animation.FFMpegBase.args_key">
<tt class="descname">args_key</tt><em class="property"> = 'animation.ffmpeg_args'</em><a class="headerlink" href="#matplotlib.animation.FFMpegBase.args_key" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.animation.FFMpegBase.exec_key">
<tt class="descname">exec_key</tt><em class="property"> = 'animation.ffmpeg_path'</em><a class="headerlink" href="#matplotlib.animation.FFMpegBase.exec_key" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.animation.FFMpegBase.output_args">
<tt class="descname">output_args</tt><a class="headerlink" href="#matplotlib.animation.FFMpegBase.output_args" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.animation.FFMpegFileWriter">
<em class="property">class </em><tt class="descclassname">matplotlib.animation.</tt><tt class="descname">FFMpegFileWriter</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.animation.FFMpegFileWriter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.animation.FileMovieWriter" title="matplotlib.animation.FileMovieWriter"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.animation.FileMovieWriter</span></tt></a>, <a class="reference internal" href="#matplotlib.animation.FFMpegBase" title="matplotlib.animation.FFMpegBase"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.animation.FFMpegBase</span></tt></a></p>
<dl class="attribute">
<dt id="matplotlib.animation.FFMpegFileWriter.supported_formats">
<tt class="descname">supported_formats</tt><em class="property"> = ['png', 'jpeg', 'ppm', 'tiff', 'sgi', 'bmp', 'pbm', 'raw', 'rgba']</em><a class="headerlink" href="#matplotlib.animation.FFMpegFileWriter.supported_formats" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.animation.FFMpegWriter">
<em class="property">class </em><tt class="descclassname">matplotlib.animation.</tt><tt class="descname">FFMpegWriter</tt><big>(</big><em>fps=5</em>, <em>codec=None</em>, <em>bitrate=None</em>, <em>extra_args=None</em>, <em>metadata=None</em><big>)</big><a class="headerlink" href="#matplotlib.animation.FFMpegWriter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.animation.MovieWriter" title="matplotlib.animation.MovieWriter"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.animation.MovieWriter</span></tt></a>, <a class="reference internal" href="#matplotlib.animation.FFMpegBase" title="matplotlib.animation.FFMpegBase"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.animation.FFMpegBase</span></tt></a></p>
<p>Construct a new MovieWriter object.</p>
<dl class="docutils">
<dt>fps: int</dt>
<dd>Framerate for movie.</dd>
<dt>codec: string or None, optional</dt>
<dd>The codec to use. If None (the default) the setting in the
rcParam <tt class="xref py py-obj docutils literal"><span class="pre">animation.codec</span></tt> is used.</dd>
<dt>bitrate: int or None, optional</dt>
<dd>The bitrate for the saved movie file, which is one way to control
the output file size and quality. The default value is None,
which uses the value stored in the rcParam <tt class="xref py py-obj docutils literal"><span class="pre">animation.bitrate</span></tt>.
A value of -1 implies that the bitrate should be determined
automatically by the underlying utility.</dd>
<dt>extra_args: list of strings or None</dt>
<dd>A list of extra string arguments to be passed to the underlying
movie utiltiy. The default is None, which passes the additional
argurments in the ‘animation.extra_args’ rcParam.</dd>
<dt>metadata: dict of string:string or None</dt>
<dd>A dictionary of keys and values for metadata to include in the
output file. Some keys that may be of use include:
title, artist, genre, subject, copyright, srcform, comment.</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.animation.FileMovieWriter">
<em class="property">class </em><tt class="descclassname">matplotlib.animation.</tt><tt class="descname">FileMovieWriter</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.animation.FileMovieWriter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.animation.MovieWriter" title="matplotlib.animation.MovieWriter"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.animation.MovieWriter</span></tt></a></p>
<p><a class="reference internal" href="#matplotlib.animation.MovieWriter" title="matplotlib.animation.MovieWriter"><tt class="xref py py-obj docutils literal"><span class="pre">MovieWriter</span></tt></a> subclass that handles writing to a file.</p>
<dl class="method">
<dt id="matplotlib.animation.FileMovieWriter.cleanup">
<tt class="descname">cleanup</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.animation.FileMovieWriter.cleanup" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.animation.FileMovieWriter.finish">
<tt class="descname">finish</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.animation.FileMovieWriter.finish" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.animation.FileMovieWriter.frame_format">
<tt class="descname">frame_format</tt><a class="headerlink" href="#matplotlib.animation.FileMovieWriter.frame_format" title="Permalink to this definition">¶</a></dt>
<dd><p>Format (png, jpeg, etc.) to use for saving the frames, which can be
decided by the individual subclasses.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.animation.FileMovieWriter.setup">
<tt class="descname">setup</tt><big>(</big><em>fig</em>, <em>outfile</em>, <em>dpi</em>, <em>frame_prefix='_tmp'</em>, <em>clear_temp=True</em><big>)</big><a class="headerlink" href="#matplotlib.animation.FileMovieWriter.setup" title="Permalink to this definition">¶</a></dt>
<dd><p>Perform setup for writing the movie file.</p>
<dl class="docutils">
<dt>fig: <tt class="xref py py-obj docutils literal"><span class="pre">matplotlib.Figure</span></tt> instance</dt>
<dd>The figure object that contains the information for frames</dd>
<dt>outfile: string</dt>
<dd>The filename of the resulting movie file</dd>
<dt>dpi: int</dt>
<dd>The DPI (or resolution) for the file. This controls the size
in pixels of the resulting movie file.</dd>
<dt>frame_prefix: string, optional</dt>
<dd>The filename prefix to use for the temporary files. Defaults
to ‘_tmp’</dd>
<dt>clear_temp: bool</dt>
<dd>Specifies whether the temporary files should be deleted after
the movie is written. (Useful for debugging.) Defaults to True.</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.animation.FuncAnimation">
<em class="property">class </em><tt class="descclassname">matplotlib.animation.</tt><tt class="descname">FuncAnimation</tt><big>(</big><em>fig</em>, <em>func</em>, <em>frames=None</em>, <em>init_func=None</em>, <em>fargs=None</em>, <em>save_count=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.animation.FuncAnimation" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.animation.TimedAnimation" title="matplotlib.animation.TimedAnimation"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.animation.TimedAnimation</span></tt></a></p>
<p>Makes an animation by repeatedly calling a function <em>func</em>, passing in
(optional) arguments in <em>fargs</em>.</p>
<p><em>frames</em> can be a generator, an iterable, or a number of frames.</p>
<p><em>init_func</em> is a function used to draw a clear frame. If not given, the
results of drawing from the first item in the frames sequence will be
used.</p>
<dl class="method">
<dt id="matplotlib.animation.FuncAnimation.new_frame_seq">
<tt class="descname">new_frame_seq</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.animation.FuncAnimation.new_frame_seq" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.animation.FuncAnimation.new_saved_frame_seq">
<tt class="descname">new_saved_frame_seq</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.animation.FuncAnimation.new_saved_frame_seq" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.animation.MencoderBase">
<em class="property">class </em><tt class="descclassname">matplotlib.animation.</tt><tt class="descname">MencoderBase</tt><a class="headerlink" href="#matplotlib.animation.MencoderBase" title="Permalink to this definition">¶</a></dt>
<dd><dl class="attribute">
<dt id="matplotlib.animation.MencoderBase.allowed_metadata">
<tt class="descname">allowed_metadata</tt><em class="property"> = ['name', 'artist', 'genre', 'subject', 'copyright', 'srcform', 'comment']</em><a class="headerlink" href="#matplotlib.animation.MencoderBase.allowed_metadata" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.animation.MencoderBase.args_key">
<tt class="descname">args_key</tt><em class="property"> = 'animation.mencoder_args'</em><a class="headerlink" href="#matplotlib.animation.MencoderBase.args_key" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.animation.MencoderBase.exec_key">
<tt class="descname">exec_key</tt><em class="property"> = 'animation.mencoder_path'</em><a class="headerlink" href="#matplotlib.animation.MencoderBase.exec_key" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.animation.MencoderBase.output_args">
<tt class="descname">output_args</tt><a class="headerlink" href="#matplotlib.animation.MencoderBase.output_args" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.animation.MencoderFileWriter">
<em class="property">class </em><tt class="descclassname">matplotlib.animation.</tt><tt class="descname">MencoderFileWriter</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.animation.MencoderFileWriter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.animation.FileMovieWriter" title="matplotlib.animation.FileMovieWriter"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.animation.FileMovieWriter</span></tt></a>, <a class="reference internal" href="#matplotlib.animation.MencoderBase" title="matplotlib.animation.MencoderBase"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.animation.MencoderBase</span></tt></a></p>
<dl class="attribute">
<dt id="matplotlib.animation.MencoderFileWriter.supported_formats">
<tt class="descname">supported_formats</tt><em class="property"> = ['png', 'jpeg', 'tga', 'sgi']</em><a class="headerlink" href="#matplotlib.animation.MencoderFileWriter.supported_formats" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.animation.MencoderWriter">
<em class="property">class </em><tt class="descclassname">matplotlib.animation.</tt><tt class="descname">MencoderWriter</tt><big>(</big><em>fps=5</em>, <em>codec=None</em>, <em>bitrate=None</em>, <em>extra_args=None</em>, <em>metadata=None</em><big>)</big><a class="headerlink" href="#matplotlib.animation.MencoderWriter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.animation.MovieWriter" title="matplotlib.animation.MovieWriter"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.animation.MovieWriter</span></tt></a>, <a class="reference internal" href="#matplotlib.animation.MencoderBase" title="matplotlib.animation.MencoderBase"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.animation.MencoderBase</span></tt></a></p>
<p>Construct a new MovieWriter object.</p>
<dl class="docutils">
<dt>fps: int</dt>
<dd>Framerate for movie.</dd>
<dt>codec: string or None, optional</dt>
<dd>The codec to use. If None (the default) the setting in the
rcParam <tt class="xref py py-obj docutils literal"><span class="pre">animation.codec</span></tt> is used.</dd>
<dt>bitrate: int or None, optional</dt>
<dd>The bitrate for the saved movie file, which is one way to control
the output file size and quality. The default value is None,
which uses the value stored in the rcParam <tt class="xref py py-obj docutils literal"><span class="pre">animation.bitrate</span></tt>.
A value of -1 implies that the bitrate should be determined
automatically by the underlying utility.</dd>
<dt>extra_args: list of strings or None</dt>
<dd>A list of extra string arguments to be passed to the underlying
movie utiltiy. The default is None, which passes the additional
argurments in the ‘animation.extra_args’ rcParam.</dd>
<dt>metadata: dict of string:string or None</dt>
<dd>A dictionary of keys and values for metadata to include in the
output file. Some keys that may be of use include:
title, artist, genre, subject, copyright, srcform, comment.</dd>
</dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.animation.MovieWriter">
<em class="property">class </em><tt class="descclassname">matplotlib.animation.</tt><tt class="descname">MovieWriter</tt><big>(</big><em>fps=5</em>, <em>codec=None</em>, <em>bitrate=None</em>, <em>extra_args=None</em>, <em>metadata=None</em><big>)</big><a class="headerlink" href="#matplotlib.animation.MovieWriter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
<p>Base class for writing movies. Fundamentally, what a MovieWriter does
is provide is a way to grab frames by calling grab_frame(). setup()
is called to start the process and finish() is called afterwards.
This class is set up to provide for writing movie frame data to a pipe.
saving() is provided as a context manager to facilitate this process as:</p>
<div class="highlight-python"><div class="highlight"><pre><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="s">'myfile.mp4'</span><span class="p">):</span>
<span class="c"># Iterate over frames</span>
<span class="n">moviewriter</span><span class="o">.</span><span class="n">grab_frame</span><span class="p">()</span>
</pre></div>
</div>
<p>The use of the context manager ensures that setup and cleanup are
performed as necessary.</p>
<dl class="docutils">
<dt>frame_format: string</dt>
<dd>The format used in writing frame data, defaults to ‘rgba’</dd>
</dl>
<p>Construct a new MovieWriter object.</p>
<dl class="docutils">
<dt>fps: int</dt>
<dd>Framerate for movie.</dd>
<dt>codec: string or None, optional</dt>
<dd>The codec to use. If None (the default) the setting in the
rcParam <tt class="xref py py-obj docutils literal"><span class="pre">animation.codec</span></tt> is used.</dd>
<dt>bitrate: int or None, optional</dt>
<dd>The bitrate for the saved movie file, which is one way to control
the output file size and quality. The default value is None,
which uses the value stored in the rcParam <tt class="xref py py-obj docutils literal"><span class="pre">animation.bitrate</span></tt>.
A value of -1 implies that the bitrate should be determined
automatically by the underlying utility.</dd>
<dt>extra_args: list of strings or None</dt>
<dd>A list of extra string arguments to be passed to the underlying
movie utiltiy. The default is None, which passes the additional
argurments in the ‘animation.extra_args’ rcParam.</dd>
<dt>metadata: dict of string:string or None</dt>
<dd>A dictionary of keys and values for metadata to include in the
output file. Some keys that may be of use include:
title, artist, genre, subject, copyright, srcform, comment.</dd>
</dl>
<dl class="classmethod">
<dt id="matplotlib.animation.MovieWriter.bin_path">
<em class="property">classmethod </em><tt class="descname">bin_path</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.animation.MovieWriter.bin_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the binary path to the commandline tool used by a specific
subclass. This is a class method so that the tool can be looked for
before making a particular MovieWriter subclass available.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.animation.MovieWriter.cleanup">
<tt class="descname">cleanup</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.animation.MovieWriter.cleanup" title="Permalink to this definition">¶</a></dt>
<dd><p>Clean-up and collect the process used to write the movie file.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.animation.MovieWriter.finish">
<tt class="descname">finish</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.animation.MovieWriter.finish" title="Permalink to this definition">¶</a></dt>
<dd><p>Finish any processing for writing the movie.</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.animation.MovieWriter.frame_size">
<tt class="descname">frame_size</tt><a class="headerlink" href="#matplotlib.animation.MovieWriter.frame_size" title="Permalink to this definition">¶</a></dt>
<dd><p>A tuple (width,height) in pixels of a movie frame.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.animation.MovieWriter.grab_frame">
<tt class="descname">grab_frame</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.animation.MovieWriter.grab_frame" title="Permalink to this definition">¶</a></dt>
<dd><p>Grab the image information from the figure and save as a movie frame.</p>
</dd></dl>
<dl class="classmethod">
<dt id="matplotlib.animation.MovieWriter.isAvailable">
<em class="property">classmethod </em><tt class="descname">isAvailable</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.animation.MovieWriter.isAvailable" title="Permalink to this definition">¶</a></dt>
<dd><p>Check to see if a MovieWriter subclass is actually available by
running the commandline tool.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.animation.MovieWriter.saving">
<tt class="descname">saving</tt><big>(</big><em>*args</em>, <em>**kwds</em><big>)</big><a class="headerlink" href="#matplotlib.animation.MovieWriter.saving" title="Permalink to this definition">¶</a></dt>
<dd><p>Context manager to facilitate writing the movie file.</p>
<p><tt class="docutils literal"><span class="pre">*args</span></tt> are any parameters that should be passed to <a class="reference internal" href="#matplotlib.animation.MovieWriter.setup" title="matplotlib.animation.MovieWriter.setup"><tt class="xref py py-obj docutils literal"><span class="pre">setup</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.animation.MovieWriter.setup">
<tt class="descname">setup</tt><big>(</big><em>fig</em>, <em>outfile</em>, <em>dpi</em>, <em>*args</em><big>)</big><a class="headerlink" href="#matplotlib.animation.MovieWriter.setup" title="Permalink to this definition">¶</a></dt>
<dd><p>Perform setup for writing the movie file.</p>
<dl class="docutils">
<dt>fig: <tt class="xref py py-obj docutils literal"><span class="pre">matplotlib.Figure</span></tt> instance</dt>
<dd>The figure object that contains the information for frames</dd>
<dt>outfile: string</dt>
<dd>The filename of the resulting movie file</dd>
<dt>dpi: int</dt>
<dd>The DPI (or resolution) for the file. This controls the size
in pixels of the resulting movie file.</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.animation.MovieWriterRegistry">
<em class="property">class </em><tt class="descclassname">matplotlib.animation.</tt><tt class="descname">MovieWriterRegistry</tt><a class="headerlink" href="#matplotlib.animation.MovieWriterRegistry" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
<dl class="method">
<dt id="matplotlib.animation.MovieWriterRegistry.list">
<tt class="descname">list</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.animation.MovieWriterRegistry.list" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a list of available MovieWriters.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.animation.MovieWriterRegistry.register">
<tt class="descname">register</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#matplotlib.animation.MovieWriterRegistry.register" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.animation.TimedAnimation">
<em class="property">class </em><tt class="descclassname">matplotlib.animation.</tt><tt class="descname">TimedAnimation</tt><big>(</big><em>fig</em>, <em>interval=200</em>, <em>repeat_delay=None</em>, <em>repeat=True</em>, <em>event_source=None</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.animation.TimedAnimation" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.animation.Animation" title="matplotlib.animation.Animation"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.animation.Animation</span></tt></a></p>
<p><a class="reference internal" href="#matplotlib.animation.Animation" title="matplotlib.animation.Animation"><tt class="xref py py-class docutils literal"><span class="pre">Animation</span></tt></a> subclass that supports time-based animation, drawing
a new frame every <em>interval</em> milliseconds.</p>
<p><em>repeat</em> controls whether the animation should repeat when the sequence
of frames is completed.</p>
<p><em>repeat_delay</em> optionally adds a delay in milliseconds before repeating
the animation.</p>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="artist_api.html" title="artists"
>next</a> |</li>
<li class="right" >
<a href="afm_api.html" title="afm (Adobe Font Metrics interface)"
>previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="http://www.matplotlib.org/downloads.html">downloads</a>| </li>
<li><a href="../search.html">search</a>| </li>
<li><a href="../examples/index.html">examples</a>| </li>
<li><a href="../gallery.html">gallery</a>| </li>
<li><a href="../citing.html">citation</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" >The Matplotlib API</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2013 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the matplotlib development team.
Last updated on May 29, 2013.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.
</div>
</body>
</html>