-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathClawPlotFigure.html
279 lines (257 loc) · 12.6 KB
/
ClawPlotFigure.html
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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>ClawPlotFigure — Clawpack 5.11.x documentation</title>
<link rel="stylesheet" href="_static/base.css" type="text/css" />
<link rel="stylesheet" href="_static/layout.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/flasky.css" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<link rel="shortcut icon" href="_static/clawicon.ico"/>
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="ClawPlotAxes" href="ClawPlotAxes.html" />
<link rel="prev" title="ClawPlotData" href="ClawPlotData.html" />
</head><body>
<div id="main-wrapper" class="sphinx">
<div id="header-wrapper">
<section id="header">
<!-- <h1><a href="http://clawpack.org/">Clawpack</a></h1> -->
<h1><a href="http://clawpack.org/">Clawpack-5</a></h1>
<nav>
<ul>
<li>
<a href="contents.html">Docs</a>
</li>
<li>
<a href="installing.html">Install</a>
</li>
<li>
<a class="" href="http://clawpack.org/gallery/index.html">Gallery</a>
</li>
<li>
<a href="about.html">Citation</a>
</li>
<li>
<a class="active" href="http://github.com/clawpack">GitHub</a>
</li>
<li>
<a class="" href="community.html">Community</a>
</li>
<li>
<a class="" href="developers.html">Contribute</a>
</li>
</ul>
</nav>
</section>
<div class="decoration"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<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="ClawPlotAxes.html" title="ClawPlotAxes"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="ClawPlotData.html" title="ClawPlotData"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="contents.html">Clawpack 5.11.x documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="plotting.html" >Plotting with Visclaw</a> »</li>
<li class="nav-item nav-item-2"><a href="setplot.html" accesskey="U">Using setplot.py to specify the desired plots</a> »</li>
<li class="nav-item nav-item-this"><a href="">ClawPlotFigure</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="clawplotfigure">
<span id="id1"></span><h1>ClawPlotFigure<a class="headerlink" href="#clawplotfigure" title="Permalink to this heading">¶</a></h1>
<p>For usage see <a class="reference internal" href="setplot.html#setplot"><span class="std std-ref">Using setplot.py to specify the desired plots</span></a> and <a class="reference internal" href="plotexamples.html#plotexamples"><span class="std std-ref">Plotting examples</span></a>.</p>
<p>Objects of this class are usually created by the new_plotfigure method of a
<a class="reference internal" href="ClawPlotData.html#clawplotdata"><span class="std std-ref">ClawPlotData</span></a> object.</p>
<dl class="py class">
<dt class="sig sig-object py" id="ClawPlotFigure">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ClawPlotFigure</span></span><a class="headerlink" href="#ClawPlotFigure" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<section id="attributes">
<h2>Attributes<a class="headerlink" href="#attributes" title="Permalink to this heading">¶</a></h2>
<blockquote>
<div><p>The following attributes can be set by the user:</p>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">figno</span> <span class="pre">:</span> <span class="pre">int</span></span></dt>
<dd><p>Figure number, by default the next unused number will be used (starting
at 1001).
This is usually set as an argument to the new_plotfigure function
of a <a class="reference internal" href="ClawPlotData.html#clawplotdata"><span class="std std-ref">ClawPlotData</span></a> object</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">figsize</span> <span class="pre">:</span> <span class="pre">tuple</span></span></dt>
<dd><p>Figure size in (x,y) as in matplotlib.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">facecolor</span> <span class="pre">:</span> <span class="pre">color</span></span></dt>
<dd><p>Color for the background of the figure (behind the axes).
By default (if <cite>facecolor is None</cite>) the clawpack theme tan color is used.</p>
<p>For plots to be included in publications you probably want to use
<cite>‘w’</cite> for a white background instead.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">kwargs</span> <span class="pre">:</span> <span class="pre">dictionary</span></span></dt>
<dd><p>A dictionary of keyword arguments for the figure command.
For example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s2">"{'figsize':[12,5], 'facecolor':[1,0,0]}"</span>
</pre></div>
</div>
<p>would specify that the figure should be
12 inches by 5 inches with a red background.</p>
<p>For more options
see the <a class="reference external" href="http://matplotlib.sourceforge.net/">matplotlib documentation</a>
for the <a class="reference external" href="http://matplotlib.sourceforge.net/api/figure_api.html#matplotlib.figure.Figure">figure command</a>.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">clf_each_frame</span> <span class="pre">:</span> <span class="pre">bool</span></span></dt>
<dd><p>If True, clear the figure with a clf command at the start of each frame.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">show</span> <span class="pre">:</span> <span class="pre">bool</span></span></dt>
<dd><p>If False, suppress showing this figure.</p>
</dd></dl>
</div></blockquote>
</section>
<section id="methods">
<h2>Methods<a class="headerlink" href="#methods" title="Permalink to this heading">¶</a></h2>
<blockquote>
<div><dl class="py method">
<dt class="sig sig-object py" id="new_plotaxes">
<span class="sig-name descname"><span class="pre">new_plotaxes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#new_plotaxes" title="Permalink to this definition">¶</a></dt>
<dd><p>Create and return a new object of class <a class="reference internal" href="ClawPlotAxes.html#clawplotaxes"><span class="std std-ref">ClawPlotAxes</span></a> associated with this
ClawPlotFigure object. A single figure may have several axes on it.</p>
<p>The name specified is used as a dictionary key. If None is provided,
one is generated automatically of the form AXES1, etc.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="gethandle">
<span class="sig-name descname"><span class="pre">gethandle</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#gethandle" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the handle for this figure.</p>
</dd></dl>
</div></blockquote>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p><a href="http://clawpack.org/">
<img class="logo" src= "_static/clawlogo.jpg" alt="Logo"/>
</a>
<h2>Version 5.11.x</h2>
</p>
<div>
<h3><a href="contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">ClawPlotFigure</a><ul>
<li><a class="reference internal" href="#ClawPlotFigure"><code class="docutils literal notranslate"><span class="pre">ClawPlotFigure</span></code></a></li>
<li><a class="reference internal" href="#attributes">Attributes</a></li>
<li><a class="reference internal" href="#methods">Methods</a><ul>
<li><a class="reference internal" href="#new_plotaxes"><code class="docutils literal notranslate"><span class="pre">new_plotaxes()</span></code></a></li>
<li><a class="reference internal" href="#gethandle"><code class="docutils literal notranslate"><span class="pre">gethandle()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div><h3>Related Topics</h3>
<ul>
<li><a href="contents.html">Documentation overview</a><ul>
<li><a href="plotting.html">Plotting with Visclaw</a><ul>
<li><a href="setplot.html">Using setplot.py to specify the desired plots</a><ul>
<li>Previous: <a href="ClawPlotData.html" title="previous chapter">ClawPlotData</a></li>
<li>Next: <a href="ClawPlotAxes.html" title="next chapter">ClawPlotAxes</a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
<div class="widget navlinks">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/ClawPlotFigure.rst.txt"
rel="nofollow"
target="_blank">Source .rst</a></li>
<li><a href="https://github.com/clawpack/doc/blob/dev/doc/ClawPlotFigure.rst"
rel="nofollow"
target="_blank">Source on GitHub</a></li>
<li><a href="https://github.com/clawpack/doc/commits/dev/doc/ClawPlotFigure.rst"
rel="nofollow"
target="_blank">History</a></li>
<li><a href="https://github.com/clawpack/doc/edit/dev/doc/ClawPlotFigure.rst"
rel="nofollow"
target="_blank">Suggest Edits</a></li>
<li><a href="https://github.com/clawpack/doc/issues/new/choose"
rel="nofollow"
target="_blank">Raise an Issue</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
<h4>Latest Version</h4>
<ul>
<li><a href="./dev/ClawPlotFigure.html">dev</a></li>
<li><a href="ClawPlotFigure.html">v5.11.x</a></li>
</ul>
<h4>Older Versions</h4>
<ul>
<li><a href="./v5.10.x/ClawPlotFigure.html">v5.10.x</a></li>
<li><a href="./v5.7.x/ClawPlotFigure.html">v5.7.x</a></li>
<li><a href="./v5.8.x/ClawPlotFigure.html">v5.8.x</a></li>
<li><a href="./v5.9.x/ClawPlotFigure.html">v5.9.x</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright CC-BY 2024, The Clawpack Development Team.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-44811544-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>