forked from matplotlib/matplotlib.github.com
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathadd_new_projection.html
More file actions
1172 lines (1096 loc) · 90.7 KB
/
add_new_projection.html
File metadata and controls
1172 lines (1096 loc) · 90.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Adding new scales and projections to matplotlib — Matplotlib 1.3.x documentation</title>
<link rel="stylesheet" href="../_static/mpl.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.3.x',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 1.3.x documentation"
href="../_static/opensearch.xml"/>
<link rel="top" title="Matplotlib 1.3.x documentation" href="../index.html" />
<link rel="up" title="The Matplotlib Developers’ Guide" href="index.html" />
<link rel="next" title="Toolkits" href="../mpl_toolkits/index.html" />
<link rel="prev" title="Working with transformations" href="transformations.html" />
</head>
<body>
<!-- Piwik -->
<script type="text/javascript">
if ("matplotlib.sourceforge.net" == document.location.hostname ||
"matplotlib.sf.net" == document.location.hostname) {
var pkBaseURL = (("https:" == document.location.protocol) ? "https://apps.sourceforge.net/piwik/matplotlib/" : "http://apps.sourceforge.net/piwik/matplotlib/");
document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
}
</script>
<script type="text/javascript">
if ("matplotlib.sourceforge.net" == document.location.hostname ||
"matplotlib.sf.net" == document.location.hostname) {
piwik_action_name = '';
piwik_idsite = 1;
piwik_url = pkBaseURL + "piwik.php";
piwik_log(piwik_action_name, piwik_idsite, piwik_url);
document.write(unescape('%3Cobject%3E%3Cnoscript%3E%3Cp%3E%3Cimg src="http://apps.sourceforge.net/piwik/matplotlib/piwik.php?idsite=1" alt="piwik"/%3E%3C/p%3E%3C/noscript%3E%3C/object%3E'));
}
</script>
<!-- End Piwik Tag -->
<link rel="shortcut icon" href="_static/favicon.ico">
<!-- The "Fork me on github" ribbon -->
<img style="float: right; margin-bottom: -40px; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" usemap="#ribbonmap"/>
<map name="ribbonmap">
<area shape="poly" coords="15,0,148,-1,148,135" href="https://github.com/matplotlib/matplotlib" title="Fork me on GitHub" />
</map>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="../index.html"><img src="../_static/logo2.png" border="0" alt="matplotlib"/></a>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="../mpl_toolkits/index.html" title="Toolkits"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="transformations.html" title="Working with transformations"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../examples/index.html">examples</a>| </li>
<li><a href="../gallery.html">gallery</a>| </li>
<li><a href="../api/pyplot_summary.html">pyplot</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" accesskey="U">The Matplotlib Developers’ Guide</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Adding new scales and projections to matplotlib</a><ul>
<li><a class="reference internal" href="#creating-a-new-scale">Creating a new scale</a></li>
<li><a class="reference internal" href="#creating-a-new-projection">Creating a new projection</a></li>
<li><a class="reference internal" href="#api-documentation">API documentation</a><ul>
<li><a class="reference internal" href="#module-matplotlib.scale">matplotlib.scale</a></li>
<li><a class="reference internal" href="#module-matplotlib.projections">matplotlib.projections</a><ul>
<li><a class="reference internal" href="#module-matplotlib.projections.polar">matplotlib.projections.polar</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="transformations.html"
title="previous chapter">Working with transformations</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="../mpl_toolkits/index.html"
title="next chapter">Toolkits</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/devel/add_new_projection.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="adding-new-scales-and-projections-to-matplotlib">
<span id="adding-new-scales"></span><h1>Adding new scales and projections to matplotlib<a class="headerlink" href="#adding-new-scales-and-projections-to-matplotlib" title="Permalink to this headline">¶</a></h1>
<p>Matplotlib supports the addition of custom procedures that transform
the data before it is displayed.</p>
<p>There is an important distinction between two kinds of
transformations. Separable transformations, working on a single
dimension, are called “scales”, and non-separable transformations,
that handle data in two or more dimensions at a time, are called
“projections”.</p>
<p>From the user’s perspective, the scale of a plot can be set with
<a class="reference internal" href="../api/axes_api.html#matplotlib.axes.Axes.set_xscale" title="matplotlib.axes.Axes.set_xscale"><tt class="xref py py-meth docutils literal"><span class="pre">set_xscale()</span></tt></a> and
<a class="reference internal" href="../api/axes_api.html#matplotlib.axes.Axes.set_xscale" title="matplotlib.axes.Axes.set_xscale"><tt class="xref py py-meth docutils literal"><span class="pre">set_xscale()</span></tt></a>. Projections can be chosen
using the <tt class="docutils literal"><span class="pre">projection</span></tt> keyword argument to the
<tt class="xref py py-func docutils literal"><span class="pre">plot()</span></tt> or <tt class="xref py py-func docutils literal"><span class="pre">subplot()</span></tt>
functions, e.g.:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">plot</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">projection</span><span class="o">=</span><span class="s">"custom"</span><span class="p">)</span>
</pre></div>
</div>
<p>This document is intended for developers and advanced users who need
to create new scales and projections for matplotlib. The necessary
code for scales and projections can be included anywhere: directly
within a plot script, in third-party code, or in the matplotlib source
tree itself.</p>
<div class="section" id="creating-a-new-scale">
<span id="creating-new-scale"></span><h2>Creating a new scale<a class="headerlink" href="#creating-a-new-scale" title="Permalink to this headline">¶</a></h2>
<p>Adding a new scale consists of defining a subclass of
<a class="reference internal" href="#matplotlib.scale.ScaleBase" title="matplotlib.scale.ScaleBase"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.scale.ScaleBase</span></tt></a>, that includes the following
elements:</p>
<blockquote>
<div><ul class="simple">
<li>A transformation from data coordinates into display coordinates.</li>
<li>An inverse of that transformation. This is used, for example, to
convert mouse positions from screen space back into data space.</li>
<li>A function to limit the range of the axis to acceptable values
(<tt class="docutils literal"><span class="pre">limit_range_for_scale()</span></tt>). A log scale, for instance, would
prevent the range from including values less than or equal to
zero.</li>
<li>Locators (major and minor) that determine where to place ticks in
the plot, and optionally, how to adjust the limits of the plot to
some “good” values. Unlike <tt class="docutils literal"><span class="pre">limit_range_for_scale()</span></tt>, which is
always enforced, the range setting here is only used when
automatically setting the range of the plot.</li>
<li>Formatters (major and minor) that specify how the tick labels
should be drawn.</li>
</ul>
</div></blockquote>
<p>Once the class is defined, it must be registered with matplotlib so
that the user can select it.</p>
<p>A full-fledged and heavily annotated example is in
<tt class="file docutils literal"><span class="pre">examples/api/custom_scale_example.py</span></tt>. There are also some classes
in <a class="reference internal" href="#module-matplotlib.scale" title="matplotlib.scale"><tt class="xref py py-mod docutils literal"><span class="pre">matplotlib.scale</span></tt></a> that may be used as starting points.</p>
</div>
<div class="section" id="creating-a-new-projection">
<span id="creating-new-projection"></span><h2>Creating a new projection<a class="headerlink" href="#creating-a-new-projection" title="Permalink to this headline">¶</a></h2>
<p>Adding a new projection consists of defining a projection axes which
subclasses <a class="reference internal" href="../api/axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.axes.Axes</span></tt></a> and includes the following
elements:</p>
<blockquote>
<div><ul class="simple">
<li>A transformation from data coordinates into display coordinates.</li>
<li>An inverse of that transformation. This is used, for example, to
convert mouse positions from screen space back into data space.</li>
<li>Transformations for the gridlines, ticks and ticklabels. Custom
projections will often need to place these elements in special
locations, and matplotlib has a facility to help with doing so.</li>
<li>Setting up default values (overriding
<a class="reference internal" href="../api/axes_api.html#matplotlib.axes.Axes.cla" title="matplotlib.axes.Axes.cla"><tt class="xref py py-meth docutils literal"><span class="pre">cla()</span></tt></a>), since the defaults for a
rectilinear axes may not be appropriate.</li>
<li>Defining the shape of the axes, for example, an elliptical axes,
that will be used to draw the background of the plot and for
clipping any data elements.</li>
<li>Defining custom locators and formatters for the projection. For
example, in a geographic projection, it may be more convenient to
display the grid in degrees, even if the data is in radians.</li>
<li>Set up interactive panning and zooming. This is left as an
“advanced” feature left to the reader, but there is an example of
this for polar plots in <a class="reference internal" href="#module-matplotlib.projections.polar" title="matplotlib.projections.polar"><tt class="xref py py-mod docutils literal"><span class="pre">matplotlib.projections.polar</span></tt></a>.</li>
<li>Any additional methods for additional convenience or features.</li>
</ul>
</div></blockquote>
<p>Once the projection axes is defined, it can be used in one of two ways:</p>
<blockquote>
<div><ul>
<li><p class="first">By defining the class attribute <tt class="docutils literal"><span class="pre">name</span></tt>, the projection axes can be
registered with <tt class="xref py py-func docutils literal"><span class="pre">matplotlib.projections.register_projection()</span></tt>
and subsequently simply invoked by name:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">plt</span><span class="o">.</span><span class="n">axes</span><span class="p">(</span><span class="n">projection</span><span class="o">=</span><span class="s">'my_proj_name'</span><span class="p">)</span>
</pre></div>
</div>
</li>
<li><p class="first">For more complex, parameterisable projections, a generic “projection”
object may be defined which includes the method <tt class="docutils literal"><span class="pre">_as_mpl_axes</span></tt>.
<tt class="docutils literal"><span class="pre">_as_mpl_axes</span></tt> should take no arguments and return the projection’s
axes subclass and a dictionary of additional arguments to pass to the
subclass’ <tt class="docutils literal"><span class="pre">__init__</span></tt> method. Subsequently a parameterised projection
can be initialised with:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">plt</span><span class="o">.</span><span class="n">axes</span><span class="p">(</span><span class="n">projection</span><span class="o">=</span><span class="n">MyProjection</span><span class="p">(</span><span class="n">param1</span><span class="o">=</span><span class="n">param1_value</span><span class="p">))</span>
</pre></div>
</div>
<p>where MyProjection is an object which implements a <tt class="docutils literal"><span class="pre">_as_mpl_axes</span></tt> method.</p>
</li>
</ul>
</div></blockquote>
<p>A full-fledged and heavily annotated example is in
<tt class="file docutils literal"><span class="pre">examples/api/custom_projection_example.py</span></tt>. The polar plot
functionality in <a class="reference internal" href="#module-matplotlib.projections.polar" title="matplotlib.projections.polar"><tt class="xref py py-mod docutils literal"><span class="pre">matplotlib.projections.polar</span></tt></a> may also be of
interest.</p>
</div>
<div class="section" id="api-documentation">
<h2>API documentation<a class="headerlink" href="#api-documentation" title="Permalink to this headline">¶</a></h2>
<div class="section" id="module-matplotlib.scale">
<span id="matplotlib-scale"></span><h3>matplotlib.scale<a class="headerlink" href="#module-matplotlib.scale" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="matplotlib.scale.LinearScale">
<em class="property">class </em><tt class="descclassname">matplotlib.scale.</tt><tt class="descname">LinearScale</tt><big>(</big><em>axis</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.scale.LinearScale" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.scale.ScaleBase" title="matplotlib.scale.ScaleBase"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.scale.ScaleBase</span></tt></a></p>
<p>The default linear scale.</p>
<dl class="method">
<dt id="matplotlib.scale.LinearScale.get_transform">
<tt class="descname">get_transform</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.scale.LinearScale.get_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>The transform for linear scaling is just the
<a class="reference internal" href="transformations.html#matplotlib.transforms.IdentityTransform" title="matplotlib.transforms.IdentityTransform"><tt class="xref py py-class docutils literal"><span class="pre">IdentityTransform</span></tt></a>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.scale.LinearScale.set_default_locators_and_formatters">
<tt class="descname">set_default_locators_and_formatters</tt><big>(</big><em>axis</em><big>)</big><a class="headerlink" href="#matplotlib.scale.LinearScale.set_default_locators_and_formatters" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the locators and formatters to reasonable defaults for
linear scaling.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.scale.LogScale">
<em class="property">class </em><tt class="descclassname">matplotlib.scale.</tt><tt class="descname">LogScale</tt><big>(</big><em>axis</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.scale.LogScale" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.scale.ScaleBase" title="matplotlib.scale.ScaleBase"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.scale.ScaleBase</span></tt></a></p>
<p>A standard logarithmic scale. Care is taken so non-positive
values are not plotted.</p>
<p>For computational efficiency (to push as much as possible to Numpy
C code in the common cases), this scale provides different
transforms depending on the base of the logarithm:</p>
<blockquote>
<div><ul class="simple">
<li>base 10 (<tt class="xref py py-class docutils literal"><span class="pre">Log10Transform</span></tt>)</li>
<li>base 2 (<tt class="xref py py-class docutils literal"><span class="pre">Log2Transform</span></tt>)</li>
<li>base e (<tt class="xref py py-class docutils literal"><span class="pre">NaturalLogTransform</span></tt>)</li>
<li>arbitrary base (<tt class="xref py py-class docutils literal"><span class="pre">LogTransform</span></tt>)</li>
</ul>
</div></blockquote>
<dl class="docutils">
<dt><em>basex</em>/<em>basey</em>:</dt>
<dd>The base of the logarithm</dd>
<dt><em>nonposx</em>/<em>nonposy</em>: [‘mask’ | ‘clip’ ]</dt>
<dd>non-positive values in <em>x</em> or <em>y</em> can be masked as
invalid, or clipped to a very small positive number</dd>
<dt><em>subsx</em>/<em>subsy</em>:</dt>
<dd><p class="first">Where to place the subticks between each major tick.
Should be a sequence of integers. For example, in a log10
scale: <tt class="docutils literal"><span class="pre">[2,</span> <span class="pre">3,</span> <span class="pre">4,</span> <span class="pre">5,</span> <span class="pre">6,</span> <span class="pre">7,</span> <span class="pre">8,</span> <span class="pre">9]</span></tt></p>
<p class="last">will place 8 logarithmically spaced minor ticks between
each major tick.</p>
</dd>
</dl>
<dl class="method">
<dt id="matplotlib.scale.LogScale.get_transform">
<tt class="descname">get_transform</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.scale.LogScale.get_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><tt class="xref py py-class docutils literal"><span class="pre">Transform</span></tt></a> instance
appropriate for the given logarithm base.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.scale.LogScale.limit_range_for_scale">
<tt class="descname">limit_range_for_scale</tt><big>(</big><em>vmin</em>, <em>vmax</em>, <em>minpos</em><big>)</big><a class="headerlink" href="#matplotlib.scale.LogScale.limit_range_for_scale" title="Permalink to this definition">¶</a></dt>
<dd><p>Limit the domain to positive values.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.scale.LogScale.set_default_locators_and_formatters">
<tt class="descname">set_default_locators_and_formatters</tt><big>(</big><em>axis</em><big>)</big><a class="headerlink" href="#matplotlib.scale.LogScale.set_default_locators_and_formatters" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the locators and formatters to specialized versions for
log scaling.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.scale.ScaleBase">
<em class="property">class </em><tt class="descclassname">matplotlib.scale.</tt><tt class="descname">ScaleBase</tt><a class="headerlink" href="#matplotlib.scale.ScaleBase" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
<p>The base class for all scales.</p>
<p>Scales are separable transformations, working on a single dimension.</p>
<p>Any subclasses will want to override:</p>
<blockquote>
<div><ul class="simple">
<li><tt class="xref py py-attr docutils literal"><span class="pre">name</span></tt></li>
<li><a class="reference internal" href="#matplotlib.scale.ScaleBase.get_transform" title="matplotlib.scale.ScaleBase.get_transform"><tt class="xref py py-meth docutils literal"><span class="pre">get_transform()</span></tt></a></li>
</ul>
</div></blockquote>
<dl class="docutils">
<dt>And optionally:</dt>
<dd><ul class="first last simple">
<li><a class="reference internal" href="#matplotlib.scale.ScaleBase.set_default_locators_and_formatters" title="matplotlib.scale.ScaleBase.set_default_locators_and_formatters"><tt class="xref py py-meth docutils literal"><span class="pre">set_default_locators_and_formatters()</span></tt></a></li>
<li><a class="reference internal" href="#matplotlib.scale.ScaleBase.limit_range_for_scale" title="matplotlib.scale.ScaleBase.limit_range_for_scale"><tt class="xref py py-meth docutils literal"><span class="pre">limit_range_for_scale()</span></tt></a></li>
</ul>
</dd>
</dl>
<dl class="method">
<dt id="matplotlib.scale.ScaleBase.get_transform">
<tt class="descname">get_transform</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.scale.ScaleBase.get_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><tt class="xref py py-class docutils literal"><span class="pre">Transform</span></tt></a> object
associated with this scale.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.scale.ScaleBase.limit_range_for_scale">
<tt class="descname">limit_range_for_scale</tt><big>(</big><em>vmin</em>, <em>vmax</em>, <em>minpos</em><big>)</big><a class="headerlink" href="#matplotlib.scale.ScaleBase.limit_range_for_scale" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the range <em>vmin</em>, <em>vmax</em>, possibly limited to the
domain supported by this scale.</p>
<dl class="docutils">
<dt><em>minpos</em> should be the minimum positive value in the data.</dt>
<dd>This is used by log scales to determine a minimum value.</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="matplotlib.scale.ScaleBase.set_default_locators_and_formatters">
<tt class="descname">set_default_locators_and_formatters</tt><big>(</big><em>axis</em><big>)</big><a class="headerlink" href="#matplotlib.scale.ScaleBase.set_default_locators_and_formatters" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the <a class="reference internal" href="../api/ticker_api.html#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><tt class="xref py py-class docutils literal"><span class="pre">Locator</span></tt></a> and
<a class="reference internal" href="../api/ticker_api.html#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><tt class="xref py py-class docutils literal"><span class="pre">Formatter</span></tt></a> objects on the given
axis to match this scale.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.scale.SymmetricalLogScale">
<em class="property">class </em><tt class="descclassname">matplotlib.scale.</tt><tt class="descname">SymmetricalLogScale</tt><big>(</big><em>axis</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.scale.SymmetricalLogScale" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.scale.ScaleBase" title="matplotlib.scale.ScaleBase"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.scale.ScaleBase</span></tt></a></p>
<p>The symmetrical logarithmic scale is logarithmic in both the
positive and negative directions from the origin.</p>
<p>Since the values close to zero tend toward infinity, there is a
need to have a range around zero that is linear. The parameter
<em>linthresh</em> allows the user to specify the size of this range
(-<em>linthresh</em>, <em>linthresh</em>).</p>
<dl class="docutils">
<dt><em>basex</em>/<em>basey</em>:</dt>
<dd>The base of the logarithm</dd>
<dt><em>linthreshx</em>/<em>linthreshy</em>:</dt>
<dd>The range (-<em>x</em>, <em>x</em>) within which the plot is linear (to
avoid having the plot go to infinity around zero).</dd>
<dt><em>subsx</em>/<em>subsy</em>:</dt>
<dd><p class="first">Where to place the subticks between each major tick.
Should be a sequence of integers. For example, in a log10
scale: <tt class="docutils literal"><span class="pre">[2,</span> <span class="pre">3,</span> <span class="pre">4,</span> <span class="pre">5,</span> <span class="pre">6,</span> <span class="pre">7,</span> <span class="pre">8,</span> <span class="pre">9]</span></tt></p>
<p class="last">will place 8 logarithmically spaced minor ticks between
each major tick.</p>
</dd>
<dt><em>linscalex</em>/<em>linscaley</em>:</dt>
<dd>This allows the linear range (-<em>linthresh</em> to <em>linthresh</em>)
to be stretched relative to the logarithmic range. Its
value is the number of decades to use for each half of the
linear range. For example, when <em>linscale</em> == 1.0 (the
default), the space used for the positive and negative
halves of the linear range will be equal to one decade in
the logarithmic range.</dd>
</dl>
<dl class="method">
<dt id="matplotlib.scale.SymmetricalLogScale.get_transform">
<tt class="descname">get_transform</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.scale.SymmetricalLogScale.get_transform" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a <tt class="xref py py-class docutils literal"><span class="pre">SymmetricalLogTransform</span></tt> instance.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.scale.SymmetricalLogScale.set_default_locators_and_formatters">
<tt class="descname">set_default_locators_and_formatters</tt><big>(</big><em>axis</em><big>)</big><a class="headerlink" href="#matplotlib.scale.SymmetricalLogScale.set_default_locators_and_formatters" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the locators and formatters to specialized versions for
symmetrical log scaling.</p>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="matplotlib.scale.get_scale_docs">
<tt class="descclassname">matplotlib.scale.</tt><tt class="descname">get_scale_docs</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.scale.get_scale_docs" title="Permalink to this definition">¶</a></dt>
<dd><p>Helper function for generating docstrings related to scales.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.scale.register_scale">
<tt class="descclassname">matplotlib.scale.</tt><tt class="descname">register_scale</tt><big>(</big><em>scale_class</em><big>)</big><a class="headerlink" href="#matplotlib.scale.register_scale" title="Permalink to this definition">¶</a></dt>
<dd><p>Register a new kind of scale.</p>
<p><em>scale_class</em> must be a subclass of <a class="reference internal" href="#matplotlib.scale.ScaleBase" title="matplotlib.scale.ScaleBase"><tt class="xref py py-class docutils literal"><span class="pre">ScaleBase</span></tt></a>.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.scale.scale_factory">
<tt class="descclassname">matplotlib.scale.</tt><tt class="descname">scale_factory</tt><big>(</big><em>scale</em>, <em>axis</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.scale.scale_factory" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a scale class by name.</p>
<p>ACCEPTS: [ linear | log | symlog ]</p>
</dd></dl>
</div>
<div class="section" id="module-matplotlib.projections">
<span id="matplotlib-projections"></span><h3>matplotlib.projections<a class="headerlink" href="#module-matplotlib.projections" title="Permalink to this headline">¶</a></h3>
<dl class="class">
<dt id="matplotlib.projections.ProjectionRegistry">
<em class="property">class </em><tt class="descclassname">matplotlib.projections.</tt><tt class="descname">ProjectionRegistry</tt><a class="headerlink" href="#matplotlib.projections.ProjectionRegistry" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
<p>Manages the set of projections available to the system.</p>
<dl class="method">
<dt id="matplotlib.projections.ProjectionRegistry.get_projection_class">
<tt class="descname">get_projection_class</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#matplotlib.projections.ProjectionRegistry.get_projection_class" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a projection class from its <em>name</em>.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.projections.ProjectionRegistry.get_projection_names">
<tt class="descname">get_projection_names</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.projections.ProjectionRegistry.get_projection_names" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a list of the names of all projections currently
registered.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.projections.ProjectionRegistry.register">
<tt class="descname">register</tt><big>(</big><em>*projections</em><big>)</big><a class="headerlink" href="#matplotlib.projections.ProjectionRegistry.register" title="Permalink to this definition">¶</a></dt>
<dd><p>Register a new set of projection(s).</p>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="matplotlib.projections.get_projection_class">
<tt class="descclassname">matplotlib.projections.</tt><tt class="descname">get_projection_class</tt><big>(</big><em>projection=None</em><big>)</big><a class="headerlink" href="#matplotlib.projections.get_projection_class" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a projection class from its name.</p>
<p>If <em>projection</em> is None, a standard rectilinear projection is
returned.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.projections.get_projection_names">
<tt class="descclassname">matplotlib.projections.</tt><tt class="descname">get_projection_names</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.projections.get_projection_names" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a list of acceptable projection names.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.projections.process_projection_requirements">
<tt class="descclassname">matplotlib.projections.</tt><tt class="descname">process_projection_requirements</tt><big>(</big><em>figure</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.projections.process_projection_requirements" title="Permalink to this definition">¶</a></dt>
<dd><p>Handle the args/kwargs to for add_axes/add_subplot/gca,
returning:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">(</span><span class="n">axes_proj_class</span><span class="p">,</span> <span class="n">proj_class_kwargs</span><span class="p">,</span> <span class="n">proj_stack_key</span><span class="p">)</span>
</pre></div>
</div>
<p>Which can be used for new axes initialization/identification.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last"><strong>kwargs</strong> is modified in place.</p>
</div>
</dd></dl>
<dl class="function">
<dt id="matplotlib.projections.projection_factory">
<tt class="descclassname">matplotlib.projections.</tt><tt class="descname">projection_factory</tt><big>(</big><em>projection</em>, <em>figure</em>, <em>rect</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.projections.projection_factory" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a new projection instance.</p>
<p><em>projection</em> is a projection name.</p>
<p><em>figure</em> is a figure to add the axes to.</p>
<p><em>rect</em> is a <a class="reference internal" href="transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><tt class="xref py py-class docutils literal"><span class="pre">Bbox</span></tt></a> object specifying
the location of the axes within the figure.</p>
<p>Any other kwargs are passed along to the specific projection
constructor being used.</p>
<div class="deprecated">
<p><span>Deprecated since version 1.3: </span>This routine is deprecated in favour of getting the projection
class directly with <a class="reference internal" href="#matplotlib.projections.get_projection_class" title="matplotlib.projections.get_projection_class"><tt class="xref py py-func docutils literal"><span class="pre">get_projection_class()</span></tt></a> and initialising it
directly. Will be removed in version 1.3.</p>
</div>
</dd></dl>
<div class="section" id="module-matplotlib.projections.polar">
<span id="matplotlib-projections-polar"></span><h4>matplotlib.projections.polar<a class="headerlink" href="#module-matplotlib.projections.polar" title="Permalink to this headline">¶</a></h4>
<dl class="class">
<dt id="matplotlib.projections.polar.InvertedPolarTransform">
<em class="property">class </em><tt class="descclassname">matplotlib.projections.polar.</tt><tt class="descname">InvertedPolarTransform</tt><big>(</big><em>axis=None</em>, <em>use_rmin=True</em><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.InvertedPolarTransform" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.transforms.Transform</span></tt></a></p>
<p>The inverse of the polar transform, mapping Cartesian
coordinate space <em>x</em> and <em>y</em> back to <em>theta</em> and <em>r</em>.</p>
<dl class="method">
<dt id="matplotlib.projections.polar.InvertedPolarTransform.inverted">
<tt class="descname">inverted</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.InvertedPolarTransform.inverted" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the corresponding inverse transformation.</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>
<p><tt class="docutils literal"><span class="pre">x</span> <span class="pre">===</span> <span class="pre">self.inverted().transform(self.transform(x))</span></tt></p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.projections.polar.InvertedPolarTransform.transform_non_affine">
<tt class="descname">transform_non_affine</tt><big>(</big><em>xy</em><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.InvertedPolarTransform.transform_non_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>Performs only the non-affine part of the transformation.</p>
<p><tt class="docutils literal"><span class="pre">transform(values)</span></tt> is always equivalent to
<tt class="docutils literal"><span class="pre">transform_affine(transform_non_affine(values))</span></tt>.</p>
<p>In non-affine transformations, this is generally equivalent to
<tt class="docutils literal"><span class="pre">transform(values)</span></tt>. In affine transformations, this is
always a no-op.</p>
<p>Accepts a numpy array of shape (N x <tt class="xref py py-attr docutils literal"><span class="pre">input_dims</span></tt>) and
returns a numpy array of shape (N x <tt class="xref py py-attr docutils literal"><span class="pre">output_dims</span></tt>).</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.projections.polar.PolarAffine">
<em class="property">class </em><tt class="descclassname">matplotlib.projections.polar.</tt><tt class="descname">PolarAffine</tt><big>(</big><em>scale_transform</em>, <em>limits</em><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.PolarAffine" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="transformations.html#matplotlib.transforms.Affine2DBase" title="matplotlib.transforms.Affine2DBase"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.transforms.Affine2DBase</span></tt></a></p>
<p>The affine part of the polar projection. Scales the output so
that maximum radius rests on the edge of the axes circle.</p>
<p><em>limits</em> is the view limit of the data. The only part of
its bounds that is used is ymax (for the radius maximum).
The theta range is always fixed to (0, 2pi).</p>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAffine.get_matrix">
<tt class="descname">get_matrix</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.PolarAffine.get_matrix" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the Affine transformation array for the affine part
of this transform.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.projections.polar.PolarAxes">
<em class="property">class </em><tt class="descclassname">matplotlib.projections.polar.</tt><tt class="descname">PolarAxes</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="../api/axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.axes.Axes</span></tt></a></p>
<p>A polar graph projection, where the input dimensions are <em>theta</em>, <em>r</em>.</p>
<p>Theta starts pointing east and goes anti-clockwise.</p>
<dl class="class">
<dt id="matplotlib.projections.polar.PolarAxes.InvertedPolarTransform">
<em class="property">class </em><tt class="descname">InvertedPolarTransform</tt><big>(</big><em>axis=None</em>, <em>use_rmin=True</em><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.transforms.Transform</span></tt></a></p>
<p>The inverse of the polar transform, mapping Cartesian
coordinate space <em>x</em> and <em>y</em> back to <em>theta</em> and <em>r</em>.</p>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.inverted">
<tt class="descname">inverted</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.inverted" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the corresponding inverse transformation.</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>
<p><tt class="docutils literal"><span class="pre">x</span> <span class="pre">===</span> <span class="pre">self.inverted().transform(self.transform(x))</span></tt></p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.transform_non_affine">
<tt class="descname">transform_non_affine</tt><big>(</big><em>xy</em><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.InvertedPolarTransform.transform_non_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>Performs only the non-affine part of the transformation.</p>
<p><tt class="docutils literal"><span class="pre">transform(values)</span></tt> is always equivalent to
<tt class="docutils literal"><span class="pre">transform_affine(transform_non_affine(values))</span></tt>.</p>
<p>In non-affine transformations, this is generally equivalent to
<tt class="docutils literal"><span class="pre">transform(values)</span></tt>. In affine transformations, this is
always a no-op.</p>
<p>Accepts a numpy array of shape (N x <tt class="xref py py-attr docutils literal"><span class="pre">input_dims</span></tt>) and
returns a numpy array of shape (N x <tt class="xref py py-attr docutils literal"><span class="pre">output_dims</span></tt>).</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.projections.polar.PolarAxes.PolarAffine">
<em class="property">class </em><tt class="descclassname">PolarAxes.</tt><tt class="descname">PolarAffine</tt><big>(</big><em>scale_transform</em>, <em>limits</em><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarAffine" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="transformations.html#matplotlib.transforms.Affine2DBase" title="matplotlib.transforms.Affine2DBase"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.transforms.Affine2DBase</span></tt></a></p>
<p>The affine part of the polar projection. Scales the output so
that maximum radius rests on the edge of the axes circle.</p>
<p><em>limits</em> is the view limit of the data. The only part of
its bounds that is used is ymax (for the radius maximum).
The theta range is always fixed to (0, 2pi).</p>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.PolarAffine.get_matrix">
<tt class="descname">get_matrix</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarAffine.get_matrix" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the Affine transformation array for the affine part
of this transform.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.projections.polar.PolarAxes.PolarTransform">
<em class="property">class </em><tt class="descclassname">PolarAxes.</tt><tt class="descname">PolarTransform</tt><big>(</big><em>axis=None</em>, <em>use_rmin=True</em><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarTransform" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.transforms.Transform</span></tt></a></p>
<p>The base polar transform. This handles projection <em>theta</em> and
<em>r</em> into Cartesian coordinate space <em>x</em> and <em>y</em>, but does not
perform the ultimate affine transformation into the correct
position.</p>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.PolarTransform.inverted">
<tt class="descname">inverted</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.inverted" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the corresponding inverse transformation.</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>
<p><tt class="docutils literal"><span class="pre">x</span> <span class="pre">===</span> <span class="pre">self.inverted().transform(self.transform(x))</span></tt></p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.PolarTransform.transform_non_affine">
<tt class="descname">transform_non_affine</tt><big>(</big><em>tr</em><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.transform_non_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>Performs only the non-affine part of the transformation.</p>
<p><tt class="docutils literal"><span class="pre">transform(values)</span></tt> is always equivalent to
<tt class="docutils literal"><span class="pre">transform_affine(transform_non_affine(values))</span></tt>.</p>
<p>In non-affine transformations, this is generally equivalent to
<tt class="docutils literal"><span class="pre">transform(values)</span></tt>. In affine transformations, this is
always a no-op.</p>
<p>Accepts a numpy array of shape (N x <tt class="xref py py-attr docutils literal"><span class="pre">input_dims</span></tt>) and
returns a numpy array of shape (N x <tt class="xref py py-attr docutils literal"><span class="pre">output_dims</span></tt>).</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.PolarTransform.transform_path_non_affine">
<tt class="descname">transform_path_non_affine</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.PolarTransform.transform_path_non_affine" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a path, transformed only by the non-affine
part of this transform.</p>
<p><em>path</em>: a <a class="reference internal" href="../api/path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-class docutils literal"><span class="pre">Path</span></tt></a> instance.</p>
<p><tt class="docutils literal"><span class="pre">transform_path(path)</span></tt> is equivalent to
<tt class="docutils literal"><span class="pre">transform_path_affine(transform_path_non_affine(values))</span></tt>.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.projections.polar.PolarAxes.RadialLocator">
<em class="property">class </em><tt class="descclassname">PolarAxes.</tt><tt class="descname">RadialLocator</tt><big>(</big><em>base</em><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.RadialLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="../api/ticker_api.html#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.Locator</span></tt></a></p>
<p>Used to locate radius ticks.</p>
<p>Ensures that all ticks are strictly positive. For all other
tasks, it delegates to the base
<a class="reference internal" href="../api/ticker_api.html#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><tt class="xref py py-class docutils literal"><span class="pre">Locator</span></tt></a> (which may be different
depending on the scale of the <em>r</em>-axis.</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.projections.polar.PolarAxes.ThetaFormatter">
<em class="property">class </em><tt class="descclassname">PolarAxes.</tt><tt class="descname">ThetaFormatter</tt><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.ThetaFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="../api/ticker_api.html#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.Formatter</span></tt></a></p>
<p>Used to format the <em>theta</em> tick labels. Converts the native
unit of radians into degrees and adds a degree symbol.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.can_pan">
<tt class="descclassname">PolarAxes.</tt><tt class="descname">can_pan</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.can_pan" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <em>True</em> if this axes supports the pan/zoom button functionality.</p>
<p>For polar axes, this is slightly misleading. Both panning and
zooming are performed by the same button. Panning is performed
in azimuth while zooming is done along the radial.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.can_zoom">
<tt class="descclassname">PolarAxes.</tt><tt class="descname">can_zoom</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.can_zoom" title="Permalink to this definition">¶</a></dt>
<dd><p>Return <em>True</em> if this axes supports the zoom box button functionality.</p>
<p>Polar axes do not support zoom boxes.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.format_coord">
<tt class="descclassname">PolarAxes.</tt><tt class="descname">format_coord</tt><big>(</big><em>theta</em>, <em>r</em><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.format_coord" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a format string formatting the coordinate using Unicode
characters.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.get_data_ratio">
<tt class="descclassname">PolarAxes.</tt><tt class="descname">get_data_ratio</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_data_ratio" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the aspect ratio of the data itself. For a polar plot,
this should always be 1.0</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.get_theta_direction">
<tt class="descclassname">PolarAxes.</tt><tt class="descname">get_theta_direction</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_theta_direction" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the direction in which theta increases.</p>
<dl class="docutils">
<dt>-1:</dt>
<dd>Theta increases in the clockwise direction</dd>
<dt>1:</dt>
<dd>Theta increases in the counterclockwise direction</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.get_theta_offset">
<tt class="descclassname">PolarAxes.</tt><tt class="descname">get_theta_offset</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.get_theta_offset" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the offset for the location of 0 in radians.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.set_rgrids">
<tt class="descclassname">PolarAxes.</tt><tt class="descname">set_rgrids</tt><big>(</big><em>radii</em>, <em>labels=None</em>, <em>angle=None</em>, <em>fmt=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.set_rgrids" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the radial locations and labels of the <em>r</em> grids.</p>
<p>The labels will appear at radial distances <em>radii</em> at the
given <em>angle</em> in degrees.</p>
<p><em>labels</em>, if not None, is a <tt class="docutils literal"><span class="pre">len(radii)</span></tt> list of strings of the
labels to use at each radius.</p>
<p>If <em>labels</em> is None, the built-in formatter will be used.</p>
<p>Return value is a list of tuples (<em>line</em>, <em>label</em>), where
<em>line</em> is <a class="reference internal" href="../api/artist_api.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><tt class="xref py py-class docutils literal"><span class="pre">Line2D</span></tt></a> instances and the
<em>label</em> is <a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><tt class="xref py py-class docutils literal"><span class="pre">Text</span></tt></a> instances.</p>
<p>kwargs are optional text properties for the labels:</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="25%" />
<col width="75%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_agg_filter" title="matplotlib.artist.Artist.set_agg_filter"><tt class="xref py py-meth docutils literal"><span class="pre">agg_filter</span></tt></a></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_alpha" title="matplotlib.artist.Artist.set_alpha"><tt class="xref py py-meth docutils literal"><span class="pre">alpha</span></tt></a></td>
<td>float (0.0 transparent through 1.0 opaque)</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_animated" title="matplotlib.artist.Artist.set_animated"><tt class="xref py py-meth docutils literal"><span class="pre">animated</span></tt></a></td>
<td>[True | False]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_axes" title="matplotlib.artist.Artist.set_axes"><tt class="xref py py-meth docutils literal"><span class="pre">axes</span></tt></a></td>
<td>an <a class="reference internal" href="../api/axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><tt class="xref py py-class docutils literal"><span class="pre">Axes</span></tt></a> instance</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_backgroundcolor" title="matplotlib.text.Text.set_backgroundcolor"><tt class="xref py py-meth docutils literal"><span class="pre">backgroundcolor</span></tt></a></td>
<td>any matplotlib color</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_bbox" title="matplotlib.text.Text.set_bbox"><tt class="xref py py-meth docutils literal"><span class="pre">bbox</span></tt></a></td>
<td>rectangle prop dict</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_clip_box" title="matplotlib.artist.Artist.set_clip_box"><tt class="xref py py-meth docutils literal"><span class="pre">clip_box</span></tt></a></td>
<td>a <a class="reference internal" href="transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.transforms.Bbox</span></tt></a> instance</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_clip_on" title="matplotlib.artist.Artist.set_clip_on"><tt class="xref py py-meth docutils literal"><span class="pre">clip_on</span></tt></a></td>
<td>[True | False]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_clip_path" title="matplotlib.artist.Artist.set_clip_path"><tt class="xref py py-meth docutils literal"><span class="pre">clip_path</span></tt></a></td>
<td>[ (<a class="reference internal" href="../api/path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-class docutils literal"><span class="pre">Path</span></tt></a>, <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><tt class="xref py py-class docutils literal"><span class="pre">Transform</span></tt></a>) | <a class="reference internal" href="../api/artist_api.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><tt class="xref py py-class docutils literal"><span class="pre">Patch</span></tt></a> | None ]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_color" title="matplotlib.text.Text.set_color"><tt class="xref py py-meth docutils literal"><span class="pre">color</span></tt></a></td>
<td>any matplotlib color</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_contains" title="matplotlib.artist.Artist.set_contains"><tt class="xref py py-meth docutils literal"><span class="pre">contains</span></tt></a></td>
<td>a callable function</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_family" title="matplotlib.text.Text.set_family"><tt class="xref py py-meth docutils literal"><span class="pre">family</span></tt></a> or fontfamily or fontname or name</td>
<td>[FONTNAME | ‘serif’ | ‘sans-serif’ | ‘cursive’ | ‘fantasy’ | ‘monospace’ ]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_figure" title="matplotlib.artist.Artist.set_figure"><tt class="xref py py-meth docutils literal"><span class="pre">figure</span></tt></a></td>
<td>a <a class="reference internal" href="../api/figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.figure.Figure</span></tt></a> instance</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_fontproperties" title="matplotlib.text.Text.set_fontproperties"><tt class="xref py py-meth docutils literal"><span class="pre">fontproperties</span></tt></a> or font_properties</td>
<td>a <a class="reference internal" href="../api/font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.font_manager.FontProperties</span></tt></a> instance</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_gid" title="matplotlib.artist.Artist.set_gid"><tt class="xref py py-meth docutils literal"><span class="pre">gid</span></tt></a></td>
<td>an id string</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_horizontalalignment" title="matplotlib.text.Text.set_horizontalalignment"><tt class="xref py py-meth docutils literal"><span class="pre">horizontalalignment</span></tt></a> or ha</td>
<td>[ ‘center’ | ‘right’ | ‘left’ ]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_label" title="matplotlib.artist.Artist.set_label"><tt class="xref py py-meth docutils literal"><span class="pre">label</span></tt></a></td>
<td>string or anything printable with ‘%s’ conversion.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_linespacing" title="matplotlib.text.Text.set_linespacing"><tt class="xref py py-meth docutils literal"><span class="pre">linespacing</span></tt></a></td>
<td>float (multiple of font size)</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_lod" title="matplotlib.artist.Artist.set_lod"><tt class="xref py py-meth docutils literal"><span class="pre">lod</span></tt></a></td>
<td>[True | False]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_multialignment" title="matplotlib.text.Text.set_multialignment"><tt class="xref py py-meth docutils literal"><span class="pre">multialignment</span></tt></a></td>
<td>[‘left’ | ‘right’ | ‘center’ ]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_path_effects" title="matplotlib.text.Text.set_path_effects"><tt class="xref py py-meth docutils literal"><span class="pre">path_effects</span></tt></a></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_picker" title="matplotlib.artist.Artist.set_picker"><tt class="xref py py-meth docutils literal"><span class="pre">picker</span></tt></a></td>
<td>[None|float|boolean|callable]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_position" title="matplotlib.text.Text.set_position"><tt class="xref py py-meth docutils literal"><span class="pre">position</span></tt></a></td>
<td>(x,y)</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_rasterized" title="matplotlib.artist.Artist.set_rasterized"><tt class="xref py py-meth docutils literal"><span class="pre">rasterized</span></tt></a></td>
<td>[True | False | None]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_rotation" title="matplotlib.text.Text.set_rotation"><tt class="xref py py-meth docutils literal"><span class="pre">rotation</span></tt></a></td>
<td>[ angle in degrees | ‘vertical’ | ‘horizontal’ ]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_rotation_mode" title="matplotlib.text.Text.set_rotation_mode"><tt class="xref py py-meth docutils literal"><span class="pre">rotation_mode</span></tt></a></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_size" title="matplotlib.text.Text.set_size"><tt class="xref py py-meth docutils literal"><span class="pre">size</span></tt></a> or fontsize</td>
<td>[size in points | ‘xx-small’ | ‘x-small’ | ‘small’ | ‘medium’ | ‘large’ | ‘x-large’ | ‘xx-large’ ]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_snap" title="matplotlib.artist.Artist.set_snap"><tt class="xref py py-meth docutils literal"><span class="pre">snap</span></tt></a></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_stretch" title="matplotlib.text.Text.set_stretch"><tt class="xref py py-meth docutils literal"><span class="pre">stretch</span></tt></a> or fontstretch</td>
<td>[a numeric value in range 0-1000 | ‘ultra-condensed’ | ‘extra-condensed’ | ‘condensed’ | ‘semi-condensed’ | ‘normal’ | ‘semi-expanded’ | ‘expanded’ | ‘extra-expanded’ | ‘ultra-expanded’ ]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_style" title="matplotlib.text.Text.set_style"><tt class="xref py py-meth docutils literal"><span class="pre">style</span></tt></a> or fontstyle</td>
<td>[ ‘normal’ | ‘italic’ | ‘oblique’]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_text" title="matplotlib.text.Text.set_text"><tt class="xref py py-meth docutils literal"><span class="pre">text</span></tt></a></td>
<td>string or anything printable with ‘%s’ conversion.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_transform" title="matplotlib.artist.Artist.set_transform"><tt class="xref py py-meth docutils literal"><span class="pre">transform</span></tt></a></td>
<td><a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><tt class="xref py py-class docutils literal"><span class="pre">Transform</span></tt></a> instance</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_url" title="matplotlib.artist.Artist.set_url"><tt class="xref py py-meth docutils literal"><span class="pre">url</span></tt></a></td>
<td>a url string</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_variant" title="matplotlib.text.Text.set_variant"><tt class="xref py py-meth docutils literal"><span class="pre">variant</span></tt></a> or fontvariant</td>
<td>[ ‘normal’ | ‘small-caps’ ]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_verticalalignment" title="matplotlib.text.Text.set_verticalalignment"><tt class="xref py py-meth docutils literal"><span class="pre">verticalalignment</span></tt></a> or va or ma</td>
<td>[ ‘center’ | ‘top’ | ‘bottom’ | ‘baseline’ ]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_visible" title="matplotlib.artist.Artist.set_visible"><tt class="xref py py-meth docutils literal"><span class="pre">visible</span></tt></a></td>
<td>[True | False]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_weight" title="matplotlib.text.Text.set_weight"><tt class="xref py py-meth docutils literal"><span class="pre">weight</span></tt></a> or fontweight</td>
<td>[a numeric value in range 0-1000 | ‘ultralight’ | ‘light’ | ‘normal’ | ‘regular’ | ‘book’ | ‘medium’ | ‘roman’ | ‘semibold’ | ‘demibold’ | ‘demi’ | ‘bold’ | ‘heavy’ | ‘extra bold’ | ‘black’ ]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_x" title="matplotlib.text.Text.set_x"><tt class="xref py py-meth docutils literal"><span class="pre">x</span></tt></a></td>
<td>float</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_y" title="matplotlib.text.Text.set_y"><tt class="xref py py-meth docutils literal"><span class="pre">y</span></tt></a></td>
<td>float</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_zorder" title="matplotlib.artist.Artist.set_zorder"><tt class="xref py py-meth docutils literal"><span class="pre">zorder</span></tt></a></td>
<td>any number</td>
</tr>
</tbody>
</table>
</div></blockquote>
<p>ACCEPTS: sequence of floats</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.set_theta_direction">
<tt class="descclassname">PolarAxes.</tt><tt class="descname">set_theta_direction</tt><big>(</big><em>direction</em><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.set_theta_direction" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the direction in which theta increases.</p>
<dl class="docutils">
<dt>clockwise, -1:</dt>
<dd>Theta increases in the clockwise direction</dd>
<dt>counterclockwise, anticlockwise, 1:</dt>
<dd>Theta increases in the counterclockwise direction</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.set_theta_offset">
<tt class="descclassname">PolarAxes.</tt><tt class="descname">set_theta_offset</tt><big>(</big><em>offset</em><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.set_theta_offset" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the offset for the location of 0 in radians.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.set_theta_zero_location">
<tt class="descclassname">PolarAxes.</tt><tt class="descname">set_theta_zero_location</tt><big>(</big><em>loc</em><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.set_theta_zero_location" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the location of theta’s zero. (Calls set_theta_offset
with the correct value in radians under the hood.)</p>
<p>May be one of “N”, “NW”, “W”, “SW”, “S”, “SE”, “E”, or “NE”.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.projections.polar.PolarAxes.set_thetagrids">
<tt class="descclassname">PolarAxes.</tt><tt class="descname">set_thetagrids</tt><big>(</big><em>angles</em>, <em>labels=None</em>, <em>frac=None</em>, <em>fmt=None</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.projections.polar.PolarAxes.set_thetagrids" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the angles at which to place the theta grids (these
gridlines are equal along the theta dimension). <em>angles</em> is in
degrees.</p>
<p><em>labels</em>, if not None, is a <tt class="docutils literal"><span class="pre">len(angles)</span></tt> list of strings of
the labels to use at each angle.</p>
<p>If <em>labels</em> is None, the labels will be <tt class="docutils literal"><span class="pre">fmt</span> <span class="pre">%</span> <span class="pre">angle</span></tt></p>
<p><em>frac</em> is the fraction of the polar axes radius at which to
place the label (1 is the edge). e.g., 1.05 is outside the axes
and 0.95 is inside the axes.</p>
<p>Return value is a list of tuples (<em>line</em>, <em>label</em>), where
<em>line</em> is <a class="reference internal" href="../api/artist_api.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><tt class="xref py py-class docutils literal"><span class="pre">Line2D</span></tt></a> instances and the
<em>label</em> is <a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><tt class="xref py py-class docutils literal"><span class="pre">Text</span></tt></a> instances.</p>
<p>kwargs are optional text properties for the labels:</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="25%" />
<col width="75%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_agg_filter" title="matplotlib.artist.Artist.set_agg_filter"><tt class="xref py py-meth docutils literal"><span class="pre">agg_filter</span></tt></a></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_alpha" title="matplotlib.artist.Artist.set_alpha"><tt class="xref py py-meth docutils literal"><span class="pre">alpha</span></tt></a></td>
<td>float (0.0 transparent through 1.0 opaque)</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_animated" title="matplotlib.artist.Artist.set_animated"><tt class="xref py py-meth docutils literal"><span class="pre">animated</span></tt></a></td>
<td>[True | False]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_axes" title="matplotlib.artist.Artist.set_axes"><tt class="xref py py-meth docutils literal"><span class="pre">axes</span></tt></a></td>
<td>an <a class="reference internal" href="../api/axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><tt class="xref py py-class docutils literal"><span class="pre">Axes</span></tt></a> instance</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_backgroundcolor" title="matplotlib.text.Text.set_backgroundcolor"><tt class="xref py py-meth docutils literal"><span class="pre">backgroundcolor</span></tt></a></td>
<td>any matplotlib color</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_bbox" title="matplotlib.text.Text.set_bbox"><tt class="xref py py-meth docutils literal"><span class="pre">bbox</span></tt></a></td>
<td>rectangle prop dict</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_clip_box" title="matplotlib.artist.Artist.set_clip_box"><tt class="xref py py-meth docutils literal"><span class="pre">clip_box</span></tt></a></td>
<td>a <a class="reference internal" href="transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.transforms.Bbox</span></tt></a> instance</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_clip_on" title="matplotlib.artist.Artist.set_clip_on"><tt class="xref py py-meth docutils literal"><span class="pre">clip_on</span></tt></a></td>
<td>[True | False]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_clip_path" title="matplotlib.artist.Artist.set_clip_path"><tt class="xref py py-meth docutils literal"><span class="pre">clip_path</span></tt></a></td>
<td>[ (<a class="reference internal" href="../api/path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><tt class="xref py py-class docutils literal"><span class="pre">Path</span></tt></a>, <a class="reference internal" href="transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><tt class="xref py py-class docutils literal"><span class="pre">Transform</span></tt></a>) | <a class="reference internal" href="../api/artist_api.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><tt class="xref py py-class docutils literal"><span class="pre">Patch</span></tt></a> | None ]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_color" title="matplotlib.text.Text.set_color"><tt class="xref py py-meth docutils literal"><span class="pre">color</span></tt></a></td>
<td>any matplotlib color</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_contains" title="matplotlib.artist.Artist.set_contains"><tt class="xref py py-meth docutils literal"><span class="pre">contains</span></tt></a></td>
<td>a callable function</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_family" title="matplotlib.text.Text.set_family"><tt class="xref py py-meth docutils literal"><span class="pre">family</span></tt></a> or fontfamily or fontname or name</td>
<td>[FONTNAME | ‘serif’ | ‘sans-serif’ | ‘cursive’ | ‘fantasy’ | ‘monospace’ ]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_figure" title="matplotlib.artist.Artist.set_figure"><tt class="xref py py-meth docutils literal"><span class="pre">figure</span></tt></a></td>
<td>a <a class="reference internal" href="../api/figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.figure.Figure</span></tt></a> instance</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_fontproperties" title="matplotlib.text.Text.set_fontproperties"><tt class="xref py py-meth docutils literal"><span class="pre">fontproperties</span></tt></a> or font_properties</td>
<td>a <a class="reference internal" href="../api/font_manager_api.html#matplotlib.font_manager.FontProperties" title="matplotlib.font_manager.FontProperties"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.font_manager.FontProperties</span></tt></a> instance</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_gid" title="matplotlib.artist.Artist.set_gid"><tt class="xref py py-meth docutils literal"><span class="pre">gid</span></tt></a></td>
<td>an id string</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_horizontalalignment" title="matplotlib.text.Text.set_horizontalalignment"><tt class="xref py py-meth docutils literal"><span class="pre">horizontalalignment</span></tt></a> or ha</td>
<td>[ ‘center’ | ‘right’ | ‘left’ ]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_label" title="matplotlib.artist.Artist.set_label"><tt class="xref py py-meth docutils literal"><span class="pre">label</span></tt></a></td>
<td>string or anything printable with ‘%s’ conversion.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_linespacing" title="matplotlib.text.Text.set_linespacing"><tt class="xref py py-meth docutils literal"><span class="pre">linespacing</span></tt></a></td>
<td>float (multiple of font size)</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.artist.Artist.set_lod" title="matplotlib.artist.Artist.set_lod"><tt class="xref py py-meth docutils literal"><span class="pre">lod</span></tt></a></td>
<td>[True | False]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="../api/artist_api.html#matplotlib.text.Text.set_multialignment" title="matplotlib.text.Text.set_multialignment"><tt class="xref py py-meth docutils literal"><span class="pre">multialignment</span></tt></a></td>
<td>[‘left’ | ‘right’ | ‘center’ ]</td>
</tr>