-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathmplot3d.html
More file actions
809 lines (772 loc) · 49.2 KB
/
mplot3d.html
File metadata and controls
809 lines (772 loc) · 49.2 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
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
<!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>The mplot3d Toolkit — Matplotlib 3.0.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/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../../_static/gallery.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></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>
<script type="text/javascript" src="../../_static/language_data.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.0.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 3.0.3 documentation" href="../../index.html" />
<link rel="up" title="Tutorials" href="../index.html" />
<link rel="next" title="Interactive plots" href="../../users/interactive.html" />
<link rel="prev" title="Overview of axisartist toolkit" href="axisartist.html" />
<link rel="canonical" href="https://matplotlib.org/stable/tutorials/toolkits/mplot3d.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 (v3.0.3). For the latest version see <a href="https://matplotlib.org/stable/tutorials/toolkits/mplot3d.html">https://matplotlib.org/stable/tutorials/toolkits/mplot3d.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 3.0.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="../../users/interactive.html" title="Interactive plots"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="axisartist.html" title="Overview of axisartist toolkit"
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="../index.html">tutorials</a>| </li>
<li><a href="../../api/api_overview.html">API</a>| </li>
<li><a href="../../contents.html">docs</a> »</li>
<li><a href="../../users/index.html" >User's Guide</a> »</li>
<li><a href="../index.html" accesskey="U">Tutorials</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>
<h3><a href="../../contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">The mplot3d Toolkit</a><ul>
<li><a class="reference internal" href="#getting-started">Getting started</a><ul>
<li><a class="reference internal" href="#line-plots">Line plots</a></li>
<li><a class="reference internal" href="#scatter-plots">Scatter plots</a></li>
<li><a class="reference internal" href="#wireframe-plots">Wireframe plots</a></li>
<li><a class="reference internal" href="#surface-plots">Surface plots</a></li>
<li><a class="reference internal" href="#tri-surface-plots">Tri-Surface plots</a></li>
<li><a class="reference internal" href="#contour-plots">Contour plots</a></li>
<li><a class="reference internal" href="#filled-contour-plots">Filled contour plots</a></li>
<li><a class="reference internal" href="#polygon-plots">Polygon plots</a></li>
<li><a class="reference internal" href="#bar-plots">Bar plots</a></li>
<li><a class="reference internal" href="#quiver">Quiver</a></li>
<li><a class="reference internal" href="#d-plots-in-3d">2D plots in 3D</a></li>
<li><a class="reference internal" href="#text">Text</a></li>
<li><a class="reference internal" href="#subplotting">Subplotting</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../contents.html">Documentation overview</a><ul>
<li><a href="../../users/index.html">User's Guide</a><ul>
<li><a href="../index.html">Tutorials</a><ul>
<li>Previous: <a href="axisartist.html" title="previous chapter">Overview of axisartist toolkit</a></li>
<li>Next: <a href="../../users/interactive.html" title="next chapter">Interactive plots</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/tutorials/toolkits/mplot3d.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="sphx-glr-download-link-note admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Click <a class="reference internal" href="#sphx-glr-download-tutorials-toolkits-mplot3d-py"><span class="std std-ref">here</span></a> to download the full example code</p>
</div>
<div class="sphx-glr-example-title section" id="the-mplot3d-toolkit">
<span id="sphx-glr-tutorials-toolkits-mplot3d-py"></span><h1>The mplot3d Toolkit<a class="headerlink" href="#the-mplot3d-toolkit" title="Permalink to this headline">¶</a></h1>
<p>Generating 3D plots using the mplot3d toolkit.</p>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#the-mplot3d-toolkit" id="id14">The mplot3d Toolkit</a><ul>
<li><a class="reference internal" href="#getting-started" id="id15">Getting started</a><ul>
<li><a class="reference internal" href="#line-plots" id="id16">Line plots</a></li>
<li><a class="reference internal" href="#scatter-plots" id="id17">Scatter plots</a></li>
<li><a class="reference internal" href="#wireframe-plots" id="id18">Wireframe plots</a></li>
<li><a class="reference internal" href="#surface-plots" id="id19">Surface plots</a></li>
<li><a class="reference internal" href="#tri-surface-plots" id="id20">Tri-Surface plots</a></li>
<li><a class="reference internal" href="#contour-plots" id="id21">Contour plots</a></li>
<li><a class="reference internal" href="#filled-contour-plots" id="id22">Filled contour plots</a></li>
<li><a class="reference internal" href="#polygon-plots" id="id23">Polygon plots</a></li>
<li><a class="reference internal" href="#bar-plots" id="id24">Bar plots</a></li>
<li><a class="reference internal" href="#quiver" id="id25">Quiver</a></li>
<li><a class="reference internal" href="#d-plots-in-3d" id="id26">2D plots in 3D</a></li>
<li><a class="reference internal" href="#text" id="id27">Text</a></li>
<li><a class="reference internal" href="#subplotting" id="id28">Subplotting</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="getting-started">
<span id="toolkit-mplot3d-tutorial"></span><h2>Getting started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2>
<p>An Axes3D object is created just like any other axes using
the projection='3d' keyword.
Create a new <a class="reference internal" href="../../api/_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.figure.Figure</span></code></a> and
add a new axes to it of type <code class="xref py py-class docutils literal notranslate"><span class="pre">Axes3D</span></code>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="kn">from</span> <span class="nn">mpl_toolkits.mplot3d</span> <span class="k">import</span> <span class="n">Axes3D</span>
<span class="n">fig</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">figure</span><span class="p">()</span>
<span class="n">ax</span> <span class="o">=</span> <span class="n">fig</span><span class="o">.</span><span class="n">add_subplot</span><span class="p">(</span><span class="mi">111</span><span class="p">,</span> <span class="n">projection</span><span class="o">=</span><span class="s1">'3d'</span><span class="p">)</span>
</pre></div>
</div>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.0.0: </span>This approach is the preferred method of creating a 3D axes.</p>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Prior to version 1.0.0, the method of creating a 3D axes was
different. For those using older versions of matplotlib, change
<code class="docutils literal notranslate"><span class="pre">ax</span> <span class="pre">=</span> <span class="pre">fig.add_subplot(111,</span> <span class="pre">projection='3d')</span></code>
to <code class="docutils literal notranslate"><span class="pre">ax</span> <span class="pre">=</span> <span class="pre">Axes3D(fig)</span></code>.</p>
</div>
<p>See the <a class="reference internal" href="../../api/toolkits/mplot3d/faq.html#toolkit-mplot3d-faq"><span class="std std-ref">mplot3d FAQ</span></a> for more information about the mplot3d
toolkit.</p>
<div class="section" id="line-plots">
<span id="plot3d"></span><h3>Line plots<a class="headerlink" href="#line-plots" title="Permalink to this headline">¶</a></h3>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.Axes3D.plot">
<code class="descclassname">Axes3D.</code><code class="descname">plot</code><span class="sig-paren">(</span><em>xs</em>, <em>ys</em>, <em>*args</em>, <em>zdir='z'</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/mpl_toolkits/mplot3d/axes3d.html#Axes3D.plot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mpl_toolkits.mplot3d.Axes3D.plot" title="Permalink to this definition">¶</a></dt>
<dd><p>Plot 2D or 3D data.</p>
<table border="1" class="docutils">
<colgroup>
<col width="17%" />
<col width="83%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Argument</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><em>xs</em>, <em>ys</em></td>
<td>x, y coordinates of vertices</td>
</tr>
<tr class="row-odd"><td><em>zs</em></td>
<td>z value(s), either one for all points or one for
each point.</td>
</tr>
<tr class="row-even"><td><em>zdir</em></td>
<td>Which direction to use as z ('x', 'y' or 'z')
when plotting a 2D set.</td>
</tr>
</tbody>
</table>
<p>Other arguments are passed on to
<a class="reference internal" href="../../api/_as_gen/matplotlib.axes.Axes.plot.html#matplotlib.axes.Axes.plot" title="matplotlib.axes.Axes.plot"><code class="xref py py-func docutils literal notranslate"><span class="pre">plot()</span></code></a></p>
</dd></dl>
<div class="figure align-center" id="id1">
<a class="reference external image-reference" href="../../gallery/mplot3d/lines3d.html"><img alt="../../_images/sphx_glr_lines3d_0011.png" src="../../_images/sphx_glr_lines3d_0011.png" style="width: 320.0px; height: 240.0px;" /></a>
<p class="caption"><span class="caption-text">Lines3d</span></p>
</div>
</div>
<div class="section" id="scatter-plots">
<span id="scatter3d"></span><h3>Scatter plots<a class="headerlink" href="#scatter-plots" title="Permalink to this headline">¶</a></h3>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.Axes3D.scatter">
<code class="descclassname">Axes3D.</code><code class="descname">scatter</code><span class="sig-paren">(</span><em>xs</em>, <em>ys</em>, <em>zs=0</em>, <em>zdir='z'</em>, <em>s=20</em>, <em>c=None</em>, <em>depthshade=True</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/mpl_toolkits/mplot3d/axes3d.html#Axes3D.scatter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mpl_toolkits.mplot3d.Axes3D.scatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a scatter plot.</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 docutils">
<dt><strong>xs, ys</strong> <span class="classifier-delimiter">:</span> <span class="classifier">array-like</span></dt>
<dd><p class="first last">The data positions.</p>
</dd>
<dt><strong>zs</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float or array-like, optional, default: 0</span></dt>
<dd><p class="first last">The z-positions. Either an array of the same length as <em>xs</em> and
<em>ys</em> or a single value to place all points in the same plane.</p>
</dd>
<dt><strong>zdir</strong> <span class="classifier-delimiter">:</span> <span class="classifier">{'x', 'y', 'z', '-x', '-y', '-z'}, optional, default: 'z'</span></dt>
<dd><p class="first">The axis direction for the <em>zs</em>. This is useful when plotting 2D
data on a 3D Axes. The data must be passed as <em>xs</em>, <em>ys</em>. Setting
<em>zdir</em> to 'y' then plots the data to the x-z-plane.</p>
<p class="last">See also <a class="reference internal" href="../../gallery/mplot3d/2dcollections3d.html"><span class="doc">Plot 2D data on 3D plot</span></a>.</p>
</dd>
<dt><strong>s</strong> <span class="classifier-delimiter">:</span> <span class="classifier">scalar or array-like, optional, default: 20</span></dt>
<dd><p class="first last">The marker size in points**2. Either an array of the same length
as <em>xs</em> and <em>ys</em> or a single value to make all markers the same
size.</p>
</dd>
<dt><strong>c</strong> <span class="classifier-delimiter">:</span> <span class="classifier">color, sequence, or sequence of color, optional</span></dt>
<dd><p class="first">The marker color. Possible values:</p>
<ul class="simple">
<li>A single color format string.</li>
<li>A sequence of color specifications of length n.</li>
<li>A sequence of n numbers to be mapped to colors using <em>cmap</em> and
<em>norm</em>.</li>
<li>A 2-D array in which the rows are RGB or RGBA.</li>
</ul>
<p class="last">For more details see the <em>c</em> argument of <a class="reference internal" href="../../api/_as_gen/matplotlib.axes.Axes.scatter.html#matplotlib.axes.Axes.scatter" title="matplotlib.axes.Axes.scatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scatter</span></code></a>.</p>
</dd>
<dt><strong>depthshade</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool, optional, default: True</span></dt>
<dd><p class="first last">Whether to shade the scatter markers to give the appearance of
depth.</p>
</dd>
<dt><strong>**kwargs</strong></dt>
<dd><p class="first last">All other arguments are passed on to <a class="reference internal" href="../../api/_as_gen/matplotlib.axes.Axes.scatter.html#matplotlib.axes.Axes.scatter" title="matplotlib.axes.Axes.scatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scatter</span></code></a>.</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>paths</strong> <span class="classifier-delimiter">:</span> <span class="classifier"><a class="reference internal" href="../../api/collections_api.html#matplotlib.collections.PathCollection" title="matplotlib.collections.PathCollection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PathCollection</span></code></a></span></dt>
<dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<div class="figure align-center" id="id2">
<a class="reference external image-reference" href="../../gallery/mplot3d/scatter3d.html"><img alt="../../_images/sphx_glr_scatter3d_0011.png" src="../../_images/sphx_glr_scatter3d_0011.png" style="width: 320.0px; height: 240.0px;" /></a>
<p class="caption"><span class="caption-text">Scatter3d</span></p>
</div>
</div>
<div class="section" id="wireframe-plots">
<span id="wireframe"></span><h3>Wireframe plots<a class="headerlink" href="#wireframe-plots" title="Permalink to this headline">¶</a></h3>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.Axes3D.plot_wireframe">
<code class="descclassname">Axes3D.</code><code class="descname">plot_wireframe</code><span class="sig-paren">(</span><em>X</em>, <em>Y</em>, <em>Z</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/mpl_toolkits/mplot3d/axes3d.html#Axes3D.plot_wireframe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mpl_toolkits.mplot3d.Axes3D.plot_wireframe" title="Permalink to this definition">¶</a></dt>
<dd><p>Plot a 3D wireframe.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The <em>rcount</em> and <em>ccount</em> kwargs, which both default to 50,
determine the maximum number of samples used in each direction. If
the input data is larger, it will be downsampled (by slicing) to
these numbers of points.</p>
</div>
<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>X, Y, Z</strong> <span class="classifier-delimiter">:</span> <span class="classifier">2d arrays</span></dt>
<dd><p class="first last">Data values.</p>
</dd>
<dt><strong>rcount, ccount</strong> <span class="classifier-delimiter">:</span> <span class="classifier">int</span></dt>
<dd><p class="first">Maximum number of samples used in each direction. If the input
data is larger, it will be downsampled (by slicing) to these
numbers of points. Setting a count to zero causes the data to be
not sampled in the corresponding direction, producing a 3D line
plot rather than a wireframe plot. Defaults to 50.</p>
<div class="last versionadded">
<p><span class="versionmodified">New in version 2.0.</span></p>
</div>
</dd>
<dt><strong>rstride, cstride</strong> <span class="classifier-delimiter">:</span> <span class="classifier">int</span></dt>
<dd><p class="first">Downsampling stride in each direction. These arguments are
mutually exclusive with <em>rcount</em> and <em>ccount</em>. If only one of
<em>rstride</em> or <em>cstride</em> is set, the other defaults to 1. Setting a
stride to zero causes the data to be not sampled in the
corresponding direction, producing a 3D line plot rather than a
wireframe plot.</p>
<p class="last">'classic' mode uses a default of <code class="docutils literal notranslate"><span class="pre">rstride</span> <span class="pre">=</span> <span class="pre">cstride</span> <span class="pre">=</span> <span class="pre">1</span></code> instead
of the new default of <code class="docutils literal notranslate"><span class="pre">rcount</span> <span class="pre">=</span> <span class="pre">ccount</span> <span class="pre">=</span> <span class="pre">50</span></code>.</p>
</dd>
<dt><strong>**kwargs :</strong></dt>
<dd><p class="first last">Other arguments are forwarded to <a class="reference internal" href="../../api/_as_gen/mpl_toolkits.mplot3d.art3d.Line3DCollection.html#mpl_toolkits.mplot3d.art3d.Line3DCollection" title="mpl_toolkits.mplot3d.art3d.Line3DCollection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Line3DCollection</span></code></a>.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<div class="figure align-center" id="id3">
<a class="reference external image-reference" href="../../gallery/mplot3d/wire3d.html"><img alt="../../_images/sphx_glr_wire3d_0011.png" src="../../_images/sphx_glr_wire3d_0011.png" style="width: 320.0px; height: 240.0px;" /></a>
<p class="caption"><span class="caption-text">Wire3d</span></p>
</div>
</div>
<div class="section" id="surface-plots">
<span id="surface"></span><h3>Surface plots<a class="headerlink" href="#surface-plots" title="Permalink to this headline">¶</a></h3>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.Axes3D.plot_surface">
<code class="descclassname">Axes3D.</code><code class="descname">plot_surface</code><span class="sig-paren">(</span><em>X</em>, <em>Y</em>, <em>Z</em>, <em>*args</em>, <em>norm=None</em>, <em>vmin=None</em>, <em>vmax=None</em>, <em>lightsource=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/mpl_toolkits/mplot3d/axes3d.html#Axes3D.plot_surface"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mpl_toolkits.mplot3d.Axes3D.plot_surface" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a surface plot.</p>
<p>By default it will be colored in shades of a solid color, but it also
supports color mapping by supplying the <em>cmap</em> argument.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The <em>rcount</em> and <em>ccount</em> kwargs, which both default to 50,
determine the maximum number of samples used in each direction. If
the input data is larger, it will be downsampled (by slicing) to
these numbers of points.</p>
</div>
<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>X, Y, Z</strong> <span class="classifier-delimiter">:</span> <span class="classifier">2d arrays</span></dt>
<dd><p class="first last">Data values.</p>
</dd>
<dt><strong>rcount, ccount</strong> <span class="classifier-delimiter">:</span> <span class="classifier">int</span></dt>
<dd><p class="first">Maximum number of samples used in each direction. If the input
data is larger, it will be downsampled (by slicing) to these
numbers of points. Defaults to 50.</p>
<div class="last versionadded">
<p><span class="versionmodified">New in version 2.0.</span></p>
</div>
</dd>
<dt><strong>rstride, cstride</strong> <span class="classifier-delimiter">:</span> <span class="classifier">int</span></dt>
<dd><p class="first">Downsampling stride in each direction. These arguments are
mutually exclusive with <em>rcount</em> and <em>ccount</em>. If only one of
<em>rstride</em> or <em>cstride</em> is set, the other defaults to 10.</p>
<p class="last">'classic' mode uses a default of <code class="docutils literal notranslate"><span class="pre">rstride</span> <span class="pre">=</span> <span class="pre">cstride</span> <span class="pre">=</span> <span class="pre">10</span></code> instead
of the new default of <code class="docutils literal notranslate"><span class="pre">rcount</span> <span class="pre">=</span> <span class="pre">ccount</span> <span class="pre">=</span> <span class="pre">50</span></code>.</p>
</dd>
<dt><strong>color</strong> <span class="classifier-delimiter">:</span> <span class="classifier">color-like</span></dt>
<dd><p class="first last">Color of the surface patches.</p>
</dd>
<dt><strong>cmap</strong> <span class="classifier-delimiter">:</span> <span class="classifier">Colormap</span></dt>
<dd><p class="first last">Colormap of the surface patches.</p>
</dd>
<dt><strong>facecolors</strong> <span class="classifier-delimiter">:</span> <span class="classifier">array-like of colors.</span></dt>
<dd><p class="first last">Colors of each individual patch.</p>
</dd>
<dt><strong>norm</strong> <span class="classifier-delimiter">:</span> <span class="classifier">Normalize</span></dt>
<dd><p class="first last">Normalization for the colormap.</p>
</dd>
<dt><strong>vmin, vmax</strong> <span class="classifier-delimiter">:</span> <span class="classifier">float</span></dt>
<dd><p class="first last">Bounds for the normalization.</p>
</dd>
<dt><strong>shade</strong> <span class="classifier-delimiter">:</span> <span class="classifier">bool</span></dt>
<dd><p class="first last">Whether to shade the face colors.</p>
</dd>
<dt><strong>**kwargs :</strong></dt>
<dd><p class="first last">Other arguments are forwarded to <a class="reference internal" href="../../api/_as_gen/mpl_toolkits.mplot3d.art3d.Poly3DCollection.html#mpl_toolkits.mplot3d.art3d.Poly3DCollection" title="mpl_toolkits.mplot3d.art3d.Poly3DCollection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Poly3DCollection</span></code></a>.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<div class="figure align-center" id="id4">
<a class="reference external image-reference" href="../../gallery/mplot3d/surface3d.html"><img alt="../../_images/sphx_glr_surface3d_0012.png" src="../../_images/sphx_glr_surface3d_0012.png" style="width: 320.0px; height: 240.0px;" /></a>
<p class="caption"><span class="caption-text">Surface3d</span></p>
<div class="legend">
<p>Surface3d 2</p>
<p>Surface3d 3</p>
</div>
</div>
</div>
<div class="section" id="tri-surface-plots">
<span id="trisurface"></span><h3>Tri-Surface plots<a class="headerlink" href="#tri-surface-plots" title="Permalink to this headline">¶</a></h3>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.Axes3D.plot_trisurf">
<code class="descclassname">Axes3D.</code><code class="descname">plot_trisurf</code><span class="sig-paren">(</span><em>*args</em>, <em>color=None</em>, <em>norm=None</em>, <em>vmin=None</em>, <em>vmax=None</em>, <em>lightsource=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/mpl_toolkits/mplot3d/axes3d.html#Axes3D.plot_trisurf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mpl_toolkits.mplot3d.Axes3D.plot_trisurf" title="Permalink to this definition">¶</a></dt>
<dd><table border="1" class="docutils">
<colgroup>
<col width="21%" />
<col width="79%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Argument</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><em>X</em>, <em>Y</em>, <em>Z</em></td>
<td>Data values as 1D arrays</td>
</tr>
<tr class="row-odd"><td><em>color</em></td>
<td>Color of the surface patches</td>
</tr>
<tr class="row-even"><td><em>cmap</em></td>
<td>A colormap for the surface patches.</td>
</tr>
<tr class="row-odd"><td><em>norm</em></td>
<td>An instance of Normalize to map values to colors</td>
</tr>
<tr class="row-even"><td><em>vmin</em></td>
<td>Minimum value to map</td>
</tr>
<tr class="row-odd"><td><em>vmax</em></td>
<td>Maximum value to map</td>
</tr>
<tr class="row-even"><td><em>shade</em></td>
<td>Whether to shade the facecolors</td>
</tr>
</tbody>
</table>
<p>The (optional) triangulation can be specified in one of two ways;
either:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">plot_trisurf</span><span class="p">(</span><span class="n">triangulation</span><span class="p">,</span> <span class="o">...</span><span class="p">)</span>
</pre></div>
</div>
<p>where triangulation is a <a class="reference internal" href="../../api/tri_api.html#matplotlib.tri.Triangulation" title="matplotlib.tri.Triangulation"><code class="xref py py-class docutils literal notranslate"><span class="pre">Triangulation</span></code></a>
object, or:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">plot_trisurf</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="n">Y</span><span class="p">,</span> <span class="o">...</span><span class="p">)</span>
<span class="n">plot_trisurf</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="n">Y</span><span class="p">,</span> <span class="n">triangles</span><span class="p">,</span> <span class="o">...</span><span class="p">)</span>
<span class="n">plot_trisurf</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="n">Y</span><span class="p">,</span> <span class="n">triangles</span><span class="o">=</span><span class="n">triangles</span><span class="p">,</span> <span class="o">...</span><span class="p">)</span>
</pre></div>
</div>
<p>in which case a Triangulation object will be created. See
<a class="reference internal" href="../../api/tri_api.html#matplotlib.tri.Triangulation" title="matplotlib.tri.Triangulation"><code class="xref py py-class docutils literal notranslate"><span class="pre">Triangulation</span></code></a> for a explanation of
these possibilities.</p>
<p>The remaining arguments are:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">plot_trisurf</span><span class="p">(</span><span class="o">...</span><span class="p">,</span> <span class="n">Z</span><span class="p">)</span>
</pre></div>
</div>
<p>where <em>Z</em> is the array of values to contour, one per point
in the triangulation.</p>
<p>Other arguments are passed on to
<a class="reference internal" href="../../api/_as_gen/mpl_toolkits.mplot3d.art3d.Poly3DCollection.html#mpl_toolkits.mplot3d.art3d.Poly3DCollection" title="mpl_toolkits.mplot3d.art3d.Poly3DCollection"><code class="xref py py-class docutils literal notranslate"><span class="pre">Poly3DCollection</span></code></a></p>
<p><strong>Examples:</strong></p>
<p>(<a class="reference external" href="../../gallery/mplot3d/trisurf3d.py">Source code</a>, <a class="reference external" href="../../gallery/mplot3d/trisurf3d.png">png</a>, <a class="reference external" href="../../gallery/mplot3d/trisurf3d.pdf">pdf</a>)</p>
<div class="figure">
<img alt="../../_images/trisurf3d.png" src="../../_images/trisurf3d.png" />
</div>
<p>(<a class="reference external" href="../../gallery/mplot3d/trisurf3d_2.py">Source code</a>, <a class="reference external" href="../../gallery/mplot3d/trisurf3d_2.png">png</a>, <a class="reference external" href="../../gallery/mplot3d/trisurf3d_2.pdf">pdf</a>)</p>
<div class="figure">
<img alt="../../_images/trisurf3d_2.png" src="../../_images/trisurf3d_2.png" />
</div>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.2.0: </span>This plotting function was added for the v1.2.0 release.</p>
</div>
</dd></dl>
<div class="figure align-center" id="id5">
<a class="reference external image-reference" href="../../gallery/mplot3d/trisurf3d.html"><img alt="../../_images/sphx_glr_trisurf3d_0011.png" src="../../_images/sphx_glr_trisurf3d_0011.png" style="width: 320.0px; height: 240.0px;" /></a>
<p class="caption"><span class="caption-text">Trisurf3d</span></p>
</div>
</div>
<div class="section" id="contour-plots">
<span id="contour3d"></span><h3>Contour plots<a class="headerlink" href="#contour-plots" title="Permalink to this headline">¶</a></h3>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.Axes3D.contour">
<code class="descclassname">Axes3D.</code><code class="descname">contour</code><span class="sig-paren">(</span><em>X</em>, <em>Y</em>, <em>Z</em>, <em>*args</em>, <em>extend3d=False</em>, <em>stride=5</em>, <em>zdir='z'</em>, <em>offset=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/mpl_toolkits/mplot3d/axes3d.html#Axes3D.contour"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mpl_toolkits.mplot3d.Axes3D.contour" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a 3D contour plot.</p>
<table border="1" class="docutils">
<colgroup>
<col width="17%" />
<col width="83%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Argument</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><em>X</em>, <em>Y</em>,</td>
<td>Data values as numpy.arrays</td>
</tr>
<tr class="row-odd"><td><em>Z</em></td>
<td> </td>
</tr>
<tr class="row-even"><td><em>extend3d</em></td>
<td>Whether to extend contour in 3D (default: False)</td>
</tr>
<tr class="row-odd"><td><em>stride</em></td>
<td>Stride (step size) for extending contour</td>
</tr>
<tr class="row-even"><td><em>zdir</em></td>
<td>The direction to use: x, y or z (default)</td>
</tr>
<tr class="row-odd"><td><em>offset</em></td>
<td>If specified plot a projection of the contour
lines on this position in plane normal to zdir</td>
</tr>
</tbody>
</table>
<p>The positional and other keyword arguments are passed on to
<a class="reference internal" href="../../api/_as_gen/matplotlib.axes.Axes.contour.html#matplotlib.axes.Axes.contour" title="matplotlib.axes.Axes.contour"><code class="xref py py-func docutils literal notranslate"><span class="pre">contour()</span></code></a></p>
<p>Returns a <a class="reference internal" href="../../api/_as_gen/matplotlib.axes.Axes.contour.html#matplotlib.axes.Axes.contour" title="matplotlib.axes.Axes.contour"><code class="xref py py-class docutils literal notranslate"><span class="pre">contour</span></code></a></p>
</dd></dl>
<div class="figure align-center" id="id6">
<a class="reference external image-reference" href="../../gallery/mplot3d/contour3d.html"><img alt="../../_images/sphx_glr_contour3d_0011.png" src="../../_images/sphx_glr_contour3d_0011.png" style="width: 320.0px; height: 240.0px;" /></a>
<p class="caption"><span class="caption-text">Contour3d</span></p>
<div class="legend">
<p>Contour3d 2</p>
<p>Contour3d 3</p>
</div>
</div>
</div>
<div class="section" id="filled-contour-plots">
<span id="contourf3d"></span><h3>Filled contour plots<a class="headerlink" href="#filled-contour-plots" title="Permalink to this headline">¶</a></h3>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.Axes3D.contourf">
<code class="descclassname">Axes3D.</code><code class="descname">contourf</code><span class="sig-paren">(</span><em>X</em>, <em>Y</em>, <em>Z</em>, <em>*args</em>, <em>zdir='z'</em>, <em>offset=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/mpl_toolkits/mplot3d/axes3d.html#Axes3D.contourf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mpl_toolkits.mplot3d.Axes3D.contourf" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a 3D contourf plot.</p>
<table border="1" class="docutils">
<colgroup>
<col width="16%" />
<col width="84%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Argument</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><em>X</em>, <em>Y</em>,</td>
<td>Data values as numpy.arrays</td>
</tr>
<tr class="row-odd"><td><em>Z</em></td>
<td> </td>
</tr>
<tr class="row-even"><td><em>zdir</em></td>
<td>The direction to use: x, y or z (default)</td>
</tr>
<tr class="row-odd"><td><em>offset</em></td>
<td>If specified plot a projection of the filled contour
on this position in plane normal to zdir</td>
</tr>
</tbody>
</table>
<p>The positional and keyword arguments are passed on to
<a class="reference internal" href="../../api/_as_gen/matplotlib.axes.Axes.contourf.html#matplotlib.axes.Axes.contourf" title="matplotlib.axes.Axes.contourf"><code class="xref py py-func docutils literal notranslate"><span class="pre">contourf()</span></code></a></p>
<p>Returns a <a class="reference internal" href="../../api/_as_gen/matplotlib.axes.Axes.contourf.html#matplotlib.axes.Axes.contourf" title="matplotlib.axes.Axes.contourf"><code class="xref py py-class docutils literal notranslate"><span class="pre">contourf</span></code></a></p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 1.1.0: </span>The <em>zdir</em> and <em>offset</em> kwargs were added.</p>
</div>
</dd></dl>
<div class="figure align-center" id="id7">
<a class="reference external image-reference" href="../../gallery/mplot3d/contourf3d.html"><img alt="../../_images/sphx_glr_contourf3d_0011.png" src="../../_images/sphx_glr_contourf3d_0011.png" style="width: 320.0px; height: 240.0px;" /></a>
<p class="caption"><span class="caption-text">Contourf3d</span></p>
<div class="legend">
Contourf3d 2</div>
</div>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.1.0: </span>The feature demoed in the second contourf3d example was enabled as a
result of a bugfix for version 1.1.0.</p>
</div>
</div>
<div class="section" id="polygon-plots">
<span id="polygon3d"></span><h3>Polygon plots<a class="headerlink" href="#polygon-plots" title="Permalink to this headline">¶</a></h3>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.Axes3D.add_collection3d">
<code class="descclassname">Axes3D.</code><code class="descname">add_collection3d</code><span class="sig-paren">(</span><em>col</em>, <em>zs=0</em>, <em>zdir='z'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/mpl_toolkits/mplot3d/axes3d.html#Axes3D.add_collection3d"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mpl_toolkits.mplot3d.Axes3D.add_collection3d" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a 3D collection object to the plot.</p>
<p>2D collection types are converted to a 3D version by
modifying the object and adding z coordinate information.</p>
<dl class="docutils">
<dt>Supported are:</dt>
<dd><ul class="first last simple">
<li>PolyCollection</li>
<li>LineCollection</li>
<li>PatchCollection</li>
</ul>
</dd>
</dl>
</dd></dl>
<div class="figure align-center" id="id8">
<a class="reference external image-reference" href="../../gallery/mplot3d/polys3d.html"><img alt="../../_images/sphx_glr_polys3d_0011.png" src="../../_images/sphx_glr_polys3d_0011.png" style="width: 320.0px; height: 240.0px;" /></a>
<p class="caption"><span class="caption-text">Polys3d</span></p>
</div>
</div>
<div class="section" id="bar-plots">
<span id="bar3d"></span><h3>Bar plots<a class="headerlink" href="#bar-plots" title="Permalink to this headline">¶</a></h3>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.Axes3D.bar">
<code class="descclassname">Axes3D.</code><code class="descname">bar</code><span class="sig-paren">(</span><em>left</em>, <em>height</em>, <em>zs=0</em>, <em>zdir='z'</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/mpl_toolkits/mplot3d/axes3d.html#Axes3D.bar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mpl_toolkits.mplot3d.Axes3D.bar" title="Permalink to this definition">¶</a></dt>
<dd><p>Add 2D bar(s).</p>
<table border="1" class="docutils">
<colgroup>
<col width="17%" />
<col width="83%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Argument</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><em>left</em></td>
<td>The x coordinates of the left sides of the bars.</td>
</tr>
<tr class="row-odd"><td><em>height</em></td>
<td>The height of the bars.</td>
</tr>
<tr class="row-even"><td><em>zs</em></td>
<td>Z coordinate of bars, if one value is specified
they will all be placed at the same z.</td>
</tr>
<tr class="row-odd"><td><em>zdir</em></td>
<td>Which direction to use as z ('x', 'y' or 'z')
when plotting a 2D set.</td>
</tr>
</tbody>
</table>
<p>Keyword arguments are passed onto <a class="reference internal" href="../../api/_as_gen/matplotlib.axes.Axes.bar.html#matplotlib.axes.Axes.bar" title="matplotlib.axes.Axes.bar"><code class="xref py py-func docutils literal notranslate"><span class="pre">bar()</span></code></a>.</p>
<p>Returns a <a class="reference internal" href="../../api/_as_gen/mpl_toolkits.mplot3d.art3d.Patch3DCollection.html#mpl_toolkits.mplot3d.art3d.Patch3DCollection" title="mpl_toolkits.mplot3d.art3d.Patch3DCollection"><code class="xref py py-class docutils literal notranslate"><span class="pre">Patch3DCollection</span></code></a></p>
</dd></dl>
<div class="figure align-center" id="id9">
<a class="reference external image-reference" href="../../gallery/mplot3d/bars3d.html"><img alt="../../_images/sphx_glr_bars3d_0011.png" src="../../_images/sphx_glr_bars3d_0011.png" style="width: 320.0px; height: 240.0px;" /></a>
<p class="caption"><span class="caption-text">Bars3d</span></p>
</div>
</div>
<div class="section" id="quiver">
<span id="quiver3d"></span><h3>Quiver<a class="headerlink" href="#quiver" title="Permalink to this headline">¶</a></h3>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.Axes3D.quiver">
<code class="descclassname">Axes3D.</code><code class="descname">quiver</code><span class="sig-paren">(</span><em>*args</em>, <em>length=1</em>, <em>arrow_length_ratio=0.3</em>, <em>pivot='tail'</em>, <em>normalize=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/mpl_toolkits/mplot3d/axes3d.html#Axes3D.quiver"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mpl_toolkits.mplot3d.Axes3D.quiver" title="Permalink to this definition">¶</a></dt>
<dd><p>Plot a 3D field of arrows.</p>
<p>call signatures:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">quiver</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="n">Y</span><span class="p">,</span> <span class="n">Z</span><span class="p">,</span> <span class="n">U</span><span class="p">,</span> <span class="n">V</span><span class="p">,</span> <span class="n">W</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<p>Arguments:</p>
<blockquote>
<div><dl class="docutils">
<dt><em>X</em>, <em>Y</em>, <em>Z</em>:</dt>
<dd>The x, y and z coordinates of the arrow locations (default is
tail of arrow; see <em>pivot</em> kwarg)</dd>
<dt><em>U</em>, <em>V</em>, <em>W</em>:</dt>
<dd>The x, y and z components of the arrow vectors</dd>
</dl>
</div></blockquote>
<p>The arguments could be array-like or scalars, so long as they
they can be broadcast together. The arguments can also be
masked arrays. If an element in any of argument is masked, then
that corresponding quiver element will not be plotted.</p>
<p>Keyword arguments:</p>
<blockquote>
<div><dl class="docutils">
<dt><em>length</em>: [1.0 | float]</dt>
<dd>The length of each quiver, default to 1.0, the unit is
the same with the axes</dd>
<dt><em>arrow_length_ratio</em>: [0.3 | float]</dt>
<dd>The ratio of the arrow head with respect to the quiver,
default to 0.3</dd>
<dt><em>pivot</em>: [ 'tail' | 'middle' | 'tip' ]</dt>
<dd>The part of the arrow that is at the grid point; the arrow
rotates about this point, hence the name <em>pivot</em>.
Default is 'tail'</dd>
<dt><em>normalize</em>: bool</dt>
<dd>When True, all of the arrows will be the same length. This
defaults to False, where the arrows will be different lengths
depending on the values of u,v,w.</dd>
</dl>
</div></blockquote>
<p>Any additional keyword arguments are delegated to
<a class="reference internal" href="../../api/collections_api.html#matplotlib.collections.LineCollection" title="matplotlib.collections.LineCollection"><code class="xref py py-class docutils literal notranslate"><span class="pre">LineCollection</span></code></a></p>
</dd></dl>
<div class="figure align-center" id="id10">
<a class="reference external image-reference" href="../../gallery/mplot3d/quiver3d.html"><img alt="../../_images/sphx_glr_quiver3d_0011.png" src="../../_images/sphx_glr_quiver3d_0011.png" style="width: 320.0px; height: 240.0px;" /></a>
<p class="caption"><span class="caption-text">Quiver3d</span></p>
</div>
</div>
<div class="section" id="d-plots-in-3d">
<span id="dcollections3d"></span><h3>2D plots in 3D<a class="headerlink" href="#d-plots-in-3d" title="Permalink to this headline">¶</a></h3>
<div class="figure align-center" id="id11">
<a class="reference external image-reference" href="../../gallery/mplot3d/2dcollections3d.html"><img alt="../../_images/sphx_glr_2dcollections3d_0011.png" src="../../_images/sphx_glr_2dcollections3d_0011.png" style="width: 320.0px; height: 240.0px;" /></a>
<p class="caption"><span class="caption-text">2dcollections3d</span></p>
</div>
</div>
<div class="section" id="text">
<span id="text3d"></span><h3>Text<a class="headerlink" href="#text" title="Permalink to this headline">¶</a></h3>
<dl class="method">
<dt id="mpl_toolkits.mplot3d.Axes3D.text">
<code class="descclassname">Axes3D.</code><code class="descname">text</code><span class="sig-paren">(</span><em>x</em>, <em>y</em>, <em>z</em>, <em>s</em>, <em>zdir=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/mpl_toolkits/mplot3d/axes3d.html#Axes3D.text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#mpl_toolkits.mplot3d.Axes3D.text" title="Permalink to this definition">¶</a></dt>
<dd><p>Add text to the plot. kwargs will be passed on to Axes.text,
except for the <code class="xref py py-obj docutils literal notranslate"><span class="pre">zdir</span></code> keyword, which sets the direction to be
used as the z direction.</p>
</dd></dl>
<div class="figure align-center" id="id12">
<a class="reference external image-reference" href="../../gallery/mplot3d/text3d.html"><img alt="../../_images/sphx_glr_text3d_0011.png" src="../../_images/sphx_glr_text3d_0011.png" style="width: 320.0px; height: 240.0px;" /></a>
<p class="caption"><span class="caption-text">Text3d</span></p>
</div>
</div>
<div class="section" id="subplotting">
<span id="dsubplots"></span><h3>Subplotting<a class="headerlink" href="#subplotting" title="Permalink to this headline">¶</a></h3>
<p>Having multiple 3D plots in a single figure is the same
as it is for 2D plots. Also, you can have both 2D and 3D plots
in the same figure.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.0.0: </span>Subplotting 3D plots was added in v1.0.0. Earlier version can not
do this.</p>
</div>
<div class="figure align-center" id="id13">
<a class="reference external image-reference" href="../../gallery/mplot3d/subplot3d.html"><img alt="../../_images/sphx_glr_subplot3d_0011.png" src="../../_images/sphx_glr_subplot3d_0011.png" style="width: 480.0px; height: 240.0px;" /></a>
<p class="caption"><span class="caption-text">Subplot3d</span></p>
<div class="legend">
Mixed Subplots</div>
</div>
<div class="sphx-glr-footer class sphx-glr-footer-example docutils container" id="sphx-glr-download-tutorials-toolkits-mplot3d-py">
<div class="sphx-glr-download docutils container">
<a class="reference download internal" download="" href="../../_downloads/fcbf2e7c5f17b03b09f59e2301953e79/mplot3d.py"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Python</span> <span class="pre">source</span> <span class="pre">code:</span> <span class="pre">mplot3d.py</span></code></a></div>
<div class="sphx-glr-download docutils container">
<a class="reference download internal" download="" href="../../_downloads/dab62ecca1b2e7cf760fb5853ccf7f1b/mplot3d.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">mplot3d.ipynb</span></code></a></div>
</div>
<p class="sphx-glr-signature">Keywords: matplotlib code example, codex, python plot, pyplot
<a class="reference external" href="https://sphinx-gallery.readthedocs.io">Gallery generated by Sphinx-Gallery</a></p>
</div>
</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 Feb 28, 2019.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 1.8.4.
Doc version v3.0.3-2-gfc177a9cd.
</div>
</body>
<footer>
</footer>
</html>