{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathcbook_api.html
More file actions
1487 lines (1347 loc) · 95.9 KB
/
Copy pathcbook_api.html
File metadata and controls
1487 lines (1347 loc) · 95.9 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
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!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>cbook — Matplotlib 1.5.3 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.5.3',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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 1.5.3 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="top" title="Matplotlib 1.5.3 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="cm (colormap)" href="cm_api.html" />
<link rel="prev" title="matplotlib.backends.backend_pdf" href="backend_pdf_api.html" />
<link rel="canonical" href="https://matplotlib.org/stable/api/cbook_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 (v1.5.3). For the latest version see <a href="https://matplotlib.org/stable/api/cbook_api.html">https://matplotlib.org/stable/api/cbook_api.html</a></div>
<div class="alert" style="background-color: #FEA46C; padding: 10px 0;
">
<h2>Matplotlib 2.0.0rc2 is available</h2>
<p><a href="../style_changes.html"
style="font-weight: bold;
color: #11557C;">Install the release candidate now!</a></p>
</div>
<!-- The "Fork me on github" ribbon -->
<img style="float: right; margin-bottom: -40px; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" usemap="#ribbonmap"/>
<map name="ribbonmap">
<area shape="poly" coords="15,0,148,-1,148,135" href="https://github.com/matplotlib/matplotlib" title="Fork me on GitHub" />
</map>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="../index.html"><img src="../_static/logo2.svg" width="540px" border="0" alt="matplotlib"/></a>
</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="cm_api.html" title="cm (colormap)"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="backend_pdf_api.html" title="matplotlib.backends.backend_pdf"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../examples/index.html">examples</a>| </li>
<li><a href="../gallery.html">gallery</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">
<a href="http://depsy.org/package/python/matplotlib">
<img src="http://depsy.org/api/package/pypi/matplotlib/badge.svg">
</a>
<br/>
Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">
<img src="https://travis-ci.org/matplotlib/matplotlib.svg?branch=master"/>
</a>
<br/>
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">cbook</a><ul>
<li><a class="reference internal" href="#module-matplotlib.cbook"><code class="docutils literal"><span class="pre">matplotlib.cbook</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="backend_pdf_api.html" title="previous chapter"><code class="docutils literal"><span class="pre">matplotlib.backends.backend_pdf</span></code></a></li>
<li>Next: <a href="cm_api.html" title="next chapter">cm (colormap)</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/cbook_api.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</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="cbook">
<h1>cbook<a class="headerlink" href="#cbook" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-matplotlib.cbook">
<span id="matplotlib-cbook"></span><h2><a class="reference internal" href="#module-matplotlib.cbook" title="matplotlib.cbook"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.cbook</span></code></a><a class="headerlink" href="#module-matplotlib.cbook" title="Permalink to this headline">¶</a></h2>
<p>A collection of utility functions and classes. Originally, many
(but not all) were from the Python Cookbook – hence the name cbook.</p>
<p>This module is safe to import from anywhere within matplotlib;
it imports matplotlib only at runtime.</p>
<dl class="class">
<dt id="matplotlib.cbook.Bunch">
<em class="property">class </em><code class="descclassname">matplotlib.cbook.</code><code class="descname">Bunch</code><span class="sig-paren">(</span><em>**kwds</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.Bunch" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Often we want to just collect a bunch of stuff together, naming each
item of the bunch; a dictionary’s OK for that, but a small do- nothing
class is even handier, and prettier to use. Whenever you want to
group a few variables:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">point</span> <span class="o">=</span> <span class="n">Bunch</span><span class="p">(</span><span class="n">datum</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">squared</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span> <span class="n">coord</span><span class="o">=</span><span class="mi">12</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">point</span><span class="o">.</span><span class="n">datum</span>
<span class="go">By: Alex Martelli</span>
<span class="go">From: http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/52308</span>
</pre></div>
</div>
</dd></dl>
<dl class="class">
<dt id="matplotlib.cbook.CallbackRegistry">
<em class="property">class </em><code class="descclassname">matplotlib.cbook.</code><code class="descname">CallbackRegistry</code><a class="headerlink" href="#matplotlib.cbook.CallbackRegistry" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Handle registering and disconnecting for a set of signals and
callbacks:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">def</span> <span class="nf">oneat</span><span class="p">(</span><span class="n">x</span><span class="p">):</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="s1">'eat'</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span>
<span class="gp">>>> </span><span class="k">def</span> <span class="nf">ondrink</span><span class="p">(</span><span class="n">x</span><span class="p">):</span>
<span class="gp">... </span> <span class="nb">print</span><span class="p">(</span><span class="s1">'drink'</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">matplotlib.cbook</span> <span class="k">import</span> <span class="n">CallbackRegistry</span>
<span class="gp">>>> </span><span class="n">callbacks</span> <span class="o">=</span> <span class="n">CallbackRegistry</span><span class="p">()</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">id_eat</span> <span class="o">=</span> <span class="n">callbacks</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s1">'eat'</span><span class="p">,</span> <span class="n">oneat</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">id_drink</span> <span class="o">=</span> <span class="n">callbacks</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s1">'drink'</span><span class="p">,</span> <span class="n">ondrink</span><span class="p">)</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">callbacks</span><span class="o">.</span><span class="n">process</span><span class="p">(</span><span class="s1">'drink'</span><span class="p">,</span> <span class="mi">123</span><span class="p">)</span>
<span class="go">drink 123</span>
<span class="gp">>>> </span><span class="n">callbacks</span><span class="o">.</span><span class="n">process</span><span class="p">(</span><span class="s1">'eat'</span><span class="p">,</span> <span class="mi">456</span><span class="p">)</span>
<span class="go">eat 456</span>
<span class="gp">>>> </span><span class="n">callbacks</span><span class="o">.</span><span class="n">process</span><span class="p">(</span><span class="s1">'be merry'</span><span class="p">,</span> <span class="mi">456</span><span class="p">)</span> <span class="c1"># nothing will be called</span>
<span class="gp">>>> </span><span class="n">callbacks</span><span class="o">.</span><span class="n">disconnect</span><span class="p">(</span><span class="n">id_eat</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">callbacks</span><span class="o">.</span><span class="n">process</span><span class="p">(</span><span class="s1">'eat'</span><span class="p">,</span> <span class="mi">456</span><span class="p">)</span> <span class="c1"># nothing will be called</span>
</pre></div>
</div>
<p>In practice, one should always disconnect all callbacks when they
are no longer needed to avoid dangling references (and thus memory
leaks). However, real code in matplotlib rarely does so, and due
to its design, it is rather difficult to place this kind of code.
To get around this, and prevent this class of memory leaks, we
instead store weak references to bound methods only, so when the
destination object needs to die, the CallbackRegistry won’t keep
it alive. The Python stdlib weakref module can not create weak
references to bound methods directly, so we need to create a proxy
object to handle weak references to bound methods (or regular free
functions). This technique was shared by Peter Parente on his
<a class="reference external" href="http://mindtrove.info/python-weak-references/">“Mindtrove” blog</a>.</p>
<dl class="method">
<dt id="matplotlib.cbook.CallbackRegistry.connect">
<code class="descname">connect</code><span class="sig-paren">(</span><em>s</em>, <em>func</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.CallbackRegistry.connect" title="Permalink to this definition">¶</a></dt>
<dd><p>register <em>func</em> to be called when a signal <em>s</em> is generated
func will be called</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.cbook.CallbackRegistry.disconnect">
<code class="descname">disconnect</code><span class="sig-paren">(</span><em>cid</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.CallbackRegistry.disconnect" title="Permalink to this definition">¶</a></dt>
<dd><p>disconnect the callback registered with callback id <em>cid</em></p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.cbook.CallbackRegistry.process">
<code class="descname">process</code><span class="sig-paren">(</span><em>s</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.CallbackRegistry.process" title="Permalink to this definition">¶</a></dt>
<dd><p>process signal <em>s</em>. All of the functions registered to receive
callbacks on <em>s</em> will be called with <em>*args</em> and <em>**kwargs</em></p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.cbook.GetRealpathAndStat">
<em class="property">class </em><code class="descclassname">matplotlib.cbook.</code><code class="descname">GetRealpathAndStat</code><a class="headerlink" href="#matplotlib.cbook.GetRealpathAndStat" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.cbook.Grouper">
<em class="property">class </em><code class="descclassname">matplotlib.cbook.</code><code class="descname">Grouper</code><span class="sig-paren">(</span><em>init=()</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.Grouper" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>This class provides a lightweight way to group arbitrary objects
together into disjoint sets when a full-blown graph data structure
would be overkill.</p>
<p>Objects can be joined using <a class="reference internal" href="#matplotlib.cbook.Grouper.join" title="matplotlib.cbook.Grouper.join"><code class="xref py py-meth docutils literal"><span class="pre">join()</span></code></a>, tested for connectedness
using <a class="reference internal" href="#matplotlib.cbook.Grouper.joined" title="matplotlib.cbook.Grouper.joined"><code class="xref py py-meth docutils literal"><span class="pre">joined()</span></code></a>, and all disjoint sets can be retreived by
using the object as an iterator.</p>
<p>The objects being joined must be hashable and weak-referenceable.</p>
<p>For example:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">matplotlib.cbook</span> <span class="k">import</span> <span class="n">Grouper</span>
<span class="gp">>>> </span><span class="k">class</span> <span class="nc">Foo</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">s</span><span class="p">):</span>
<span class="gp">... </span> <span class="bp">self</span><span class="o">.</span><span class="n">s</span> <span class="o">=</span> <span class="n">s</span>
<span class="gp">... </span> <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">s</span>
<span class="gp">...</span>
<span class="gp">>>> </span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">,</span> <span class="n">c</span><span class="p">,</span> <span class="n">d</span><span class="p">,</span> <span class="n">e</span><span class="p">,</span> <span class="n">f</span> <span class="o">=</span> <span class="p">[</span><span class="n">Foo</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="s1">'abcdef'</span><span class="p">]</span>
<span class="gp">>>> </span><span class="n">grp</span> <span class="o">=</span> <span class="n">Grouper</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">grp</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">grp</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">b</span><span class="p">,</span> <span class="n">c</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">grp</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">d</span><span class="p">,</span> <span class="n">e</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">sorted</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">tuple</span><span class="p">,</span> <span class="n">grp</span><span class="p">))</span>
<span class="go">[(a, b, c), (d, e)]</span>
<span class="gp">>>> </span><span class="n">grp</span><span class="o">.</span><span class="n">joined</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">b</span><span class="p">)</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">grp</span><span class="o">.</span><span class="n">joined</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">c</span><span class="p">)</span>
<span class="go">True</span>
<span class="gp">>>> </span><span class="n">grp</span><span class="o">.</span><span class="n">joined</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">d</span><span class="p">)</span>
<span class="go">False</span>
</pre></div>
</div>
<dl class="method">
<dt id="matplotlib.cbook.Grouper.clean">
<code class="descname">clean</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.Grouper.clean" title="Permalink to this definition">¶</a></dt>
<dd><p>Clean dead weak references from the dictionary</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.cbook.Grouper.get_siblings">
<code class="descname">get_siblings</code><span class="sig-paren">(</span><em>a</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.Grouper.get_siblings" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns all of the items joined with <em>a</em>, including itself.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.cbook.Grouper.join">
<code class="descname">join</code><span class="sig-paren">(</span><em>a</em>, <em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.Grouper.join" title="Permalink to this definition">¶</a></dt>
<dd><p>Join given arguments into the same set. Accepts one or more
arguments.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.cbook.Grouper.joined">
<code class="descname">joined</code><span class="sig-paren">(</span><em>a</em>, <em>b</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.Grouper.joined" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns True if <em>a</em> and <em>b</em> are members of the same set.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.cbook.Grouper.remove">
<code class="descname">remove</code><span class="sig-paren">(</span><em>a</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.Grouper.remove" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="exception">
<dt id="matplotlib.cbook.IgnoredKeywordWarning">
<em class="property">exception </em><code class="descclassname">matplotlib.cbook.</code><code class="descname">IgnoredKeywordWarning</code><a class="headerlink" href="#matplotlib.cbook.IgnoredKeywordWarning" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">UserWarning</span></code></p>
<p>A class for issuing warnings about keyword arguments that will be ignored
by matplotlib</p>
</dd></dl>
<dl class="exception">
<dt id="matplotlib.cbook.MatplotlibDeprecationWarning">
<em class="property">exception </em><code class="descclassname">matplotlib.cbook.</code><code class="descname">MatplotlibDeprecationWarning</code><a class="headerlink" href="#matplotlib.cbook.MatplotlibDeprecationWarning" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">UserWarning</span></code></p>
<p>A class for issuing deprecation warnings for Matplotlib users.</p>
<p>In light of the fact that Python builtin DeprecationWarnings are ignored
by default as of Python 2.7 (see link below), this class was put in to
allow for the signaling of deprecation, but via UserWarnings which are not
ignored by default.</p>
<p><a class="reference external" href="http://docs.python.org/dev/whatsnew/2.7.html#the-future-for-python-2-x">http://docs.python.org/dev/whatsnew/2.7.html#the-future-for-python-2-x</a></p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.cbook.MemoryMonitor">
<em class="property">class </em><code class="descclassname">matplotlib.cbook.</code><code class="descname">MemoryMonitor</code><span class="sig-paren">(</span><em>nmax=20000</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.MemoryMonitor" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<dl class="method">
<dt id="matplotlib.cbook.MemoryMonitor.clear">
<code class="descname">clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.MemoryMonitor.clear" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.cbook.MemoryMonitor.plot">
<code class="descname">plot</code><span class="sig-paren">(</span><em>i0=0</em>, <em>isub=1</em>, <em>fig=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.MemoryMonitor.plot" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.cbook.MemoryMonitor.report">
<code class="descname">report</code><span class="sig-paren">(</span><em>segments=4</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.MemoryMonitor.report" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.cbook.MemoryMonitor.xy">
<code class="descname">xy</code><span class="sig-paren">(</span><em>i0=0</em>, <em>isub=1</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.MemoryMonitor.xy" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.cbook.Null">
<em class="property">class </em><code class="descclassname">matplotlib.cbook.</code><code class="descname">Null</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.Null" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Null objects always and reliably “do nothing.”</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.cbook.RingBuffer">
<em class="property">class </em><code class="descclassname">matplotlib.cbook.</code><code class="descname">RingBuffer</code><span class="sig-paren">(</span><em>size_max</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.RingBuffer" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>class that implements a not-yet-full buffer</p>
<dl class="method">
<dt id="matplotlib.cbook.RingBuffer.append">
<code class="descname">append</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.RingBuffer.append" title="Permalink to this definition">¶</a></dt>
<dd><p>append an element at the end of the buffer</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.cbook.RingBuffer.get">
<code class="descname">get</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.RingBuffer.get" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of elements from the oldest to the newest.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.cbook.Sorter">
<em class="property">class </em><code class="descclassname">matplotlib.cbook.</code><code class="descname">Sorter</code><a class="headerlink" href="#matplotlib.cbook.Sorter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Sort by attribute or item</p>
<p>Example usage:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sort</span> <span class="o">=</span> <span class="n">Sorter</span><span class="p">()</span>
<span class="nb">list</span> <span class="o">=</span> <span class="p">[(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">),</span> <span class="p">(</span><span class="mi">4</span><span class="p">,</span> <span class="mi">8</span><span class="p">),</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">3</span><span class="p">)]</span>
<span class="nb">dict</span> <span class="o">=</span> <span class="p">[{</span><span class="s1">'a'</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span> <span class="s1">'b'</span><span class="p">:</span> <span class="mi">4</span><span class="p">},</span> <span class="p">{</span><span class="s1">'a'</span><span class="p">:</span> <span class="mi">5</span><span class="p">,</span> <span class="s1">'b'</span><span class="p">:</span> <span class="mi">2</span><span class="p">},</span> <span class="p">{</span><span class="s1">'a'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s1">'b'</span><span class="p">:</span> <span class="mi">0</span><span class="p">},</span>
<span class="p">{</span><span class="s1">'a'</span><span class="p">:</span> <span class="mi">9</span><span class="p">,</span> <span class="s1">'b'</span><span class="p">:</span> <span class="mi">9</span><span class="p">}]</span>
<span class="n">sort</span><span class="p">(</span><span class="nb">list</span><span class="p">)</span> <span class="c1"># default sort</span>
<span class="n">sort</span><span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> <span class="c1"># sort by index 1</span>
<span class="n">sort</span><span class="p">(</span><span class="nb">dict</span><span class="p">,</span> <span class="s1">'a'</span><span class="p">)</span> <span class="c1"># sort a list of dicts by key 'a'</span>
</pre></div>
</div>
<dl class="method">
<dt id="matplotlib.cbook.Sorter.byAttribute">
<code class="descname">byAttribute</code><span class="sig-paren">(</span><em>data</em>, <em>attributename</em>, <em>inplace=1</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.Sorter.byAttribute" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.cbook.Sorter.byItem">
<code class="descname">byItem</code><span class="sig-paren">(</span><em>data</em>, <em>itemindex=None</em>, <em>inplace=1</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.Sorter.byItem" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.cbook.Sorter.sort">
<code class="descname">sort</code><span class="sig-paren">(</span><em>data</em>, <em>itemindex=None</em>, <em>inplace=1</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.Sorter.sort" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.cbook.Stack">
<em class="property">class </em><code class="descclassname">matplotlib.cbook.</code><code class="descname">Stack</code><span class="sig-paren">(</span><em>default=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.Stack" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Implement a stack where elements can be pushed on and you can move
back and forth. But no pop. Should mimic home / back / forward
in a browser</p>
<dl class="method">
<dt id="matplotlib.cbook.Stack.back">
<code class="descname">back</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.Stack.back" title="Permalink to this definition">¶</a></dt>
<dd><p>move the position back and return the current element</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.cbook.Stack.bubble">
<code class="descname">bubble</code><span class="sig-paren">(</span><em>o</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.Stack.bubble" title="Permalink to this definition">¶</a></dt>
<dd><p>raise <em>o</em> to the top of the stack and return <em>o</em>. <em>o</em> must be
in the stack</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.cbook.Stack.clear">
<code class="descname">clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.Stack.clear" title="Permalink to this definition">¶</a></dt>
<dd><p>empty the stack</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.cbook.Stack.empty">
<code class="descname">empty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.Stack.empty" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.cbook.Stack.forward">
<code class="descname">forward</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.Stack.forward" title="Permalink to this definition">¶</a></dt>
<dd><p>move the position forward and return the current element</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.cbook.Stack.home">
<code class="descname">home</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.Stack.home" title="Permalink to this definition">¶</a></dt>
<dd><p>push the first element onto the top of the stack</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.cbook.Stack.push">
<code class="descname">push</code><span class="sig-paren">(</span><em>o</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.Stack.push" title="Permalink to this definition">¶</a></dt>
<dd><p>push object onto stack at current position - all elements
occurring later than the current position are discarded</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.cbook.Stack.remove">
<code class="descname">remove</code><span class="sig-paren">(</span><em>o</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.Stack.remove" title="Permalink to this definition">¶</a></dt>
<dd><p>remove element <em>o</em> from the stack</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.cbook.Xlator">
<em class="property">class </em><code class="descclassname">matplotlib.cbook.</code><code class="descname">Xlator</code><a class="headerlink" href="#matplotlib.cbook.Xlator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">dict</span></code></p>
<p>All-in-one multiple-string-substitution class</p>
<p>Example usage:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">text</span> <span class="o">=</span> <span class="s2">"Larry Wall is the creator of Perl"</span>
<span class="n">adict</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"Larry Wall"</span> <span class="p">:</span> <span class="s2">"Guido van Rossum"</span><span class="p">,</span>
<span class="s2">"creator"</span> <span class="p">:</span> <span class="s2">"Benevolent Dictator for Life"</span><span class="p">,</span>
<span class="s2">"Perl"</span> <span class="p">:</span> <span class="s2">"Python"</span><span class="p">,</span>
<span class="p">}</span>
<span class="nb">print</span><span class="p">(</span><span class="n">multiple_replace</span><span class="p">(</span><span class="n">adict</span><span class="p">,</span> <span class="n">text</span><span class="p">))</span>
<span class="n">xlat</span> <span class="o">=</span> <span class="n">Xlator</span><span class="p">(</span><span class="n">adict</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="n">xlat</span><span class="o">.</span><span class="n">xlat</span><span class="p">(</span><span class="n">text</span><span class="p">))</span>
</pre></div>
</div>
<dl class="method">
<dt id="matplotlib.cbook.Xlator.xlat">
<code class="descname">xlat</code><span class="sig-paren">(</span><em>text</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.Xlator.xlat" title="Permalink to this definition">¶</a></dt>
<dd><p>Translate <em>text</em>, returns the modified text.</p>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.align_iterators">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">align_iterators</code><span class="sig-paren">(</span><em>func</em>, <em>*iterables</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.align_iterators" title="Permalink to this definition">¶</a></dt>
<dd><p>This generator takes a bunch of iterables that are ordered by func
It sends out ordered tuples:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">func</span><span class="p">(</span><span class="n">row</span><span class="p">),</span> <span class="p">[</span><span class="n">rows</span> <span class="kn">from</span> <span class="nn">all</span> <span class="n">iterators</span> <span class="n">matching</span> <span class="n">func</span><span class="p">(</span><span class="n">row</span><span class="p">)])</span>
</pre></div>
</div>
<p>It is used by <a class="reference internal" href="mlab_api.html#matplotlib.mlab.recs_join" title="matplotlib.mlab.recs_join"><code class="xref py py-func docutils literal"><span class="pre">matplotlib.mlab.recs_join()</span></code></a> to join record arrays</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.allequal">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">allequal</code><span class="sig-paren">(</span><em>seq</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.allequal" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <em>True</em> if all elements of <em>seq</em> compare equal. If <em>seq</em> is
0 or 1 length, return <em>True</em></p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.allpairs">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">allpairs</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.allpairs" title="Permalink to this definition">¶</a></dt>
<dd><p>return all possible pairs in sequence <em>x</em></p>
<p>Condensed by Alex Martelli from this <a class="reference external" href="http://groups.google.com/groups?q=all+pairs+group:*python*&hl=en&lr=&ie=UTF-8&selm=mailman.4028.1096403649.5135.python-list%40python.org&rnum=1">thread</a> on c.l.python</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.alltrue">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">alltrue</code><span class="sig-paren">(</span><em>seq</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.alltrue" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <em>True</em> if all elements of <em>seq</em> evaluate to <em>True</em>. If
<em>seq</em> is empty, return <em>False</em>.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.boxplot_stats">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">boxplot_stats</code><span class="sig-paren">(</span><em>X</em>, <em>whis=1.5</em>, <em>bootstrap=None</em>, <em>labels=None</em>, <em>autorange=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.boxplot_stats" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns list of dictionaries of statistics used to draw a series
of box and whisker plots. The <code class="xref py py-obj docutils literal"><span class="pre">Returns</span></code> section enumerates the
required keys of the dictionary. Users can skip this function and
pass a user-defined set of dictionaries to the new <code class="xref py py-obj docutils literal"><span class="pre">axes.bxp</span></code> method
instead of relying on MPL to do the calculations.</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>X</strong> : array-like</p>
<blockquote>
<div><p>Data that will be represented in the boxplots. Should have 2 or
fewer dimensions.</p>
</div></blockquote>
<p><strong>whis</strong> : float, string, or sequence (default = 1.5)</p>
<blockquote>
<div><p>As a float, determines the reach of the whiskers past the first
and third quartiles (e.g., Q3 + whis*IQR, QR = interquartile
range, Q3-Q1). Beyond the whiskers, data are considered outliers
and are plotted as individual points. This can be set this to an
ascending sequence of percentile (e.g., [5, 95]) to set the
whiskers at specific percentiles of the data. Finally, <code class="xref py py-obj docutils literal"><span class="pre">whis</span></code>
can be the string <code class="docutils literal"><span class="pre">'range'</span></code> to force the whiskers to the
minimum and maximum of the data. In the edge case that the 25th
and 75th percentiles are equivalent, <code class="xref py py-obj docutils literal"><span class="pre">whis</span></code> can be automatically
set to <code class="docutils literal"><span class="pre">'range'</span></code> via the <code class="xref py py-obj docutils literal"><span class="pre">autorange</span></code> option.</p>
</div></blockquote>
<p><strong>bootstrap</strong> : int, optional</p>
<blockquote>
<div><p>Number of times the confidence intervals around the median
should be bootstrapped (percentile method).</p>
</div></blockquote>
<p><strong>labels</strong> : array-like, optional</p>
<blockquote>
<div><p>Labels for each dataset. Length must be compatible with
dimensions of <code class="xref py py-obj docutils literal"><span class="pre">X</span></code>.</p>
</div></blockquote>
<p><strong>autorange</strong> : bool, optional (False)</p>
<blockquote>
<div><p>When <code class="xref py py-obj docutils literal"><span class="pre">True</span></code> and the data are distributed such that the 25th and
75th percentiles are equal, <code class="docutils literal"><span class="pre">whis</span></code> is set to <code class="docutils literal"><span class="pre">'range'</span></code> such
that the whisker ends are at the minimum and maximum of the
data.</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>bxpstats</strong> : list of dict</p>
<blockquote class="last">
<div><p>A list of dictionaries containing the results for each column
of data. Keys of each dictionary are the following:</p>
<table border="1" class="docutils">
<colgroup>
<col width="19%" />
<col width="81%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Key</th>
<th class="head">Value Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>label</td>
<td>tick label for the boxplot</td>
</tr>
<tr class="row-odd"><td>mean</td>
<td>arithemetic mean value</td>
</tr>
<tr class="row-even"><td>med</td>
<td>50th percentile</td>
</tr>
<tr class="row-odd"><td>q1</td>
<td>first quartile (25th percentile)</td>
</tr>
<tr class="row-even"><td>q3</td>
<td>third quartile (75th percentile)</td>
</tr>
<tr class="row-odd"><td>cilo</td>
<td>lower notch around the median</td>
</tr>
<tr class="row-even"><td>cihi</td>
<td>upper notch around the median</td>
</tr>
<tr class="row-odd"><td>whislo</td>
<td>end of the lower whisker</td>
</tr>
<tr class="row-even"><td>whishi</td>
<td>end of the upper whisker</td>
</tr>
<tr class="row-odd"><td>fliers</td>
<td>outliers</td>
</tr>
</tbody>
</table>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>Non-bootstrapping approach to confidence interval uses Gaussian-
based asymptotic approximation:</p>
<img src="../_images/mathmpl/math-1742f7b9ed.png" class="center" /><p>General approach from:
McGill, R., Tukey, J.W., and Larsen, W.A. (1978) “Variations of
Boxplots”, The American Statistician, 32:12-16.</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.cbook.converter">
<em class="property">class </em><code class="descclassname">matplotlib.cbook.</code><code class="descname">converter</code><span class="sig-paren">(</span><em>missing='Null'</em>, <em>missingval=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.converter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Base class for handling string -> python type with support for
missing values</p>
<dl class="method">
<dt id="matplotlib.cbook.converter.is_missing">
<code class="descname">is_missing</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.converter.is_missing" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.dedent">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">dedent</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.dedent" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove excess indentation from docstring <em>s</em>.</p>
<p>Discards any leading blank lines, then removes up to n whitespace
characters from each line, where n is the number of leading
whitespace characters in the first line. It differs from
textwrap.dedent in its deletion of leading blank lines and its use
of the first non-blank line to determine the indentation.</p>
<p>It is also faster in most cases.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.delete_masked_points">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">delete_masked_points</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.delete_masked_points" title="Permalink to this definition">¶</a></dt>
<dd><p>Find all masked and/or non-finite points in a set of arguments,
and return the arguments with only the unmasked points remaining.</p>
<p>Arguments can be in any of 5 categories:</p>
<ol class="arabic simple">
<li>1-D masked arrays</li>
<li>1-D ndarrays</li>
<li>ndarrays with more than one dimension</li>
<li>other non-string iterables</li>
<li>anything else</li>
</ol>
<p>The first argument must be in one of the first four categories;
any argument with a length differing from that of the first
argument (and hence anything in category 5) then will be
passed through unchanged.</p>
<p>Masks are obtained from all arguments of the correct length
in categories 1, 2, and 4; a point is bad if masked in a masked
array or if it is a nan or inf. No attempt is made to
extract a mask from categories 2, 3, and 4 if <code class="xref py py-meth docutils literal"><span class="pre">np.isfinite()</span></code>
does not yield a Boolean array.</p>
<p>All input arguments that are not passed unchanged are returned
as ndarrays after removing the points or rows corresponding to
masks in any of the arguments.</p>
<p>A vastly simpler version of this function was originally
written as a helper for Axes.scatter().</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.deprecated">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">deprecated</code><span class="sig-paren">(</span><em>since</em>, <em>message=''</em>, <em>name=''</em>, <em>alternative=''</em>, <em>pending=False</em>, <em>obj_type='function'</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.deprecated" title="Permalink to this definition">¶</a></dt>
<dd><p>Decorator to mark a function as deprecated.</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>since</strong> : str</p>
<blockquote>
<div><p>The release at which this API became deprecated. This is
required.</p>
</div></blockquote>
<p><strong>message</strong> : str, optional</p>
<blockquote>
<div><p>Override the default deprecation message. The format
specifier <code class="xref py py-obj docutils literal"><span class="pre">%(func)s</span></code> may be used for the name of the function,
and <code class="xref py py-obj docutils literal"><span class="pre">%(alternative)s</span></code> may be used in the deprecation message
to insert the name of an alternative to the deprecated
function. <code class="xref py py-obj docutils literal"><span class="pre">%(obj_type)</span></code> may be used to insert a friendly name
for the type of object being deprecated.</p>
</div></blockquote>
<p><strong>name</strong> : str, optional</p>
<blockquote>
<div><p>The name of the deprecated function; if not provided the name
is automatically determined from the passed in function,
though this is useful in the case of renamed functions, where
the new function is just assigned to the name of the
deprecated function. For example:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">new_function</span><span class="p">():</span>
<span class="o">...</span>
<span class="n">oldFunction</span> <span class="o">=</span> <span class="n">new_function</span>
</pre></div>
</div>
</div></blockquote>
<p><strong>alternative</strong> : str, optional</p>
<blockquote>
<div><p>An alternative function that the user may use in place of the
deprecated function. The deprecation warning will tell the user about
this alternative if provided.</p>
</div></blockquote>
<p><strong>pending</strong> : bool, optional</p>
<blockquote class="last">
<div><p>If True, uses a PendingDeprecationWarning instead of a
DeprecationWarning.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<p>Basic example:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="nd">@deprecated</span><span class="p">(</span><span class="s1">'1.4.0'</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">the_function_to_deprecate</span><span class="p">():</span>
<span class="k">pass</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.dict_delall">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">dict_delall</code><span class="sig-paren">(</span><em>d</em>, <em>keys</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.dict_delall" title="Permalink to this definition">¶</a></dt>
<dd><p>delete all of the <em>keys</em> from the <code class="xref py py-class docutils literal"><span class="pre">dict</span></code> <em>d</em></p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.exception_to_str">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">exception_to_str</code><span class="sig-paren">(</span><em>s=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.exception_to_str" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.file_requires_unicode">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">file_requires_unicode</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.file_requires_unicode" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns <code class="xref py py-obj docutils literal"><span class="pre">True</span></code> if the given writable file-like object requires Unicode
to be written to it.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.finddir">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">finddir</code><span class="sig-paren">(</span><em>o</em>, <em>match</em>, <em>case=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.finddir" title="Permalink to this definition">¶</a></dt>
<dd><p>return all attributes of <em>o</em> which match string in match. if case
is True require an exact case match.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.flatten">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">flatten</code><span class="sig-paren">(</span><em>seq</em>, <em>scalarp=<function is_scalar_or_string></em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.flatten" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a generator of flattened nested containers</p>
<p>For example:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">matplotlib.cbook</span> <span class="k">import</span> <span class="n">flatten</span>
<span class="gp">>>> </span><span class="n">l</span> <span class="o">=</span> <span class="p">((</span><span class="s1">'John'</span><span class="p">,</span> <span class="p">[</span><span class="s1">'Hunter'</span><span class="p">]),</span> <span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">23</span><span class="p">),</span> <span class="p">[[([</span><span class="mi">42</span><span class="p">,</span> <span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mi">23</span><span class="p">)],</span> <span class="p">)]])</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">flatten</span><span class="p">(</span><span class="n">l</span><span class="p">)))</span>
<span class="go">['John', 'Hunter', 1, 23, 42, 5, 23]</span>
</pre></div>
</div>
<p>By: Composite of Holger Krekel and Luther Blissett
From: <a class="reference external" href="http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/121294">http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/121294</a>
and Recipe 1.12 in cookbook</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.get_label">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">get_label</code><span class="sig-paren">(</span><em>y</em>, <em>default_name</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.get_label" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.get_recursive_filelist">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">get_recursive_filelist</code><span class="sig-paren">(</span><em>args</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.get_recursive_filelist" title="Permalink to this definition">¶</a></dt>
<dd><p>Recurse all the files and dirs in <em>args</em> ignoring symbolic links
and return the files as a list of strings</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.get_sample_data">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">get_sample_data</code><span class="sig-paren">(</span><em>fname</em>, <em>asfileobj=True</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.get_sample_data" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a sample data file. <em>fname</em> is a path relative to the
<code class="xref py py-obj docutils literal"><span class="pre">mpl-data/sample_data</span></code> directory. If <em>asfileobj</em> is <code class="xref py py-obj docutils literal"><span class="pre">True</span></code>
return a file object, otherwise just a file path.</p>
<p>Set the rc parameter examples.directory to the directory where we should
look, if sample_data files are stored in a location different than
default (which is ‘mpl-data/sample_data` at the same level of ‘matplotlib`
Python module files).</p>
<p>If the filename ends in .gz, the file is implicitly ungzipped.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.get_split_ind">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">get_split_ind</code><span class="sig-paren">(</span><em>seq</em>, <em>N</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.get_split_ind" title="Permalink to this definition">¶</a></dt>
<dd><p><em>seq</em> is a list of words. Return the index into seq such that:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="nb">len</span><span class="p">(</span><span class="s1">' '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">seq</span><span class="p">[:</span><span class="n">ind</span><span class="p">])</span><span class="o"><=</span><span class="n">N</span>
</pre></div>
</div>
<p>.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.index_of">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">index_of</code><span class="sig-paren">(</span><em>y</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.index_of" title="Permalink to this definition">¶</a></dt>
<dd><p>A helper function to get the index of an input to plot
against if x values are not explicitly given.</p>
<p>Tries to get <code class="xref py py-obj docutils literal"><span class="pre">y.index</span></code> (works if this is a pd.Series), if that
fails, return np.arange(y.shape[0]).</p>
<p>This will be extended in the future to deal with more types of
labeled data.</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>y</strong> : scalar or array-like</p>
<blockquote>
<div><p>The proposed y-value</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>x, y</strong> : ndarray</p>
<blockquote class="last">
<div><p>The x and y values to plot.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.is_hashable">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">is_hashable</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.is_hashable" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns true if <em>obj</em> can be hashed</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.is_math_text">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">is_math_text</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.is_math_text" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.is_numlike">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">is_numlike</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.is_numlike" title="Permalink to this definition">¶</a></dt>
<dd><p>return true if <em>obj</em> looks like a number</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.is_scalar">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">is_scalar</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.is_scalar" title="Permalink to this definition">¶</a></dt>
<dd><p>return true if <em>obj</em> is not string like and is not iterable</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.is_scalar_or_string">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">is_scalar_or_string</code><span class="sig-paren">(</span><em>val</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.is_scalar_or_string" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether the given object is a scalar or string like.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.is_sequence_of_strings">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">is_sequence_of_strings</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.is_sequence_of_strings" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns true if <em>obj</em> is iterable and contains strings</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.is_string_like">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">is_string_like</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.is_string_like" title="Permalink to this definition">¶</a></dt>
<dd><p>Return True if <em>obj</em> looks like a string</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.is_writable_file_like">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">is_writable_file_like</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.is_writable_file_like" title="Permalink to this definition">¶</a></dt>
<dd><p>return true if <em>obj</em> looks like a file object with a <em>write</em> method</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.issubclass_safe">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">issubclass_safe</code><span class="sig-paren">(</span><em>x</em>, <em>klass</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.issubclass_safe" title="Permalink to this definition">¶</a></dt>
<dd><p>return issubclass(x, klass) and return False on a TypeError</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.iterable">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">iterable</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.iterable" title="Permalink to this definition">¶</a></dt>
<dd><p>return true if <em>obj</em> is iterable</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.listFiles">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">listFiles</code><span class="sig-paren">(</span><em>root</em>, <em>patterns='*'</em>, <em>recurse=1</em>, <em>return_folders=0</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.listFiles" title="Permalink to this definition">¶</a></dt>
<dd><p>Recursively list files</p>
<p>from Parmar and Martelli in the Python Cookbook</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.local_over_kwdict">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">local_over_kwdict</code><span class="sig-paren">(</span><em>local_var</em>, <em>kwargs</em>, <em>*keys</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.local_over_kwdict" title="Permalink to this definition">¶</a></dt>
<dd><p>Enforces the priority of a local variable over potentially conflicting
argument(s) from a kwargs dict. The following possible output values are
considered in order of priority:</p>
<blockquote>
<div>local_var > kwargs[keys[0]] > ... > kwargs[keys[-1]]</div></blockquote>
<p>The first of these whose value is not None will be returned. If all are
None then None will be returned. Each key in keys will be removed from the
kwargs dict in place.</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>local_var: any object</strong></p>
<blockquote>
<div><blockquote>
<div><p>The local variable (highest priority)</p>
</div></blockquote>
<dl class="docutils">
<dt>kwargs: dict</dt>
<dd><p class="first last">Dictionary of keyword arguments; modified in place</p>
</dd>
<dt>keys: str(s)</dt>
<dd><p class="first last">Name(s) of keyword arguments to process, in descending order of
priority</p>
</dd>
</dl>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">out: any object</p>
<blockquote>
<div><p>Either local_var or one of kwargs[key] for key in keys</p>
</div></blockquote>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first"><strong>IgnoredKeywordWarning</strong></p>
<blockquote class="last">
<div><p>For each key in keys that is removed from kwargs but not used as
the output value</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="matplotlib.cbook.maxdict">
<em class="property">class </em><code class="descclassname">matplotlib.cbook.</code><code class="descname">maxdict</code><span class="sig-paren">(</span><em>maxsize</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.maxdict" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">dict</span></code></p>
<p>A dictionary with a maximum size; this doesn’t override all the
relevant methods to contrain size, just setitem, so use with
caution</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.mkdirs">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">mkdirs</code><span class="sig-paren">(</span><em>newdir</em>, <em>mode=511</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.cbook.mkdirs" title="Permalink to this definition">¶</a></dt>
<dd><p>make directory <em>newdir</em> recursively, and set <em>mode</em>. Equivalent to</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">></span> <span class="n">mkdir</span> <span class="o">-</span><span class="n">p</span> <span class="n">NEWDIR</span>
<span class="o">></span> <span class="n">chmod</span> <span class="n">MODE</span> <span class="n">NEWDIR</span>
</pre></div>
</div>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.cbook.mplDeprecation">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">mplDeprecation</code><a class="headerlink" href="#matplotlib.cbook.mplDeprecation" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <a class="reference internal" href="#matplotlib.cbook.MatplotlibDeprecationWarning" title="matplotlib.cbook.MatplotlibDeprecationWarning"><code class="xref py py-class docutils literal"><span class="pre">MatplotlibDeprecationWarning</span></code></a></p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.normalize_kwargs">
You can’t perform that action at this time.