matplotlib.github.com/3.1.1/api/units_api.html at main · matplotlib/matplotlib.github.com

History

290 lines (248 loc) · 19.1 KB

Raw

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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>matplotlib.units — Matplotlib 3.1.2 documentation</title>

type="text/css" />

type="text/css" />

title="Search within Matplotlib 3.1.2 documentation"

href="../_static/opensearch.xml"/>

</head>

<body>

<div id="unreleased-message"> You are reading an old version of the documentation (v3.1.1). 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 style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 3.1.2</div>

<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>

</div>

<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>

</ul>

</nav>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="widgets_api.html" title="matplotlib.widgets"

accesskey="N">next</a> |</li>

<a href="type1font.html" title="matplotlib.type1font"

accesskey="P">previous</a> |</li>

<li><a href="../contents.html">contents</a> »</li>

<li><a href="index.html" accesskey="U">API Overview</a> »</li>

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

<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">matplotlib.type1font</code></a></li>

<li>Next: <a href="widgets_api.html" title="next chapter"><code class="docutils literal notranslate">matplotlib.widgets</code></a></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>

<h1><code class="docutils literal notranslate">matplotlib.units</code><a class="headerlink" href="#module-matplotlib.units" title="Permalink to this headline">¶</a></h1>

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">ConversionInterface</code></a>. For example,

here is a complete implementation which supports plotting with native

datetime objects:

<div class="highlight-default notranslate"><div class="highlight"><pre>import matplotlib.units as units

import matplotlib.dates as dates

import matplotlib.ticker as ticker

import datetime

class DateConverter(units.ConversionInterface):

@staticmethod

def convert(value, unit, axis):

'Convert a datetime value to a scalar or array'

return dates.date2num(value)

@staticmethod

def axisinfo(unit, axis):

'Return major and minor tick locators and formatters'

if unit!='date': return None

majloc = dates.AutoDateLocator()

majfmt = dates.AutoDateFormatter(majloc)

return AxisInfo(majloc=majloc,

majfmt=majfmt,

label='date')

@staticmethod

def default_units(x, axis):

'Return the default unit for x or None'

return 'date'

# Finally we register our object type with the Matplotlib units registry.

units.registry[datetime.date] = DateConverter()

</pre></div>

</div>

class <code class="descclassname">matplotlib.units.</code><code class="descname">AxisInfo</code>(majloc=None, minloc=None, majfmt=None, minfmt=None, label=None, default_limits=None)<a class="reference internal" href="../_modules/matplotlib/units.html#AxisInfo">[source]</a><a class="headerlink" href="#matplotlib.units.AxisInfo" title="Permalink to this definition">¶</a></dt>

<dd>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">object</code></a>

Information to support default axis labeling, tick labeling, and limits.

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">ConversionInterface.axisinfo</code></a>.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>majloc, minloc : Locator, optional</dt>

<dd>Tick locators for the major and minor ticks.

</dd>

<dt>majfmt, minfmt : Formatter, optional</dt>

<dd>Tick formatters for the major and minor ticks.

</dd>

<dt>label : str, optional</dt>

<dd>The default axis label.

</dd>

<dt>default_limits : optional</dt>

<dd>The default min and max limits of the axis if no data has

been plotted.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

Notes

If any of the above are <code class="docutils literal notranslate">None</code>, the axis will simply use the

default value.

</dd></dl>

exception <code class="descclassname">matplotlib.units.</code><code class="descname">ConversionError</code><a class="reference internal" href="../_modules/matplotlib/units.html#ConversionError">[source]</a><a class="headerlink" href="#matplotlib.units.ConversionError" title="Permalink to this definition">¶</a></dt>

<dd>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">TypeError</code></a>

</dd></dl>

class <code class="descclassname">matplotlib.units.</code><code class="descname">ConversionInterface</code><a class="reference internal" href="../_modules/matplotlib/units.html#ConversionInterface">[source]</a><a class="headerlink" href="#matplotlib.units.ConversionInterface" title="Permalink to this definition">¶</a></dt>

The minimal interface for a converter to take custom data types (or

sequences) and convert them to values Matplotlib can use.

static <code class="descname">axisinfo</code>(unit, axis)<a class="reference internal" href="../_modules/matplotlib/units.html#ConversionInterface.axisinfo">[source]</a><a class="headerlink" href="#matplotlib.units.ConversionInterface.axisinfo" title="Permalink to this definition">¶</a></dt>

<dd>Return an <code class="xref py py-obj docutils literal notranslate">AxisInfo</code> for the axis with the specified units.

</dd></dl>

static <code class="descname">convert</code>(obj, unit, axis)<a class="reference internal" href="../_modules/matplotlib/units.html#ConversionInterface.convert">[source]</a><a class="headerlink" href="#matplotlib.units.ConversionInterface.convert" title="Permalink to this definition">¶</a></dt>

<dd>Convert obj using unit for the specified axis.

If obj is a sequence, return the converted sequence. The output must

be a sequence of scalars that can be used by the numpy array layer.

</dd></dl>

static <code class="descname">default_units</code>(x, axis)<a class="reference internal" href="../_modules/matplotlib/units.html#ConversionInterface.default_units">[source]</a><a class="headerlink" href="#matplotlib.units.ConversionInterface.default_units" title="Permalink to this definition">¶</a></dt>

<dd>Return the default unit for x or <code class="docutils literal notranslate">None</code> for the given axis.

</dd></dl>

static <code class="descname">is_numlike</code>(x)<a class="reference internal" href="../_modules/matplotlib/units.html#ConversionInterface.is_numlike">[source]</a><a class="headerlink" href="#matplotlib.units.ConversionInterface.is_numlike" title="Permalink to this definition">¶</a></dt>

<dd>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.

</dd></dl>

class <code class="descclassname">matplotlib.units.</code><code class="descname">Registry</code><a class="reference internal" href="../_modules/matplotlib/units.html#Registry">[source]</a><a class="headerlink" href="#matplotlib.units.Registry" title="Permalink to this definition">¶</a></dt>

<dd>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">dict</code></a>

Register types with conversion interface.

<code class="descname">get_converter</code>(self, x)<a class="reference internal" href="../_modules/matplotlib/units.html#Registry.get_converter">[source]</a><a class="headerlink" href="#matplotlib.units.Registry.get_converter" title="Permalink to this definition">¶</a></dt>

<dd>Get the converter interface instance for x, or None.

</dd></dl>

</div>

</div>

Last updated on Jan 05, 2020.

Created using

<a href="http://sphinx-doc.org/">Sphinx</a> 1.8.5.

Doc version v3.1.1-79-g90d53b526.

</div>

</body>

</footer>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

units_api.html

Latest commit

History

units_api.html

File metadata and controls