matplotlib.github.com/2.2.0/gallery/units/evans_test.html at main · matplotlib/matplotlib.github.com

History

230 lines (189 loc) · 18 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

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

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

<head>

<title>Evans test — Matplotlib 2.2.0 documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../../',

VERSION: '2.2.0',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

title="Search within Matplotlib 2.2.0 documentation"

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

</head>

<body>

<div id="unreleased-message"> You are reading an old version of the documentation (v2.2.0). For the latest version see <a href="https://matplotlib.org/stable/gallery/units/evans_test.html">https://matplotlib.org/stable/gallery/units/evans_test.html</a></div>

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 2.2.0</div>

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

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

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

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

<li><a href="../../api/pyplot_summary.html">pyplot</a>| </li>

</ul>

</div>

<h3>Related Topics</h3>

<ul>

<li><a href="../../contents.html">Documentation overview</a><ul>

</ul></li>

</ul>

</div>

<li><a href="../../_sources/gallery/units/evans_test.rst.txt"

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

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

</div>

<h1>Evans test<a class="headerlink" href="#evans-test" title="Permalink to this headline">¶</a></h1>

A mockup “Foo” units class which supports conversion and different tick

formatting depending on the “unit”. Here the “unit” is just a scalar

conversion factor, but this example shows that Matplotlib is entirely agnostic

to what kind of units client packages use.

<div class="highlight-python notranslate"><div class="highlight"><pre>from matplotlib.cbook import <a href="../../api/cbook_api.html#matplotlib.cbook.iterable" title="View documentation for matplotlib.cbook.iterable">iterable</a>

import matplotlib.units as units

import matplotlib.ticker as ticker

import matplotlib.pyplot as plt

class Foo(object):

def __init__(self, val, unit=1.0):

self.unit = unit

self._val = val * unit

def value(self, unit):

if unit is None:

unit = self.unit

return self._val / unit

class FooConverter(object):

@staticmethod

def axisinfo(unit, axis):

'return the Foo AxisInfo'

if unit == 1.0 or unit == 2.0:

return <a href="../../api/units_api.html#matplotlib.units.AxisInfo" title="View documentation for matplotlib.units.AxisInfo">units.AxisInfo</a>(

majloc=<a href="../../api/ticker_api.html#matplotlib.ticker.IndexLocator" title="View documentation for matplotlib.ticker.IndexLocator">ticker.IndexLocator</a>(8, 0),

majfmt=<a href="../../api/ticker_api.html#matplotlib.ticker.FormatStrFormatter" title="View documentation for matplotlib.ticker.FormatStrFormatter">ticker.FormatStrFormatter</a>("VAL: %s"),

label='foo',

)

else:

return None

@staticmethod

def convert(obj, unit, axis):

"""

convert obj using unit. If obj is a sequence, return the

converted sequence

"""

if <a href="../../api/units_api.html#matplotlib.units.ConversionInterface.is_numlike" title="View documentation for matplotlib.units.ConversionInterface.is_numlike">units.ConversionInterface.is_numlike</a>(obj):

return obj

if <a href="../../api/cbook_api.html#matplotlib.cbook.iterable" title="View documentation for matplotlib.cbook.iterable">iterable</a>(obj):

return [o.value(unit) for o in obj]

else:

return obj.value(unit)

@staticmethod

def default_units(x, axis):

'return the default unit for x or None'

for thisx in x:

return thisx.unit

else:

return x.unit

units.registry[Foo] = FooConverter()

# create some Foos

x = []

for val in range(0, 50, 2):

x.append(Foo(val, 1.0))

# and some arbitrary y data

y = [i for i in range(len(x))]

fig, (ax1, ax2) = <a href="../../api/_as_gen/matplotlib.pyplot.subplots.html#matplotlib.pyplot.subplots" title="View documentation for matplotlib.pyplot.subplots">plt.subplots</a>(1, 2)

fig.suptitle("Custom units")

fig.subplots_adjust(bottom=0.2)

# plot specifying units

ax2.plot(x, y, 'o', xunits=2.0)

ax2.set_title("xunits = 2.0")

<a href="../../api/_as_gen/matplotlib.pyplot.setp.html#matplotlib.pyplot.setp" title="View documentation for matplotlib.pyplot.setp">plt.setp</a>(ax2.get_xticklabels(), rotation=30, ha='right')

# plot without specifying units; will use the None branch for axisinfo

ax1.plot(x, y) # uses default units

ax1.set_title('default units')

<a href="../../api/_as_gen/matplotlib.pyplot.setp.html#matplotlib.pyplot.setp" title="View documentation for matplotlib.pyplot.setp">plt.setp</a>(ax1.get_xticklabels(), rotation=30, ha='right')

<a href="../../api/_as_gen/matplotlib.pyplot.show.html#matplotlib.pyplot.show" title="View documentation for matplotlib.pyplot.show">plt.show</a>()

</pre></div>

</div>

<a class="reference download internal" href="../../_downloads/evans_test.py" download=""><code class="xref download docutils literal notranslate">Download Python source code: evans_test.py</code></a></div>

<a class="reference download internal" href="../../_downloads/evans_test.ipynb" download=""><code class="xref download docutils literal notranslate">Download Jupyter notebook: evans_test.ipynb</code></a></div>

</div>

<a class="reference external" href="https://sphinx-gallery.readthedocs.io">Gallery generated by Sphinx-Gallery</a>

</div>

</div>

Last updated on Mar 06, 2018.

Created using <a

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

</div>

</body>

</footer>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

evans_test.html

Latest commit

History

evans_test.html

File metadata and controls