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

History

503 lines (406 loc) · 63.3 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

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

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

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

<head>

<title>Basic Units — 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/basic_units.html">https://matplotlib.org/stable/gallery/units/basic_units.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/basic_units.rst.txt"

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

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

</div>

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

<div class="highlight-python notranslate"><div class="highlight"><pre>import six

import math

import numpy as np

import matplotlib.units as units

import matplotlib.ticker as ticker

from matplotlib.axes import Axes

from matplotlib.cbook import <a href="../../api/cbook_api.html#matplotlib.cbook.iterable" title="View documentation for matplotlib.cbook.iterable">iterable</a>

class ProxyDelegate(object):

def __init__(self, fn_name, proxy_type):

self.proxy_type = proxy_type

self.fn_name = fn_name

def __get__(self, obj, objtype=None):

return self.proxy_type(self.fn_name, obj)

class TaggedValueMeta(type):

def __init__(cls, name, bases, dict):

for fn_name in cls._proxies:

try:

dummy = getattr(cls, fn_name)

except AttributeError:

setattr(cls, fn_name,

ProxyDelegate(fn_name, cls._proxies[fn_name]))

class PassThroughProxy(object):

self.fn_name = fn_name

self.target = obj.proxy_target

def __call__(self, *args):

fn = getattr(self.target, self.fn_name)

ret = fn(*args)

return ret

class ConvertArgsProxy(PassThroughProxy):

PassThroughProxy.__init__(self, fn_name, obj)

self.unit = obj.unit

converted_args = []

for a in args:

try:

converted_args.append(a.convert_to(self.unit))

except AttributeError:

converted_args.append(TaggedValue(a, self.unit))

converted_args = tuple([c.get_value() for c in converted_args])

return PassThroughProxy.__call__(self, *converted_args)

class ConvertReturnProxy(PassThroughProxy):

self.unit = obj.unit

ret = PassThroughProxy.__call__(self, *args)

return (NotImplemented if ret is NotImplemented

else TaggedValue(ret, self.unit))

class ConvertAllProxy(PassThroughProxy):

self.unit = obj.unit

converted_args = []

arg_units = [self.unit]

for a in args:

if hasattr(a, 'get_unit') and not hasattr(a, 'convert_to'):

# if this arg has a unit type but no conversion ability,

# this operation is prohibited

return NotImplemented

if hasattr(a, 'convert_to'):

try:

a = a.convert_to(self.unit)

except:

pass

arg_units.append(a.get_unit())

else:

converted_args.append(a)

if hasattr(a, 'get_unit'):

else:

arg_units.append(None)

converted_args = tuple(converted_args)

if ret is NotImplemented:

return NotImplemented

ret_unit = unit_resolver(self.fn_name, arg_units)

if ret_unit is NotImplemented:

return NotImplemented

return TaggedValue(ret, ret_unit)

class TaggedValue(six.with_metaclass(TaggedValueMeta)):

_proxies = {'__add__': ConvertAllProxy,

'__sub__': ConvertAllProxy,

'__mul__': ConvertAllProxy,

'__rmul__': ConvertAllProxy,

'__cmp__': ConvertAllProxy,

'__lt__': ConvertAllProxy,

'__gt__': ConvertAllProxy,

'__len__': PassThroughProxy}

def __new__(cls, value, unit):

# generate a new subclass for value

value_class = type(value)

try:

subcls = type('TaggedValue_of_%s' % (value_class.__name__),

tuple([cls, value_class]),

{})

if subcls not in <a href="../../api/units_api.html#module-matplotlib.units" title="View documentation for matplotlib.units">units</a>.registry:

<a href="../../api/units_api.html#module-matplotlib.units" title="View documentation for matplotlib.units">units</a>.registry[subcls] = basicConverter

return object.__new__(subcls)

except TypeError:

if cls not in <a href="../../api/units_api.html#module-matplotlib.units" title="View documentation for matplotlib.units">units</a>.registry:

