matplotlib.github.com/1.2.1/api/units_api.html at master · Redwa/matplotlib.github.com · GitHub

History

285 lines (255 loc) · 15.6 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

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

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

<head>

<title>units — Matplotlib 1.2.1 documentation</title>

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '1.2.1',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true

};

</script>

title="Search within Matplotlib 1.2.1 documentation"

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

</head>

<body>

if ("matplotlib.sourceforge.net" == document.location.hostname ||

"matplotlib.sf.net" == document.location.hostname) {

var pkBaseURL = (("https:" == document.location.protocol) ? "https://apps.sourceforge.net/piwik/matplotlib/" : "http://apps.sourceforge.net/piwik/matplotlib/");

document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));

}

</script>

if ("matplotlib.sourceforge.net" == document.location.hostname ||

"matplotlib.sf.net" == document.location.hostname) {

piwik_action_name = '';

piwik_idsite = 1;

piwik_url = pkBaseURL + "piwik.php";

piwik_log(piwik_action_name, piwik_idsite, piwik_url);

document.write(unescape('%3Cobject%3E%3Cnoscript%3E%3Cp%3E%3Cimg src="http://apps.sourceforge.net/piwik/matplotlib/piwik.php?idsite=1" alt="piwik"/%3E%3C/p%3E%3C/noscript%3E%3C/object%3E'));

}

</script>

</map>

</div>

<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="widgets"

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

<a href="tight_layout_api.html" title="tight_layout"

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

<li><a href="http://www.matplotlib.org/downloads.html">downloads</a>| </li>

<li><a href="../search.html">search</a>| </li>

<li><a href="../examples/index.html">examples</a>| </li>

<li><a href="../gallery.html">gallery</a>| </li>

<li><a href="../citing.html">citation</a>| </li>

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

</ul>

</div>

<h3><a href="../contents.html">Table Of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#">units</a><ul>

<li><a class="reference internal" href="#module-matplotlib.units"><tt class="docutils literal"><span class="pre">matplotlib.units</span></tt></a></li>

</ul>

</li>

</ul>

<h4>Previous topic</h4>

<p class="topless"><a href="tight_layout_api.html"

title="previous chapter">tight_layout</a></p>

<h4>Next topic</h4>

<p class="topless"><a href="widgets_api.html"

title="next chapter">widgets</a></p>

<li><a href="../_sources/api/units_api.txt"

rel="nofollow">Show Source</a></li>

</ul>

<h3>Quick search</h3>

</form>

Enter search terms or a module, class or function name.

</p>

</div>

</div>

<h1>units<a class="headerlink" href="#units" title="Permalink to this headline">¶</a></h1>

<span id="matplotlib-units"></span><h2><a class="reference internal" href="#module-matplotlib.units" title="matplotlib.units"><tt class="xref py py-mod docutils literal"><span class="pre">matplotlib.units</span></tt></a><a class="headerlink" href="#module-matplotlib.units" title="Permalink to this headline">¶</a></h2>

<p>The classes here provide support for using custom classes with

matplotlib, eg those that do not expose the array interface but know

how to converter themselves to arrays. It also supoprts classes with

units and units conversion. Use cases include converters for custom

objects, eg 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 a ConversionInterface, and

the register with the Registry converter dictionary. For example,

here is a complete implementation which supports plotting with native

datetime objects:</p>

<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">matplotlib.units</span> <span class="kn">as</span> <span class="nn">units</span>

<span class="kn">import</span> <span class="nn">matplotlib.dates</span> <span class="kn">as</span> <span class="nn">dates</span>

<span class="kn">import</span> <span class="nn">matplotlib.ticker</span> <span class="kn">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="s">'convert 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="s">'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="s">'date'</span><span class="p">:</span> <span class="k">return</span> <span class="bp">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="s">'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="s">'return the default unit for x or None'</span>

<span class="k">return</span> <span class="s">'date'</span>

<span class="c"># finally we register our object type with a converter</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>

