{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathcbook_api.html
More file actions
1160 lines (1087 loc) · 88 KB
/
Copy pathcbook_api.html
File metadata and controls
1160 lines (1087 loc) · 88 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="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>matplotlib.cbook — Matplotlib 3.3.0 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css?v3.3.0-3-g8994f1b60" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-dataframe.css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/clipboard.min.js"></script>
<script type="text/javascript" src="../_static/copybutton.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.3.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="next" title="matplotlib.cm" href="cm_api.html" />
<link rel="prev" title="matplotlib.category" href="category_api.html" />
<link rel="top" title="Matplotlib 3.3.0 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/cbook_api.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head><body>
<div id="unreleased-message"> You are reading an old version of the documentation (v3.3.0). 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 id="annc-banner">
</div>
-->
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.3.0</span></div>
<img src="../_static/logo2_compressed.svg" 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>
<nav class="main-nav">
<ul>
<li><a href="../users/installing.html">Installation</a></li>
<li><a href="../contents.html">Documentation</a></li>
<li><a href="../gallery/index.html">Examples</a></li>
<li><a href="../tutorials/index.html">Tutorials</a></li>
<li><a href="../devel/index.html">Contributing</a></li>
<li class="nav-right">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" placeholder="Search"/>
</form>
</li>
</ul>
</nav>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="cm_api.html" title="matplotlib.cm"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="category_api.html" title="matplotlib.category"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../contents.html">contents</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">API Overview</a> »</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">API Overview</a><ul>
<li>Previous: <a href="category_api.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.category</span></code></a></li>
<li>Next: <a href="cm_api.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.cm</span></code></a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="sidebar-pagesource" role="note" aria-label="source link"
style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">
<a href="../_sources/api/cbook_api.rst.txt"
style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-matplotlib.cbook">
<span id="matplotlib-cbook"></span><h1><code class="docutils literal notranslate"><span class="pre">matplotlib.cbook</span></code><a class="headerlink" href="#module-matplotlib.cbook" title="Permalink to this headline">¶</a></h1>
<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.CallbackRegistry">
<em class="property">class </em><code class="descclassname">matplotlib.cbook.</code><code class="descname">CallbackRegistry</code><span class="sig-paren">(</span><em>exception_handler=<function _exception_printer></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#CallbackRegistry"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.CallbackRegistry" 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.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Handle registering and disconnecting for a set of signals and callbacks:</p>
<div class="highlight-default notranslate"><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 notranslate"><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 notranslate"><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 notranslate"><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.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>exception_handler</strong><span class="classifier">callable, optional</span></dt><dd><p>If provided must have signature</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">handler</span><span class="p">(</span><span class="n">exc</span><span class="p">:</span> <span class="ne">Exception</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
</pre></div>
</div>
<p>If not None this function will be called with any <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Exception</span></code></a>
subclass raised by the callbacks in <a class="reference internal" href="#matplotlib.cbook.CallbackRegistry.process" title="matplotlib.cbook.CallbackRegistry.process"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CallbackRegistry.process</span></code></a>.
The handler may either consume the exception or re-raise.</p>
<p>The callable must be pickle-able.</p>
<p>The default handler is</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">h</span><span class="p">(</span><span class="n">exc</span><span class="p">):</span>
<span class="n">traceback</span><span class="o">.</span><span class="n">print_exc</span><span class="p">()</span>
</pre></div>
</div>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="matplotlib.cbook.CallbackRegistry.connect">
<code class="descname">connect</code><span class="sig-paren">(</span><em>self</em>, <em>s</em>, <em>func</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#CallbackRegistry.connect"><span class="viewcode-link">[source]</span></a><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 signal <em>s</em> is generated.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.cbook.CallbackRegistry.disconnect">
<code class="descname">disconnect</code><span class="sig-paren">(</span><em>self</em>, <em>cid</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#CallbackRegistry.disconnect"><span class="viewcode-link">[source]</span></a><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>self</em>, <em>s</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#CallbackRegistry.process"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.CallbackRegistry.process" title="Permalink to this definition">¶</a></dt>
<dd><p>Process signal <em>s</em>.</p>
<p>All of the functions registered to receive callbacks on <em>s</em> will be
called with <code class="docutils literal notranslate"><span class="pre">*args</span></code> and <code class="docutils literal notranslate"><span class="pre">**kwargs</span></code>.</p>
</dd></dl>
</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="reference internal" href="../_modules/matplotlib/cbook.html#Grouper"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.Grouper" 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.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>A disjoint-set data structure.</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 notranslate"><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 notranslate"><span class="pre">joined()</span></code></a>, and all disjoint sets can be retrieved by
using the object as an iterator.</p>
<p>The objects being joined must be hashable and weak-referenceable.</p>
<p class="rubric">Examples</p>
<div class="highlight-default notranslate"><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="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><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#Grouper.clean"><span class="viewcode-link">[source]</span></a><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>self</em>, <em>a</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#Grouper.get_siblings"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.Grouper.get_siblings" title="Permalink to this definition">¶</a></dt>
<dd><p>Return 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>self</em>, <em>a</em>, <em>*args</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#Grouper.join"><span class="viewcode-link">[source]</span></a><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>self</em>, <em>a</em>, <em>b</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#Grouper.joined"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.Grouper.joined" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether <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>self</em>, <em>a</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#Grouper.remove"><span class="viewcode-link">[source]</span></a><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><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#IgnoredKeywordWarning"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.IgnoredKeywordWarning" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#UserWarning" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">UserWarning</span></code></a></p>
<p>[<em>Deprecated</em>] A class for issuing warnings about keyword arguments that will be ignored
by Matplotlib.</p>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.3.</span></p>
</div>
</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="reference internal" href="../_modules/matplotlib/cbook.html#Stack"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.Stack" 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.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Stack of elements with a movable cursor.</p>
<p>Mimics home/back/forward in a web browser.</p>
<dl class="method">
<dt id="matplotlib.cbook.Stack.back">
<code class="descname">back</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#Stack.back"><span class="viewcode-link">[source]</span></a><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>self</em>, <em>o</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#Stack.bubble"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.Stack.bubble" title="Permalink to this definition">¶</a></dt>
<dd><p>Raise all references of <em>o</em> to the top of the stack, and return it.</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">Raises:</th><td class="field-body"><dl class="first last docutils">
<dt>ValueError</dt><dd><p>If <em>o</em> is not in the stack.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.cbook.Stack.clear">
<code class="descname">clear</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#Stack.clear"><span class="viewcode-link">[source]</span></a><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><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#Stack.empty"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.Stack.empty" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether the stack is empty.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.cbook.Stack.forward">
<code class="descname">forward</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#Stack.forward"><span class="viewcode-link">[source]</span></a><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><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#Stack.home"><span class="viewcode-link">[source]</span></a><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>
<p>The first element is returned.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.cbook.Stack.push">
<code class="descname">push</code><span class="sig-paren">(</span><em>self</em>, <em>o</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#Stack.push"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.Stack.push" title="Permalink to this definition">¶</a></dt>
<dd><p>Push <em>o</em> to the stack at current position. Discard all later elements.</p>
<p><em>o</em> is returned.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.cbook.Stack.remove">
<code class="descname">remove</code><span class="sig-paren">(</span><em>self</em>, <em>o</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#Stack.remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.Stack.remove" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove <em>o</em> from the stack.</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">Raises:</th><td class="field-body"><dl class="first last docutils">
<dt>ValueError</dt><dd><p>If <em>o</em> is not in the stack.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</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="reference internal" href="../_modules/matplotlib/cbook.html#boxplot_stats"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.boxplot_stats" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of dictionaries of statistics used to draw a series of box
and whisker plots using <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.bxp.html#matplotlib.axes.Axes.bxp" title="matplotlib.axes.Axes.bxp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bxp</span></code></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>X</strong><span class="classifier">array-like</span></dt><dd><p>Data that will be represented in the boxplots. Should have 2 or
fewer dimensions.</p>
</dd>
<dt><strong>whis</strong><span class="classifier">float or (float, float), default: 1.5</span></dt><dd><p>The position of the whiskers.</p>
<p>If a float, the lower whisker is at the lowest datum above
<code class="docutils literal notranslate"><span class="pre">Q1</span> <span class="pre">-</span> <span class="pre">whis*(Q3-Q1)</span></code>, and the upper whisker at the highest datum below
<code class="docutils literal notranslate"><span class="pre">Q3</span> <span class="pre">+</span> <span class="pre">whis*(Q3-Q1)</span></code>, where Q1 and Q3 are the first and third
quartiles. The default value of <code class="docutils literal notranslate"><span class="pre">whis</span> <span class="pre">=</span> <span class="pre">1.5</span></code> corresponds to Tukey's
original definition of boxplots.</p>
<p>If a pair of floats, they indicate the percentiles at which to draw the
whiskers (e.g., (5, 95)). In particular, setting this to (0, 100)
results in whiskers covering the whole range of the data. "range" is
a deprecated synonym for (0, 100).</p>
<p>In the edge case where <code class="docutils literal notranslate"><span class="pre">Q1</span> <span class="pre">==</span> <span class="pre">Q3</span></code>, <em>whis</em> is automatically set to
(0, 100) (cover the whole range of the data) if <em>autorange</em> is True.</p>
<p>Beyond the whiskers, data are considered outliers and are plotted as
individual points.</p>
</dd>
<dt><strong>bootstrap</strong><span class="classifier">int, optional</span></dt><dd><p>Number of times the confidence intervals around the median
should be bootstrapped (percentile method).</p>
</dd>
<dt><strong>labels</strong><span class="classifier">array-like, optional</span></dt><dd><p>Labels for each dataset. Length must be compatible with
dimensions of <em>X</em>.</p>
</dd>
<dt><strong>autorange</strong><span class="classifier">bool, optional (False)</span></dt><dd><p>When <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a> and the data are distributed such that the 25th and 75th
percentiles are equal, <code class="docutils literal notranslate"><span class="pre">whis</span></code> is set to (0, 100) such that the
whisker ends are at the minimum and maximum of the data.</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt>list of dict</dt><dd><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 align-default">
<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>arithmetic 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>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>Non-bootstrapping approach to confidence interval uses Gaussian-based
asymptotic approximation:</p>
<div class="math notranslate nohighlight">
\[\mathrm{med} \pm 1.57 \times \frac{\mathrm{iqr}}{\sqrt{N}}\]</div>
<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="function">
<dt id="matplotlib.cbook.contiguous_regions">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">contiguous_regions</code><span class="sig-paren">(</span><em>mask</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#contiguous_regions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.contiguous_regions" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of (ind0, ind1) such that <code class="docutils literal notranslate"><span class="pre">mask[ind0:ind1].all()</span></code> is
True and we cover all such regions.</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="reference internal" href="../_modules/matplotlib/cbook.html#delete_masked_points"><span class="viewcode-link">[source]</span></a><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 <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.isfinite.html#numpy.isfinite" title="(in NumPy v1.19)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.isfinite</span></code></a>
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.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="reference internal" href="../_modules/matplotlib/cbook.html#file_requires_unicode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.file_requires_unicode" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether the given writable file-like object requires Unicode to be
written to it.</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 at 0x7f08c4304310></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#flatten"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.flatten" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a generator of flattened nested containers.</p>
<p>For example:</p>
<div class="highlight-default notranslate"><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="https://code.activestate.com/recipes/121294/">https://code.activestate.com/recipes/121294/</a>
and Recipe 1.12 in cookbook</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.get_realpath_and_stat">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">get_realpath_and_stat</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#get_realpath_and_stat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.get_realpath_and_stat" title="Permalink to this definition">¶</a></dt>
<dd><p>[<em>Deprecated</em>]</p>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.3: </span></p>
</div>
</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>, <em>*</em>, <em>np_load=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#get_sample_data"><span class="viewcode-link">[source]</span></a><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="file docutils literal notranslate"><span class="pre">mpl-data/sample_data</span></code> directory. If <em>asfileobj</em> is <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a>
return a file object, otherwise just a file path.</p>
<p>Sample data files are stored in the 'mpl-data/sample_data' directory within
the Matplotlib package.</p>
<p>If the filename ends in .gz, the file is implicitly ungzipped. If the
filename ends with .npy or .npz, <em>asfileobj</em> is True, and <em>np_load</em> is
True, the file is loaded with <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.load.html#numpy.load" title="(in NumPy v1.19)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.load</span></code></a>. <em>np_load</em> currently defaults
to False but will default to True in a future release.</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="reference internal" href="../_modules/matplotlib/cbook.html#index_of"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.index_of" title="Permalink to this definition">¶</a></dt>
<dd><p>A helper function to create reasonable x values for the given <em>y</em>.</p>
<p>This is used for plotting (x, y) if x values are not explicitly given.</p>
<p>First try <code class="docutils literal notranslate"><span class="pre">y.index</span></code> (assuming <em>y</em> is a <a class="reference external" href="https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.Series.html#pandas.Series" title="(in pandas v1.0.5)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pandas.Series</span></code></a>), if that
fails, use <code class="docutils literal notranslate"><span class="pre">range(len(y))</span></code>.</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"><dl class="first docutils">
<dt><strong>y</strong><span class="classifier">float or array-like</span></dt><dd></dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>x, y</strong><span class="classifier">ndarray</span></dt><dd><p>The x and y values to plot.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</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="reference internal" href="../_modules/matplotlib/cbook.html#is_math_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.is_math_text" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether the string <em>s</em> contains math expressions.</p>
<p>This is done by checking whether <em>s</em> contains an even number of
non-escaped dollar signs.</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="reference internal" href="../_modules/matplotlib/cbook.html#is_scalar_or_string"><span class="viewcode-link">[source]</span></a><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_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="reference internal" href="../_modules/matplotlib/cbook.html#is_writable_file_like"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.is_writable_file_like" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether <em>obj</em> looks like a file object with a <em>write</em> method.</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="reference internal" href="../_modules/matplotlib/cbook.html#local_over_kwdict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.local_over_kwdict" title="Permalink to this definition">¶</a></dt>
<dd><p>[<em>Deprecated</em>] 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>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">local_var</span> <span class="o">></span> <span class="n">kwargs</span><span class="p">[</span><span class="n">keys</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span> <span class="o">></span> <span class="o">...</span> <span class="o">></span> <span class="n">kwargs</span><span class="p">[</span><span class="n">keys</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]]</span>
</pre></div>
</div>
<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"><dl class="first docutils">
<dt><strong>local_var</strong><span class="classifier">any object</span></dt><dd><p>The local variable (highest priority).</p>
</dd>
<dt><strong>kwargs</strong><span class="classifier">dict</span></dt><dd><p>Dictionary of keyword arguments; modified in place.</p>
</dd>
<dt><strong>keys</strong><span class="classifier">str(s)</span></dt><dd><p>Name(s) of keyword arguments to process, in descending order of
priority.</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first docutils">
<dt>any object</dt><dd><p>Either local_var or one of kwargs[key] for key in keys.</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><dl class="first last docutils">
<dt>IgnoredKeywordWarning</dt><dd><p>For each key in keys that is removed from kwargs but not used as
the output value.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.3.</span></p>
</div>
</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="reference internal" href="../_modules/matplotlib/cbook.html#maxdict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.maxdict" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p>
<p>A dictionary with a maximum size.</p>
<p class="rubric">Notes</p>
<p>This doesn't override all the relevant methods to constrain the size,
just <code class="docutils literal notranslate"><span class="pre">__setitem__</span></code>, so use with caution.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.normalize_kwargs">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">normalize_kwargs</code><span class="sig-paren">(</span><em>kw</em>, <em>alias_mapping=None</em>, <em>required=<deprecated parameter></em>, <em>forbidden=<deprecated parameter></em>, <em>allowed=<deprecated parameter></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#normalize_kwargs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.normalize_kwargs" title="Permalink to this definition">¶</a></dt>
<dd><p>Helper function to normalize kwarg inputs.</p>
<p>The order they are resolved are:</p>
<ol class="arabic simple">
<li>aliasing</li>
<li>required</li>
<li>forbidden</li>
<li>allowed</li>
</ol>
<p>This order means that only the canonical names need appear in
<em>allowed</em>, <em>forbidden</em>, <em>required</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"><dl class="first docutils">
<dt><strong>kw</strong><span class="classifier">dict</span></dt><dd><p>A dict of keyword arguments.</p>
</dd>
<dt><strong>alias_mapping</strong><span class="classifier">dict or Artist subclass or Artist instance, optional</span></dt><dd><p>A mapping between a canonical name to a list of
aliases, in order of precedence from lowest to highest.</p>
<p>If the canonical value is not in the list it is assumed to have
the highest priority.</p>
<p>If an Artist subclass or instance is passed, use its properties alias
mapping.</p>
</dd>
<dt><strong>required</strong><span class="classifier">list of str, optional</span></dt><dd><p>A list of keys that must be in <em>kws</em>. This parameter is deprecated.</p>
</dd>
<dt><strong>forbidden</strong><span class="classifier">list of str, optional</span></dt><dd><p>A list of keys which may not be in <em>kw</em>. This parameter is deprecated.</p>
</dd>
<dt><strong>allowed</strong><span class="classifier">list of str, optional</span></dt><dd><p>A list of allowed fields. If this not None, then raise if
<em>kw</em> contains any keys not in the union of <em>required</em>
and <em>allowed</em>. To allow only the required fields pass in
an empty tuple <code class="docutils literal notranslate"><span class="pre">allowed=()</span></code>. This parameter is deprecated.</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><dl class="first last docutils">
<dt>TypeError</dt><dd><p>To match what python raises if invalid args/kwargs are passed to
a callable.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.open_file_cm">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">open_file_cm</code><span class="sig-paren">(</span><em>path_or_file</em>, <em>mode='r'</em>, <em>encoding=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#open_file_cm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.open_file_cm" title="Permalink to this definition">¶</a></dt>
<dd><p>Pass through file objects and context-manage path-likes.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.print_cycles">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">print_cycles</code><span class="sig-paren">(</span><em>objects</em>, <em>outstream=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'></em>, <em>show_progress=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#print_cycles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.print_cycles" title="Permalink to this definition">¶</a></dt>
<dd><p>Print loops of cyclic references in the given <em>objects</em>.</p>
<p>It is often useful to pass in <code class="docutils literal notranslate"><span class="pre">gc.garbage</span></code> to find the cycles that are
preventing some objects from being garbage collected.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>objects</strong></dt><dd><p>A list of objects to find cycles in.</p>
</dd>
<dt><strong>outstream</strong></dt><dd><p>The stream for output.</p>
</dd>
<dt><strong>show_progress</strong><span class="classifier">bool</span></dt><dd><p>If True, print the number of objects reached as they are found.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.pts_to_midstep">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">pts_to_midstep</code><span class="sig-paren">(</span><em>x</em>, <em>*args</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#pts_to_midstep"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.pts_to_midstep" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert continuous line to mid-steps.</p>
<p>Given a set of <code class="docutils literal notranslate"><span class="pre">N</span></code> points convert to <code class="docutils literal notranslate"><span class="pre">2N</span></code> points which when connected
linearly give a step function which changes values at the middle of the
intervals.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>x</strong><span class="classifier">array</span></dt><dd><p>The x location of the steps. May be empty.</p>
</dd>
<dt><strong>y1, ..., yp</strong><span class="classifier">array</span></dt><dd><p>y arrays to be turned into steps; all must be the same length as
<code class="docutils literal notranslate"><span class="pre">x</span></code>.</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt>array</dt><dd><p>The x and y values converted to steps in the same order as the input;
can be unpacked as <code class="docutils literal notranslate"><span class="pre">x_out,</span> <span class="pre">y1_out,</span> <span class="pre">...,</span> <span class="pre">yp_out</span></code>. If the input is
length <code class="docutils literal notranslate"><span class="pre">N</span></code>, each of these arrays will be length <code class="docutils literal notranslate"><span class="pre">2N</span></code>.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">x_s</span><span class="p">,</span> <span class="n">y1_s</span><span class="p">,</span> <span class="n">y2_s</span> <span class="o">=</span> <span class="n">pts_to_midstep</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y1</span><span class="p">,</span> <span class="n">y2</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.pts_to_poststep">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">pts_to_poststep</code><span class="sig-paren">(</span><em>x</em>, <em>*args</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#pts_to_poststep"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.pts_to_poststep" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert continuous line to post-steps.</p>
<p>Given a set of <code class="docutils literal notranslate"><span class="pre">N</span></code> points convert to <code class="docutils literal notranslate"><span class="pre">2N</span> <span class="pre">+</span> <span class="pre">1</span></code> points, which when
connected linearly give a step function which changes values at the end of
the intervals.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>x</strong><span class="classifier">array</span></dt><dd><p>The x location of the steps. May be empty.</p>
</dd>
<dt><strong>y1, ..., yp</strong><span class="classifier">array</span></dt><dd><p>y arrays to be turned into steps; all must be the same length as <code class="docutils literal notranslate"><span class="pre">x</span></code>.</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt>array</dt><dd><p>The x and y values converted to steps in the same order as the input;
can be unpacked as <code class="docutils literal notranslate"><span class="pre">x_out,</span> <span class="pre">y1_out,</span> <span class="pre">...,</span> <span class="pre">yp_out</span></code>. If the input is
length <code class="docutils literal notranslate"><span class="pre">N</span></code>, each of these arrays will be length <code class="docutils literal notranslate"><span class="pre">2N</span> <span class="pre">+</span> <span class="pre">1</span></code>. For
<code class="docutils literal notranslate"><span class="pre">N=0</span></code>, the length will be 0.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">x_s</span><span class="p">,</span> <span class="n">y1_s</span><span class="p">,</span> <span class="n">y2_s</span> <span class="o">=</span> <span class="n">pts_to_poststep</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y1</span><span class="p">,</span> <span class="n">y2</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.pts_to_prestep">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">pts_to_prestep</code><span class="sig-paren">(</span><em>x</em>, <em>*args</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#pts_to_prestep"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.pts_to_prestep" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert continuous line to pre-steps.</p>
<p>Given a set of <code class="docutils literal notranslate"><span class="pre">N</span></code> points, convert to <code class="docutils literal notranslate"><span class="pre">2N</span> <span class="pre">-</span> <span class="pre">1</span></code> points, which when
connected linearly give a step function which changes values at the
beginning of the intervals.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>x</strong><span class="classifier">array</span></dt><dd><p>The x location of the steps. May be empty.</p>
</dd>
<dt><strong>y1, ..., yp</strong><span class="classifier">array</span></dt><dd><p>y arrays to be turned into steps; all must be the same length as <code class="docutils literal notranslate"><span class="pre">x</span></code>.</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt>array</dt><dd><p>The x and y values converted to steps in the same order as the input;
can be unpacked as <code class="docutils literal notranslate"><span class="pre">x_out,</span> <span class="pre">y1_out,</span> <span class="pre">...,</span> <span class="pre">yp_out</span></code>. If the input is
length <code class="docutils literal notranslate"><span class="pre">N</span></code>, each of these arrays will be length <code class="docutils literal notranslate"><span class="pre">2N</span> <span class="pre">+</span> <span class="pre">1</span></code>. For
<code class="docutils literal notranslate"><span class="pre">N=0</span></code>, the length will be 0.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Examples</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">x_s</span><span class="p">,</span> <span class="n">y1_s</span><span class="p">,</span> <span class="n">y2_s</span> <span class="o">=</span> <span class="n">pts_to_prestep</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y1</span><span class="p">,</span> <span class="n">y2</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.report_memory">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">report_memory</code><span class="sig-paren">(</span><em>i=0</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#report_memory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.report_memory" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the memory consumed by the process.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.safe_first_element">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">safe_first_element</code><span class="sig-paren">(</span><em>obj</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#safe_first_element"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.safe_first_element" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the first element in <em>obj</em>.</p>
<p>This is an type-independent way of obtaining the first element, supporting
both index access and the iterator protocol.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.safe_masked_invalid">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">safe_masked_invalid</code><span class="sig-paren">(</span><em>x</em>, <em>copy=False</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#safe_masked_invalid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.safe_masked_invalid" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.sanitize_sequence">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">sanitize_sequence</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#sanitize_sequence"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.sanitize_sequence" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert dictview objects to list. Other inputs are returned unchanged.</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.cbook.silent_list">
<em class="property">class </em><code class="descclassname">matplotlib.cbook.</code><code class="descname">silent_list</code><span class="sig-paren">(</span><em>type</em>, <em>seq=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#silent_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.silent_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a></p>
<p>A list with a short <code class="docutils literal notranslate"><span class="pre">repr()</span></code>.</p>
<p>This is meant to be used for a homogeneous list of artists, so that they
don't cause long, meaningless output.</p>
<p>Instead of</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="o"><</span><span class="n">matplotlib</span><span class="o">.</span><span class="n">lines</span><span class="o">.</span><span class="n">Line2D</span> <span class="nb">object</span> <span class="n">at</span> <span class="mh">0x7f5749fed3c8</span><span class="o">></span><span class="p">,</span>
<span class="o"><</span><span class="n">matplotlib</span><span class="o">.</span><span class="n">lines</span><span class="o">.</span><span class="n">Line2D</span> <span class="nb">object</span> <span class="n">at</span> <span class="mh">0x7f5749fed4e0</span><span class="o">></span><span class="p">,</span>
<span class="o"><</span><span class="n">matplotlib</span><span class="o">.</span><span class="n">lines</span><span class="o">.</span><span class="n">Line2D</span> <span class="nb">object</span> <span class="n">at</span> <span class="mh">0x7f5758016550</span><span class="o">></span><span class="p">]</span>
</pre></div>
</div>
<p>one will get</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">a</span> <span class="nb">list</span> <span class="n">of</span> <span class="mi">3</span> <span class="n">Line2D</span> <span class="n">objects</span><span class="o">></span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.simple_linear_interpolation">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">simple_linear_interpolation</code><span class="sig-paren">(</span><em>a</em>, <em>steps</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#simple_linear_interpolation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.simple_linear_interpolation" title="Permalink to this definition">¶</a></dt>
<dd><p>Resample an array with <code class="docutils literal notranslate"><span class="pre">steps</span> <span class="pre">-</span> <span class="pre">1</span></code> points between original point pairs.</p>
<p>Along each column of <em>a</em>, <code class="docutils literal notranslate"><span class="pre">(steps</span> <span class="pre">-</span> <span class="pre">1)</span></code> points are introduced between
each original values; the values are linearly interpolated.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>a</strong><span class="classifier">array, shape (n, ...)</span></dt><dd></dd>
<dt><strong>steps</strong><span class="classifier">int</span></dt><dd></dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt>array</dt><dd><p>shape <code class="docutils literal notranslate"><span class="pre">((n</span> <span class="pre">-</span> <span class="pre">1)</span> <span class="pre">*</span> <span class="pre">steps</span> <span class="pre">+</span> <span class="pre">1,</span> <span class="pre">...)</span></code></p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.strip_math">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">strip_math</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#strip_math"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.strip_math" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove latex formatting from mathtext.</p>
<p>Only handles fully math and fully non-math strings.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.to_filehandle">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">to_filehandle</code><span class="sig-paren">(</span><em>fname</em>, <em>flag='r'</em>, <em>return_opened=False</em>, <em>encoding=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#to_filehandle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.to_filehandle" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert a path to an open file handle or pass-through a file-like object.</p>
<p>Consider using <a class="reference internal" href="#matplotlib.cbook.open_file_cm" title="matplotlib.cbook.open_file_cm"><code class="xref py py-obj docutils literal notranslate"><span class="pre">open_file_cm</span></code></a> instead, as it allows one to properly close
newly created file objects more easily.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>fname</strong><span class="classifier">str or path-like or file-like</span></dt><dd><p>If <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a> or <a class="reference external" href="https://docs.python.org/3/library/os.html#os.PathLike" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">os.PathLike</span></code></a>, the file is opened using the flags specified
by <em>flag</em> and <em>encoding</em>. If a file-like object, it is passed through.</p>
</dd>
<dt><strong>flag</strong><span class="classifier">str, default 'r'</span></dt><dd><p>Passed as the <em>mode</em> argument to <a class="reference external" href="https://docs.python.org/3/library/functions.html#open" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">open</span></code></a> when <em>fname</em> is <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a> or
<a class="reference external" href="https://docs.python.org/3/library/os.html#os.PathLike" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">os.PathLike</span></code></a>; ignored if <em>fname</em> is file-like.</p>
</dd>
<dt><strong>return_opened</strong><span class="classifier">bool, default False</span></dt><dd><p>If True, return both the file object and a boolean indicating whether
this was a new file (that the caller needs to close). If False, return
only the new file.</p>
</dd>
<dt><strong>encoding</strong><span class="classifier">str or None, default None</span></dt><dd><p>Passed as the <em>mode</em> argument to <a class="reference external" href="https://docs.python.org/3/library/functions.html#open" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">open</span></code></a> when <em>fname</em> is <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a> or
<a class="reference external" href="https://docs.python.org/3/library/os.html#os.PathLike" title="(in Python v3.8)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">os.PathLike</span></code></a>; ignored if <em>fname</em> is file-like.</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>fh</strong><span class="classifier">file-like</span></dt><dd></dd>
<dt><strong>opened</strong><span class="classifier">bool</span></dt><dd><p><em>opened</em> is only returned if <em>return_opened</em> is True.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="matplotlib.cbook.violin_stats">
<code class="descclassname">matplotlib.cbook.</code><code class="descname">violin_stats</code><span class="sig-paren">(</span><em>X</em>, <em>method</em>, <em>points=100</em>, <em>quantiles=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cbook.html#violin_stats"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cbook.violin_stats" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a list of dictionaries of data which can be used to draw a series
of violin plots.</p>
<p>See the <code class="docutils literal notranslate"><span class="pre">Returns</span></code> section below to view the required keys of the
dictionary.</p>
<p>Users can skip this function and pass a user-defined set of dictionaries
with the same keys to <a class="reference internal" href="_as_gen/matplotlib.axes.Axes.violinplot.html#matplotlib.axes.Axes.violinplot" title="matplotlib.axes.Axes.violinplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">violinplot</span></code></a> instead of using Matplotlib
to do the calculations. See the <em>Returns</em> section below for the keys
that must be present in the dictionaries.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">
<dt><strong>X</strong><span class="classifier">array-like</span></dt><dd><p>Sample data that will be used to produce the gaussian kernel density
estimates. Must have 2 or fewer dimensions.</p>
</dd>
<dt><strong>method</strong><span class="classifier">callable</span></dt><dd><p>The method used to calculate the kernel density estimate for each
column of data. When called via <code class="docutils literal notranslate"><span class="pre">method(v,</span> <span class="pre">coords)</span></code>, it should
return a vector of the values of the KDE evaluated at the values
specified in coords.</p>
</dd>
<dt><strong>points</strong><span class="classifier">int, default: 100</span></dt><dd><p>Defines the number of points to evaluate each of the gaussian kernel
density estimates at.</p>
</dd>
<dt><strong>quantiles</strong><span class="classifier">array-like, default: None</span></dt><dd><p>Defines (if not None) a list of floats in interval [0, 1] for each
column of data, which represents the quantiles that will be rendered
for that column of data. Must have 2 or fewer dimensions. 1D array will
be treated as a singleton list containing them.</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt>list of dict</dt><dd><p>A list of dictionaries containing the results for each column of data.
The dictionaries contain at least the following:</p>
You can’t perform that action at this time.