<a href="../../api/units_api.html#module-matplotlib.units" title="View documentation for matplotlib.units">units</a>.registry[cls] = basicConverter

return object.__new__(cls)

def __init__(self, value, unit):

self.value = value

self.unit = unit

self.proxy_target = self.value

def __getattribute__(self, name):

if name.startswith('__'):

return object.__getattribute__(self, name)

variable = object.__getattribute__(self, 'value')

if hasattr(variable, name) and name not in self.__class__.__dict__:

return getattr(variable, name)

def __array__(self, dtype=object):

return <a href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.asarray.html#numpy.asarray" title="View documentation for numpy.asarray">np.asarray</a>(self.value).astype(dtype)

def __array_wrap__(self, array, context):

return TaggedValue(array, self.unit)

def __repr__(self):

return 'TaggedValue(' + repr(self.value) + ', ' + repr(self.unit) + ')'

def __str__(self):

return str(self.value) + ' in ' + str(self.unit)

def __len__(self):

return len(self.value)

def __iter__(self):

# Return a generator expression rather than use `yield`, so that

# TypeError is raised by iter(self) if appropriate when checking for

# iterability.

return (TaggedValue(inner, self.unit) for inner in self.value)

def get_compressed_copy(self, mask):

new_value = <a href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.ma.masked_array.html#numpy.ma.masked_array" title="View documentation for numpy.ma.masked_array">np.ma.masked_array</a>(self.value, mask=mask).compressed()

return TaggedValue(new_value, self.unit)

def convert_to(self, unit):

if unit == self.unit or not unit:

return self

new_value = self.unit.convert_value_to(self.value, unit)

return TaggedValue(new_value, unit)

def get_value(self):

return self.value

def get_unit(self):

return self.unit

class BasicUnit(object):

def __init__(self, name, fullname=None):

self.name = name

if fullname is None:

fullname = name

self.fullname = fullname

self.conversions = dict()

def __repr__(self):

return 'BasicUnit(%s)' % self.name

def __str__(self):

return self.fullname

def __call__(self, value):

return TaggedValue(value, self)

def __mul__(self, rhs):

value = rhs

unit = self

if hasattr(rhs, 'get_unit'):

value = rhs.get_value()

unit = rhs.get_unit()

unit = unit_resolver('__mul__', (self, unit))

if unit is NotImplemented:

return NotImplemented

return TaggedValue(value, unit)

def __rmul__(self, lhs):

return self*lhs

return TaggedValue(array, self)

def __array__(self, t=None, context=None):

ret = <a href="https://docs.scipy.org/doc/numpy/reference/generated/numpy.array.html#numpy.array" title="View documentation for numpy.array">np.array</a>([1])

if t is not None:

return ret.astype(t)

else:

return ret

def add_conversion_factor(self, unit, factor):

def convert(x):

return x*factor

self.conversions[unit] = convert

def add_conversion_fn(self, unit, fn):

def get_conversion_fn(self, unit):

return self.conversions[unit]

def convert_value_to(self, value, unit):

conversion_fn = self.conversions[unit]

ret = conversion_fn(value)

return ret

def get_unit(self):

return self

class UnitResolver(object):

def addition_rule(self, <a href="../../api/units_api.html#module-matplotlib.units" title="View documentation for matplotlib.units">units</a>):

for unit_1, unit_2 in zip(<a href="../../api/units_api.html#module-matplotlib.units" title="View documentation for matplotlib.units">units</a>[:-1], <a href="../../api/units_api.html#module-matplotlib.units" title="View documentation for matplotlib.units">units</a>[1:]):

if (unit_1 != unit_2):

return NotImplemented

return <a href="../../api/units_api.html#module-matplotlib.units" title="View documentation for matplotlib.units">units</a>[0]

def multiplication_rule(self, <a href="../../api/units_api.html#module-matplotlib.units" title="View documentation for matplotlib.units">units</a>):

non_null = [u for u in <a href="../../api/units_api.html#module-matplotlib.units" title="View documentation for matplotlib.units">units</a> if u]

