-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathmatplotlib.animation.AbstractMovieWriter.html
More file actions
220 lines (191 loc) · 12.5 KB
/
matplotlib.animation.AbstractMovieWriter.html
File metadata and controls
220 lines (191 loc) · 12.5 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
<!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.AbstractMovieWriter — Matplotlib 2.2.3 documentation</title>
<link rel="stylesheet" href="../../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../../_static/gallery.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '2.2.3',
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.2.3 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.2.3 documentation" href="../../index.html" />
<link rel="up" title="animation" href="../animation_api.html" />
<link rel="next" title="matplotlib.animation.MovieWriter" href="matplotlib.animation.MovieWriter.html" />
<link rel="prev" title="matplotlib.animation.MovieWriterRegistry" href="matplotlib.animation.MovieWriterRegistry.html" />
<link rel="canonical" href="https://matplotlib.org/stable/api/_as_gen/matplotlib.animation.AbstractMovieWriter.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.2.3). For the latest version see <a href="https://matplotlib.org/stable/api/_as_gen/matplotlib.animation.AbstractMovieWriter.html">https://matplotlib.org/stable/api/_as_gen/matplotlib.animation.AbstractMovieWriter.html</a></div>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 2.2.3</span></div>
<img src="../../_static/logo2.png" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="matplotlib.animation.MovieWriter.html" title="matplotlib.animation.MovieWriter"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="matplotlib.animation.MovieWriterRegistry.html" title="matplotlib.animation.MovieWriterRegistry"
accesskey="P">previous</a> |</li>
<li><a href="../../index.html">home</a>| </li>
<li><a href="../../gallery/index.html">examples</a>| </li>
<li><a href="../../tutorials/index.html">tutorials</a>| </li>
<li><a href="../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">animation</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script><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">animation</a><ul>
<li>Previous: <a href="matplotlib.animation.MovieWriterRegistry.html" title="previous chapter">matplotlib.animation.MovieWriterRegistry</a></li>
<li>Next: <a href="matplotlib.animation.MovieWriter.html" title="next chapter">matplotlib.animation.MovieWriter</a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="sidebar-pagesource" role="note" aria-label="source link"
style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">
<a href="../../_sources/api/_as_gen/matplotlib.animation.AbstractMovieWriter.rst.txt"
style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="matplotlib-animation-abstractmoviewriter">
<h1>matplotlib.animation.AbstractMovieWriter<a class="headerlink" href="#matplotlib-animation-abstractmoviewriter" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="matplotlib.animation.AbstractMovieWriter">
<em class="property">class </em><code class="descclassname">matplotlib.animation.</code><code class="descname">AbstractMovieWriter</code><a class="reference internal" href="../../_modules/matplotlib/animation.html#AbstractMovieWriter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.animation.AbstractMovieWriter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Abstract base class for writing movies. Fundamentally, what a MovieWriter
does is provide is a way to grab frames by calling grab_frame().</p>
<p>setup() is called to start the process and finish() is called afterwards.</p>
<p>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-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">moviewriter</span><span class="o">.</span><span class="n">saving</span><span class="p">(</span><span class="n">fig</span><span class="p">,</span> <span class="n">outfile</span><span class="o">=</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="c1"># Iterate over frames</span>
<span class="n">moviewriter</span><span class="o">.</span><span class="n">grab_frame</span><span class="p">(</span><span class="o">**</span><span class="n">savefig_kwargs</span><span class="p">)</span>
</pre></div>
</div>
<p>The use of the context manager ensures that setup() and finish() are
performed as necessary.</p>
<p>An instance of a concrete subclass of this class can be given as the
<code class="docutils literal notranslate"><span class="pre">writer</span></code> argument of <a class="reference internal" href="matplotlib.animation.Animation.html#matplotlib.animation.Animation.save" title="matplotlib.animation.Animation.save"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Animation.save()</span></code></a>.</p>
<dl class="method">
<dt id="matplotlib.animation.AbstractMovieWriter.finish">
<code class="descname">finish</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/matplotlib/animation.html#AbstractMovieWriter.finish"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.animation.AbstractMovieWriter.finish" title="Permalink to this definition">¶</a></dt>
<dd><p>Finish any processing for writing the movie.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.animation.AbstractMovieWriter.grab_frame">
<code class="descname">grab_frame</code><span class="sig-paren">(</span><em>**savefig_kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/matplotlib/animation.html#AbstractMovieWriter.grab_frame"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.animation.AbstractMovieWriter.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>
<p>All keyword arguments in savefig_kwargs are passed on to the <code class="xref py py-obj docutils literal notranslate"><span class="pre">savefig</span></code>
command that saves the figure.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.animation.AbstractMovieWriter.saving">
<code class="descname">saving</code><span class="sig-paren">(</span><em>fig</em>, <em>outfile</em>, <em>dpi</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/matplotlib/animation.html#AbstractMovieWriter.saving"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.animation.AbstractMovieWriter.saving" title="Permalink to this definition">¶</a></dt>
<dd><p>Context manager to facilitate writing the movie file.</p>
<p><code class="docutils literal notranslate"><span class="pre">*args,</span> <span class="pre">**kw</span></code> are any parameters that should be passed to <a class="reference internal" href="#matplotlib.animation.AbstractMovieWriter.setup" title="matplotlib.animation.AbstractMovieWriter.setup"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setup</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.animation.AbstractMovieWriter.setup">
<code class="descname">setup</code><span class="sig-paren">(</span><em>fig</em>, <em>outfile</em>, <em>dpi=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/matplotlib/animation.html#AbstractMovieWriter.setup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.animation.AbstractMovieWriter.setup" title="Permalink to this definition">¶</a></dt>
<dd><p>Perform setup for writing the movie file.</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"><dl class="first last docutils">
<dt><strong>fig: `matplotlib.figure.Figure` instance</strong></dt>
<dd><p class="first last">The figure object that contains the information for frames</p>
</dd>
<dt><strong>outfile: string</strong></dt>
<dd><p class="first last">The filename of the resulting movie file</p>
</dd>
<dt><strong>dpi: int, optional</strong></dt>
<dd><p class="first last">The DPI (or resolution) for the file. This controls the size
in pixels of the resulting movie file. Default is <code class="docutils literal notranslate"><span class="pre">fig.dpi</span></code>.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<div class="clearer"></div></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2018 The Matplotlib development team.
<br />
Last updated on Aug 11, 2018.
Created using
<ahref="http://sphinx-doc.org/">Sphinx</a> 1.7.6.
Doc version v2.2.3-1-gd47e15e7a.
</div>
</body>
<footer>
</footer>
</html>