<em class="property">class </em><tt class="descclassname">matplotlib.units.</tt><tt class="descname">AxisInfo</tt><big>(</big><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><big>)</big><a class="headerlink" href="#matplotlib.units.AxisInfo" title="Permalink to this definition">¶</a></dt>

<dd><p>information to support default axis labeling and tick labeling, and default limits</p>

<p>majloc and minloc: TickLocators for the major and minor ticks

majfmt and minfmt: TickFormatters for the major and minor ticks

label: the default axis label

default_limits: the default min, max of the axis if no data is present

If any of the above are None, the axis will simply use the default</p>

</dd></dl>

<em class="property">class </em><tt class="descclassname">matplotlib.units.</tt><tt class="descname">ConversionInterface</tt><a class="headerlink" href="#matplotlib.units.ConversionInterface" title="Permalink to this definition">¶</a></dt>

<dd><p>The minimal interface for a converter to take custom instances (or

sequences) and convert them to values mpl can use</p>

<em class="property">static </em><tt class="descname">axisinfo</tt><big>(</big><em>unit</em>, <em>axis</em><big>)</big><a class="headerlink" href="#matplotlib.units.ConversionInterface.axisinfo" title="Permalink to this definition">¶</a></dt>

<dd><p>return an units.AxisInfo instance for axis with the specified units</p>

</dd></dl>

<em class="property">static </em><tt class="descname">convert</tt><big>(</big><em>obj</em>, <em>unit</em>, <em>axis</em><big>)</big><a class="headerlink" href="#matplotlib.units.ConversionInterface.convert" title="Permalink to this definition">¶</a></dt>

<dd><p>convert obj using unit for the specified axis. If obj is a sequence,

return the converted sequence. The ouput must be a sequence of scalars

that can be used by the numpy array layer</p>

</dd></dl>

<em class="property">static </em><tt class="descname">default_units</tt><big>(</big><em>x</em>, <em>axis</em><big>)</big><a class="headerlink" href="#matplotlib.units.ConversionInterface.default_units" title="Permalink to this definition">¶</a></dt>

<dd><p>return the default unit for x or None for the given axis</p>

</dd></dl>

<em class="property">static </em><tt class="descname">is_numlike</tt><big>(</big><em>x</em><big>)</big><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. Derived conversion

interfaces may opt to pass plain-ol unitless numbers through

the conversion interface and this is a helper function for

them.</p>

</dd></dl>

<em class="property">class </em><tt class="descclassname">matplotlib.units.</tt><tt class="descname">Registry</tt><a class="headerlink" href="#matplotlib.units.Registry" title="Permalink to this definition">¶</a></dt>

<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt></p>

<p>register types with conversion interface</p>

<tt class="descname">get_converter</tt><big>(</big><em>x</em><big>)</big><a class="headerlink" href="#matplotlib.units.Registry.get_converter" title="Permalink to this definition">¶</a></dt>

<dd><p>get the converter interface instance for x, or None</p>

</dd></dl>

</div>

</div>

<h3>Navigation</h3>

<ul>

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

>index</a></li>

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

>modules</a> |</li>

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

>next</a> |</li>

<a href="tight_layout_api.html" title="tight_layout"

>previous</a> |</li>

<li><a href="http://www.matplotlib.org/downloads.html">downloads</a>| </li>

<li><a href="../search.html">search</a>| </li>

<li><a href="../examples/index.html">examples</a>| </li>

<li><a href="../gallery.html">gallery</a>| </li>

<li><a href="../citing.html">citation</a>| </li>

<li><a href="index.html" >The Matplotlib API</a> »</li>

</ul>

</div>

Last updated on May 29, 2013.

Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1.

</div>

</body>

</html>

matplotlib.github.com/1.2.1/api/units_api.html at master · Redwa/matplotlib.github.com · GitHub

Expand file tree

Breadcrumbs

units_api.html

Latest commit

History

Breadcrumbs

units_api.html

File metadata and controls