if (len(non_null) > 1):

return NotImplemented

return non_null[0]

op_dict = {

'__mul__': multiplication_rule,

'__rmul__': multiplication_rule,

'__add__': addition_rule,

'__radd__': addition_rule,

'__sub__': addition_rule,

'__rsub__': addition_rule}

def __call__(self, operation, <a href="../../api/units_api.html#module-matplotlib.units" title="View documentation for matplotlib.units">units</a>):

if (operation not in self.op_dict):

return NotImplemented

return self.op_dict[operation](self, <a href="../../api/units_api.html#module-matplotlib.units" title="View documentation for matplotlib.units">units</a>)

unit_resolver = UnitResolver()

cm = BasicUnit('cm', 'centimeters')

inch = BasicUnit('inch', 'inches')

inch.add_conversion_factor(cm, 2.54)

cm.add_conversion_factor(inch, 1/2.54)

radians = BasicUnit('rad', 'radians')

degrees = BasicUnit('deg', 'degrees')

radians.add_conversion_factor(degrees, 180.0/np.pi)

degrees.add_conversion_factor(radians, np.pi/180.0)

secs = BasicUnit('s', 'seconds')

hertz = BasicUnit('Hz', 'Hertz')

minutes = BasicUnit('min', 'minutes')

secs.add_conversion_fn(hertz, lambda x: 1./x)

secs.add_conversion_factor(minutes, 1/60.0)

# radians formatting

def rad_fn(x, pos=None):

n = int((x / np.pi) * 2.0 + 0.25)

if n == 0:

return '0'

elif n == 1:

return r'$\pi/2$'

elif n == 2:

return r'$\pi$'

elif n % 2 == 0:

return r'$%s\pi$' % (n//2,)

else:

return r'$%s\pi/2$' % (n,)

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

@staticmethod

def axisinfo(unit, axis):

'return AxisInfo instance for x and unit'

if unit == radians:

majloc=<a href="../../api/ticker_api.html#matplotlib.ticker.MultipleLocator" title="View documentation for matplotlib.ticker.MultipleLocator">ticker.MultipleLocator</a>(base=np.pi/2),

majfmt=<a href="../../api/ticker_api.html#matplotlib.ticker.FuncFormatter" title="View documentation for matplotlib.ticker.FuncFormatter">ticker.FuncFormatter</a>(rad_fn),

label=unit.fullname,

)

elif unit == degrees:

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

majfmt=<a href="../../api/ticker_api.html#matplotlib.ticker.FormatStrFormatter" title="View documentation for matplotlib.ticker.FormatStrFormatter">ticker.FormatStrFormatter</a>(r'$%i^\circ$'),

label=unit.fullname,

)

elif unit is not None:

if hasattr(unit, 'fullname'):

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

elif hasattr(unit, 'unit'):

return None

@staticmethod

def convert(val, unit, axis):

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>(val):

return val

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

return [thisval.convert_to(unit).get_value() for thisval in val]

else:

return val.convert_to(unit).get_value()

@staticmethod

def default_units(x, axis):

'return the default unit for x or None'

for thisx in x:

return thisx.unit

return x.unit

def cos(x):

return [math.cos(val.convert_to(radians).get_value()) for val in x]

else:

return math.cos(x.convert_to(radians).get_value())

basicConverter = BasicUnitConverter()

<a href="../../api/units_api.html#module-matplotlib.units" title="View documentation for matplotlib.units">units</a>.registry[BasicUnit] = basicConverter

<a href="../../api/units_api.html#module-matplotlib.units" title="View documentation for matplotlib.units">units</a>.registry[TaggedValue] = basicConverter

</pre></div>

</div>

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

<a class="reference download internal" href="../../_downloads/basic_units.ipynb" download=""><code class="xref download docutils literal notranslate">Download Jupyter notebook: basic_units.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

basic_units.html

Latest commit

History

basic_units.html

File metadata and controls