-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathmatplotlib.animation.Animation.save.html
More file actions
244 lines (217 loc) · 12.6 KB
/
matplotlib.animation.Animation.save.html
File metadata and controls
244 lines (217 loc) · 12.6 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
<!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.Animation.save — Matplotlib 2.0.2 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.2',
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.2 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.2 documentation" href="../../index.html" />
<link rel="up" title="animation module" href="../animation_api.html" />
<link rel="next" title="matplotlib.animation.Animation.to_html5_video" href="matplotlib.animation.Animation.to_html5_video.html" />
<link rel="prev" title="matplotlib.animation.ArtistAnimation" href="matplotlib.animation.ArtistAnimation.html" />
<link rel="canonical" href="https://matplotlib.org/2.0.2/api/_as_gen/matplotlib.animation.Animation.save.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.2). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</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="matplotlib.animation.Animation.to_html5_video.html" title="matplotlib.animation.Animation.to_html5_video"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="matplotlib.animation.ArtistAnimation.html" title="matplotlib.animation.ArtistAnimation"
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" >The Matplotlib API</a> »</li>
<li><a href="../animation_api.html" accesskey="U"><code class="docutils literal"><span class="pre">animation</span></code> module</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<a href="http://depsy.org/package/python/matplotlib">
<img src="../../_static/depsy_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/><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><a href="../animation_api.html"><code class="docutils literal"><span class="pre">animation</span></code> module</a><ul>
<li>Previous: <a href="matplotlib.animation.ArtistAnimation.html" title="previous chapter">matplotlib.animation.ArtistAnimation</a></li>
<li>Next: <a href="matplotlib.animation.Animation.to_html5_video.html" title="next chapter">matplotlib.animation.Animation.to_html5_video</a></li>
</ul></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/_as_gen/matplotlib.animation.Animation.save.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="matplotlib-animation-animation-save">
<h1>matplotlib.animation.Animation.save<a class="headerlink" href="#matplotlib-animation-animation-save" title="Permalink to this headline">¶</a></h1>
<dl class="method">
<dt id="matplotlib.animation.Animation.save">
<code class="descclassname">Animation.</code><code class="descname">save</code><span class="sig-paren">(</span><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>, <em>savefig_kwargs=None</em><span class="sig-paren">)</span><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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>filename</strong> : str</p>
<blockquote>
<div><p>The output filename, e.g., <code class="file docutils literal"><span class="pre">mymovie.mp4</span></code></p>
</div></blockquote>
<p><strong>writer</strong> : <a class="reference internal" href="matplotlib.animation.MovieWriter.html#matplotlib.animation.MovieWriter" title="matplotlib.animation.MovieWriter"><code class="xref py py-class docutils literal"><span class="pre">MovieWriter</span></code></a> or str, optional</p>
<blockquote>
<div><p>A <a class="reference internal" href="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> instance to use or a key that identifies a
class to use, such as ‘ffmpeg’ or ‘mencoder’. If <code class="xref py py-obj docutils literal"><span class="pre">None</span></code>,
defaults to <code class="docutils literal"><span class="pre">rcParams['animation.writer']</span></code></p>
</div></blockquote>
<p><strong>fps</strong> : number, optional</p>
<blockquote>
<div><p>frames per second in the movie. Defaults to None,
which will use the animation’s specified interval to set
the frames per second.</p>
</div></blockquote>
<p><strong>dpi</strong> : number, optional</p>
<blockquote>
<div><p>Controls the dots per inch for the movie frames. This
combined with the figure’s size in inches controls the size of
the movie. If None, defaults to <code class="docutils literal"><span class="pre">rcparam['savefig.dpi']</span></code></p>
</div></blockquote>
<p><strong>codec</strong> : str, optional</p>
<blockquote>
<div><p>The video codec to be used. Not all codecs are supported by
a given <a class="reference internal" href="matplotlib.animation.MovieWriter.html#matplotlib.animation.MovieWriter" title="matplotlib.animation.MovieWriter"><code class="xref py py-class docutils literal"><span class="pre">MovieWriter</span></code></a>. If <code class="xref py py-obj docutils literal"><span class="pre">None</span></code>,
default to <code class="docutils literal"><span class="pre">rcParams['animation.codec']</span></code></p>
</div></blockquote>
<p><strong>bitrate</strong> : number, optional</p>
<blockquote>
<div><p>Specifies the number 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 <code class="xref py py-obj docutils literal"><span class="pre">None</span></code>, defaults to
<code class="docutils literal"><span class="pre">rcParam['animation.bitrate']</span></code></p>
</div></blockquote>
<p><strong>extra_args</strong> : list, optional</p>
<blockquote>
<div><p>List of extra string arguments to be passed to the
underlying movie utility. If <code class="xref py py-obj docutils literal"><span class="pre">None</span></code>, defaults to
<code class="docutils literal"><span class="pre">rcParams['animation.extra_args']</span></code></p>
</div></blockquote>
<p><strong>metadata</strong> : dict, optional</p>
<blockquote>
<div><p>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>
</div></blockquote>
<p><strong>extra_anim</strong> : list, optional</p>
<blockquote>
<div><p>Additional <a class="reference internal" href="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> objects that should be included in
the saved movie file. These need to be from the same
<code class="xref py py-obj docutils literal"><span class="pre">matplotlib.Figure</span></code> 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>
</div></blockquote>
<p><strong>savefig_kwargs</strong> : dict, optional</p>
<blockquote class="last">
<div><p>Is a dictionary containing keyword arguments to be passed
on to the ‘savefig’ command which is called repeatedly to
save the individual frames.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>fps, codec, bitrate, extra_args, metadata are used to
construct a <a class="reference internal" href="matplotlib.animation.MovieWriter.html#matplotlib.animation.MovieWriter" title="matplotlib.animation.MovieWriter"><code class="xref py py-class docutils literal"><span class="pre">MovieWriter</span></code></a> instance and can only be
passed if <code class="xref py py-obj docutils literal"><span class="pre">writer</span></code> is a string. If they are passed as
non-<code class="xref py py-obj docutils literal"><span class="pre">None</span></code> and <code class="docutils literal"><span class="pre">writer</span></code> is a <a class="reference internal" href="matplotlib.animation.MovieWriter.html#matplotlib.animation.MovieWriter" title="matplotlib.animation.MovieWriter"><code class="xref py py-class docutils literal"><span class="pre">MovieWriter</span></code></a>, a
<code class="xref py py-obj docutils literal"><span class="pre">RuntimeError</span></code> will be raised.</p>
</dd></dl>
</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 May 10, 2017.
Created using <a
href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.
</div>
</body>
<footer>
</footer>
</html>