forked from matplotlib/matplotlib.github.com
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathprojections.html
More file actions
215 lines (171 loc) · 13.8 KB
/
projections.html
File metadata and controls
215 lines (171 loc) · 13.8 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
<!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>matplotlib.projections — Matplotlib 3.1.1 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/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../../_static/gallery.css" type="text/css" />
<link rel="stylesheet" href="../../_static/copybutton.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/language_data.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script>
<script type="text/javascript" src="../../_static/copybutton.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.1.1 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 3.1.1 documentation" href="../../index.html" />
<link rel="up" title="matplotlib" href="../matplotlib.html" />
<link rel="canonical" href="https://matplotlib.org/3.1.1/_modules/matplotlib/projections.html" />
</head>
<body>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.1.1</span></div>
<img src="../../_static/logo2.png" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<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="../../tutorials/index.html">tutorials</a>| </li>
<li><a href="../../api/index.html">API</a>| </li>
<li><a href="../../contents.html">contents</a> »</li>
<li><a href="../index.html" >Module code</a> »</li>
<li><a href="../matplotlib.html" accesskey="U">matplotlib</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<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>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../contents.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
<li><a href="../matplotlib.html">matplotlib</a><ul>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for matplotlib.projections</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">..</span> <span class="k">import</span> <span class="n">axes</span><span class="p">,</span> <span class="n">cbook</span>
<span class="kn">from</span> <span class="nn">.geo</span> <span class="k">import</span> <span class="n">AitoffAxes</span><span class="p">,</span> <span class="n">HammerAxes</span><span class="p">,</span> <span class="n">LambertAxes</span><span class="p">,</span> <span class="n">MollweideAxes</span>
<span class="kn">from</span> <span class="nn">.polar</span> <span class="k">import</span> <span class="n">PolarAxes</span>
<div class="viewcode-block" id="ProjectionRegistry"><a class="viewcode-back" href="../../api/projections_api.html#matplotlib.projections.ProjectionRegistry">[docs]</a><span class="k">class</span> <span class="nc">ProjectionRegistry</span><span class="p">:</span>
<span class="sd">"""</span>
<span class="sd"> Manages the set of projections available to the system.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_all_projection_types</span> <span class="o">=</span> <span class="p">{}</span>
<div class="viewcode-block" id="ProjectionRegistry.register"><a class="viewcode-back" href="../../api/projections_api.html#matplotlib.projections.ProjectionRegistry.register">[docs]</a> <span class="k">def</span> <span class="nf">register</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">projections</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Register a new set of projections.</span>
<span class="sd"> """</span>
<span class="k">for</span> <span class="n">projection</span> <span class="ow">in</span> <span class="n">projections</span><span class="p">:</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">projection</span><span class="o">.</span><span class="n">name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_all_projection_types</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">projection</span></div>
<div class="viewcode-block" id="ProjectionRegistry.get_projection_class"><a class="viewcode-back" href="../../api/projections_api.html#matplotlib.projections.ProjectionRegistry.get_projection_class">[docs]</a> <span class="k">def</span> <span class="nf">get_projection_class</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Get a projection class from its *name*.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_all_projection_types</span><span class="p">[</span><span class="n">name</span><span class="p">]</span></div>
<div class="viewcode-block" id="ProjectionRegistry.get_projection_names"><a class="viewcode-back" href="../../api/projections_api.html#matplotlib.projections.ProjectionRegistry.get_projection_names">[docs]</a> <span class="k">def</span> <span class="nf">get_projection_names</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Get a list of the names of all projections currently registered.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="nb">sorted</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_all_projection_types</span><span class="p">)</span></div></div>
<span class="n">projection_registry</span> <span class="o">=</span> <span class="n">ProjectionRegistry</span><span class="p">()</span>
<span class="n">projection_registry</span><span class="o">.</span><span class="n">register</span><span class="p">(</span>
<span class="n">axes</span><span class="o">.</span><span class="n">Axes</span><span class="p">,</span>
<span class="n">PolarAxes</span><span class="p">,</span>
<span class="n">AitoffAxes</span><span class="p">,</span>
<span class="n">HammerAxes</span><span class="p">,</span>
<span class="n">LambertAxes</span><span class="p">,</span>
<span class="n">MollweideAxes</span><span class="p">)</span>
<div class="viewcode-block" id="register_projection"><a class="viewcode-back" href="../../api/projections_api.html#matplotlib.projections.register_projection">[docs]</a><span class="k">def</span> <span class="nf">register_projection</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
<span class="n">projection_registry</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="bp">cls</span><span class="p">)</span></div>
<div class="viewcode-block" id="get_projection_class"><a class="viewcode-back" href="../../api/projections_api.html#matplotlib.projections.get_projection_class">[docs]</a><span class="k">def</span> <span class="nf">get_projection_class</span><span class="p">(</span><span class="n">projection</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Get a projection class from its name.</span>
<span class="sd"> If *projection* is None, a standard rectilinear projection is returned.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">projection</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">projection</span> <span class="o">=</span> <span class="s1">'rectilinear'</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="n">projection_registry</span><span class="o">.</span><span class="n">get_projection_class</span><span class="p">(</span><span class="n">projection</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Unknown projection </span><span class="si">%r</span><span class="s2">"</span> <span class="o">%</span> <span class="n">projection</span><span class="p">)</span></div>
<div class="viewcode-block" id="process_projection_requirements"><a class="viewcode-back" href="../../api/projections_api.html#matplotlib.projections.process_projection_requirements">[docs]</a><span class="nd">@cbook</span><span class="o">.</span><span class="n">deprecated</span><span class="p">(</span><span class="s2">"3.1"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">process_projection_requirements</span><span class="p">(</span><span class="n">figure</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">return</span> <span class="n">figure</span><span class="o">.</span><span class="n">_process_projection_requirements</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
<div class="viewcode-block" id="get_projection_names"><a class="viewcode-back" href="../../api/projections_api.html#matplotlib.projections.get_projection_names">[docs]</a><span class="k">def</span> <span class="nf">get_projection_names</span><span class="p">():</span>
<span class="sd">"""</span>
<span class="sd"> Get a list of acceptable projection names.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">projection_registry</span><span class="o">.</span><span class="n">get_projection_names</span><span class="p">()</span></div>
</pre></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 - 2018 The Matplotlib development team.
<br />
Last updated on Jul 09, 2019.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
Doc version v3.1.1-9-g823365338.
</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>
</footer>
</html>