{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathunits_api.html
More file actions
312 lines (273 loc) · 22.3 KB
/
Copy pathunits_api.html
File metadata and controls
312 lines (273 loc) · 22.3 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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>matplotlib.units — Matplotlib 3.3.0 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css?v3.3.0-3-g8994f1b60" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="../_static/gallery-dataframe.css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/clipboard.min.js"></script>
<script type="text/javascript" src="../_static/copybutton.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.3.0 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="matplotlib.widgets" href="widgets_api.html" />
<link rel="prev" title="matplotlib.type1font" href="type1font.html" />
<link rel="top" title="Matplotlib 3.3.0 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/units_api.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head><body>
<div id="unreleased-message"> You are reading an old version of the documentation (v3.3.0). For the latest version see <a href="https://matplotlib.org/stable/api/units_api.html">https://matplotlib.org/stable/api/units_api.html</a></div>
<!--
<div id="annc-banner">
</div>
-->
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.3.0</span></div>
<img src="../_static/logo2_compressed.svg" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<nav class="main-nav">
<ul>
<li><a href="../users/installing.html">Installation</a></li>
<li><a href="../contents.html">Documentation</a></li>
<li><a href="../gallery/index.html">Examples</a></li>
<li><a href="../tutorials/index.html">Tutorials</a></li>
<li><a href="../devel/index.html">Contributing</a></li>
<li class="nav-right">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" placeholder="Search"/>
</form>
</li>
</ul>
</nav>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="widgets_api.html" title="matplotlib.widgets"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="type1font.html" title="matplotlib.type1font"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../contents.html">contents</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">API Overview</a> »</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">API Overview</a><ul>
<li>Previous: <a href="type1font.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.type1font</span></code></a></li>
<li>Next: <a href="widgets_api.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.widgets</span></code></a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="sidebar-pagesource" role="note" aria-label="source link"
style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">
<a href="../_sources/api/units_api.rst.txt"
style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-matplotlib.units">
<span id="matplotlib-units"></span><h1><code class="docutils literal notranslate"><span class="pre">matplotlib.units</span></code><a class="headerlink" href="#module-matplotlib.units" title="Permalink to this headline">¶</a></h1>
<p>The classes here provide support for using custom classes with
Matplotlib, e.g., those that do not expose the array interface but know
how to convert themselves to arrays. It also supports classes with
units and units conversion. Use cases include converters for custom
objects, e.g., a list of datetime objects, as well as for objects that
are unit aware. We don't assume any particular units implementation;
rather a units implementation must provide the register with the Registry
converter dictionary and a <a class="reference internal" href="#matplotlib.units.ConversionInterface" title="matplotlib.units.ConversionInterface"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ConversionInterface</span></code></a>. For example,
here is a complete implementation which supports plotting with native
datetime objects:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">matplotlib.units</span> <span class="k">as</span> <span class="nn">units</span>
<span class="kn">import</span> <span class="nn">matplotlib.dates</span> <span class="k">as</span> <span class="nn">dates</span>
<span class="kn">import</span> <span class="nn">matplotlib.ticker</span> <span class="k">as</span> <span class="nn">ticker</span>
<span class="kn">import</span> <span class="nn">datetime</span>
<span class="k">class</span> <span class="nc">DateConverter</span><span class="p">(</span><span class="n">units</span><span class="o">.</span><span class="n">ConversionInterface</span><span class="p">):</span>
<span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">convert</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">unit</span><span class="p">,</span> <span class="n">axis</span><span class="p">):</span>
<span class="s1">'Convert a datetime value to a scalar or array'</span>
<span class="k">return</span> <span class="n">dates</span><span class="o">.</span><span class="n">date2num</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">axisinfo</span><span class="p">(</span><span class="n">unit</span><span class="p">,</span> <span class="n">axis</span><span class="p">):</span>
<span class="s1">'Return major and minor tick locators and formatters'</span>
<span class="k">if</span> <span class="n">unit</span><span class="o">!=</span><span class="s1">'date'</span><span class="p">:</span> <span class="k">return</span> <span class="kc">None</span>
<span class="n">majloc</span> <span class="o">=</span> <span class="n">dates</span><span class="o">.</span><span class="n">AutoDateLocator</span><span class="p">()</span>
<span class="n">majfmt</span> <span class="o">=</span> <span class="n">dates</span><span class="o">.</span><span class="n">AutoDateFormatter</span><span class="p">(</span><span class="n">majloc</span><span class="p">)</span>
<span class="k">return</span> <span class="n">AxisInfo</span><span class="p">(</span><span class="n">majloc</span><span class="o">=</span><span class="n">majloc</span><span class="p">,</span>
<span class="n">majfmt</span><span class="o">=</span><span class="n">majfmt</span><span class="p">,</span>
<span class="n">label</span><span class="o">=</span><span class="s1">'date'</span><span class="p">)</span>
<span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">default_units</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">axis</span><span class="p">):</span>
<span class="s1">'Return the default unit for x or None'</span>
<span class="k">return</span> <span class="s1">'date'</span>
<span class="c1"># Finally we register our object type with the Matplotlib units registry.</span>
<span class="n">units</span><span class="o">.</span><span class="n">registry</span><span class="p">[</span><span class="n">datetime</span><span class="o">.</span><span class="n">date</span><span class="p">]</span> <span class="o">=</span> <span class="n">DateConverter</span><span class="p">()</span>
</pre></div>
</div>
<dl class="class">
<dt id="matplotlib.units.AxisInfo">
<em class="property">class </em><code class="descclassname">matplotlib.units.</code><code class="descname">AxisInfo</code><span class="sig-paren">(</span><em>majloc=None</em>, <em>minloc=None</em>, <em>majfmt=None</em>, <em>minfmt=None</em>, <em>label=None</em>, <em>default_limits=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/units.html#AxisInfo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.units.AxisInfo" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Information to support default axis labeling, tick labeling, and limits.</p>
<p>An instance of this class must be returned by
<a class="reference internal" href="#matplotlib.units.ConversionInterface.axisinfo" title="matplotlib.units.ConversionInterface.axisinfo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ConversionInterface.axisinfo</span></code></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>majloc, minloc</strong><span class="classifier">Locator, optional</span></dt><dd><p>Tick locators for the major and minor ticks.</p>
</dd>
<dt><strong>majfmt, minfmt</strong><span class="classifier">Formatter, optional</span></dt><dd><p>Tick formatters for the major and minor ticks.</p>
</dd>
<dt><strong>label</strong><span class="classifier">str, optional</span></dt><dd><p>The default axis label.</p>
</dd>
<dt><strong>default_limits</strong><span class="classifier">optional</span></dt><dd><p>The default min and max limits of the axis if no data has
been plotted.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>If any of the above are <code class="docutils literal notranslate"><span class="pre">None</span></code>, the axis will simply use the
default value.</p>
</dd></dl>
<dl class="exception">
<dt id="matplotlib.units.ConversionError">
<em class="property">exception </em><code class="descclassname">matplotlib.units.</code><code class="descname">ConversionError</code><a class="reference internal" href="../_modules/matplotlib/units.html#ConversionError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.units.ConversionError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeError</span></code></a></p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.units.ConversionInterface">
<em class="property">class </em><code class="descclassname">matplotlib.units.</code><code class="descname">ConversionInterface</code><a class="reference internal" href="../_modules/matplotlib/units.html#ConversionInterface"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.units.ConversionInterface" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>The minimal interface for a converter to take custom data types (or
sequences) and convert them to values Matplotlib can use.</p>
<dl class="method">
<dt id="matplotlib.units.ConversionInterface.axisinfo">
<em class="property">static </em><code class="descname">axisinfo</code><span class="sig-paren">(</span><em>unit</em>, <em>axis</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/units.html#ConversionInterface.axisinfo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.units.ConversionInterface.axisinfo" title="Permalink to this definition">¶</a></dt>
<dd><p>Return an <a class="reference internal" href="#matplotlib.units.AxisInfo" title="matplotlib.units.AxisInfo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AxisInfo</span></code></a> for the axis with the specified units.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.units.ConversionInterface.convert">
<em class="property">static </em><code class="descname">convert</code><span class="sig-paren">(</span><em>obj</em>, <em>unit</em>, <em>axis</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/units.html#ConversionInterface.convert"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.units.ConversionInterface.convert" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert <em>obj</em> using <em>unit</em> for the specified <em>axis</em>.</p>
<p>If <em>obj</em> is a sequence, return the converted sequence. The output must
be a sequence of scalars that can be used by the numpy array layer.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.units.ConversionInterface.default_units">
<em class="property">static </em><code class="descname">default_units</code><span class="sig-paren">(</span><em>x</em>, <em>axis</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/units.html#ConversionInterface.default_units"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.units.ConversionInterface.default_units" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the default unit for <em>x</em> or <code class="docutils literal notranslate"><span class="pre">None</span></code> for the given axis.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.units.ConversionInterface.is_numlike">
<em class="property">static </em><code class="descname">is_numlike</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/units.html#ConversionInterface.is_numlike"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.units.ConversionInterface.is_numlike" title="Permalink to this definition">¶</a></dt>
<dd><p>The Matplotlib datalim, autoscaling, locators etc work with scalars
which are the units converted to floats given the current unit. The
converter may be passed these floats, or arrays of them, even when
units are set.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.units.DecimalConverter">
<em class="property">class </em><code class="descclassname">matplotlib.units.</code><code class="descname">DecimalConverter</code><a class="reference internal" href="../_modules/matplotlib/units.html#DecimalConverter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.units.DecimalConverter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.units.ConversionInterface" title="matplotlib.units.ConversionInterface"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.units.ConversionInterface</span></code></a></p>
<p>Converter for decimal.Decimal data to float.</p>
<dl class="method">
<dt id="matplotlib.units.DecimalConverter.axisinfo">
<em class="property">static </em><code class="descname">axisinfo</code><span class="sig-paren">(</span><em>unit</em>, <em>axis</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/units.html#DecimalConverter.axisinfo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.units.DecimalConverter.axisinfo" title="Permalink to this definition">¶</a></dt>
<dd><p>Return an <a class="reference internal" href="#matplotlib.units.AxisInfo" title="matplotlib.units.AxisInfo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">AxisInfo</span></code></a> for the axis with the specified units.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.units.DecimalConverter.convert">
<em class="property">static </em><code class="descname">convert</code><span class="sig-paren">(</span><em>value</em>, <em>unit</em>, <em>axis</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/units.html#DecimalConverter.convert"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.units.DecimalConverter.convert" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert Decimals to floats.</p>
<p>The <em>unit</em> and <em>axis</em> arguments are not used.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>value</strong><span class="classifier">decimal.Decimal or iterable</span></dt><dd><p>Decimal or list of Decimal need to be converted</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.units.DecimalConverter.default_units">
<em class="property">static </em><code class="descname">default_units</code><span class="sig-paren">(</span><em>x</em>, <em>axis</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/units.html#DecimalConverter.default_units"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.units.DecimalConverter.default_units" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the default unit for <em>x</em> or <code class="docutils literal notranslate"><span class="pre">None</span></code> for the given axis.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.units.Registry">
<em class="property">class </em><code class="descclassname">matplotlib.units.</code><code class="descname">Registry</code><a class="reference internal" href="../_modules/matplotlib/units.html#Registry"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.units.Registry" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p>
<p>Register types with conversion interface.</p>
<dl class="method">
<dt id="matplotlib.units.Registry.get_converter">
<code class="descname">get_converter</code><span class="sig-paren">(</span><em>self</em>, <em>x</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/units.html#Registry.get_converter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.units.Registry.get_converter" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the converter interface instance for <em>x</em>, or None.</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<footer>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2020 The Matplotlib development team.
<br />
Last updated on Jul 17, 2020.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 2.2.2.
Doc version v3.3.0-3-g8994f1b60.
</div>
</footer>
</body>
</html>
You can’t perform that action at this time.