-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathaxisartist.html
More file actions
988 lines (918 loc) · 60.6 KB
/
axisartist.html
File metadata and controls
988 lines (918 loc) · 60.6 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
<!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>Overview of axisartist toolkit — Matplotlib 2.0.2.post4416.dev0+g1df513f documentation</title>
<link rel="stylesheet" href="../../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../../_static/gallery.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '2.0.2.post4416.dev0+g1df513f',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 2.0.2.post4416.dev0+g1df513f documentation"
href="../../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
<link rel="index" title="Index" href="../../genindex.html"
/>
<link rel="search" title="Search" href="../../search.html"
/>
<link rel="top" title="Matplotlib 2.0.2.post4416.dev0+g1df513f documentation" href="../../index.html" />
</head>
<body>
<!-- The "Fork me on github" ribbon -->
<img style="float: right; margin-bottom: -40px; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" usemap="#ribbonmap"/>
<map name="ribbonmap">
<area shape="poly" coords="15,0,148,-1,148,135" href="https://github.com/matplotlib/matplotlib" title="Fork me on GitHub" />
</map>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="../../index.html"><img src="../../_static/logo2.svg" width="540px" border="0" alt="matplotlib"/></a>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../index.html">home</a>| </li>
<li><a href="../../gallery/index.html">examples</a>| </li>
<li><a href="../index.html">tutorials</a>| </li>
<li><a href="../../api/pyplot_summary.html">pyplot</a>| </li>
<li><a href="../../contents.html">docs</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper"><a href="https://www.numfocus.org">
<image src="https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A">
</a>
<br/>
<a href="http://depsy.org/package/python/matplotlib">
<img src="../../_static/depsy_badge.svg">
</a>
<br/>
Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">
<img src="https://travis-ci.org/matplotlib/matplotlib.svg?branch=master"/>
</a>
<br/>
<h3><a href="../../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Overview of axisartist toolkit</a><ul>
<li><a class="reference internal" href="#axisartist">axisartist</a><ul>
<li><a class="reference internal" href="#axisartist-with-parasiteaxes">axisartist with ParasiteAxes</a></li>
<li><a class="reference internal" href="#curvilinear-grid">Curvilinear Grid</a></li>
<li><a class="reference internal" href="#floating-axes">Floating Axes</a></li>
</ul>
</li>
<li><a class="reference internal" href="#axisartist-namespace">axisartist namespace</a></li>
<li><a class="reference internal" href="#id1">AxisArtist</a><ul>
<li><a class="reference internal" href="#line">line</a></li>
<li><a class="reference internal" href="#major-ticks-minor-ticks">major_ticks, minor_ticks</a></li>
<li><a class="reference internal" href="#major-ticklabels-minor-ticklabels">major_ticklabels, minor_ticklabels</a></li>
<li><a class="reference internal" href="#axislabel">axislabel</a></li>
</ul>
</li>
<li><a class="reference internal" href="#default-axisartists">Default AxisArtists</a></li>
<li><a class="reference internal" href="#howto">HowTo</a></li>
<li><a class="reference internal" href="#rotation-and-alignment-of-ticklabels">Rotation and Alignment of TickLabels</a><ul>
<li><a class="reference internal" href="#adjusting-ticklabels-alignment">Adjusting ticklabels alignment</a></li>
<li><a class="reference internal" href="#adjusting-pad">Adjusting pad</a></li>
</ul>
</li>
<li><a class="reference internal" href="#gridhelper">GridHelper</a></li>
<li><a class="reference internal" href="#floatingaxis">FloatingAxis</a></li>
<li><a class="reference internal" href="#current-limitations-and-todo-s">Current Limitations and TODO’s</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../contents.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/tutorials/toolkits/axisartist.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="overview-of-axisartist-toolkit">
<span id="sphx-glr-tutorials-toolkits-axisartist-py"></span><h1>Overview of axisartist toolkit<a class="headerlink" href="#overview-of-axisartist-toolkit" title="Permalink to this headline">¶</a></h1>
<p>The axisartist toolkit tutorial.</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last"><em>axisartist</em> uses a custom Axes class
(derived from the mpl’s original Axes class).
As a side effect, some commands (mostly tick-related) do not work.</p>
</div>
<p>The <em>axisartist</em> contains a custom Axes class that is meant to support
curvilinear grids (e.g., the world coordinate system in astronomy).
Unlike mpl’s original Axes class which uses Axes.xaxis and Axes.yaxis
to draw ticks, ticklines, etc., axisartist uses a special
artist (AxisArtist) that can handle ticks, ticklines, etc. for
curved coordinate systems.</p>
<div class="figure align-center" id="id2">
<a class="reference external image-reference" href="../../gallery/axisartist/demo_floating_axis.html"><img alt="../../_images/sphx_glr_demo_floating_axis_0011.png" src="../../_images/sphx_glr_demo_floating_axis_0011.png" style="width: 250.0px; height: 250.0px;" /></a>
<p class="caption"><span class="caption-text">Demo Floating Axis</span></p>
</div>
<p>Since it uses special artists, some Matplotlib commands that work on
Axes.xaxis and Axes.yaxis may not work.</p>
<div class="section" id="axisartist">
<span id="axisartist-users-guide-index"></span><h2>axisartist<a class="headerlink" href="#axisartist" title="Permalink to this headline">¶</a></h2>
<p>The <em>axisartist</em> module provides a custom (and very experimental) Axes
class, where each axis (left, right, top, and bottom) have a separate
associated artist which is responsible for drawing the axis-line, ticks,
ticklabels, and labels. You can also create your own axis, which can pass
through a fixed position in the axes coordinate, or a fixed position
in the data coordinate (i.e., the axis floats around when viewlimit
changes).</p>
<p>The axes class, by default, has its xaxis and yaxis invisible, and
has 4 additional artists which are responsible for drawing the 4 axis spines in
“left”, “right”, “bottom”, and “top”. They are accessed as
ax.axis[“left”], ax.axis[“right”], and so on, i.e., ax.axis is a
dictionary that contains artists (note that ax.axis is still a
callable method and it behaves as an original Axes.axis method in
Matplotlib).</p>
<p>To create an axes,</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">mpl_toolkits.axisartist</span> <span class="k">as</span> <span class="nn">AA</span>
<span class="n">fig</span> <span class="o">=</span> <span class="n">plt</span><span class="o">.</span><span class="n">figure</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="n">ax</span> <span class="o">=</span> <span class="n">AA</span><span class="o">.</span><span class="n">Axes</span><span class="p">(</span><span class="n">fig</span><span class="p">,</span> <span class="p">[</span><span class="mf">0.1</span><span class="p">,</span> <span class="mf">0.1</span><span class="p">,</span> <span class="mf">0.8</span><span class="p">,</span> <span class="mf">0.8</span><span class="p">])</span>
<span class="n">fig</span><span class="o">.</span><span class="n">add_axes</span><span class="p">(</span><span class="n">ax</span><span class="p">)</span>
</pre></div>
</div>
<p>or to create a subplot</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span> <span class="o">=</span> <span class="n">AA</span><span class="o">.</span><span class="n">Subplot</span><span class="p">(</span><span class="n">fig</span><span class="p">,</span> <span class="mi">111</span><span class="p">)</span>
<span class="n">fig</span><span class="o">.</span><span class="n">add_subplot</span><span class="p">(</span><span class="n">ax</span><span class="p">)</span>
</pre></div>
</div>
<p>For example, you can hide the right and top spines using:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="s2">"right"</span><span class="p">]</span><span class="o">.</span><span class="n">set_visible</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
<span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="s2">"top"</span><span class="p">]</span><span class="o">.</span><span class="n">set_visible</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
</pre></div>
</div>
<div class="figure align-center" id="id3">
<a class="reference external image-reference" href="../../gallery/userdemo/simple_axisline3.html"><img alt="../../_images/sphx_glr_simple_axisline3_0011.png" src="../../_images/sphx_glr_simple_axisline3_0011.png" style="width: 150.0px; height: 150.0px;" /></a>
<p class="caption"><span class="caption-text">Simple Axisline3</span></p>
</div>
<p>It is also possible to add a horizontal axis. For example, you may have an
horizontal axis at y=0 (in data coordinate).</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="s2">"y=0"</span><span class="p">]</span> <span class="o">=</span> <span class="n">ax</span><span class="o">.</span><span class="n">new_floating_axis</span><span class="p">(</span><span class="n">nth_coord</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
</pre></div>
</div>
<div class="figure align-center" id="id4">
<a class="reference external image-reference" href="../../gallery/userdemo/simple_axisartist1.html"><img alt="../../_images/sphx_glr_simple_axisartist1_0011.png" src="../../_images/sphx_glr_simple_axisartist1_0011.png" style="width: 320.0px; height: 240.0px;" /></a>
<p class="caption"><span class="caption-text">Simple Axisartist1</span></p>
</div>
<p>Or a fixed axis with some offset</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># make new (right-side) yaxis, but wth some offset</span>
<span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="s2">"right2"</span><span class="p">]</span> <span class="o">=</span> <span class="n">ax</span><span class="o">.</span><span class="n">new_fixed_axis</span><span class="p">(</span><span class="n">loc</span><span class="o">=</span><span class="s2">"right"</span><span class="p">,</span>
<span class="n">offset</span><span class="o">=</span><span class="p">(</span><span class="mi">20</span><span class="p">,</span> <span class="mi">0</span><span class="p">))</span>
</pre></div>
</div>
<div class="section" id="axisartist-with-parasiteaxes">
<h3>axisartist with ParasiteAxes<a class="headerlink" href="#axisartist-with-parasiteaxes" title="Permalink to this headline">¶</a></h3>
<p>Most commands in the axes_grid1 toolkit can take an axes_class keyword
argument, and the commands create an axes of the given class. For example,
to create a host subplot with axisartist.Axes,</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">mpl_toolkits.axisartist</span> <span class="k">as</span> <span class="nn">AA</span>
<span class="kn">from</span> <span class="nn">mpl_toolkits.axes_grid1</span> <span class="k">import</span> <span class="n">host_subplot</span>
<span class="n">host</span> <span class="o">=</span> <span class="n">host_subplot</span><span class="p">(</span><span class="mi">111</span><span class="p">,</span> <span class="n">axes_class</span><span class="o">=</span><span class="n">AA</span><span class="o">.</span><span class="n">Axes</span><span class="p">)</span>
</pre></div>
</div>
<p>Here is an example that uses parasiteAxes.</p>
<div class="figure align-center" id="id5">
<a class="reference external image-reference" href="../../gallery/axisartist/demo_parasite_axes2.html"><img alt="../../_images/sphx_glr_demo_parasite_axes2_0011.png" src="../../_images/sphx_glr_demo_parasite_axes2_0011.png" style="width: 320.0px; height: 240.0px;" /></a>
<p class="caption"><span class="caption-text">Demo Parasite Axes2</span></p>
</div>
</div>
<div class="section" id="curvilinear-grid">
<h3>Curvilinear Grid<a class="headerlink" href="#curvilinear-grid" title="Permalink to this headline">¶</a></h3>
<p>The motivation behind the AxisArtist module is to support a curvilinear grid
and ticks.</p>
<div class="figure align-center" id="id6">
<a class="reference external image-reference" href="../../gallery/axisartist/demo_curvelinear_grid.html"><img alt="../../_images/sphx_glr_demo_curvelinear_grid_0011.png" src="../../_images/sphx_glr_demo_curvelinear_grid_0011.png" style="width: 350.0px; height: 200.0px;" /></a>
<p class="caption"><span class="caption-text">Demo Curvelinear Grid</span></p>
</div>
</div>
<div class="section" id="floating-axes">
<h3>Floating Axes<a class="headerlink" href="#floating-axes" title="Permalink to this headline">¶</a></h3>
<p>AxisArtist also supports a Floating Axes whose outer axes are defined as
floating axis.</p>
<div class="figure align-center" id="id7">
<a class="reference external image-reference" href="../../gallery/axisartist/demo_floating_axes.html"><img alt="../../_images/sphx_glr_demo_floating_axes_0011.png" src="../../_images/sphx_glr_demo_floating_axes_0011.png" style="width: 400.0px; height: 200.0px;" /></a>
<p class="caption"><span class="caption-text">Demo Floating Axes</span></p>
</div>
</div>
</div>
<div class="section" id="axisartist-namespace">
<h2>axisartist namespace<a class="headerlink" href="#axisartist-namespace" title="Permalink to this headline">¶</a></h2>
<p>The <em>axisartist</em> namespace includes a derived Axes implementation. The
biggest difference is that the artists responsible to draw axis line,
ticks, ticklabel and axis labels are separated out from the mpl’s Axis
class, which are much more than artists in the original mpl. This
change was strongly motivated to support curvilinear grid. Here are a
few things that mpl_tootlkits.axisartist.Axes is different from original
Axes from mpl.</p>
<ul class="simple">
<li>Axis elements (axis line(spine), ticks, ticklabel and axis labels)
are drawn by a AxisArtist instance. Unlike Axis, left, right, top
and bottom axis are drawn by separate artists. And each of them may
have different tick location and different tick labels.</li>
<li>gridlines are drawn by a Gridlines instance. The change was
motivated that in curvilinear coordinate, a gridline may not cross
axis-lines (i.e., no associated ticks). In the original Axes class,
gridlines are tied to ticks.</li>
<li>ticklines can be rotated if necessary (i.e, along the gridlines)</li>
</ul>
<p>In summary, all these changes was to support</p>
<ul class="simple">
<li>a curvilinear grid.</li>
<li>a floating axis</li>
</ul>
<div class="figure align-center" id="id8">
<a class="reference external image-reference" href="../../gallery/axisartist/demo_floating_axis.html"><img alt="../../_images/sphx_glr_demo_floating_axis_0011.png" src="../../_images/sphx_glr_demo_floating_axis_0011.png" style="width: 250.0px; height: 250.0px;" /></a>
<p class="caption"><span class="caption-text">Demo Floating Axis</span></p>
</div>
<p><em>mpl_toolkits.axisartist.Axes</em> class defines a <em>axis</em> attribute, which
is a dictionary of AxisArtist instances. By default, the dictionary
has 4 AxisArtist instances, responsible for drawing of left, right,
bottom and top axis.</p>
<p>xaxis and yaxis attributes are still available, however they are set
to not visible. As separate artists are used for rendering axis, some
axis-related method in mpl may have no effect.
In addition to AxisArtist instances, the mpl_toolkits.axisartist.Axes will
have <em>gridlines</em> attribute (Gridlines), which obviously draws grid
lines.</p>
<p>In both AxisArtist and Gridlines, the calculation of tick and grid
location is delegated to an instance of GridHelper class.
mpl_toolkits.axisartist.Axes class uses GridHelperRectlinear as a grid
helper. The GridHelperRectlinear class is a wrapper around the <em>xaxis</em>
and <em>yaxis</em> of mpl’s original Axes, and it was meant to work as the
way how mpl’s original axes works. For example, tick location changes
using set_ticks method and etc. should work as expected. But change in
artist properties (e.g., color) will not work in general, although
some effort has been made so that some often-change attributes (color,
etc.) are respected.</p>
</div>
<div class="section" id="id1">
<h2>AxisArtist<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
<p>AxisArtist can be considered as a container artist with following
attributes which will draw ticks, labels, etc.</p>
<blockquote>
<div><ul class="simple">
<li>line</li>
<li>major_ticks, major_ticklabels</li>
<li>minor_ticks, minor_ticklabels</li>
<li>offsetText</li>
<li>label</li>
</ul>
</div></blockquote>
<div class="section" id="line">
<h3>line<a class="headerlink" href="#line" title="Permalink to this headline">¶</a></h3>
<p>Derived from Line2d class. Responsible for drawing a spinal(?) line.</p>
</div>
<div class="section" id="major-ticks-minor-ticks">
<h3>major_ticks, minor_ticks<a class="headerlink" href="#major-ticks-minor-ticks" title="Permalink to this headline">¶</a></h3>
<p>Derived from Line2d class. Note that ticks are markers.</p>
</div>
<div class="section" id="major-ticklabels-minor-ticklabels">
<h3>major_ticklabels, minor_ticklabels<a class="headerlink" href="#major-ticklabels-minor-ticklabels" title="Permalink to this headline">¶</a></h3>
<p>Derived from Text. Note that it is not a list of Text artist, but a
single artist (similar to a collection).</p>
</div>
<div class="section" id="axislabel">
<h3>axislabel<a class="headerlink" href="#axislabel" title="Permalink to this headline">¶</a></h3>
<p>Derived from Text.</p>
</div>
</div>
<div class="section" id="default-axisartists">
<h2>Default AxisArtists<a class="headerlink" href="#default-axisartists" title="Permalink to this headline">¶</a></h2>
<p>By default, following for axis artists are defined.:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="s2">"left"</span><span class="p">],</span> <span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="s2">"bottom"</span><span class="p">],</span> <span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="s2">"right"</span><span class="p">],</span> <span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="s2">"top"</span><span class="p">]</span>
</pre></div>
</div>
<p>The ticklabels and axislabel of the top and the right axis are set to
not visible.</p>
<p>For example, if you want to change the color attributes of
major_ticklabels of the bottom x-axis</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="s2">"bottom"</span><span class="p">]</span><span class="o">.</span><span class="n">major_ticklabels</span><span class="o">.</span><span class="n">set_color</span><span class="p">(</span><span class="s2">"b"</span><span class="p">)</span>
</pre></div>
</div>
<p>Similarly, to make ticklabels invisible</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="s2">"bottom"</span><span class="p">]</span><span class="o">.</span><span class="n">major_ticklabels</span><span class="o">.</span><span class="n">set_visible</span><span class="p">(</span><span class="kc">False</span><span class="p">)</span>
</pre></div>
</div>
<p>AxisAritst provides a helper method to control the visibility of ticks,
ticklabels, and label. To make ticklabel invisible,</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="s2">"bottom"</span><span class="p">]</span><span class="o">.</span><span class="n">toggle</span><span class="p">(</span><span class="n">ticklabels</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</pre></div>
</div>
<p>To make all of ticks, ticklabels, and (axis) label invisible</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="s2">"bottom"</span><span class="p">]</span><span class="o">.</span><span class="n">toggle</span><span class="p">(</span><span class="nb">all</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
</pre></div>
</div>
<p>To turn all off but ticks on</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="s2">"bottom"</span><span class="p">]</span><span class="o">.</span><span class="n">toggle</span><span class="p">(</span><span class="nb">all</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">ticks</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
<p>To turn all on but (axis) label off</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="s2">"bottom"</span><span class="p">]</span><span class="o">.</span><span class="n">toggle</span><span class="p">(</span><span class="nb">all</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">label</span><span class="o">=</span><span class="kc">False</span><span class="p">))</span>
</pre></div>
</div>
<p>ax.axis’s __getitem__ method can take multiple axis names. For
example, to turn ticklabels of “top” and “right” axis on,</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="s2">"top"</span><span class="p">,</span><span class="s2">"right"</span><span class="p">]</span><span class="o">.</span><span class="n">toggle</span><span class="p">(</span><span class="n">ticklabels</span><span class="o">=</span><span class="kc">True</span><span class="p">))</span>
</pre></div>
</div>
<p>Note that ‘ax.axis[“top”,”right”]’ returns a simple proxy object that translate above code to something like below.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="k">for</span> <span class="n">n</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">"top"</span><span class="p">,</span><span class="s2">"right"</span><span class="p">]:</span>
<span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="n">n</span><span class="p">]</span><span class="o">.</span><span class="n">toggle</span><span class="p">(</span><span class="n">ticklabels</span><span class="o">=</span><span class="kc">True</span><span class="p">))</span>
</pre></div>
</div>
<p>So, any return values in the for loop are ignored. And you should not
use it anything more than a simple method.</p>
<p>Like the list indexing “:” means all items, i.e.,</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">[:]</span><span class="o">.</span><span class="n">major_ticks</span><span class="o">.</span><span class="n">set_color</span><span class="p">(</span><span class="s2">"r"</span><span class="p">)</span>
</pre></div>
</div>
<p>changes tick color in all axis.</p>
</div>
<div class="section" id="howto">
<h2>HowTo<a class="headerlink" href="#howto" title="Permalink to this headline">¶</a></h2>
<ol class="arabic simple">
<li>Changing tick locations and label.</li>
</ol>
<blockquote>
<div><p>Same as the original mpl’s axes.:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">set_xticks</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">3</span><span class="p">])</span>
</pre></div>
</div>
</div></blockquote>
<ol class="arabic simple" start="2">
<li>Changing axis properties like color, etc.</li>
</ol>
<blockquote>
<div><p>Change the properties of appropriate artists. For example, to change
the color of the ticklabels:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="s2">"left"</span><span class="p">]</span><span class="o">.</span><span class="n">major_ticklabels</span><span class="o">.</span><span class="n">set_color</span><span class="p">(</span><span class="s2">"r"</span><span class="p">)</span>
</pre></div>
</div>
</div></blockquote>
<ol class="arabic" start="3">
<li><p class="first">To change the attributes of multiple axis:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="s2">"left"</span><span class="p">,</span><span class="s2">"bottom"</span><span class="p">]</span><span class="o">.</span><span class="n">major_ticklabels</span><span class="o">.</span><span class="n">set_color</span><span class="p">(</span><span class="s2">"r"</span><span class="p">)</span>
</pre></div>
</div>
<p>or to change the attributes of all axis:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">[:]</span><span class="o">.</span><span class="n">major_ticklabels</span><span class="o">.</span><span class="n">set_color</span><span class="p">(</span><span class="s2">"r"</span><span class="p">)</span>
</pre></div>
</div>
</li>
<li><dl class="first docutils">
<dt>To change the tick size (length), you need to use</dt>
<dd><p class="first">axis.major_ticks.set_ticksize method. To change the direction of
the ticks (ticks are in opposite direction of ticklabels by
default), use axis.major_ticks.set_tick_out method.</p>
<p>To change the pad between ticks and ticklabels, use
axis.major_ticklabels.set_pad method.</p>
<p class="last">To change the pad between ticklabels and axis label,
axis.label.set_pad method.</p>
</dd>
</dl>
</li>
</ol>
</div>
<div class="section" id="rotation-and-alignment-of-ticklabels">
<h2>Rotation and Alignment of TickLabels<a class="headerlink" href="#rotation-and-alignment-of-ticklabels" title="Permalink to this headline">¶</a></h2>
<p>This is also quite different from the original mpl and can be
confusing. When you want to rotate the ticklabels, first consider
using “set_axis_direction” method.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax1</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="s2">"left"</span><span class="p">]</span><span class="o">.</span><span class="n">major_ticklabels</span><span class="o">.</span><span class="n">set_axis_direction</span><span class="p">(</span><span class="s2">"top"</span><span class="p">)</span>
<span class="n">ax1</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="s2">"right"</span><span class="p">]</span><span class="o">.</span><span class="n">label</span><span class="o">.</span><span class="n">set_axis_direction</span><span class="p">(</span><span class="s2">"left"</span><span class="p">)</span>
</pre></div>
</div>
<div class="figure align-center" id="id9">
<a class="reference external image-reference" href="../../gallery/userdemo/simple_axis_direction01.html"><img alt="../../_images/sphx_glr_simple_axis_direction01_0011.png" src="../../_images/sphx_glr_simple_axis_direction01_0011.png" style="width: 200.0px; height: 125.0px;" /></a>
<p class="caption"><span class="caption-text">Simple Axis Direction01</span></p>
</div>
<p>The parameter for set_axis_direction is one of [“left”, “right”,
“bottom”, “top”].</p>
<p>You must understand some underlying concept of directions.</p>
<blockquote>
<div><ol class="arabic">
<li><p class="first">There is a reference direction which is defined as the direction
of the axis line with increasing coordinate. For example, the
reference direction of the left x-axis is from bottom to top.</p>
<div class="figure align-center" id="id10">
<a class="reference external image-reference" href="../../gallery/userdemo/axis_direction_demo_step01.html"><img alt="../../_images/sphx_glr_axis_direction_demo_step01_0011.png" src="../../_images/sphx_glr_axis_direction_demo_step01_0011.png" style="width: 150.0px; height: 125.0px;" /></a>
<p class="caption"><span class="caption-text">Axis Direction Demo - Step 01</span></p>
</div>
</li>
</ol>
<blockquote>
<div>The direction, text angle, and alignments of the ticks, ticklabels and
axis-label is determined with respect to the reference direction</div></blockquote>
<ol class="arabic" start="2">
<li><p class="first"><em>ticklabel_direction</em> is either the right-hand side (+) of the
reference direction or the left-hand side (-).</p>
<div class="figure align-center" id="id11">
<a class="reference external image-reference" href="../../gallery/userdemo/axis_direction_demo_step02.html"><img alt="../../_images/sphx_glr_axis_direction_demo_step02_0011.png" src="../../_images/sphx_glr_axis_direction_demo_step02_0011.png" style="width: 300.0px; height: 125.0px;" /></a>
<p class="caption"><span class="caption-text">Axis Direction Demo - Step 02</span></p>
</div>
</li>
<li><p class="first">same for the <em>label_direction</em></p>
<div class="figure align-center" id="id12">
<a class="reference external image-reference" href="../../gallery/userdemo/axis_direction_demo_step03.html"><img alt="../../_images/sphx_glr_axis_direction_demo_step03_0011.png" src="../../_images/sphx_glr_axis_direction_demo_step03_0011.png" style="width: 300.0px; height: 125.0px;" /></a>
<p class="caption"><span class="caption-text">Axis Direction Demo - Step 03</span></p>
</div>
</li>
<li><p class="first">ticks are by default drawn toward the opposite direction of the ticklabels.</p>
</li>
<li><p class="first">text rotation of ticklabels and label is determined in reference
to the <em>ticklabel_direction</em> or <em>label_direction</em>,
respectively. The rotation of ticklabels and label is anchored.</p>
<div class="figure align-center" id="id13">
<a class="reference external image-reference" href="../../gallery/userdemo/axis_direction_demo_step04.html"><img alt="../../_images/sphx_glr_axis_direction_demo_step04_0011.png" src="../../_images/sphx_glr_axis_direction_demo_step04_0011.png" style="width: 300.0px; height: 125.0px;" /></a>
<p class="caption"><span class="caption-text">Axis Direction Demo - Step 04</span></p>
</div>
</li>
</ol>
</div></blockquote>
<p>On the other hand, there is a concept of “axis_direction”. This is a
default setting of above properties for each, “bottom”, “left”, “top”,
and “right” axis.</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="17%" />
<col width="19%" />
<col width="15%" />
<col width="17%" />
<col width="15%" />
<col width="17%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>?</td>
<td>?</td>
<td>left</td>
<td>bottom</td>
<td>right</td>
<td>top</td>
</tr>
<tr class="row-even"><td>axislabel</td>
<td>direction</td>
<td>‘-‘</td>
<td>‘+’</td>
<td>‘+’</td>
<td>‘-‘</td>
</tr>
<tr class="row-odd"><td>axislabel</td>
<td>rotation</td>
<td>180</td>
<td>0</td>
<td>0</td>
<td>180</td>
</tr>
<tr class="row-even"><td>axislabel</td>
<td>va</td>
<td>center</td>
<td>top</td>
<td>center</td>
<td>bottom</td>
</tr>
<tr class="row-odd"><td>axislabel</td>
<td>ha</td>
<td>right</td>
<td>center</td>
<td>right</td>
<td>center</td>
</tr>
<tr class="row-even"><td>ticklabel</td>
<td>direction</td>
<td>‘-‘</td>
<td>‘+’</td>
<td>‘+’</td>
<td>‘-‘</td>
</tr>
<tr class="row-odd"><td>ticklabels</td>
<td>rotation</td>
<td>90</td>
<td>0</td>
<td>-90</td>
<td>180</td>
</tr>
<tr class="row-even"><td>ticklabel</td>
<td>ha</td>
<td>right</td>
<td>center</td>
<td>right</td>
<td>center</td>
</tr>
<tr class="row-odd"><td>ticklabel</td>
<td>va</td>
<td>center</td>
<td>baseline</td>
<td>center</td>
<td>baseline</td>
</tr>
</tbody>
</table>
</div></blockquote>
<p>And, ‘set_axis_direction(“top”)’ means to adjust the text rotation
etc, for settings suitable for “top” axis. The concept of axis
direction can be more clear with curved axis.</p>
<div class="figure align-center" id="id14">
<a class="reference external image-reference" href="../../gallery/userdemo/demo_axis_direction.html"><img alt="../../_images/sphx_glr_demo_axis_direction_0011.png" src="../../_images/sphx_glr_demo_axis_direction_0011.png" style="width: 400.0px; height: 200.0px;" /></a>
<p class="caption"><span class="caption-text">Demo Axis Direction</span></p>
</div>
<p>The axis_direction can be adjusted in the AxisArtist level, or in the
level of its child arists, i.e., ticks, ticklabels, and axis-label.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax1</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="s2">"left"</span><span class="p">]</span><span class="o">.</span><span class="n">set_axis_direction</span><span class="p">(</span><span class="s2">"top"</span><span class="p">)</span>
</pre></div>
</div>
<p>changes axis_direction of all the associated artist with the “left”
axis, while</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax1</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="s2">"left"</span><span class="p">]</span><span class="o">.</span><span class="n">major_ticklabels</span><span class="o">.</span><span class="n">set_axis_direction</span><span class="p">(</span><span class="s2">"top"</span><span class="p">)</span>
</pre></div>
</div>
<p>changes the axis_direction of only the major_ticklabels. Note that
set_axis_direction in the AxisArtist level changes the
ticklabel_direction and label_direction, while changing the
axis_direction of ticks, ticklabels, and axis-label does not affect
them.</p>
<p>If you want to make ticks outward and ticklabels inside the axes,
use invert_ticklabel_direction method.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">[:]</span><span class="o">.</span><span class="n">invert_ticklabel_direction</span><span class="p">()</span>
</pre></div>
</div>
<p>A related method is “set_tick_out”. It makes ticks outward (as a
matter of fact, it makes ticks toward the opposite direction of the
default direction).</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">[:]</span><span class="o">.</span><span class="n">major_ticks</span><span class="o">.</span><span class="n">set_tick_out</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
<div class="figure align-center" id="id15">
<a class="reference external image-reference" href="../../gallery/userdemo/simple_axis_direction03.html"><img alt="../../_images/sphx_glr_simple_axis_direction03_0011.png" src="../../_images/sphx_glr_simple_axis_direction03_0011.png" style="width: 250.0px; height: 100.0px;" /></a>
<p class="caption"><span class="caption-text">Simple Axis Direction03</span></p>
</div>
<p>So, in summary,</p>
<blockquote>
<div><ul>
<li><dl class="first docutils">
<dt>AxisArtist’s methods</dt>
<dd><ul class="first last simple">
<li>set_axis_direction : “left”, “right”, “bottom”, or “top”</li>
<li>set_ticklabel_direction : “+” or “-“</li>
<li>set_axislabel_direction : “+” or “-“</li>
<li>invert_ticklabel_direction</li>
</ul>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Ticks’ methods (major_ticks and minor_ticks)</dt>
<dd><ul class="first last simple">
<li>set_tick_out : True or False</li>
<li>set_ticksize : size in points</li>
</ul>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>TickLabels’ methods (major_ticklabels and minor_ticklabels)</dt>
<dd><ul class="first last simple">
<li>set_axis_direction : “left”, “right”, “bottom”, or “top”</li>
<li>set_rotation : angle with respect to the reference direction</li>
<li>set_ha and set_va : see below</li>
</ul>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>AxisLabels’ methods (label)</dt>
<dd><ul class="first last simple">
<li>set_axis_direction : “left”, “right”, “bottom”, or “top”</li>
<li>set_rotation : angle with respect to the reference direction</li>
<li>set_ha and set_va</li>
</ul>
</dd>
</dl>
</li>
</ul>
</div></blockquote>
<div class="section" id="adjusting-ticklabels-alignment">
<h3>Adjusting ticklabels alignment<a class="headerlink" href="#adjusting-ticklabels-alignment" title="Permalink to this headline">¶</a></h3>
<p>Alignment of TickLabels are treated specially. See below</p>
<div class="figure align-center" id="id16">
<a class="reference external image-reference" href="../../gallery/userdemo/demo_ticklabel_alignment.html"><img alt="../../_images/sphx_glr_demo_ticklabel_alignment_0011.png" src="../../_images/sphx_glr_demo_ticklabel_alignment_0011.png" style="width: 150.0px; height: 250.0px;" /></a>
<p class="caption"><span class="caption-text">Demo Ticklabel Alignment</span></p>
</div>
</div>
<div class="section" id="adjusting-pad">
<h3>Adjusting pad<a class="headerlink" href="#adjusting-pad" title="Permalink to this headline">¶</a></h3>
<p>To change the pad between ticks and ticklabels</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="s2">"left"</span><span class="p">]</span><span class="o">.</span><span class="n">major_ticklabels</span><span class="o">.</span><span class="n">set_pad</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span>
</pre></div>
</div>
<p>Or ticklabels and axis-label</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="s2">"left"</span><span class="p">]</span><span class="o">.</span><span class="n">label</span><span class="o">.</span><span class="n">set_pad</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span>
</pre></div>
</div>
<div class="figure align-center" id="id17">
<a class="reference external image-reference" href="../../gallery/userdemo/simple_axis_pad.html"><img alt="../../_images/sphx_glr_simple_axis_pad_0011.png" src="../../_images/sphx_glr_simple_axis_pad_0011.png" style="width: 450.0px; height: 150.0px;" /></a>
<p class="caption"><span class="caption-text">Simple Axis Pad</span></p>
</div>
</div>
</div>
<div class="section" id="gridhelper">
<h2>GridHelper<a class="headerlink" href="#gridhelper" title="Permalink to this headline">¶</a></h2>
<p>To actually define a curvilinear coordinate, you have to use your own
grid helper. A generalised version of grid helper class is supplied
and this class should suffice in most of cases. A user may provide
two functions which defines a transformation (and its inverse pair)
from the curved coordinate to (rectilinear) image coordinate. Note that
while ticks and grids are drawn for curved coordinate, the data
transform of the axes itself (ax.transData) is still rectilinear
(image) coordinate.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">mpl_toolkits.axisartist.grid_helper_curvelinear</span> <span class="k">import</span> <span class="n">GridHelperCurveLinear</span>
<span class="kn">from</span> <span class="nn">mpl_toolkits.axisartist</span> <span class="k">import</span> <span class="n">Subplot</span>
<span class="c1"># from curved coordinate to rectlinear coordinate.</span>
<span class="k">def</span> <span class="nf">tr</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">x</span><span class="p">,</span> <span class="n">y</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">x</span><span class="p">),</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">y</span><span class="p">)</span>
<span class="k">return</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="o">-</span><span class="n">x</span>
<span class="c1"># from rectlinear coordinate to curved coordinate.</span>
<span class="k">def</span> <span class="nf">inv_tr</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">x</span><span class="p">,</span> <span class="n">y</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">x</span><span class="p">),</span> <span class="n">np</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">y</span><span class="p">)</span>
<span class="k">return</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="o">+</span><span class="n">x</span>
<span class="n">grid_helper</span> <span class="o">=</span> <span class="n">GridHelperCurveLinear</span><span class="p">((</span><span class="n">tr</span><span class="p">,</span> <span class="n">inv_tr</span><span class="p">))</span>
<span class="n">ax1</span> <span class="o">=</span> <span class="n">Subplot</span><span class="p">(</span><span class="n">fig</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">1</span><span class="p">,</span> <span class="n">grid_helper</span><span class="o">=</span><span class="n">grid_helper</span><span class="p">)</span>
<span class="n">fig</span><span class="o">.</span><span class="n">add_subplot</span><span class="p">(</span><span class="n">ax1</span><span class="p">)</span>
</pre></div>
</div>
<p>You may use matplotlib’s Transform instance instead (but a
inverse transformation must be defined). Often, coordinate range in a
curved coordinate system may have a limited range, or may have
cycles. In those cases, a more customized version of grid helper is
required.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">mpl_toolkits.axisartist.angle_helper</span> <span class="k">as</span> <span class="nn">angle_helper</span>
<span class="c1"># PolarAxes.PolarTransform takes radian. However, we want our coordinate</span>
<span class="c1"># system in degree</span>
<span class="n">tr</span> <span class="o">=</span> <span class="n">Affine2D</span><span class="p">()</span><span class="o">.</span><span class="n">scale</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">pi</span><span class="o">/</span><span class="mf">180.</span><span class="p">,</span> <span class="mf">1.</span><span class="p">)</span> <span class="o">+</span> <span class="n">PolarAxes</span><span class="o">.</span><span class="n">PolarTransform</span><span class="p">()</span>
<span class="c1"># extreme finder : find a range of coordinate.</span>
<span class="c1"># 20, 20 : number of sampling points along x, y direction</span>
<span class="c1"># The first coordinate (longitude, but theta in polar)</span>
<span class="c1"># has a cycle of 360 degree.</span>
<span class="c1"># The second coordinate (latitude, but radius in polar) has a minimum of 0</span>
<span class="n">extreme_finder</span> <span class="o">=</span> <span class="n">angle_helper</span><span class="o">.</span><span class="n">ExtremeFinderCycle</span><span class="p">(</span><span class="mi">20</span><span class="p">,</span> <span class="mi">20</span><span class="p">,</span>
<span class="n">lon_cycle</span> <span class="o">=</span> <span class="mi">360</span><span class="p">,</span>
<span class="n">lat_cycle</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">lon_minmax</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">lat_minmax</span> <span class="o">=</span> <span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">inf</span><span class="p">),</span>
<span class="p">)</span>
<span class="c1"># Find a grid values appropriate for the coordinate (degree,</span>
<span class="c1"># minute, second). The argument is a approximate number of grids.</span>
<span class="n">grid_locator1</span> <span class="o">=</span> <span class="n">angle_helper</span><span class="o">.</span><span class="n">LocatorDMS</span><span class="p">(</span><span class="mi">12</span><span class="p">)</span>
<span class="c1"># And also uses an appropriate formatter. Note that,the</span>
<span class="c1"># acceptable Locator and Formatter class is a bit different than</span>
<span class="c1"># that of mpl's, and you cannot directly use mpl's Locator and</span>
<span class="c1"># Formatter here (but may be possible in the future).</span>
<span class="n">tick_formatter1</span> <span class="o">=</span> <span class="n">angle_helper</span><span class="o">.</span><span class="n">FormatterDMS</span><span class="p">()</span>
<span class="n">grid_helper</span> <span class="o">=</span> <span class="n">GridHelperCurveLinear</span><span class="p">(</span><span class="n">tr</span><span class="p">,</span>
<span class="n">extreme_finder</span><span class="o">=</span><span class="n">extreme_finder</span><span class="p">,</span>
<span class="n">grid_locator1</span><span class="o">=</span><span class="n">grid_locator1</span><span class="p">,</span>
<span class="n">tick_formatter1</span><span class="o">=</span><span class="n">tick_formatter1</span>
<span class="p">)</span>
</pre></div>
</div>
<p>Again, the <em>transData</em> of the axes is still a rectilinear coordinate
(image coordinate). You may manually do conversion between two
coordinates, or you may use Parasite Axes for convenience.:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ax1</span> <span class="o">=</span> <span class="n">SubplotHost</span><span class="p">(</span><span class="n">fig</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">2</span><span class="p">,</span> <span class="n">grid_helper</span><span class="o">=</span><span class="n">grid_helper</span><span class="p">)</span>
<span class="c1"># A parasite axes with given transform</span>
<span class="n">ax2</span> <span class="o">=</span> <span class="n">ParasiteAxesAuxTrans</span><span class="p">(</span><span class="n">ax1</span><span class="p">,</span> <span class="n">tr</span><span class="p">,</span> <span class="s2">"equal"</span><span class="p">)</span>
<span class="c1"># note that ax2.transData == tr + ax1.transData</span>
<span class="c1"># Anthing you draw in ax2 will match the ticks and grids of ax1.</span>
<span class="n">ax1</span><span class="o">.</span><span class="n">parasites</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">ax2</span><span class="p">)</span>
</pre></div>
</div>
<div class="figure align-center" id="id18">
<a class="reference external image-reference" href="../../gallery/axisartist/demo_curvelinear_grid.html"><img alt="../../_images/sphx_glr_demo_curvelinear_grid_0011.png" src="../../_images/sphx_glr_demo_curvelinear_grid_0011.png" style="width: 350.0px; height: 200.0px;" /></a>
<p class="caption"><span class="caption-text">Demo Curvelinear Grid</span></p>
</div>
</div>
<div class="section" id="floatingaxis">
<h2>FloatingAxis<a class="headerlink" href="#floatingaxis" title="Permalink to this headline">¶</a></h2>
<p>A floating axis is an axis one of whose data coordinate is fixed, i.e,
its location is not fixed in Axes coordinate but changes as axes data
limits changes. A floating axis can be created using
<em>new_floating_axis</em> method. However, it is your responsibility that
the resulting AxisArtist is properly added to the axes. A recommended
way is to add it as an item of Axes’s axis attribute.:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># floating axis whose first (index starts from 0) coordinate</span>
<span class="c1"># (theta) is fixed at 60</span>
<span class="n">ax1</span><span class="o">.</span><span class="n">axis</span><span class="p">[</span><span class="s2">"lat"</span><span class="p">]</span> <span class="o">=</span> <span class="n">axis</span> <span class="o">=</span> <span class="n">ax1</span><span class="o">.</span><span class="n">new_floating_axis</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">60</span><span class="p">)</span>
<span class="n">axis</span><span class="o">.</span><span class="n">label</span><span class="o">.</span><span class="n">set_text</span><span class="p">(</span><span class="s2">r"$ heta = 60^{\circ}$"</span><span class="p">)</span>
<span class="n">axis</span><span class="o">.</span><span class="n">label</span><span class="o">.</span><span class="n">set_visible</span><span class="p">(</span><span class="kc">True</span><span class="p">)</span>
</pre></div>
</div>
<p>See the first example of this page.</p>
</div>
<div class="section" id="current-limitations-and-todo-s">
<h2>Current Limitations and TODO’s<a class="headerlink" href="#current-limitations-and-todo-s" title="Permalink to this headline">¶</a></h2>
<p>The code need more refinement. Here is a incomplete list of issues and TODO’s</p>
<ul class="simple">
<li>No easy way to support a user customized tick location (for
curvilinear grid). A new Locator class needs to be created.</li>
<li>FloatingAxis may have coordinate limits, e.g., a floating axis of x
= 0, but y only spans from 0 to 1.</li>
<li>The location of axislabel of FloatingAxis needs to be optionally
given as a coordinate value. ex, a floating axis of x=0 with label at y=1</li>
</ul>
<p><strong>Total running time of the script:</strong> ( 0 minutes 0.000 seconds)</p>
<div class="sphx-glr-footer container">
<div class="sphx-glr-download container">
<a class="reference download internal" href="../../_downloads/axisartist.py" download=""><code class="xref download docutils literal"><span class="pre">Download</span> <span class="pre">Python</span> <span class="pre">source</span> <span class="pre">code:</span> <span class="pre">axisartist.py</span></code></a></div>
<div class="sphx-glr-download container">
<a class="reference download internal" href="../../_downloads/axisartist.ipynb" download=""><code class="xref download docutils literal"><span class="pre">Download</span> <span class="pre">Jupyter</span> <span class="pre">notebook:</span> <span class="pre">axisartist.ipynb</span></code></a></div>
</div>
<p class="sphx-glr-signature"><a class="reference external" href="https://sphinx-gallery.readthedocs.io">Generated by Sphinx-Gallery</a></p>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2017 The Matplotlib development team.
Last updated on Jul 16, 2017.
Created using <a
href="http://sphinx-doc.org/">Sphinx</a> 1.6.2.
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-55954603-1', 'auto');
ga('send', 'pageview');
</script>
</body>
<footer>
<!--Flipcause Integration v3.0// Flipcause Integration Instructions:
Install the following code block once in the website Header (after <head> tag) -->
<style>
.fc-black_overlay{
display:none; position: fixed; z-index:1000001; top: 0%;left: 0%;width: 100%;height: 100%;
background-color: black; filter: alpha(opacity=50); cursor:pointer; opacity:0.5;
}
.fc-white_content {
opacity:1; display:none; margin-top: -320px; margin-left: -485px; width:970px; height:640px;
position:fixed; top:50%; left:50%; border: none;z-index:1000002;overflow: auto;
}
.fc-main-box{
opacity:1; display:none; margin:15px auto 0 auto; width:930px; position:relative; z-index:1000003;
}
.fc-widget_close{
opacity:1; content:url(http://i1338.photobucket.com/albums/o691/WeCause/X_zpse4a7e538.png);
position:absolute; z-index=1000004; right:-16px; top:-16px; display:block; cursor:pointer;
}
.floating_button{
display: block; margin-top: 0px; margin-left: 0px; width:auto ; height: auto;
position:fixed; z-index:999999; overflow: auto;
}
@keyframes backfadesin {
from { opacity:0; }
to {opacity:.5;}
}
@-moz-keyframes backfadesin {
from { opacity:0; }
to {opacity:.5;}
}
@-webkit-keyframes backfadesin {
from { opacity:0; }
to {opacity:.5;}
}
@-o-keyframes backfadesin {
from { opacity:0; }
to {opacity:.5;}
}
@-ms-keyframes backfadesin {
from { opacity:0; }
to {opacity:.5;}
}
@keyframes fadesin {
0%{ opacity:0; }
50%{ opacity:0; }
75% {opacity: 0; transform: translateY(20px);}
100% {opacity: 1; transform: translateY(0);}
}
@-moz-keyframes fadesin {
0%{ opacity:0; }
50%{ opacity:0; }
75% {opacity: 0; -moz-transform: translateY(20px);}
100% {opacity: 1; -moz-transform: translateY(0);}
}
@-webkit-keyframes fadesin {
0%{ opacity:0; }
50%{ opacity:0; }
75% {opacity: 0; -webkit-transform: translateY(20px);}
100% {opacity: 1; -webkit-transform: translateY(0);}
}
@-o-keyframes fadesin {
0%{ opacity:0; }
50%{ opacity:0; }
75% {opacity: 0; -o-transform: translateY(20px);}
100% {opacity: 1; -o-transform: translateY(0);}
}
@-ms-keyframes fadesin {
0%{ opacity:0; }
50%{ opacity:0; }
75% {opacity: 0; -ms-transform: translateY(20px);}
100% {opacity: 1; -ms-transform: translateY(0);}
}
</style>
<script>
function open_window(cause_id) {
var protocol=String(document.location.protocol);
var new_url;
if( /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent)){
new_url="https://www.flipcause.com/widget/"+cause_id
window.open(new_url);
}
else {
document.getElementById("fc-fade").style.display = "block";
document.getElementById("fc-fade").style.webkitAnimation = "backfadesin 1s";
document.getElementById("fc-fade").style.animation = "backfadesin 1s";
document.getElementById("fc-fade").style.mozAnimation = "backfadesin 1s";
document.getElementById("fc-light").style.display = "block";
document.getElementById("fc-light").style.webkitAnimation = "fadesin 1.5s";
document.getElementById("fc-light").style.animation = "fadesin 1.5s";
document.getElementById("fc-light").style.mozAnimation = "fadesin 1.5s";
document.getElementById("fc-main").style.display = "block";
document.getElementById("fc-main").style.webkitAnimation = "fadesin 1.5s";
document.getElementById("fc-main").style.animation = "fadesin 1.5s";
document.getElementById("fc-main").style.mozAnimation = "fadesin 1.5s";
document.getElementById("fc-close").style.display = "block";
document.getElementById("fc-close").style.webkitAnimation = "fadesin 1.5s";
document.getElementById("fc-close").style.animation = "fadesin 1.5s";
document.getElementById("fc-close").style.mozAnimation = "fadesin 1.5s";
document.getElementById("fc-myFrame").style.display = "block";
document.getElementById("fc-myFrame").style.webkitAnimation = "fadesin 1.5s";
document.getElementById("fc-myFrame").style.animation = "fadesin 1.5s";
document.getElementById("fc-myFrame").style.mozAnimation = "fadesin 1.5s";
document.getElementById("fc-myFrame").src="https://www.flipcause.com/widget/"+cause_id;
}
}
function close_window() {
document.getElementById("fc-fade").style.display="none";
document.getElementById("fc-light").style.display="none";
document.getElementById("fc-main").style.display="none";
document.getElementById("fc-close").style.display="none";
document.getElementById("fc-myFrame").style.display="none";
}
</script>
<div id="fc-fade" class="fc-black_overlay" onclick="close_window()"></div>
<div id="fc-light" class="fc-white_content">
<div id="fc-main" class="fc-main-box">
<div id="fc-close" class="fc-widget_close" onclick="close_window()">
</div><iframe id="fc-myFrame" iframe height="580" width="925" style="border: 0;
border-radius:5px 5px 5px 5px; box-shadow:0 0 8px rgba(0, 0, 0, 0.5);" scrolling="no" src=""></iframe></div>
</div>
<!--END Flipcause Main Integration Code-->
</footer>
</html>