-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathcontour_api.html
More file actions
730 lines (681 loc) · 52.8 KB
/
contour_api.html
File metadata and controls
730 lines (681 loc) · 52.8 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
<!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>contour — Matplotlib 2.2.0 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../_static/gallery.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.2.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 2.2.0 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html"
/>
<link rel="search" title="Search" href="../search.html"
/>
<link rel="top" title="Matplotlib 2.2.0 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="container" href="container_api.html" />
<link rel="prev" title="matplotlib.colors.get_named_colors_mapping" href="_as_gen/matplotlib.colors.get_named_colors_mapping.html" />
<link rel="canonical" href="https://matplotlib.org/stable/api/contour_api.html" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head>
<body>
<div id="unreleased-message"> You are reading an old version of the documentation (v2.2.0). For the latest version see <a href="https://matplotlib.org/stable/api/contour_api.html">https://matplotlib.org/stable/api/contour_api.html</a></div>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 2.2.0</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="container_api.html" title="container"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="_as_gen/matplotlib.colors.get_named_colors_mapping.html" title="matplotlib.colors.get_named_colors_mapping"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../gallery/index.html">examples</a>| </li>
<li><a href="../tutorials/index.html">tutorials</a>| </li>
<li><a href="pyplot_summary.html">pyplot</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" accesskey="U">The Matplotlib API</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">contour</a><ul>
<li><a class="reference internal" href="#module-matplotlib.contour"><code class="docutils literal notranslate"><span class="pre">matplotlib.contour</span></code></a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">The Matplotlib API</a><ul>
<li>Previous: <a href="_as_gen/matplotlib.colors.get_named_colors_mapping.html" title="previous chapter">matplotlib.colors.get_named_colors_mapping</a></li>
<li>Next: <a href="container_api.html" title="next chapter">container</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/contour_api.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="contour">
<h1>contour<a class="headerlink" href="#contour" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-matplotlib.contour">
<span id="matplotlib-contour"></span><h2><a class="reference internal" href="#module-matplotlib.contour" title="matplotlib.contour"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.contour</span></code></a><a class="headerlink" href="#module-matplotlib.contour" title="Permalink to this headline">¶</a></h2>
<p>These are classes to support contour plotting and labelling for the Axes class.</p>
<dl class="class">
<dt id="matplotlib.contour.ClabelText">
<em class="property">class </em><code class="descclassname">matplotlib.contour.</code><code class="descname">ClabelText</code><span class="sig-paren">(</span><em>x=0</em>, <em>y=0</em>, <em>text=''</em>, <em>color=None</em>, <em>verticalalignment='baseline'</em>, <em>horizontalalignment='left'</em>, <em>multialignment=None</em>, <em>fontproperties=None</em>, <em>rotation=None</em>, <em>linespacing=None</em>, <em>rotation_mode=None</em>, <em>usetex=None</em>, <em>wrap=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ClabelText" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.text.Text</span></code></a></p>
<p>Unlike the ordinary text, the get_rotation returns an updated
angle in the pixel coordinate assuming that the input rotation is
an angle in data coordinate (or whatever transform set).</p>
<p>Create a <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-class docutils literal notranslate"><span class="pre">Text</span></code></a> instance at <em>x</em>, <em>y</em>
with string <em>text</em>.</p>
<p>Valid kwargs are</p>
<blockquote>
<div><table border="1" class="property-table docutils">
<colgroup>
<col width="30%" />
<col width="70%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_agg_filter.html#matplotlib.artist.Artist.set_agg_filter" title="matplotlib.artist.Artist.set_agg_filter"><code class="xref py py-meth docutils literal notranslate"><span class="pre">agg_filter</span></code></a></td>
<td>a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_alpha.html#matplotlib.artist.Artist.set_alpha" title="matplotlib.artist.Artist.set_alpha"><code class="xref py py-meth docutils literal notranslate"><span class="pre">alpha</span></code></a></td>
<td>float (0.0 transparent through 1.0 opaque)</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_animated.html#matplotlib.artist.Artist.set_animated" title="matplotlib.artist.Artist.set_animated"><code class="xref py py-meth docutils literal notranslate"><span class="pre">animated</span></code></a></td>
<td>bool</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_backgroundcolor" title="matplotlib.text.Text.set_backgroundcolor"><code class="xref py py-meth docutils literal notranslate"><span class="pre">backgroundcolor</span></code></a></td>
<td>any matplotlib color</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_bbox" title="matplotlib.text.Text.set_bbox"><code class="xref py py-meth docutils literal notranslate"><span class="pre">bbox</span></code></a></td>
<td>FancyBboxPatch prop dict</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_clip_box" title="matplotlib.text.Text.set_clip_box"><code class="xref py py-meth docutils literal notranslate"><span class="pre">clip_box</span></code></a></td>
<td>a <a class="reference internal" href="transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.transforms.Bbox</span></code></a> instance</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_clip_on" title="matplotlib.text.Text.set_clip_on"><code class="xref py py-meth docutils literal notranslate"><span class="pre">clip_on</span></code></a></td>
<td>bool</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_clip_path" title="matplotlib.text.Text.set_clip_path"><code class="xref py py-meth docutils literal notranslate"><span class="pre">clip_path</span></code></a></td>
<td>[ (<a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-class docutils literal notranslate"><span class="pre">Path</span></code></a>, <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transform</span></code></a>) | <a class="reference internal" href="_as_gen/matplotlib.patches.Patch.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><code class="xref py py-class docutils literal notranslate"><span class="pre">Patch</span></code></a> | None ]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_color" title="matplotlib.text.Text.set_color"><code class="xref py py-meth docutils literal notranslate"><span class="pre">color</span></code></a></td>
<td>any matplotlib color</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_contains.html#matplotlib.artist.Artist.set_contains" title="matplotlib.artist.Artist.set_contains"><code class="xref py py-meth docutils literal notranslate"><span class="pre">contains</span></code></a></td>
<td>a callable function</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_family" title="matplotlib.text.Text.set_family"><code class="xref py py-meth docutils literal notranslate"><span class="pre">family</span></code></a> or fontfamily or fontname or name</td>
<td>[FONTNAME | ‘serif’ | ‘sans-serif’ | ‘cursive’ | ‘fantasy’ | ‘monospace’ ]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_figure.html#matplotlib.artist.Artist.set_figure" title="matplotlib.artist.Artist.set_figure"><code class="xref py py-meth docutils literal notranslate"><span class="pre">figure</span></code></a></td>
<td>a <a class="reference internal" href="_as_gen/matplotlib.figure.Figure.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Figure</span></code></a> instance</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_fontproperties" title="matplotlib.text.Text.set_fontproperties"><code class="xref py py-meth docutils literal notranslate"><span class="pre">fontproperties</span></code></a> or font_properties</td>
<td>a <a class="reference internal" href="font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.font_manager.FontProperties</span></code></a> instance</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_gid.html#matplotlib.artist.Artist.set_gid" title="matplotlib.artist.Artist.set_gid"><code class="xref py py-meth docutils literal notranslate"><span class="pre">gid</span></code></a></td>
<td>an id string</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_horizontalalignment" title="matplotlib.text.Text.set_horizontalalignment"><code class="xref py py-meth docutils literal notranslate"><span class="pre">horizontalalignment</span></code></a> or ha</td>
<td>[ ‘center’ | ‘right’ | ‘left’ ]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_label.html#matplotlib.artist.Artist.set_label" title="matplotlib.artist.Artist.set_label"><code class="xref py py-meth docutils literal notranslate"><span class="pre">label</span></code></a></td>
<td>object</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_linespacing" title="matplotlib.text.Text.set_linespacing"><code class="xref py py-meth docutils literal notranslate"><span class="pre">linespacing</span></code></a></td>
<td>float (multiple of font size)</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_multialignment" title="matplotlib.text.Text.set_multialignment"><code class="xref py py-meth docutils literal notranslate"><span class="pre">multialignment</span></code></a> or ma</td>
<td>[‘left’ | ‘right’ | ‘center’ ]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_path_effects.html#matplotlib.artist.Artist.set_path_effects" title="matplotlib.artist.Artist.set_path_effects"><code class="xref py py-meth docutils literal notranslate"><span class="pre">path_effects</span></code></a></td>
<td><a class="reference internal" href="patheffects_api.html#matplotlib.patheffects.AbstractPathEffect" title="matplotlib.patheffects.AbstractPathEffect"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AbstractPathEffect</span></code></a></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_picker.html#matplotlib.artist.Artist.set_picker" title="matplotlib.artist.Artist.set_picker"><code class="xref py py-meth docutils literal notranslate"><span class="pre">picker</span></code></a></td>
<td>[None | bool | float | callable]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_position" title="matplotlib.text.Text.set_position"><code class="xref py py-meth docutils literal notranslate"><span class="pre">position</span></code></a></td>
<td>(x,y)</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_rasterized.html#matplotlib.artist.Artist.set_rasterized" title="matplotlib.artist.Artist.set_rasterized"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rasterized</span></code></a></td>
<td>bool or None</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_rotation" title="matplotlib.text.Text.set_rotation"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rotation</span></code></a></td>
<td>[ angle in degrees | ‘vertical’ | ‘horizontal’ ]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_rotation_mode" title="matplotlib.text.Text.set_rotation_mode"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rotation_mode</span></code></a></td>
<td>[ None | “default” | “anchor” ]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_size" title="matplotlib.text.Text.set_size"><code class="xref py py-meth docutils literal notranslate"><span class="pre">size</span></code></a> or fontsize</td>
<td>[size in points | ‘xx-small’ | ‘x-small’ | ‘small’ | ‘medium’ | ‘large’ | ‘x-large’ | ‘xx-large’ ]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_sketch_params.html#matplotlib.artist.Artist.set_sketch_params" title="matplotlib.artist.Artist.set_sketch_params"><code class="xref py py-meth docutils literal notranslate"><span class="pre">sketch_params</span></code></a></td>
<td>(scale: float, length: float, randomness: float)</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_snap.html#matplotlib.artist.Artist.set_snap" title="matplotlib.artist.Artist.set_snap"><code class="xref py py-meth docutils literal notranslate"><span class="pre">snap</span></code></a></td>
<td>bool or None</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_stretch" title="matplotlib.text.Text.set_stretch"><code class="xref py py-meth docutils literal notranslate"><span class="pre">stretch</span></code></a> or fontstretch</td>
<td>[a numeric value in range 0-1000 | ‘ultra-condensed’ | ‘extra-condensed’ | ‘condensed’ | ‘semi-condensed’ | ‘normal’ | ‘semi-expanded’ | ‘expanded’ | ‘extra-expanded’ | ‘ultra-expanded’ ]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_style" title="matplotlib.text.Text.set_style"><code class="xref py py-meth docutils literal notranslate"><span class="pre">style</span></code></a> or fontstyle</td>
<td>[ ‘normal’ | ‘italic’ | ‘oblique’]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_text" title="matplotlib.text.Text.set_text"><code class="xref py py-meth docutils literal notranslate"><span class="pre">text</span></code></a></td>
<td>string or anything printable with ‘%s’ conversion.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_transform.html#matplotlib.artist.Artist.set_transform" title="matplotlib.artist.Artist.set_transform"><code class="xref py py-meth docutils literal notranslate"><span class="pre">transform</span></code></a></td>
<td><a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Transform</span></code></a></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_url.html#matplotlib.artist.Artist.set_url" title="matplotlib.artist.Artist.set_url"><code class="xref py py-meth docutils literal notranslate"><span class="pre">url</span></code></a></td>
<td>a url string</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_usetex" title="matplotlib.text.Text.set_usetex"><code class="xref py py-meth docutils literal notranslate"><span class="pre">usetex</span></code></a></td>
<td>bool or None</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_variant" title="matplotlib.text.Text.set_variant"><code class="xref py py-meth docutils literal notranslate"><span class="pre">variant</span></code></a> or fontvariant</td>
<td>[ ‘normal’ | ‘small-caps’ ]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_verticalalignment" title="matplotlib.text.Text.set_verticalalignment"><code class="xref py py-meth docutils literal notranslate"><span class="pre">verticalalignment</span></code></a> or va</td>
<td>[ ‘center’ | ‘top’ | ‘bottom’ | ‘baseline’ ]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_visible.html#matplotlib.artist.Artist.set_visible" title="matplotlib.artist.Artist.set_visible"><code class="xref py py-meth docutils literal notranslate"><span class="pre">visible</span></code></a></td>
<td>bool</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_weight" title="matplotlib.text.Text.set_weight"><code class="xref py py-meth docutils literal notranslate"><span class="pre">weight</span></code></a> or fontweight</td>
<td>[a numeric value in range 0-1000 | ‘ultralight’ | ‘light’ | ‘normal’ | ‘regular’ | ‘book’ | ‘medium’ | ‘roman’ | ‘semibold’ | ‘demibold’ | ‘demi’ | ‘bold’ | ‘heavy’ | ‘extra bold’ | ‘black’ ]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_wrap" title="matplotlib.text.Text.set_wrap"><code class="xref py py-meth docutils literal notranslate"><span class="pre">wrap</span></code></a></td>
<td>bool</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_x" title="matplotlib.text.Text.set_x"><code class="xref py py-meth docutils literal notranslate"><span class="pre">x</span></code></a></td>
<td>float</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="text_api.html#matplotlib.text.Text.set_y" title="matplotlib.text.Text.set_y"><code class="xref py py-meth docutils literal notranslate"><span class="pre">y</span></code></a></td>
<td>float</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="_as_gen/matplotlib.artist.Artist.set_zorder.html#matplotlib.artist.Artist.set_zorder" title="matplotlib.artist.Artist.set_zorder"><code class="xref py py-meth docutils literal notranslate"><span class="pre">zorder</span></code></a></td>
<td>float</td>
</tr>
</tbody>
</table>
</div></blockquote>
<dl class="method">
<dt id="matplotlib.contour.ClabelText.get_rotation">
<code class="descname">get_rotation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ClabelText.get_rotation" title="Permalink to this definition">¶</a></dt>
<dd><p>return the text angle as float in degrees</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.contour.ContourLabeler">
<em class="property">class </em><code class="descclassname">matplotlib.contour.</code><code class="descname">ContourLabeler</code><a class="headerlink" href="#matplotlib.contour.ContourLabeler" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.6)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Mixin to provide labelling capability to ContourSet</p>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.add_label">
<code class="descname">add_label</code><span class="sig-paren">(</span><em>x</em>, <em>y</em>, <em>rotation</em>, <em>lev</em>, <em>cvalue</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourLabeler.add_label" title="Permalink to this definition">¶</a></dt>
<dd><p>Add contour label using <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-class docutils literal notranslate"><span class="pre">Text</span></code></a> class.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.add_label_clabeltext">
<code class="descname">add_label_clabeltext</code><span class="sig-paren">(</span><em>x</em>, <em>y</em>, <em>rotation</em>, <em>lev</em>, <em>cvalue</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourLabeler.add_label_clabeltext" title="Permalink to this definition">¶</a></dt>
<dd><p>Add contour label using <a class="reference internal" href="#matplotlib.contour.ClabelText" title="matplotlib.contour.ClabelText"><code class="xref py py-class docutils literal notranslate"><span class="pre">ClabelText</span></code></a> class.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.add_label_near">
<code class="descname">add_label_near</code><span class="sig-paren">(</span><em>x</em>, <em>y</em>, <em>inline=True</em>, <em>inline_spacing=5</em>, <em>transform=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourLabeler.add_label_near" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a label near the point (x, y). If transform is None
(default), (x, y) is in data coordinates; if transform is
False, (x, y) is in display coordinates; otherwise, the
specified transform will be used to translate (x, y) into
display coordinates.</p>
<dl class="docutils">
<dt><em>inline</em>:</dt>
<dd>controls whether the underlying contour is removed or
not. Default is <em>True</em>.</dd>
<dt><em>inline_spacing</em>:</dt>
<dd>space in pixels to leave on each side of label when
placing inline. Defaults to 5. This spacing will be
exact for labels at locations where the contour is
straight, less so for labels on curved contours.</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.calc_label_rot_and_inline">
<code class="descname">calc_label_rot_and_inline</code><span class="sig-paren">(</span><em>slc</em>, <em>ind</em>, <em>lw</em>, <em>lc=None</em>, <em>spacing=5</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourLabeler.calc_label_rot_and_inline" title="Permalink to this definition">¶</a></dt>
<dd><p>This function calculates the appropriate label rotation given
the linecontour coordinates in screen units, the index of the
label location and the label width.</p>
<p>It will also break contour and calculate inlining if <em>lc</em> is
not empty (lc defaults to the empty list if None). <em>spacing</em>
is the space around the label in pixels to leave empty.</p>
<p>Do both of these tasks at once to avoid calculating path lengths
multiple times, which is relatively costly.</p>
<p>The method used here involves calculating the path length
along the contour in pixel coordinates and then looking
approximately label width / 2 away from central point to
determine rotation and then to break contour if desired.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.clabel">
<code class="descname">clabel</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourLabeler.clabel" title="Permalink to this definition">¶</a></dt>
<dd><p>Label a contour plot.</p>
<p>Call signature:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">clabel</span><span class="p">(</span><span class="n">cs</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<p>Adds labels to line contours in <em>cs</em>, where <em>cs</em> is a
<a class="reference internal" href="#matplotlib.contour.ContourSet" title="matplotlib.contour.ContourSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">ContourSet</span></code></a> object returned by
contour.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">clabel</span><span class="p">(</span><span class="n">cs</span><span class="p">,</span> <span class="n">v</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<p>only labels contours listed in <em>v</em>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>fontsize</strong> : string or float, optional</p>
<blockquote>
<div><p>Size in points or relative size e.g., ‘smaller’, ‘x-large’.
See <code class="xref py py-obj docutils literal notranslate"><span class="pre">Text.set_size</span></code> for accepted string values.</p>
</div></blockquote>
<p><strong>colors :</strong></p>
<blockquote>
<div><p>Color of each label</p>
<ul class="simple">
<li>if <em>None</em>, the color of each label matches the color of
the corresponding contour</li>
<li>if one string color, e.g., <em>colors</em> = ‘r’ or <em>colors</em> =
‘red’, all labels will be plotted in this color</li>
<li>if a tuple of matplotlib color args (string, float, rgb, etc),
different labels will be plotted in different colors in the order
specified</li>
</ul>
</div></blockquote>
<p><strong>inline</strong> : bool, optional</p>
<blockquote>
<div><p>If <code class="docutils literal notranslate"><span class="pre">True</span></code> the underlying contour is removed where the label is
placed. Default is <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
</div></blockquote>
<p><strong>inline_spacing</strong> : float, optional</p>
<blockquote>
<div><p>Space in pixels to leave on each side of label when
placing inline. Defaults to 5.</p>
<p>This spacing will be exact for labels at locations where the
contour is straight, less so for labels on curved contours.</p>
</div></blockquote>
<p><strong>fmt</strong> : string or dict, optional</p>
<blockquote>
<div><p>A format string for the label. Default is ‘%1.3f’</p>
<p>Alternatively, this can be a dictionary matching contour
levels with arbitrary strings to use for each contour level
(i.e., fmt[level]=string), or it can be any callable, such
as a <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal notranslate"><span class="pre">Formatter</span></code></a> instance, that
returns a string when called with a numeric contour level.</p>
</div></blockquote>
<p><strong>manual</strong> : bool or iterable, optional</p>
<blockquote>
<div><p>If <code class="docutils literal notranslate"><span class="pre">True</span></code>, contour labels will be placed manually using
mouse clicks. Click the first button near a contour to
add a label, click the second button (or potentially both
mouse buttons at once) to finish adding labels. The third
button can be used to remove the last label added, but
only if labels are not inline. Alternatively, the keyboard
can be used to select label locations (enter to end label
placement, delete or backspace act like the third mouse button,
and any other key will select a label location).</p>
<p><em>manual</em> can also be an iterable object of x,y tuples.
Contour labels will be created as if mouse is clicked at each
x,y positions.</p>
</div></blockquote>
<p><strong>rightside_up</strong> : bool, optional</p>
<blockquote>
<div><p>If <code class="docutils literal notranslate"><span class="pre">True</span></code>, label rotations will always be plus
or minus 90 degrees from level. Default is <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
</div></blockquote>
<p><strong>use_clabeltext</strong> : bool, optional</p>
<blockquote class="last">
<div><p>If <code class="docutils literal notranslate"><span class="pre">True</span></code>, <a class="reference internal" href="#matplotlib.contour.ClabelText" title="matplotlib.contour.ClabelText"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ClabelText</span></code></a> class (instead of <code class="xref py py-obj docutils literal notranslate"><span class="pre">Text</span></code>) is used to
create labels. <a class="reference internal" href="#matplotlib.contour.ClabelText" title="matplotlib.contour.ClabelText"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ClabelText</span></code></a> recalculates rotation angles
of texts during the drawing time, therefore this can be used if
aspect of the axes changes. Default is <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.get_label_coords">
<code class="descname">get_label_coords</code><span class="sig-paren">(</span><em>distances</em>, <em>XX</em>, <em>YY</em>, <em>ysize</em>, <em>lw</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourLabeler.get_label_coords" title="Permalink to this definition">¶</a></dt>
<dd><p>Return x, y, and the index of a label location.</p>
<p>Labels are plotted at a location with the smallest
deviation of the contour from a straight line
unless there is another label nearby, in which case
the next best place on the contour is picked up.
If all such candidates are rejected, the beginning
of the contour is chosen.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.get_label_width">
<code class="descname">get_label_width</code><span class="sig-paren">(</span><em>lev</em>, <em>fmt</em>, <em>fsize</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourLabeler.get_label_width" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the width of the label in points.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.get_real_label_width">
<code class="descname">get_real_label_width</code><span class="sig-paren">(</span><em>lev</em>, <em>fmt</em>, <em>fsize</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourLabeler.get_real_label_width" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
<p><span class="versionmodified">Deprecated since version 2.2: </span>The get_real_label_width function was deprecated in version 2.2.</p>
</div>
<p>This computes actual onscreen label width.
This uses some black magic to determine onscreen extent of non-drawn
label. This magic may not be very robust.</p>
<p>This method is not being used, and may be modified or removed.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.get_text">
<code class="descname">get_text</code><span class="sig-paren">(</span><em>lev</em>, <em>fmt</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourLabeler.get_text" title="Permalink to this definition">¶</a></dt>
<dd><p>get the text of the label</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.labels">
<code class="descname">labels</code><span class="sig-paren">(</span><em>inline</em>, <em>inline_spacing</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourLabeler.labels" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.locate_label">
<code class="descname">locate_label</code><span class="sig-paren">(</span><em>linecontour</em>, <em>labelwidth</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourLabeler.locate_label" title="Permalink to this definition">¶</a></dt>
<dd><p>Find good place to draw a label (relatively flat part of the contour).</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.pop_label">
<code class="descname">pop_label</code><span class="sig-paren">(</span><em>index=-1</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourLabeler.pop_label" title="Permalink to this definition">¶</a></dt>
<dd><p>Defaults to removing last label, but any index can be supplied</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.print_label">
<code class="descname">print_label</code><span class="sig-paren">(</span><em>linecontour</em>, <em>labelwidth</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourLabeler.print_label" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <em>False</em> if contours are too short for a label.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.set_label_props">
<code class="descname">set_label_props</code><span class="sig-paren">(</span><em>label</em>, <em>text</em>, <em>color</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourLabeler.set_label_props" title="Permalink to this definition">¶</a></dt>
<dd><p>set the label properties - color, fontsize, text</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.contour.ContourLabeler.too_close">
<code class="descname">too_close</code><span class="sig-paren">(</span><em>x</em>, <em>y</em>, <em>lw</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourLabeler.too_close" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <em>True</em> if a label is already near this location.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.contour.ContourSet">
<em class="property">class </em><code class="descclassname">matplotlib.contour.</code><code class="descname">ContourSet</code><span class="sig-paren">(</span><em>ax</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourSet" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="cm_api.html#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.cm.ScalarMappable</span></code></a>, <a class="reference internal" href="#matplotlib.contour.ContourLabeler" title="matplotlib.contour.ContourLabeler"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.contour.ContourLabeler</span></code></a></p>
<p>Store a set of contour lines or filled regions.</p>
<p>User-callable method: clabel</p>
<p class="rubric">Attributes</p>
<table border="1" class="docutils">
<colgroup>
<col width="13%" />
<col width="87%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><strong>ax:</strong></td>
<td>The axes object in which the contours are drawn.</td>
</tr>
<tr class="row-even"><td><strong>collections:</strong></td>
<td>A silent_list of LineCollections or PolyCollections.</td>
</tr>
<tr class="row-odd"><td><strong>levels:</strong></td>
<td>Contour levels.</td>
</tr>
<tr class="row-even"><td><strong>layers:</strong></td>
<td>Same as levels for line contours; half-way between levels for filled contours. See <code class="xref py py-meth docutils literal notranslate"><span class="pre">_process_colors()</span></code>.</td>
</tr>
</tbody>
</table>
<p>Draw contour lines or filled regions, depending on
whether keyword arg <em>filled</em> is <code class="docutils literal notranslate"><span class="pre">False</span></code> (default) or <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
<p>The first three arguments must be:</p>
<blockquote>
<div><p><em>ax</em>: axes object.</p>
<dl class="docutils">
<dt><em>levels</em>: [level0, level1, …, leveln]</dt>
<dd>A list of floating point numbers indicating the contour
levels.</dd>
<dt><em>allsegs</em>: [level0segs, level1segs, …]</dt>
<dd><p class="first">List of all the polygon segments for all the <em>levels</em>.
For contour lines <code class="docutils literal notranslate"><span class="pre">len(allsegs)</span> <span class="pre">==</span> <span class="pre">len(levels)</span></code>, and for
filled contour regions <code class="docutils literal notranslate"><span class="pre">len(allsegs)</span> <span class="pre">=</span> <span class="pre">len(levels)-1</span></code>. The lists
should look like:</p>
<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">level0segs</span> <span class="o">=</span> <span class="p">[</span><span class="n">polygon0</span><span class="p">,</span> <span class="n">polygon1</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span>
<span class="n">polygon0</span> <span class="o">=</span> <span class="n">array_like</span> <span class="p">[[</span><span class="n">x0</span><span class="p">,</span><span class="n">y0</span><span class="p">],</span> <span class="p">[</span><span class="n">x1</span><span class="p">,</span><span class="n">y1</span><span class="p">],</span> <span class="o">...</span><span class="p">]</span>
</pre></div>
</div>
</dd>
<dt><em>allkinds</em>: <em>None</em> or [level0kinds, level1kinds, …]</dt>
<dd><p class="first">Optional list of all the polygon vertex kinds (code types), as
described and used in Path. This is used to allow multiply-
connected paths such as holes within filled polygons.
If not <code class="docutils literal notranslate"><span class="pre">None</span></code>, <code class="docutils literal notranslate"><span class="pre">len(allkinds)</span> <span class="pre">==</span> <span class="pre">len(allsegs)</span></code>. The lists
should look like:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">level0kinds</span> <span class="o">=</span> <span class="p">[</span><span class="n">polygon0kinds</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span>
<span class="n">polygon0kinds</span> <span class="o">=</span> <span class="p">[</span><span class="n">vertexcode0</span><span class="p">,</span> <span class="n">vertexcode1</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span>
</pre></div>
</div>
<p class="last">If <em>allkinds</em> is not <code class="docutils literal notranslate"><span class="pre">None</span></code>, usually all polygons for a
particular contour level are grouped together so that
<code class="docutils literal notranslate"><span class="pre">level0segs</span> <span class="pre">=</span> <span class="pre">[polygon0]</span></code> and <code class="docutils literal notranslate"><span class="pre">level0kinds</span> <span class="pre">=</span> <span class="pre">[polygon0kinds]</span></code>.</p>
</dd>
</dl>
</div></blockquote>
<p>Keyword arguments are as described in the docstring of
<a class="reference internal" href="_as_gen/matplotlib.axes.Axes.contour.html#matplotlib.axes.Axes.contour" title="matplotlib.axes.Axes.contour"><code class="xref py py-obj docutils literal notranslate"><span class="pre">contour</span></code></a>.</p>
<dl class="method">
<dt id="matplotlib.contour.ContourSet.changed">
<code class="descname">changed</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourSet.changed" title="Permalink to this definition">¶</a></dt>
<dd><p>Call this whenever the mappable is changed to notify all the
callbackSM listeners to the ‘changed’ signal</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.contour.ContourSet.find_nearest_contour">
<code class="descname">find_nearest_contour</code><span class="sig-paren">(</span><em>x</em>, <em>y</em>, <em>indices=None</em>, <em>pixel=True</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourSet.find_nearest_contour" title="Permalink to this definition">¶</a></dt>
<dd><p>Finds contour that is closest to a point. Defaults to
measuring distance in pixels (screen space - useful for manual
contour labeling), but this can be controlled via a keyword
argument.</p>
<p>Returns a tuple containing the contour, segment, index of
segment, x & y of segment point and distance to minimum point.</p>
<p>Optional keyword arguments:</p>
<blockquote>
<div><dl class="docutils">
<dt><em>indices</em>:</dt>
<dd>Indexes of contour levels to consider when looking for
nearest point. Defaults to using all levels.</dd>
<dt><em>pixel</em>:</dt>
<dd>If <em>True</em>, measure distance in pixel space, if not, measure
distance in axes space. Defaults to <em>True</em>.</dd>
</dl>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="matplotlib.contour.ContourSet.get_alpha">
<code class="descname">get_alpha</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourSet.get_alpha" title="Permalink to this definition">¶</a></dt>
<dd><p>returns alpha to be applied to all ContourSet artists</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.contour.ContourSet.get_transform">
<code class="descname">get_transform</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourSet.get_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal notranslate"><span class="pre">Transform</span></code></a>
instance used by this ContourSet.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.contour.ContourSet.legend_elements">
<code class="descname">legend_elements</code><span class="sig-paren">(</span><em>variable_name='x'</em>, <em>str_format=<class 'str'></em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourSet.legend_elements" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of artist and labels suitable for passing through
to <code class="xref py py-func docutils literal notranslate"><span class="pre">plt.legend()</span></code> which represent this ContourSet.</p>
<p>Args:</p>
<blockquote>
<div><dl class="docutils">
<dt><em>variable_name</em>: the string used inside the inequality used</dt>
<dd>on the labels</dd>
</dl>
<p><em>str_format</em>: function used to format the numbers in the labels</p>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="matplotlib.contour.ContourSet.set_alpha">
<code class="descname">set_alpha</code><span class="sig-paren">(</span><em>alpha</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.ContourSet.set_alpha" title="Permalink to this definition">¶</a></dt>
<dd><p>sets alpha for all ContourSet artists</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.contour.QuadContourSet">
<em class="property">class </em><code class="descclassname">matplotlib.contour.</code><code class="descname">QuadContourSet</code><span class="sig-paren">(</span><em>ax</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.contour.QuadContourSet" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.contour.ContourSet" title="matplotlib.contour.ContourSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.contour.ContourSet</span></code></a></p>
<p>Create and store a set of contour lines or filled regions.</p>
<p>User-callable method: <code class="xref py py-meth docutils literal notranslate"><span class="pre">clabel()</span></code></p>
<p class="rubric">Attributes</p>
<table border="1" class="docutils">
<colgroup>
<col width="12%" />
<col width="88%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><strong>ax:</strong></td>
<td>The axes object in which the contours are drawn.</td>
</tr>
<tr class="row-even"><td><strong>collections:</strong></td>
<td>A silent_list of LineCollections or PolyCollections.</td>
</tr>
<tr class="row-odd"><td><strong>levels:</strong></td>
<td>Contour levels.</td>
</tr>
<tr class="row-even"><td><strong>layers:</strong></td>
<td>Same as levels for line contours; half-way between levels for filled contours. See <code class="xref py py-meth docutils literal notranslate"><span class="pre">_process_colors()</span></code> method.</td>
</tr>
</tbody>
</table>
<p>Draw contour lines or filled regions, depending on
whether keyword arg <em>filled</em> is <code class="docutils literal notranslate"><span class="pre">False</span></code> (default) or <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
<p>The first three arguments must be:</p>
<blockquote>
<div><p><em>ax</em>: axes object.</p>
<dl class="docutils">
<dt><em>levels</em>: [level0, level1, …, leveln]</dt>
<dd>A list of floating point numbers indicating the contour
levels.</dd>
<dt><em>allsegs</em>: [level0segs, level1segs, …]</dt>
<dd><p class="first">List of all the polygon segments for all the <em>levels</em>.
For contour lines <code class="docutils literal notranslate"><span class="pre">len(allsegs)</span> <span class="pre">==</span> <span class="pre">len(levels)</span></code>, and for
filled contour regions <code class="docutils literal notranslate"><span class="pre">len(allsegs)</span> <span class="pre">=</span> <span class="pre">len(levels)-1</span></code>. The lists
should look like:</p>
<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">level0segs</span> <span class="o">=</span> <span class="p">[</span><span class="n">polygon0</span><span class="p">,</span> <span class="n">polygon1</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span>
<span class="n">polygon0</span> <span class="o">=</span> <span class="n">array_like</span> <span class="p">[[</span><span class="n">x0</span><span class="p">,</span><span class="n">y0</span><span class="p">],</span> <span class="p">[</span><span class="n">x1</span><span class="p">,</span><span class="n">y1</span><span class="p">],</span> <span class="o">...</span><span class="p">]</span>
</pre></div>
</div>
</dd>
<dt><em>allkinds</em>: <em>None</em> or [level0kinds, level1kinds, …]</dt>
<dd><p class="first">Optional list of all the polygon vertex kinds (code types), as
described and used in Path. This is used to allow multiply-
connected paths such as holes within filled polygons.
If not <code class="docutils literal notranslate"><span class="pre">None</span></code>, <code class="docutils literal notranslate"><span class="pre">len(allkinds)</span> <span class="pre">==</span> <span class="pre">len(allsegs)</span></code>. The lists
should look like:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">level0kinds</span> <span class="o">=</span> <span class="p">[</span><span class="n">polygon0kinds</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span>
<span class="n">polygon0kinds</span> <span class="o">=</span> <span class="p">[</span><span class="n">vertexcode0</span><span class="p">,</span> <span class="n">vertexcode1</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span>
</pre></div>
</div>
<p class="last">If <em>allkinds</em> is not <code class="docutils literal notranslate"><span class="pre">None</span></code>, usually all polygons for a
particular contour level are grouped together so that
<code class="docutils literal notranslate"><span class="pre">level0segs</span> <span class="pre">=</span> <span class="pre">[polygon0]</span></code> and <code class="docutils literal notranslate"><span class="pre">level0kinds</span> <span class="pre">=</span> <span class="pre">[polygon0kinds]</span></code>.</p>
</dd>
</dl>
</div></blockquote>
<p>Keyword arguments are as described in the docstring of
<a class="reference internal" href="_as_gen/matplotlib.axes.Axes.contour.html#matplotlib.axes.Axes.contour" title="matplotlib.axes.Axes.contour"><code class="xref py py-obj docutils literal notranslate"><span class="pre">contour</span></code></a>.</p>
</dd></dl>
</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 - 2017 The Matplotlib development team.
Last updated on Mar 06, 2018.
Created using <a
href="http://sphinx-doc.org/">Sphinx</a> 1.7.1.
</div>
</body>
<footer>
</footer>
</html>