-
Notifications
You must be signed in to change notification settings - Fork 7
/
ClawPlotAxes.html
514 lines (465 loc) · 27.6 KB
/
ClawPlotAxes.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
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
<!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>ClawPlotAxes — Clawpack 5.10.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="ClawPlotItem" href="ClawPlotItem.html" />
<link rel="prev" title="ClawPlotFigure" href="ClawPlotFigure.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="ClawPlotItem.html" title="ClawPlotItem"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="ClawPlotFigure.html" title="ClawPlotFigure"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="contents.html">Clawpack 5.10.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="">ClawPlotAxes</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="clawplotaxes">
<span id="id1"></span><h1>ClawPlotAxes<a class="headerlink" href="#clawplotaxes" 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_plotaxes method of a
<a class="reference internal" href="ClawPlotFigure.html#clawplotfigure"><span class="std std-ref">ClawPlotFigure</span></a> object.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><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>
</div>
<dl class="py class">
<dt class="sig sig-object py" id="ClawPlotAxes">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ClawPlotAxes</span></span><a class="headerlink" href="#ClawPlotAxes" 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">name</span> <span class="pre">:</span> <span class="pre">str</span></span></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">axescmd</span> <span class="pre">:</span> <span class="pre">str</span></span></dt>
<dd></dd></dl>
<dl class="simple">
<dt>The command to be used to create this axes, for example:</dt><dd><ul class="simple">
<li><p>“subplot(1,1,1)” for a single axes filling the figure</p></li>
<li><p>“subplot(2,1,1)” for the top half</p></li>
<li><p>“axes([0.1, 0.1, 0.2, 0.8])” for a tall skinny axis.</p></li>
</ul>
</dd>
</dl>
<p>See the matplotlib documentation for axes.</p>
<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 axes and all items on it.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">title</span> <span class="pre">:</span> <span class="pre">str</span></span></dt>
<dd><p>The title to appear at the top of the axis. Defaults to string
specified by the <em>name</em> attribute.</p>
<p><strong>New in v5.9.1:</strong></p>
<p>Note that the title can now include the string <cite>h:m:s</cite> or <cite>d:h:m:s</cite>
as described further below for the case <cite>title_with_t == True</cite>.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">title_fontsize</span> <span class="pre">:</span> <span class="pre">float</span></span></dt>
<dd><p>Fontsize for title</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">title_kwargs</span> <span class="pre">:</span> <span class="pre">str</span></span></dt>
<dd><p>Any other kwargs to be passed to plt.title(), e.g. <cite>‘color’</cite></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">title_with_t</span> <span class="pre">:</span> <span class="pre">bool</span></span></dt>
<dd><p>If True, creates a title using a default format like:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>`"%s at time t = %14.8e" % (title, t)`
</pre></div>
</div>
<p>And rather than <cite>%14.8e</cite> for <cite>t</cite>, the default format uses <cite>%14.8f</cite>
if <cite>0.001 <= t <= 1000</cite>.</p>
<p>A different format can be specified with the <cite>title_t_format</cite> attribute.</p>
<p><strong>New in v5.9.1:</strong></p>
<p>If the <cite>title</cite> attribute contains the string
<cite>d:h:m:s</cite> then the time is formatted as days:hours:minutes:seconds.</p>
<p>Otherwise, if the <cite>title</cite> attribute contains the string
<cite>h:m:s</cite> then the time is formatted as hours:minutes:seconds.</p>
<p>For example, you could specify:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">plotaxes</span><span class="o">.</span><span class="n">title_with_t</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">plotaxes</span><span class="o">.</span><span class="n">title</span> <span class="o">=</span> <span class="s1">'Surface elevation at time h:m:s after earthquake'</span>
</pre></div>
</div>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">title_t_format</span> <span class="pre">:</span> <span class="pre">str</span></span></dt>
<dd><p>A format string used to format <cite>t</cite> in the title. If this is not
<cite>None</cite>, then this is used instead of the conventions mentioned above.</p>
<p>Internally it formats using:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">t_str</span> <span class="o">=</span> <span class="n">plotaxes</span><span class="o">.</span><span class="n">title_t_format</span> <span class="o">%</span> <span class="n">t</span>
<span class="n">title_str</span> <span class="o">=</span> <span class="s2">"</span><span class="si">%s</span><span class="s2"> at time t = </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">plotaxes</span><span class="o">.</span><span class="n">title</span><span class="p">,</span><span class="n">t_str</span><span class="p">)</span>
<span class="n">plt</span><span class="o">.</span><span class="n">title</span><span class="p">(</span><span class="n">title_str</span><span class="p">,</span> <span class="o">**</span><span class="n">plotaxes</span><span class="o">.</span><span class="n">title_kwargs</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">xlimits</span> <span class="pre">:</span> <span class="pre">array</span> <span class="pre">[xmin,</span> <span class="pre">xmax]</span>  <span class="pre">or</span> <span class="pre">'auto'</span></span></dt>
<dd><p>The x-axis limits if an array with two elements, or choose
automatically</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">ylimits</span> <span class="pre">:</span> <span class="pre">array</span> <span class="pre">[ymin,</span> <span class="pre">ymax]</span>  <span class="pre">or</span> <span class="pre">'auto'</span></span></dt>
<dd><p>The y-axis limits if an array with two elements, or choose
automatically</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">xticks_fontsize</span> <span class="pre">:</span> <span class="pre">float</span></span></dt>
<dd><p>Fontsize for xtick mark labels</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">xticks_kwargs</span> <span class="pre">:</span> <span class="pre">dictionary</span></span></dt>
<dd><p>Other kwargs to be passed to <cite>xticks</cite> (e.g. locations)</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">xlabel</span> <span class="pre">:</span> <span class="pre">str</span></span></dt>
<dd><p>Label for x-axis</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">xlabel_fontsize</span> <span class="pre">:</span> <span class="pre">str</span></span></dt>
<dd><p>Fontsize for x-axis label</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">xlabel_kwargs</span> <span class="pre">:</span> <span class="pre">dictionary</span></span></dt>
<dd><p>Other kwargs to be passed to <cite>xlabel</cite> (e.g. color)</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">yticks_fontsize</span> <span class="pre">:</span> <span class="pre">float</span></span></dt>
<dd><p>Fontsize for ytick mark labels</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">yticks_kwargs</span> <span class="pre">:</span> <span class="pre">dictionary</span></span></dt>
<dd><p>Other kwargs to be passed to <cite>yticks</cite> (e.g. locations)</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">ylabel</span> <span class="pre">:</span> <span class="pre">str</span></span></dt>
<dd><p>Label for y-axis</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">ylabel_fontsize</span> <span class="pre">:</span> <span class="pre">str</span></span></dt>
<dd><p>Fontsize for y-axis label</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">ylabel_kwargs</span> <span class="pre">:</span> <span class="pre">dictionary</span></span></dt>
<dd><p>Other kwargs to be passed to <cite>ylabel</cite> (e.g. color)</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">aspect</span> <span class="pre">:</span> <span class="pre">float</span></span></dt>
<dd><p>Aspect ratio for plot, used internally in the command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">plt</span><span class="o">.</span><span class="n">gca</span><span class="p">()</span><span class="o">.</span><span class="n">set_aspect</span><span class="p">(</span><span class="n">plotaxes</span><span class="o">.</span><span class="n">aspect</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">aspect_latitude</span> <span class="pre">:</span> <span class="pre">float</span></span></dt>
<dd><p>For plots in longitude-latitude coordinates, the latitude to use for
chosing the aspect ratio so that distances in meters are the same
in x and y at this latitude. (For plots covering a broad range of
latitudes, the the latitude near the middle or near the location of
most interest is generally most appropriate.</p>
<p>This value is used internally in the command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">plt</span><span class="o">.</span><span class="n">gca</span><span class="p">()</span><span class="o">.</span><span class="n">set_aspect</span><span class="p">(</span><span class="mf">1.</span><span class="o">/</span><span class="n">np</span><span class="o">.</span><span class="n">cos</span><span class="p">(</span><span class="n">plotaxes</span><span class="o">.</span><span class="n">aspect_latitude</span> \
<span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">pi</span><span class="o">/</span><span class="mi">180</span><span class="p">))</span>
</pre></div>
</div>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">useOffset</span> <span class="pre">:</span> <span class="pre">boolean</span></span></dt>
<dd><p>If <cite>True</cite>, then tick marks may be labeled with an offset from some
common value that is printed at the corner. Often it is nicer to see
the full value at each tick mark, for which this should be set to <cite>False</cite>.</p>
<p>Internally the command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">plt</span><span class="o">.</span><span class="n">ticklabel_format</span><span class="p">(</span><span class="n">useOffset</span> <span class="o">=</span> <span class="n">plotaxes</span><span class="o">.</span><span class="n">useOffset</span><span class="p">)</span>
</pre></div>
</div>
<p>is issued if <cite>useOffset is not None</cite>.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">grid</span> <span class="pre">:</span> <span class="pre">boolean</span></span></dt>
<dd><p>If <cite>True</cite> then internally the command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">plt</span><span class="o">.</span><span class="n">grid</span><span class="p">(</span><span class="o">**</span><span class="n">plotaxes</span><span class="o">.</span><span class="n">grid_kwargs</span><span class="p">)</span>
</pre></div>
</div>
<p>is issued to add grid lines to the plot.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">grid_kwargs</span> <span class="pre">:</span> <span class="pre">dictionary</span></span></dt>
<dd><p>Any kwargs to be passed to <cite>plt.grid</cite>, e.g. <cite>‘color’</cite> or <cite>‘linewidth’</cite>.</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>Any other attributes to be passed to <cite>axes</cite> command.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">afteraxes</span> <span class="pre">:</span> <span class="pre">function</span> <span class="pre">or</span> <span class="pre">str</span></span></dt>
<dd><p>A string or function that is to be executed after creating all
plot items on this axes.
If a string, this string is executed using <em>exec</em>. If a
function, it should be defined to have a single argument
<a class="reference internal" href="current_data.html#current-data"><span class="std std-ref">current_data</span></a>.</p>
<p>The string version is useful for 1-liners such as:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">afteraxes</span> <span class="o">=</span> <span class="s2">"pylab.title('My custom title')"</span>
</pre></div>
</div>
<p>pylab commands can be used, since pylab has been imported into the
plotting module.</p>
<p>The function form is better if you want to do several things, or if you
need access to the data stored in <a class="reference internal" href="current_data.html#current-data"><span class="std std-ref">current_data</span></a>. For example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">afteraxes</span><span class="p">(</span><span class="n">current_data</span><span class="p">):</span>
<span class="c1"># add x- and y-axes to a 1d plot already created</span>
<span class="kn">from</span> <span class="nn">pylab</span> <span class="kn">import</span> <span class="n">plot</span>
<span class="n">xlower</span> <span class="o">=</span> <span class="n">current_data</span><span class="o">.</span><span class="n">xlower</span>
<span class="n">xupper</span> <span class="o">=</span> <span class="n">current_data</span><span class="o">.</span><span class="n">xupper</span>
<span class="n">plot</span><span class="p">([</span><span class="n">xlower</span><span class="p">,</span> <span class="n">xupper</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.</span><span class="p">,</span><span class="mf">0.</span><span class="p">],</span> <span class="s1">'k'</span><span class="p">)</span> <span class="c1"># x-axis</span>
<span class="c1"># Get y limits from variable just plotted, which is</span>
<span class="c1"># available in current_data.var.</span>
<span class="n">ymin</span> <span class="o">=</span> <span class="n">current_data</span><span class="o">.</span><span class="n">var</span><span class="o">.</span><span class="n">min</span><span class="p">()</span>
<span class="n">ymax</span> <span class="o">=</span> <span class="n">current_data</span><span class="o">.</span><span class="n">var</span><span class="o">.</span><span class="n">max</span><span class="p">()</span>
<span class="n">plot</span><span class="p">([</span><span class="mf">0.</span><span class="p">,</span><span class="mf">0.</span><span class="p">],</span> <span class="p">[</span><span class="n">ymin</span><span class="p">,</span><span class="n">ymax</span><span class="p">],</span> <span class="s1">'k'</span><span class="p">)</span> <span class="c1"># y-axis</span>
</pre></div>
</div>
</dd></dl>
</div></blockquote>
</section>
<section id="attributes-for-gauge-plots">
<h2>Attributes for gauge plots<a class="headerlink" href="#attributes-for-gauge-plots" title="Permalink to this heading">¶</a></h2>
<p>The following attributes are primarily useful for gauge plots, where the
horizontal axis is time <cite>t</cite> rather than <cite>x</cite>, and are implemented in
<cite>$CLAW/visclaw/src/python/visclaw/gaugetools.py</cite>:</p>
<blockquote>
<div><dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">time_scale</span> <span class="pre">:</span> <span class="pre">float</span></span></dt>
<dd><p>Scaling for time values, e.g. if <cite>t</cite> is in seconds but you want the
plot to show hours on the horizontal axis then set
<cite>time_scale = 1/3600.</cite>.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">time_label</span> <span class="pre">:</span> <span class="pre">str</span></span></dt>
<dd><p>Label for time axis (same as setting <cite>xlabel</cite>)</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">time_label_fontsize</span> <span class="pre">:</span> <span class="pre">float</span></span></dt>
<dd><p>Fontsize for <cite>xlabel</cite> (time axis)</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">time_label_kwargs</span> <span class="pre">:</span> <span class="pre">dictionary</span></span></dt>
<dd><p>Other kwargs to be passed to <cite>xlabel</cite> (e.g. color)</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_plotitem">
<span class="sig-name descname"><span class="pre">new_plotitem</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plot_type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#new_plotitem" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns an object of class <a class="reference internal" href="ClawPlotItem.html#clawplotitem"><span class="std std-ref">ClawPlotItem</span></a> associated with this axes.
A single axes may have several items associated with it.</p>
<p>The name specified is used as a dictionary key. If None is provided,
one is generated automatically of the form ITEM1, 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 axes.</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.10.x</h2>
</p>
<div>
<h3><a href="contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">ClawPlotAxes</a><ul>
<li><a class="reference internal" href="#ClawPlotAxes"><code class="docutils literal notranslate"><span class="pre">ClawPlotAxes</span></code></a></li>
<li><a class="reference internal" href="#attributes">Attributes</a></li>
<li><a class="reference internal" href="#attributes-for-gauge-plots">Attributes for gauge plots</a></li>
<li><a class="reference internal" href="#methods">Methods</a><ul>
<li><a class="reference internal" href="#new_plotitem"><code class="docutils literal notranslate"><span class="pre">new_plotitem()</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="ClawPlotFigure.html" title="previous chapter">ClawPlotFigure</a></li>
<li>Next: <a href="ClawPlotItem.html" title="next chapter">ClawPlotItem</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/ClawPlotAxes.rst.txt"
rel="nofollow"
target="_blank">Source .rst</a></li>
<li><a href="https://github.com/clawpack/doc/blob/dev/doc/ClawPlotAxes.rst"
rel="nofollow"
target="_blank">Source on GitHub</a></li>
<li><a href="https://github.com/clawpack/doc/commits/dev/doc/ClawPlotAxes.rst"
rel="nofollow"
target="_blank">History</a></li>
<li><a href="https://github.com/clawpack/doc/edit/dev/doc/ClawPlotAxes.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/ClawPlotAxes.html">dev</a></li>
<li><a href="ClawPlotAxes.html">v5.10.x</a></li>
</ul>
<h4>Older Versions</h4>
<ul>
<li><a href="./v5.7.x/ClawPlotAxes.html">v5.7.x</a></li>
<li><a href="./v5.8.x/ClawPlotAxes.html">v5.8.x</a></li>
<li><a href="./v5.9.x/ClawPlotAxes.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>