-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathtransformations.html
More file actions
3313 lines (2992 loc) · 282 KB
/
transformations.html
File metadata and controls
3313 lines (2992 loc) · 282 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.transforms — 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.tri" href="tri_api.html" />
<link rel="prev" title="matplotlib.tight_layout" href="tight_layout_api.html" />
<link rel="top" title="Matplotlib 3.3.0 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/transformations.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/transformations.html">https://matplotlib.org/stable/api/transformations.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="tri_api.html" title="matplotlib.tri"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="tight_layout_api.html" title="matplotlib.tight_layout"
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="tight_layout_api.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.tight_layout</span></code></a></li>
<li>Next: <a href="tri_api.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.tri</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/transformations.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="matplotlib-transforms">
<h1><code class="docutils literal notranslate"><span class="pre">matplotlib.transforms</span></code><a class="headerlink" href="#matplotlib-transforms" title="Permalink to this headline">¶</a></h1>
<div class="graphviz"><img src="../_images/inheritance-3bf40f082f0e9a6ed7f1dda6a95ffb4415e7d80a.png" alt="Inheritance diagram of matplotlib.transforms, matplotlib.path" usemap="#inheritancedbde0cb62f" class="inheritance graphviz" /></div>
<map id="inheritancedbde0cb62f" name="inheritancedbde0cb62f">
<area shape="rect" id="node1" href="#matplotlib.transforms.Affine2D" target="_top" title="A mutable 2D affine transformation." alt="" coords="524,2,576,18"/>
<area shape="rect" id="node2" href="#matplotlib.transforms.Affine2DBase" target="_top" title="The base class of all 2D affine transformations." alt="" coords="395,110,472,126"/>
<area shape="rect" id="node5" href="#matplotlib.transforms.AffineDeltaTransform" target="_top" title="A transform wrapper for transforming displacements between pairs of points." alt="" coords="493,29,607,45"/>
<area shape="rect" id="node9" href="#matplotlib.transforms.BboxTransform" target="_top" title="`BboxTransform` linearly transforms points from one `Bbox` to another." alt="" coords="508,56,592,72"/>
<area shape="rect" id="node10" href="#matplotlib.transforms.BboxTransformFrom" target="_top" title="`BboxTransformFrom` linearly transforms points from a given `Bbox` to the" alt="" coords="496,83,604,99"/>
<area shape="rect" id="node11" href="#matplotlib.transforms.BboxTransformTo" target="_top" title="`BboxTransformTo` is a transformation that linearly transforms points from" alt="" coords="503,110,597,126"/>
<area shape="rect" id="node13" href="#matplotlib.transforms.BlendedAffine2D" target="_top" title="A "blended" transform uses one transform for the *x*-direction, and" alt="" coords="504,137,597,153"/>
<area shape="rect" id="node15" href="#matplotlib.transforms.CompositeAffine2D" target="_top" title="A composite transform formed by applying transform *a* then transform *b*." alt="" coords="498,163,603,179"/>
<area shape="rect" id="node17" href="#matplotlib.transforms.IdentityTransform" target="_top" title="A special class that does one thing, the identity transform, in a" alt="" coords="502,190,598,206"/>
<area shape="rect" id="node20" href="#matplotlib.transforms.ScaledTranslation" target="_top" title="A transformation that translates by *xt* and *yt*, after *xt* and *yt*" alt="" coords="502,217,598,233"/>
<area shape="rect" id="node3" href="#matplotlib.transforms.AffineBase" target="_top" title="The base class of all affine transformations of any number of dimensions." alt="" coords="267,110,330,126"/>
<area shape="rect" id="node4" href="#matplotlib.transforms.Transform" target="_top" title="The base class of all `TransformNode` instances that" alt="" coords="126,163,185,179"/>
<area shape="rect" id="node14" href="#matplotlib.transforms.BlendedGenericTransform" target="_top" title="A "blended" transform uses one transform for the *x*-direction, and" alt="" coords="229,137,368,153"/>
<area shape="rect" id="node16" href="#matplotlib.transforms.CompositeGenericTransform" target="_top" title="A composite transform formed by applying transform *a* then" alt="" coords="224,163,373,179"/>
<area shape="rect" id="node21" href="#matplotlib.transforms.TransformWrapper" target="_top" title="A helper class that holds a single child transform and acts" alt="" coords="248,190,349,206"/>
<area shape="rect" id="node6" href="#matplotlib.transforms.Bbox" target="_top" title="A mutable bounding box." alt="" coords="281,217,316,233"/>
<area shape="rect" id="node7" href="#matplotlib.transforms.BboxBase" target="_top" title="The base class of all bounding boxes." alt="" coords="126,244,185,260"/>
<area shape="rect" id="node18" href="#matplotlib.transforms.LockableBbox" target="_top" title="A `Bbox` where some elements may be locked at certain values." alt="" coords="260,244,338,260"/>
<area shape="rect" id="node22" href="#matplotlib.transforms.TransformedBbox" target="_top" title="A `Bbox` that is automatically transformed by a given" alt="" coords="250,271,347,287"/>
<area shape="rect" id="node8" href="#matplotlib.transforms.TransformNode" target="_top" title="The base class for anything that participates in the transform tree" alt="" coords="2,244,87,260"/>
<area shape="rect" id="node24" href="#matplotlib.transforms.TransformedPath" target="_top" title="A `TransformedPath` caches a non-affine transformed copy of the" alt="" coords="109,284,202,300"/>
<area shape="rect" id="node12" href="#matplotlib.transforms.BboxTransformToMaxOnly" target="_top" title="`BboxTransformTo` is a transformation that linearly transforms points from" alt="" coords="629,110,766,126"/>
<area shape="rect" id="node19" href="path_api.html#matplotlib.path.Path" target="_top" title="A series of possibly disconnected, possibly closed, line and curve" alt="" coords="28,217,61,233"/>
<area shape="rect" id="node23" href="#matplotlib.transforms.TransformedPatchPath" target="_top" title="A `TransformedPatchPath` caches a non-affine transformed copy of the" alt="" coords="239,298,359,314"/>
</map><span class="target" id="module-matplotlib.transforms"></span><p>Matplotlib includes a framework for arbitrary geometric
transformations that is used determine the final position of all
elements drawn on the canvas.</p>
<p>Transforms are composed into trees of <a class="reference internal" href="#matplotlib.transforms.TransformNode" title="matplotlib.transforms.TransformNode"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TransformNode</span></code></a> objects
whose actual value depends on their children. When the contents of
children change, their parents are automatically invalidated. The
next time an invalidated transform is accessed, it is recomputed to
reflect those changes. This invalidation/caching approach prevents
unnecessary recomputations of transforms, and contributes to better
interactive performance.</p>
<p>For example, here is a graph of the transform tree used to plot data
to the graph:</p>
<img alt="../_images/transforms.png" src="../_images/transforms.png" />
<p>The framework can be used for both affine and non-affine
transformations. However, for speed, we want use the backend
renderers to perform affine transformations whenever possible.
Therefore, it is possible to perform just the affine or non-affine
part of a transformation on a set of data. The affine is always
assumed to occur after the non-affine. For any transform:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">full</span> <span class="n">transform</span> <span class="o">==</span> <span class="n">non</span><span class="o">-</span><span class="n">affine</span> <span class="n">part</span> <span class="o">+</span> <span class="n">affine</span> <span class="n">part</span>
</pre></div>
</div>
<p>The backends are not expected to handle non-affine transformations
themselves.</p>
<dl class="class">
<dt id="matplotlib.transforms.Affine2D">
<em class="property">class </em><code class="descclassname">matplotlib.transforms.</code><code class="descname">Affine2D</code><span class="sig-paren">(</span><em>matrix=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Affine2D" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.transforms.Affine2DBase" title="matplotlib.transforms.Affine2DBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.transforms.Affine2DBase</span></code></a></p>
<p>A mutable 2D affine transformation.</p>
<p>Initialize an Affine transform from a 3x3 numpy float array:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">a</span> <span class="n">c</span> <span class="n">e</span>
<span class="n">b</span> <span class="n">d</span> <span class="n">f</span>
<span class="mi">0</span> <span class="mi">0</span> <span class="mi">1</span>
</pre></div>
</div>
<p>If <em>matrix</em> is None, initialize with the identity transform.</p>
<dl class="method">
<dt id="matplotlib.transforms.Affine2D.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>self</em>, <em>matrix=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Affine2D.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize an Affine transform from a 3x3 numpy float array:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">a</span> <span class="n">c</span> <span class="n">e</span>
<span class="n">b</span> <span class="n">d</span> <span class="n">f</span>
<span class="mi">0</span> <span class="mi">0</span> <span class="mi">1</span>
</pre></div>
</div>
<p>If <em>matrix</em> is None, initialize with the identity transform.</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.transforms.Affine2D.__module__">
<code class="descname">__module__</code><em class="property"> = 'matplotlib.transforms'</em><a class="headerlink" href="#matplotlib.transforms.Affine2D.__module__" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Affine2D.__str__">
<code class="descname">__str__</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.transforms.Affine2D.__str__" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Affine2D.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/transforms.html#Affine2D.clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Affine2D.clear" title="Permalink to this definition">¶</a></dt>
<dd><p>Reset the underlying matrix to the identity transform.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Affine2D.from_values">
<em class="property">static </em><code class="descname">from_values</code><span class="sig-paren">(</span><em>a</em>, <em>b</em>, <em>c</em>, <em>d</em>, <em>e</em>, <em>f</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.from_values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Affine2D.from_values" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new Affine2D instance from the given values:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">a</span> <span class="n">c</span> <span class="n">e</span>
<span class="n">b</span> <span class="n">d</span> <span class="n">f</span>
<span class="mi">0</span> <span class="mi">0</span> <span class="mi">1</span>
</pre></div>
</div>
<p>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Affine2D.get_matrix">
<code class="descname">get_matrix</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.get_matrix"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Affine2D.get_matrix" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the underlying transformation matrix as a 3x3 numpy array:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">a</span> <span class="n">c</span> <span class="n">e</span>
<span class="n">b</span> <span class="n">d</span> <span class="n">f</span>
<span class="mi">0</span> <span class="mi">0</span> <span class="mi">1</span>
</pre></div>
</div>
<p>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Affine2D.identity">
<em class="property">static </em><code class="descname">identity</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.identity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Affine2D.identity" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a new <a class="reference internal" href="#matplotlib.transforms.Affine2D" title="matplotlib.transforms.Affine2D"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Affine2D</span></code></a> object that is the identity transform.</p>
<p>Unless this transform will be mutated later on, consider using
the faster <a class="reference internal" href="#matplotlib.transforms.IdentityTransform" title="matplotlib.transforms.IdentityTransform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IdentityTransform</span></code></a> class instead.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Affine2D.rotate">
<code class="descname">rotate</code><span class="sig-paren">(</span><em>self</em>, <em>theta</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.rotate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Affine2D.rotate" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a rotation (in radians) to this transform in place.</p>
<p>Returns <em>self</em>, so this method can easily be chained with more
calls to <a class="reference internal" href="#matplotlib.transforms.Affine2D.rotate" title="matplotlib.transforms.Affine2D.rotate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rotate()</span></code></a>, <a class="reference internal" href="#matplotlib.transforms.Affine2D.rotate_deg" title="matplotlib.transforms.Affine2D.rotate_deg"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rotate_deg()</span></code></a>, <a class="reference internal" href="#matplotlib.transforms.Affine2D.translate" title="matplotlib.transforms.Affine2D.translate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">translate()</span></code></a>
and <a class="reference internal" href="#matplotlib.transforms.Affine2D.scale" title="matplotlib.transforms.Affine2D.scale"><code class="xref py py-meth docutils literal notranslate"><span class="pre">scale()</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Affine2D.rotate_around">
<code class="descname">rotate_around</code><span class="sig-paren">(</span><em>self</em>, <em>x</em>, <em>y</em>, <em>theta</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.rotate_around"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Affine2D.rotate_around" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a rotation (in radians) around the point (x, y) in place.</p>
<p>Returns <em>self</em>, so this method can easily be chained with more
calls to <a class="reference internal" href="#matplotlib.transforms.Affine2D.rotate" title="matplotlib.transforms.Affine2D.rotate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rotate()</span></code></a>, <a class="reference internal" href="#matplotlib.transforms.Affine2D.rotate_deg" title="matplotlib.transforms.Affine2D.rotate_deg"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rotate_deg()</span></code></a>, <a class="reference internal" href="#matplotlib.transforms.Affine2D.translate" title="matplotlib.transforms.Affine2D.translate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">translate()</span></code></a>
and <a class="reference internal" href="#matplotlib.transforms.Affine2D.scale" title="matplotlib.transforms.Affine2D.scale"><code class="xref py py-meth docutils literal notranslate"><span class="pre">scale()</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Affine2D.rotate_deg">
<code class="descname">rotate_deg</code><span class="sig-paren">(</span><em>self</em>, <em>degrees</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.rotate_deg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Affine2D.rotate_deg" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a rotation (in degrees) to this transform in place.</p>
<p>Returns <em>self</em>, so this method can easily be chained with more
calls to <a class="reference internal" href="#matplotlib.transforms.Affine2D.rotate" title="matplotlib.transforms.Affine2D.rotate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rotate()</span></code></a>, <a class="reference internal" href="#matplotlib.transforms.Affine2D.rotate_deg" title="matplotlib.transforms.Affine2D.rotate_deg"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rotate_deg()</span></code></a>, <a class="reference internal" href="#matplotlib.transforms.Affine2D.translate" title="matplotlib.transforms.Affine2D.translate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">translate()</span></code></a>
and <a class="reference internal" href="#matplotlib.transforms.Affine2D.scale" title="matplotlib.transforms.Affine2D.scale"><code class="xref py py-meth docutils literal notranslate"><span class="pre">scale()</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Affine2D.rotate_deg_around">
<code class="descname">rotate_deg_around</code><span class="sig-paren">(</span><em>self</em>, <em>x</em>, <em>y</em>, <em>degrees</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.rotate_deg_around"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Affine2D.rotate_deg_around" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a rotation (in degrees) around the point (x, y) in place.</p>
<p>Returns <em>self</em>, so this method can easily be chained with more
calls to <a class="reference internal" href="#matplotlib.transforms.Affine2D.rotate" title="matplotlib.transforms.Affine2D.rotate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rotate()</span></code></a>, <a class="reference internal" href="#matplotlib.transforms.Affine2D.rotate_deg" title="matplotlib.transforms.Affine2D.rotate_deg"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rotate_deg()</span></code></a>, <a class="reference internal" href="#matplotlib.transforms.Affine2D.translate" title="matplotlib.transforms.Affine2D.translate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">translate()</span></code></a>
and <a class="reference internal" href="#matplotlib.transforms.Affine2D.scale" title="matplotlib.transforms.Affine2D.scale"><code class="xref py py-meth docutils literal notranslate"><span class="pre">scale()</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Affine2D.scale">
<code class="descname">scale</code><span class="sig-paren">(</span><em>self</em>, <em>sx</em>, <em>sy=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.scale"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Affine2D.scale" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a scale in place.</p>
<p>If <em>sy</em> is None, the same scale is applied in both the <em>x</em>- and
<em>y</em>-directions.</p>
<p>Returns <em>self</em>, so this method can easily be chained with more
calls to <a class="reference internal" href="#matplotlib.transforms.Affine2D.rotate" title="matplotlib.transforms.Affine2D.rotate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rotate()</span></code></a>, <a class="reference internal" href="#matplotlib.transforms.Affine2D.rotate_deg" title="matplotlib.transforms.Affine2D.rotate_deg"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rotate_deg()</span></code></a>, <a class="reference internal" href="#matplotlib.transforms.Affine2D.translate" title="matplotlib.transforms.Affine2D.translate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">translate()</span></code></a>
and <a class="reference internal" href="#matplotlib.transforms.Affine2D.scale" title="matplotlib.transforms.Affine2D.scale"><code class="xref py py-meth docutils literal notranslate"><span class="pre">scale()</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Affine2D.set">
<code class="descname">set</code><span class="sig-paren">(</span><em>self</em>, <em>other</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Affine2D.set" title="Permalink to this definition">¶</a></dt>
<dd><p>Set this transformation from the frozen copy of another
<a class="reference internal" href="#matplotlib.transforms.Affine2DBase" title="matplotlib.transforms.Affine2DBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Affine2DBase</span></code></a> object.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Affine2D.set_matrix">
<code class="descname">set_matrix</code><span class="sig-paren">(</span><em>self</em>, <em>mtx</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.set_matrix"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Affine2D.set_matrix" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the underlying transformation matrix from a 3x3 numpy array:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">a</span> <span class="n">c</span> <span class="n">e</span>
<span class="n">b</span> <span class="n">d</span> <span class="n">f</span>
<span class="mi">0</span> <span class="mi">0</span> <span class="mi">1</span>
</pre></div>
</div>
<p>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Affine2D.skew">
<code class="descname">skew</code><span class="sig-paren">(</span><em>self</em>, <em>xShear</em>, <em>yShear</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.skew"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Affine2D.skew" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a skew in place.</p>
<p><em>xShear</em> and <em>yShear</em> are the shear angles along the <em>x</em>- and
<em>y</em>-axes, respectively, in radians.</p>
<p>Returns <em>self</em>, so this method can easily be chained with more
calls to <a class="reference internal" href="#matplotlib.transforms.Affine2D.rotate" title="matplotlib.transforms.Affine2D.rotate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rotate()</span></code></a>, <a class="reference internal" href="#matplotlib.transforms.Affine2D.rotate_deg" title="matplotlib.transforms.Affine2D.rotate_deg"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rotate_deg()</span></code></a>, <a class="reference internal" href="#matplotlib.transforms.Affine2D.translate" title="matplotlib.transforms.Affine2D.translate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">translate()</span></code></a>
and <a class="reference internal" href="#matplotlib.transforms.Affine2D.scale" title="matplotlib.transforms.Affine2D.scale"><code class="xref py py-meth docutils literal notranslate"><span class="pre">scale()</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Affine2D.skew_deg">
<code class="descname">skew_deg</code><span class="sig-paren">(</span><em>self</em>, <em>xShear</em>, <em>yShear</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.skew_deg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Affine2D.skew_deg" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a skew in place.</p>
<p><em>xShear</em> and <em>yShear</em> are the shear angles along the <em>x</em>- and
<em>y</em>-axes, respectively, in degrees.</p>
<p>Returns <em>self</em>, so this method can easily be chained with more
calls to <a class="reference internal" href="#matplotlib.transforms.Affine2D.rotate" title="matplotlib.transforms.Affine2D.rotate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rotate()</span></code></a>, <a class="reference internal" href="#matplotlib.transforms.Affine2D.rotate_deg" title="matplotlib.transforms.Affine2D.rotate_deg"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rotate_deg()</span></code></a>, <a class="reference internal" href="#matplotlib.transforms.Affine2D.translate" title="matplotlib.transforms.Affine2D.translate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">translate()</span></code></a>
and <a class="reference internal" href="#matplotlib.transforms.Affine2D.scale" title="matplotlib.transforms.Affine2D.scale"><code class="xref py py-meth docutils literal notranslate"><span class="pre">scale()</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Affine2D.translate">
<code class="descname">translate</code><span class="sig-paren">(</span><em>self</em>, <em>tx</em>, <em>ty</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2D.translate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Affine2D.translate" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a translation in place.</p>
<p>Returns <em>self</em>, so this method can easily be chained with more
calls to <a class="reference internal" href="#matplotlib.transforms.Affine2D.rotate" title="matplotlib.transforms.Affine2D.rotate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rotate()</span></code></a>, <a class="reference internal" href="#matplotlib.transforms.Affine2D.rotate_deg" title="matplotlib.transforms.Affine2D.rotate_deg"><code class="xref py py-meth docutils literal notranslate"><span class="pre">rotate_deg()</span></code></a>, <a class="reference internal" href="#matplotlib.transforms.Affine2D.translate" title="matplotlib.transforms.Affine2D.translate"><code class="xref py py-meth docutils literal notranslate"><span class="pre">translate()</span></code></a>
and <a class="reference internal" href="#matplotlib.transforms.Affine2D.scale" title="matplotlib.transforms.Affine2D.scale"><code class="xref py py-meth docutils literal notranslate"><span class="pre">scale()</span></code></a>.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.transforms.Affine2DBase">
<em class="property">class </em><code class="descclassname">matplotlib.transforms.</code><code class="descname">Affine2DBase</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2DBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Affine2DBase" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.transforms.AffineBase" title="matplotlib.transforms.AffineBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.transforms.AffineBase</span></code></a></p>
<p>The base class of all 2D affine transformations.</p>
<p>2D affine transformations are performed using a 3x3 numpy array:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">a</span> <span class="n">c</span> <span class="n">e</span>
<span class="n">b</span> <span class="n">d</span> <span class="n">f</span>
<span class="mi">0</span> <span class="mi">0</span> <span class="mi">1</span>
</pre></div>
</div>
<p>This class provides the read-only interface. For a mutable 2D
affine transformation, use <a class="reference internal" href="#matplotlib.transforms.Affine2D" title="matplotlib.transforms.Affine2D"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Affine2D</span></code></a>.</p>
<p>Subclasses of this class will generally only need to override a
constructor and <code class="xref py py-meth docutils literal notranslate"><span class="pre">get_matrix()</span></code> that generates a custom 3x3 matrix.</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>shorthand_name</strong><span class="classifier">str</span></dt><dd><p>A string representing the "name" of the transform. The name carries
no significance other than to improve the readability of
<code class="docutils literal notranslate"><span class="pre">str(transform)</span></code> when DEBUG=True.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="matplotlib.transforms.Affine2DBase.__module__">
<code class="descname">__module__</code><em class="property"> = 'matplotlib.transforms'</em><a class="headerlink" href="#matplotlib.transforms.Affine2DBase.__module__" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Affine2DBase.frozen">
<code class="descname">frozen</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2DBase.frozen"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Affine2DBase.frozen" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a frozen copy of this transform node. The frozen copy will not
be updated when its children change. Useful for storing a previously
known state of a transform where <code class="docutils literal notranslate"><span class="pre">copy.deepcopy()</span></code> might normally be
used.</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.transforms.Affine2DBase.has_inverse">
<code class="descname">has_inverse</code><em class="property"> = True</em><a class="headerlink" href="#matplotlib.transforms.Affine2DBase.has_inverse" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.transforms.Affine2DBase.input_dims">
<code class="descname">input_dims</code><em class="property"> = 2</em><a class="headerlink" href="#matplotlib.transforms.Affine2DBase.input_dims" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Affine2DBase.inverted">
<code class="descname">inverted</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2DBase.inverted"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Affine2DBase.inverted" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the corresponding inverse transformation.</p>
<p>It holds <code class="docutils literal notranslate"><span class="pre">x</span> <span class="pre">==</span> <span class="pre">self.inverted().transform(self.transform(x))</span></code>.</p>
<p>The return value of this method should be treated as
temporary. An update to <em>self</em> does not cause a corresponding
update to its inverted copy.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Affine2DBase.is_separable">
<em class="property">property </em><code class="descname">is_separable</code><a class="headerlink" href="#matplotlib.transforms.Affine2DBase.is_separable" title="Permalink to this definition">¶</a></dt>
<dd><p>bool(x) -> bool</p>
<p>Returns True when the argument x is true, False otherwise.
The builtins True and False are the only two instances of the class bool.
The class bool is a subclass of the class int, and cannot be subclassed.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Affine2DBase.matrix_from_values">
<em class="property">static </em><code class="descname">matrix_from_values</code><span class="sig-paren">(</span><em>a</em>, <em>b</em>, <em>c</em>, <em>d</em>, <em>e</em>, <em>f</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2DBase.matrix_from_values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Affine2DBase.matrix_from_values" title="Permalink to this definition">¶</a></dt>
<dd><p>[<em>Deprecated</em>] Create a new transformation matrix as a 3x3 numpy array of the form:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">a</span> <span class="n">c</span> <span class="n">e</span>
<span class="n">b</span> <span class="n">d</span> <span class="n">f</span>
<span class="mi">0</span> <span class="mi">0</span> <span class="mi">1</span>
</pre></div>
</div>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.2.</span></p>
</div>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.transforms.Affine2DBase.output_dims">
<code class="descname">output_dims</code><em class="property"> = 2</em><a class="headerlink" href="#matplotlib.transforms.Affine2DBase.output_dims" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Affine2DBase.to_values">
<code class="descname">to_values</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2DBase.to_values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Affine2DBase.to_values" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the values of the matrix as an <code class="docutils literal notranslate"><span class="pre">(a,</span> <span class="pre">b,</span> <span class="pre">c,</span> <span class="pre">d,</span> <span class="pre">e,</span> <span class="pre">f)</span></code> tuple.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Affine2DBase.transform_affine">
<code class="descname">transform_affine</code><span class="sig-paren">(</span><em>self</em>, <em>points</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Affine2DBase.transform_affine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Affine2DBase.transform_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>Apply only the affine part of this transformation on the
given array of values.</p>
<p><code class="docutils literal notranslate"><span class="pre">transform(values)</span></code> is always equivalent to
<code class="docutils literal notranslate"><span class="pre">transform_affine(transform_non_affine(values))</span></code>.</p>
<p>In non-affine transformations, this is generally a no-op. In
affine transformations, this is equivalent to
<code class="docutils literal notranslate"><span class="pre">transform(values)</span></code>.</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>values</strong><span class="classifier">array</span></dt><dd><p>The input values as NumPy array of length <a class="reference internal" href="#matplotlib.transforms.Affine2DBase.input_dims" title="matplotlib.transforms.Affine2DBase.input_dims"><code class="xref py py-attr docutils literal notranslate"><span class="pre">input_dims</span></code></a> or
shape (N x <a class="reference internal" href="#matplotlib.transforms.Affine2DBase.input_dims" title="matplotlib.transforms.Affine2DBase.input_dims"><code class="xref py py-attr docutils literal notranslate"><span class="pre">input_dims</span></code></a>).</p>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt>array</dt><dd><p>The output values as NumPy array of length <a class="reference internal" href="#matplotlib.transforms.Affine2DBase.input_dims" title="matplotlib.transforms.Affine2DBase.input_dims"><code class="xref py py-attr docutils literal notranslate"><span class="pre">input_dims</span></code></a> or
shape (N x <a class="reference internal" href="#matplotlib.transforms.Affine2DBase.output_dims" title="matplotlib.transforms.Affine2DBase.output_dims"><code class="xref py py-attr docutils literal notranslate"><span class="pre">output_dims</span></code></a>), depending on the input.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.transforms.AffineBase">
<em class="property">class </em><code class="descclassname">matplotlib.transforms.</code><code class="descname">AffineBase</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#AffineBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.AffineBase" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.transforms.Transform</span></code></a></p>
<p>The base class of all affine transformations of any number of dimensions.</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>shorthand_name</strong><span class="classifier">str</span></dt><dd><p>A string representing the "name" of the transform. The name carries
no significance other than to improve the readability of
<code class="docutils literal notranslate"><span class="pre">str(transform)</span></code> when DEBUG=True.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="matplotlib.transforms.AffineBase.__array__">
<code class="descname">__array__</code><span class="sig-paren">(</span><em>self</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#AffineBase.__array__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.AffineBase.__array__" title="Permalink to this definition">¶</a></dt>
<dd><p>Array interface to get at this Transform's affine matrix.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.AffineBase.__eq__">
<code class="descname">__eq__</code><span class="sig-paren">(</span><em>self</em>, <em>other</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#AffineBase.__eq__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.AffineBase.__eq__" title="Permalink to this definition">¶</a></dt>
<dd><p>Return self==value.</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.transforms.AffineBase.__hash__">
<code class="descname">__hash__</code><em class="property"> = None</em><a class="headerlink" href="#matplotlib.transforms.AffineBase.__hash__" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.AffineBase.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>self</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#AffineBase.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.AffineBase.__init__" title="Permalink to this definition">¶</a></dt>
<dd><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>shorthand_name</strong><span class="classifier">str</span></dt><dd><p>A string representing the "name" of the transform. The name carries
no significance other than to improve the readability of
<code class="docutils literal notranslate"><span class="pre">str(transform)</span></code> when DEBUG=True.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.transforms.AffineBase.__module__">
<code class="descname">__module__</code><em class="property"> = 'matplotlib.transforms'</em><a class="headerlink" href="#matplotlib.transforms.AffineBase.__module__" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.AffineBase.get_affine">
<code class="descname">get_affine</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#AffineBase.get_affine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.AffineBase.get_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the affine part of this transform.</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.transforms.AffineBase.is_affine">
<code class="descname">is_affine</code><em class="property"> = True</em><a class="headerlink" href="#matplotlib.transforms.AffineBase.is_affine" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.AffineBase.transform">
<code class="descname">transform</code><span class="sig-paren">(</span><em>self</em>, <em>values</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#AffineBase.transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.AffineBase.transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Apply this transformation on the given array of <em>values</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>values</strong><span class="classifier">array</span></dt><dd><p>The input values as NumPy array of length <code class="xref py py-attr docutils literal notranslate"><span class="pre">input_dims</span></code> or
shape (N x <code class="xref py py-attr docutils literal notranslate"><span class="pre">input_dims</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 output values as NumPy array of length <code class="xref py py-attr docutils literal notranslate"><span class="pre">input_dims</span></code> or
shape (N x <code class="xref py py-attr docutils literal notranslate"><span class="pre">output_dims</span></code>), depending on the input.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.AffineBase.transform_affine">
<code class="descname">transform_affine</code><span class="sig-paren">(</span><em>self</em>, <em>values</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#AffineBase.transform_affine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.AffineBase.transform_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>Apply only the affine part of this transformation on the
given array of values.</p>
<p><code class="docutils literal notranslate"><span class="pre">transform(values)</span></code> is always equivalent to
<code class="docutils literal notranslate"><span class="pre">transform_affine(transform_non_affine(values))</span></code>.</p>
<p>In non-affine transformations, this is generally a no-op. In
affine transformations, this is equivalent to
<code class="docutils literal notranslate"><span class="pre">transform(values)</span></code>.</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>values</strong><span class="classifier">array</span></dt><dd><p>The input values as NumPy array of length <code class="xref py py-attr docutils literal notranslate"><span class="pre">input_dims</span></code> or
shape (N x <code class="xref py py-attr docutils literal notranslate"><span class="pre">input_dims</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 output values as NumPy array of length <code class="xref py py-attr docutils literal notranslate"><span class="pre">input_dims</span></code> or
shape (N x <code class="xref py py-attr docutils literal notranslate"><span class="pre">output_dims</span></code>), depending on the input.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.AffineBase.transform_non_affine">
<code class="descname">transform_non_affine</code><span class="sig-paren">(</span><em>self</em>, <em>points</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#AffineBase.transform_non_affine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.AffineBase.transform_non_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>Apply only the non-affine part of this transformation.</p>
<p><code class="docutils literal notranslate"><span class="pre">transform(values)</span></code> is always equivalent to
<code class="docutils literal notranslate"><span class="pre">transform_affine(transform_non_affine(values))</span></code>.</p>
<p>In non-affine transformations, this is generally equivalent to
<code class="docutils literal notranslate"><span class="pre">transform(values)</span></code>. In affine transformations, this is
always a no-op.</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>values</strong><span class="classifier">array</span></dt><dd><p>The input values as NumPy array of length <code class="xref py py-attr docutils literal notranslate"><span class="pre">input_dims</span></code> or
shape (N x <code class="xref py py-attr docutils literal notranslate"><span class="pre">input_dims</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 output values as NumPy array of length <code class="xref py py-attr docutils literal notranslate"><span class="pre">input_dims</span></code> or
shape (N x <code class="xref py py-attr docutils literal notranslate"><span class="pre">output_dims</span></code>), depending on the input.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.AffineBase.transform_path">
<code class="descname">transform_path</code><span class="sig-paren">(</span><em>self</em>, <em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#AffineBase.transform_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.AffineBase.transform_path" title="Permalink to this definition">¶</a></dt>
<dd><p>Apply the transform to <a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Path</span></code></a> <em>path</em>, returning a new <a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Path</span></code></a>.</p>
<p>In some cases, this transform may insert curves into the path
that began as line segments.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.AffineBase.transform_path_affine">
<code class="descname">transform_path_affine</code><span class="sig-paren">(</span><em>self</em>, <em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#AffineBase.transform_path_affine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.AffineBase.transform_path_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>Apply the affine part of this transform to <a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Path</span></code></a> <em>path</em>, returning a
new <a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Path</span></code></a>.</p>
<p><code class="docutils literal notranslate"><span class="pre">transform_path(path)</span></code> is equivalent to
<code class="docutils literal notranslate"><span class="pre">transform_path_affine(transform_path_non_affine(values))</span></code>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.AffineBase.transform_path_non_affine">
<code class="descname">transform_path_non_affine</code><span class="sig-paren">(</span><em>self</em>, <em>path</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#AffineBase.transform_path_non_affine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.AffineBase.transform_path_non_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>Apply the non-affine part of this transform to <a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Path</span></code></a> <em>path</em>,
returning a new <a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Path</span></code></a>.</p>
<p><code class="docutils literal notranslate"><span class="pre">transform_path(path)</span></code> is equivalent to
<code class="docutils literal notranslate"><span class="pre">transform_path_affine(transform_path_non_affine(values))</span></code>.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.transforms.AffineDeltaTransform">
<em class="property">class </em><code class="descclassname">matplotlib.transforms.</code><code class="descname">AffineDeltaTransform</code><span class="sig-paren">(</span><em>transform</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#AffineDeltaTransform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.AffineDeltaTransform" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.transforms.Affine2DBase" title="matplotlib.transforms.Affine2DBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.transforms.Affine2DBase</span></code></a></p>
<p>A transform wrapper for transforming displacements between pairs of points.</p>
<p>This class is intended to be used to transform displacements ("position
deltas") between pairs of points (e.g., as the <code class="docutils literal notranslate"><span class="pre">offset_transform</span></code>
of <a class="reference internal" href="collections_api.html#matplotlib.collections.Collection" title="matplotlib.collections.Collection"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Collection</span></code></a>s): given a transform <code class="docutils literal notranslate"><span class="pre">t</span></code> such that <code class="docutils literal notranslate"><span class="pre">t</span> <span class="pre">=</span>
<span class="pre">AffineDeltaTransform(t)</span> <span class="pre">+</span> <span class="pre">offset</span></code>, <code class="docutils literal notranslate"><span class="pre">AffineDeltaTransform</span></code>
satisfies <code class="docutils literal notranslate"><span class="pre">AffineDeltaTransform(a</span> <span class="pre">-</span> <span class="pre">b)</span> <span class="pre">==</span> <span class="pre">AffineDeltaTransform(a)</span> <span class="pre">-</span>
<span class="pre">AffineDeltaTransform(b)</span></code>.</p>
<p>This is implemented by forcing the offset components of the transform
matrix to zero.</p>
<p>This class is experimental as of 3.3, and the API may change.</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>shorthand_name</strong><span class="classifier">str</span></dt><dd><p>A string representing the "name" of the transform. The name carries
no significance other than to improve the readability of
<code class="docutils literal notranslate"><span class="pre">str(transform)</span></code> when DEBUG=True.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="matplotlib.transforms.AffineDeltaTransform.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>self</em>, <em>transform</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#AffineDeltaTransform.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.AffineDeltaTransform.__init__" title="Permalink to this definition">¶</a></dt>
<dd><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>shorthand_name</strong><span class="classifier">str</span></dt><dd><p>A string representing the "name" of the transform. The name carries
no significance other than to improve the readability of
<code class="docutils literal notranslate"><span class="pre">str(transform)</span></code> when DEBUG=True.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.transforms.AffineDeltaTransform.__module__">
<code class="descname">__module__</code><em class="property"> = 'matplotlib.transforms'</em><a class="headerlink" href="#matplotlib.transforms.AffineDeltaTransform.__module__" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.AffineDeltaTransform.__str__">
<code class="descname">__str__</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.transforms.AffineDeltaTransform.__str__" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.AffineDeltaTransform.get_matrix">
<code class="descname">get_matrix</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#AffineDeltaTransform.get_matrix"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.AffineDeltaTransform.get_matrix" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the matrix for the affine part of this transform.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.transforms.Bbox">
<em class="property">class </em><code class="descclassname">matplotlib.transforms.</code><code class="descname">Bbox</code><span class="sig-paren">(</span><em>points</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Bbox" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.transforms.BboxBase" title="matplotlib.transforms.BboxBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.transforms.BboxBase</span></code></a></p>
<p>A mutable bounding box.</p>
<p class="rubric">Examples</p>
<p><strong>Create from known bounds</strong></p>
<p>The default constructor takes the boundary "points" <code class="docutils literal notranslate"><span class="pre">[[xmin,</span> <span class="pre">ymin],</span>
<span class="pre">[xmax,</span> <span class="pre">ymax]]</span></code>.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">Bbox</span><span class="p">([[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="p">[</span><span class="mi">3</span><span class="p">,</span> <span class="mi">7</span><span class="p">]])</span>
<span class="go">Bbox([[1.0, 1.0], [3.0, 7.0]])</span>
</pre></div>
</div>
<p>Alternatively, a Bbox can be created from the flattened points array, the
so-called "extents" <code class="docutils literal notranslate"><span class="pre">(xmin,</span> <span class="pre">ymin,</span> <span class="pre">xmax,</span> <span class="pre">ymax)</span></code></p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">Bbox</span><span class="o">.</span><span class="n">from_extents</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">7</span><span class="p">)</span>
<span class="go">Bbox([[1.0, 1.0], [3.0, 7.0]])</span>
</pre></div>
</div>
<p>or from the "bounds" <code class="docutils literal notranslate"><span class="pre">(xmin,</span> <span class="pre">ymin,</span> <span class="pre">width,</span> <span class="pre">height)</span></code>.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">Bbox</span><span class="o">.</span><span class="n">from_bounds</span><span class="p">(</span><span class="mi">1</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="mi">6</span><span class="p">)</span>
<span class="go">Bbox([[1.0, 1.0], [3.0, 7.0]])</span>
</pre></div>
</div>
<p><strong>Create from collections of points</strong></p>
<p>The "empty" object for accumulating Bboxs is the null bbox, which is a
stand-in for the empty set.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">Bbox</span><span class="o">.</span><span class="n">null</span><span class="p">()</span>
<span class="go">Bbox([[inf, inf], [-inf, -inf]])</span>
</pre></div>
</div>
<p>Adding points to the null bbox will give you the bbox of those points.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">box</span> <span class="o">=</span> <span class="n">Bbox</span><span class="o">.</span><span class="n">null</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">box</span><span class="o">.</span><span class="n">update_from_data_xy</span><span class="p">([[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">]])</span>
<span class="gp">>>> </span><span class="n">box</span>
<span class="go">Bbox([[1.0, 1.0], [1.0, 1.0]])</span>
<span class="gp">>>> </span><span class="n">box</span><span class="o">.</span><span class="n">update_from_data_xy</span><span class="p">([[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">],</span> <span class="p">[</span><span class="mi">3</span><span class="p">,</span> <span class="mi">2</span><span class="p">]],</span> <span class="n">ignore</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">box</span>
<span class="go">Bbox([[1.0, 1.0], [3.0, 3.0]])</span>
</pre></div>
</div>
<p>Setting <code class="docutils literal notranslate"><span class="pre">ignore=True</span></code> is equivalent to starting over from a null bbox.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">box</span><span class="o">.</span><span class="n">update_from_data_xy</span><span class="p">([[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">]],</span> <span class="n">ignore</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">box</span>
<span class="go">Bbox([[1.0, 1.0], [1.0, 1.0]])</span>
</pre></div>
</div>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">It is recommended to always specify <code class="docutils literal notranslate"><span class="pre">ignore</span></code> explicitly. If not, the
default value of <code class="docutils literal notranslate"><span class="pre">ignore</span></code> can be changed at any time by code with
access to your Bbox, for example using the method <a class="reference internal" href="#matplotlib.transforms.Bbox.ignore" title="matplotlib.transforms.Bbox.ignore"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ignore</span></code></a>.</p>
</div>
<p><strong>Properties of the ``null`` bbox</strong></p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The current behavior of <a class="reference internal" href="#matplotlib.transforms.Bbox.null" title="matplotlib.transforms.Bbox.null"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Bbox.null()</span></code></a> may be surprising as it does
not have all of the properties of the "empty set", and as such does
not behave like a "zero" object in the mathematical sense. We may
change that in the future (with a deprecation period).</p>
</div>
<p>The null bbox is the identity for intersections</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">Bbox</span><span class="o">.</span><span class="n">intersection</span><span class="p">(</span><span class="n">Bbox</span><span class="p">([[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">],</span> <span class="p">[</span><span class="mi">3</span><span class="p">,</span> <span class="mi">7</span><span class="p">]]),</span> <span class="n">Bbox</span><span class="o">.</span><span class="n">null</span><span class="p">())</span>
<span class="go">Bbox([[1.0, 1.0], [3.0, 7.0]])</span>
</pre></div>
</div>
<p>except with itself, where it returns the full space.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">Bbox</span><span class="o">.</span><span class="n">intersection</span><span class="p">(</span><span class="n">Bbox</span><span class="o">.</span><span class="n">null</span><span class="p">(),</span> <span class="n">Bbox</span><span class="o">.</span><span class="n">null</span><span class="p">())</span>
<span class="go">Bbox([[-inf, -inf], [inf, inf]])</span>
</pre></div>
</div>
<p>A union containing null will always return the full space (not the other
set!)</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">Bbox</span><span class="o">.</span><span class="n">union</span><span class="p">([</span><span class="n">Bbox</span><span class="p">([[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">],</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">]]),</span> <span class="n">Bbox</span><span class="o">.</span><span class="n">null</span><span class="p">()])</span>
<span class="go">Bbox([[-inf, -inf], [inf, inf]])</span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>points</strong><span class="classifier">ndarray</span></dt><dd><p>A 2x2 numpy array of the form <code class="docutils literal notranslate"><span class="pre">[[x0,</span> <span class="pre">y0],</span> <span class="pre">[x1,</span> <span class="pre">y1]]</span></code>.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="matplotlib.transforms.Bbox.__format__">
<code class="descname">__format__</code><span class="sig-paren">(</span><em>self</em>, <em>fmt</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.__format__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Bbox.__format__" title="Permalink to this definition">¶</a></dt>
<dd><p>Default object formatter.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Bbox.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>self</em>, <em>points</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Bbox.__init__" title="Permalink to this definition">¶</a></dt>
<dd><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>points</strong><span class="classifier">ndarray</span></dt><dd><p>A 2x2 numpy array of the form <code class="docutils literal notranslate"><span class="pre">[[x0,</span> <span class="pre">y0],</span> <span class="pre">[x1,</span> <span class="pre">y1]]</span></code>.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.transforms.Bbox.__module__">
<code class="descname">__module__</code><em class="property"> = 'matplotlib.transforms'</em><a class="headerlink" href="#matplotlib.transforms.Bbox.__module__" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Bbox.__repr__">
<code class="descname">__repr__</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.__repr__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Bbox.__repr__" title="Permalink to this definition">¶</a></dt>
<dd><p>Return repr(self).</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Bbox.__str__">
<code class="descname">__str__</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.__str__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Bbox.__str__" title="Permalink to this definition">¶</a></dt>
<dd><p>Return str(self).</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Bbox.bounds">
<em class="property">property </em><code class="descname">bounds</code><a class="headerlink" href="#matplotlib.transforms.Bbox.bounds" title="Permalink to this definition">¶</a></dt>
<dd><p>Return (<a class="reference internal" href="#matplotlib.transforms.Bbox.x0" title="matplotlib.transforms.Bbox.x0"><code class="xref py py-attr docutils literal notranslate"><span class="pre">x0</span></code></a>, <a class="reference internal" href="#matplotlib.transforms.Bbox.y0" title="matplotlib.transforms.Bbox.y0"><code class="xref py py-attr docutils literal notranslate"><span class="pre">y0</span></code></a>, <code class="xref py py-attr docutils literal notranslate"><span class="pre">width</span></code>, <code class="xref py py-attr docutils literal notranslate"><span class="pre">height</span></code>).</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Bbox.from_bounds">
<em class="property">static </em><code class="descname">from_bounds</code><span class="sig-paren">(</span><em>x0</em>, <em>y0</em>, <em>width</em>, <em>height</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.from_bounds"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Bbox.from_bounds" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Bbox</span></code></a> from <em>x0</em>, <em>y0</em>, <em>width</em> and <em>height</em>.</p>
<p><em>width</em> and <em>height</em> may be negative.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Bbox.from_extents">
<em class="property">static </em><code class="descname">from_extents</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.from_extents"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Bbox.from_extents" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new Bbox from <em>left</em>, <em>bottom</em>, <em>right</em> and <em>top</em>.</p>
<p>The <em>y</em>-axis increases upwards.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Bbox.get_points">
<code class="descname">get_points</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.get_points"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Bbox.get_points" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the points of the bounding box directly as a numpy array
of the form: <code class="docutils literal notranslate"><span class="pre">[[x0,</span> <span class="pre">y0],</span> <span class="pre">[x1,</span> <span class="pre">y1]]</span></code>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Bbox.ignore">
<code class="descname">ignore</code><span class="sig-paren">(</span><em>self</em>, <em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.ignore"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Bbox.ignore" title="Permalink to this definition">¶</a></dt>
<dd><p>Set whether the existing bounds of the box should be ignored
by subsequent calls to <a class="reference internal" href="#matplotlib.transforms.Bbox.update_from_data_xy" title="matplotlib.transforms.Bbox.update_from_data_xy"><code class="xref py py-meth docutils literal notranslate"><span class="pre">update_from_data_xy()</span></code></a>.</p>
<dl class="docutils">
<dt>value<span class="classifier">bool</span></dt><dd><ul class="simple">
<li>When <code class="docutils literal notranslate"><span class="pre">True</span></code>, subsequent calls to <a class="reference internal" href="#matplotlib.transforms.Bbox.update_from_data_xy" title="matplotlib.transforms.Bbox.update_from_data_xy"><code class="xref py py-meth docutils literal notranslate"><span class="pre">update_from_data_xy()</span></code></a>
will ignore the existing bounds of the <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Bbox</span></code></a>.</li>
<li>When <code class="docutils literal notranslate"><span class="pre">False</span></code>, subsequent calls to <a class="reference internal" href="#matplotlib.transforms.Bbox.update_from_data_xy" title="matplotlib.transforms.Bbox.update_from_data_xy"><code class="xref py py-meth docutils literal notranslate"><span class="pre">update_from_data_xy()</span></code></a>
will include the existing bounds of the <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Bbox</span></code></a>.</li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Bbox.intervalx">
<em class="property">property </em><code class="descname">intervalx</code><a class="headerlink" href="#matplotlib.transforms.Bbox.intervalx" title="Permalink to this definition">¶</a></dt>
<dd><p>The pair of <em>x</em> coordinates that define the bounding box.</p>
<p>This is not guaranteed to be sorted from left to right.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Bbox.intervaly">
<em class="property">property </em><code class="descname">intervaly</code><a class="headerlink" href="#matplotlib.transforms.Bbox.intervaly" title="Permalink to this definition">¶</a></dt>
<dd><p>The pair of <em>y</em> coordinates that define the bounding box.</p>
<p>This is not guaranteed to be sorted from bottom to top.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Bbox.minpos">
<em class="property">property </em><code class="descname">minpos</code><a class="headerlink" href="#matplotlib.transforms.Bbox.minpos" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Bbox.minposx">
<em class="property">property </em><code class="descname">minposx</code><a class="headerlink" href="#matplotlib.transforms.Bbox.minposx" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Bbox.minposy">
<em class="property">property </em><code class="descname">minposy</code><a class="headerlink" href="#matplotlib.transforms.Bbox.minposy" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Bbox.mutated">
<code class="descname">mutated</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.mutated"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Bbox.mutated" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether the bbox has changed since init.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Bbox.mutatedx">
<code class="descname">mutatedx</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.mutatedx"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Bbox.mutatedx" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether the x-limits have changed since init.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Bbox.mutatedy">
<code class="descname">mutatedy</code><span class="sig-paren">(</span><em>self</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.mutatedy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Bbox.mutatedy" title="Permalink to this definition">¶</a></dt>
<dd><p>Return whether the y-limits have changed since init.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Bbox.null">
<em class="property">static </em><code class="descname">null</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.null"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Bbox.null" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new null <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Bbox</span></code></a> from (inf, inf) to (-inf, -inf).</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Bbox.p0">
<em class="property">property </em><code class="descname">p0</code><a class="headerlink" href="#matplotlib.transforms.Bbox.p0" title="Permalink to this definition">¶</a></dt>
<dd><p>The first pair of (<em>x</em>, <em>y</em>) coordinates that define the bounding box.</p>
<p>This is not guaranteed to be the bottom-left corner (for that, use
<code class="xref py py-attr docutils literal notranslate"><span class="pre">min</span></code>).</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Bbox.p1">
<em class="property">property </em><code class="descname">p1</code><a class="headerlink" href="#matplotlib.transforms.Bbox.p1" title="Permalink to this definition">¶</a></dt>
<dd><p>The second pair of (<em>x</em>, <em>y</em>) coordinates that define the bounding box.</p>
<p>This is not guaranteed to be the top-right corner (for that, use
<code class="xref py py-attr docutils literal notranslate"><span class="pre">max</span></code>).</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Bbox.set">
<code class="descname">set</code><span class="sig-paren">(</span><em>self</em>, <em>other</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Bbox.set" title="Permalink to this definition">¶</a></dt>
<dd><p>Set this bounding box from the "frozen" bounds of another <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Bbox</span></code></a>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Bbox.set_points">
<code class="descname">set_points</code><span class="sig-paren">(</span><em>self</em>, <em>points</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.set_points"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Bbox.set_points" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the points of the bounding box directly from a numpy array
of the form: <code class="docutils literal notranslate"><span class="pre">[[x0,</span> <span class="pre">y0],</span> <span class="pre">[x1,</span> <span class="pre">y1]]</span></code>. No error checking is
performed, as this method is mainly for internal use.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Bbox.unit">
<em class="property">static </em><code class="descname">unit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.unit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Bbox.unit" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new unit <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Bbox</span></code></a> from (0, 0) to (1, 1).</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.transforms.Bbox.update_from_data_xy">
<code class="descname">update_from_data_xy</code><span class="sig-paren">(</span><em>self</em>, <em>xy</em>, <em>ignore=None</em>, <em>updatex=True</em>, <em>updatey=True</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/transforms.html#Bbox.update_from_data_xy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.transforms.Bbox.update_from_data_xy" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the bounds of the <a class="reference internal" href="#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Bbox</span></code></a> based on the passed in
data. After updating, the bounds will have positive <em>width</em>
and <em>height</em>; <em>x0</em> and <em>y0</em> will be the minimal values.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />