devdocs/gallery/api/custom_scale_example.html at first_commit · matplotlib/devdocs

History

493 lines (405 loc) · 34.2 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

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

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

<head>

<title>Custom scale — Matplotlib 2.0.2.post4416.dev0+g1df513f documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../../',

VERSION: '2.0.2.post4416.dev0+g1df513f',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

title="Search within Matplotlib 2.0.2.post4416.dev0+g1df513f documentation"

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

</head>

<body>

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

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

</a>

</a>

Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">

</a>

<h3>Related Topics</h3>

<ul>

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

</ul></li>

</ul>

</div>

<li><a href="../../_sources/gallery/api/custom_scale_example.rst.txt"

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

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

</div>

<h1>Custom scale<a class="headerlink" href="#custom-scale" title="Permalink to this headline">¶</a></h1>

This example showcases how to create a custom scale, by implementing the

scaling use for latitude data in a Mercator Projection.

<div class="highlight-python"><div class="highlight"><pre>from __future__ import unicode_literals

import numpy as np

from numpy import ma

from matplotlib import scale as mscale

from matplotlib import transforms as mtransforms

from matplotlib.ticker import <a href="../../api/ticker_api.html#matplotlib.ticker.Formatter" title="View documentation for matplotlib.ticker.Formatter">Formatter</a>, <a href="../../api/ticker_api.html#matplotlib.ticker.FixedLocator" title="View documentation for matplotlib.ticker.FixedLocator">FixedLocator</a>

from matplotlib import <a href="../../api/matplotlib_configuration_api.html#matplotlib.rcParams" title="View documentation for matplotlib.rcParams">rcParams</a>

# BUG: this example fails with any other setting of axisbelow

<a href="../../api/matplotlib_configuration_api.html#matplotlib.rcParams" title="View documentation for matplotlib.rcParams">rcParams</a>['axes.axisbelow'] = False

class MercatorLatitudeScale(<a href="../../api/scale_api.html#matplotlib.scale.ScaleBase" title="View documentation for matplotlib.scale.ScaleBase">mscale.ScaleBase</a>):

"""

Scales data in range -pi/2 to pi/2 (-90 to 90 degrees) using

the system used to scale latitudes in a Mercator projection.

The scale function:

ln(tan(y) + sec(y))

The inverse scale function:

atan(sinh(y))

Since the Mercator scale tends to infinity at +/- 90 degrees,

there is user-defined threshold, above and below which nothing

will be plotted. This defaults to +/- 85 degrees.

source:

http://en.wikipedia.org/wiki/Mercator_projection

"""

# The scale class must have a member ``name`` that defines the

# string used to select the scale. For example,

# ``gca().set_yscale("mercator")`` would be used to select this

# scale.

name = 'mercator'

def __init__(self, axis, **kwargs):

"""

Any keyword arguments passed to ``set_xscale`` and

``set_yscale`` will be passed along to the scale's

constructor.

thresh: The degree above which to crop the data.

"""

<a href="../../api/scale_api.html#matplotlib.scale.ScaleBase" title="View documentation for matplotlib.scale.ScaleBase">mscale.ScaleBase</a>.__init__(self)

thresh = kwargs.pop("thresh", np.radians(85))

if thresh >= np.pi / 2.0:

raise ValueError("thresh must be less than pi/2")

self.thresh = thresh

def get_transform(self):

"""

Override this method to return a new instance that does the

actual transformation of the data.

The MercatorLatitudeTransform class is defined below as a

nested class of this one.

"""

return self.MercatorLatitudeTransform(self.thresh)

def set_default_locators_and_formatters(self, axis):

"""

Override to set up the locators and formatters to use with the

scale. This is only required if the scale requires custom

locators and formatters. Writing custom locators and

formatters is rather outside the scope of this example, but

there are many helpful examples in ``ticker.py``.

In our case, the Mercator example uses a fixed locator from

-90 to 90 degrees and a custom formatter class to put convert

the radians to degrees and put a degree symbol after the

value::

"""

class DegreeFormatter(<a href="../../api/ticker_api.html#matplotlib.ticker.Formatter" title="View documentation for matplotlib.ticker.Formatter">Formatter</a>):

def __call__(self, x, pos=None):

return "%d\N{DEGREE SIGN}" % np.degrees(x)

axis.set_major_locator(<a href="../../api/ticker_api.html#matplotlib.ticker.FixedLocator" title="View documentation for matplotlib.ticker.FixedLocator">FixedLocator</a>(

np.radians(np.arange(-90, 90, 10))))

axis.set_major_formatter(DegreeFormatter())

axis.set_minor_formatter(DegreeFormatter())

def limit_range_for_scale(self, vmin, vmax, minpos):

"""

Override to limit the bounds of the axis to the domain of the

transform. In the case of Mercator, the bounds should be

limited to the threshold that was passed in. Unlike the

autoscaling provided by the tick locators, this range limiting

will always be adhered to, whether the axis range is set

manually, determined automatically or changed through panning

and zooming.

"""

return max(vmin, -self.thresh), min(vmax, self.thresh)

class MercatorLatitudeTransform(<a href="../../api/transformations.html#matplotlib.transforms.Transform" title="View documentation for matplotlib.transforms.Transform">mtransforms.Transform</a>):

# There are two value members that must be defined.

# ``input_dims`` and ``output_dims`` specify number of input

# dimensions and output dimensions to the transformation.

# These are used by the transformation framework to do some

# error checking and prevent incompatible transformations from

# being connected together. When defining transforms for a

# scale, which are, by definition, separable and have only one

# dimension, these members should always be set to 1.

input_dims = 1

output_dims = 1

is_separable = True

has_inverse = True

def __init__(self, thresh):

<a href="../../api/transformations.html#matplotlib.transforms.Transform" title="View documentation for matplotlib.transforms.Transform">mtransforms.Transform</a>.__init__(self)

self.thresh = thresh

def transform_non_affine(self, a):

"""

This transform takes an Nx1 ``numpy`` array and returns a

transformed copy. Since the range of the Mercator scale

is limited by the user-specified threshold, the input

array must be masked to contain only valid values.

``matplotlib`` will handle masked arrays and remove the

out-of-range data from the plot. Importantly, the

``transform`` method *must* return an array that is the

same shape as the input array, since these values need to

remain synchronized with values in the other dimension.

"""

masked = ma.masked_where((a < -self.thresh) | (a > self.thresh), a)

if masked.mask.any():

return ma.log(np.abs(ma.tan(masked) + 1.0 / ma.cos(masked)))

else:

return np.log(np.abs(np.tan(a) + 1.0 / np.cos(a)))

def inverted(self):

"""

Override this method so matplotlib knows how to get the

inverse transform for this transform.

"""

return MercatorLatitudeScale.InvertedMercatorLatitudeTransform(

self.thresh)

class InvertedMercatorLatitudeTransform(<a href="../../api/transformations.html#matplotlib.transforms.Transform" title="View documentation for matplotlib.transforms.Transform">mtransforms.Transform</a>):

input_dims = 1

output_dims = 1

is_separable = True

has_inverse = True

def __init__(self, thresh):

self.thresh = thresh

def transform_non_affine(self, a):

return np.arctan(np.sinh(a))

def inverted(self):

return MercatorLatitudeScale.MercatorLatitudeTransform(self.thresh)

# Now that the Scale class has been defined, it must be registered so

# that ``matplotlib`` can find it.

<a href="../../api/scale_api.html#matplotlib.scale.register_scale" title="View documentation for matplotlib.scale.register_scale">mscale.register_scale</a>(MercatorLatitudeScale)

if __name__ == '__main__':

import matplotlib.pyplot as plt

t = np.arange(-180.0, 180.0, 0.1)

s = np.radians(t)/2.

<a href="../../api/_as_gen/matplotlib.pyplot.plot.html#matplotlib.pyplot.plot" title="View documentation for matplotlib.pyplot.plot">plt.plot</a>(t, s, '-', lw=2)

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

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

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

<a href="../../api/_as_gen/matplotlib.pyplot.title.html#matplotlib.pyplot.title" title="View documentation for matplotlib.pyplot.title">plt.title</a>('Mercator: Projection of the Oppressor')

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

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

Total running time of the script: ( 0 minutes 0.034 seconds)

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

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

</div>

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

</div>

</div>

Last updated on Jul 16, 2017.

Created using <a

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

</div>

(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){

(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),

m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)

})(window,document,'script','//www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-55954603-1', 'auto');

ga('send', 'pageview');

</script>

</body>

<!--Flipcause Integration v3.0// Flipcause Integration Instructions:

Install the following code block once in the website Header (after <head> tag) -->

<style>

.fc-black_overlay{

display:none; position: fixed; z-index:1000001; top: 0%;left: 0%;width: 100%;height: 100%;

background-color: black; filter: alpha(opacity=50); cursor:pointer; opacity:0.5;

}

.fc-white_content {

opacity:1; display:none; margin-top: -320px; margin-left: -485px; width:970px; height:640px;

position:fixed; top:50%; left:50%; border: none;z-index:1000002;overflow: auto;

}

.fc-main-box{

opacity:1; display:none; margin:15px auto 0 auto; width:930px; position:relative; z-index:1000003;

}

.fc-widget_close{

opacity:1; content:url(http://i1338.photobucket.com/albums/o691/WeCause/X_zpse4a7e538.png);

position:absolute; z-index=1000004; right:-16px; top:-16px; display:block; cursor:pointer;

}

.floating_button{

display: block; margin-top: 0px; margin-left: 0px; width:auto ; height: auto;

position:fixed; z-index:999999; overflow: auto;

}

@keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-moz-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-webkit-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-o-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-ms-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; transform: translateY(20px);}

100% {opacity: 1; transform: translateY(0);}

}

@-moz-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -moz-transform: translateY(20px);}

100% {opacity: 1; -moz-transform: translateY(0);}

}

@-webkit-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -webkit-transform: translateY(20px);}

100% {opacity: 1; -webkit-transform: translateY(0);}

}

@-o-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -o-transform: translateY(20px);}

100% {opacity: 1; -o-transform: translateY(0);}

}

@-ms-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -ms-transform: translateY(20px);}

100% {opacity: 1; -ms-transform: translateY(0);}

}

</style>

function open_window(cause_id) {

var protocol=String(document.location.protocol);

var new_url;

if( /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent)){

new_url="https://www.flipcause.com/widget/"+cause_id

window.open(new_url);

}

else {

document.getElementById("fc-fade").style.display = "block";

document.getElementById("fc-fade").style.webkitAnimation = "backfadesin 1s";

document.getElementById("fc-fade").style.animation = "backfadesin 1s";

document.getElementById("fc-fade").style.mozAnimation = "backfadesin 1s";

document.getElementById("fc-light").style.display = "block";

document.getElementById("fc-light").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-light").style.animation = "fadesin 1.5s";

document.getElementById("fc-light").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-main").style.display = "block";

document.getElementById("fc-main").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-main").style.animation = "fadesin 1.5s";

document.getElementById("fc-main").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-close").style.display = "block";

document.getElementById("fc-close").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-close").style.animation = "fadesin 1.5s";

document.getElementById("fc-close").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-myFrame").style.display = "block";

document.getElementById("fc-myFrame").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-myFrame").style.animation = "fadesin 1.5s";

document.getElementById("fc-myFrame").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-myFrame").src="https://www.flipcause.com/widget/"+cause_id;

}

function close_window() {

document.getElementById("fc-fade").style.display="none";

document.getElementById("fc-light").style.display="none";

document.getElementById("fc-main").style.display="none";

document.getElementById("fc-close").style.display="none";

document.getElementById("fc-myFrame").style.display="none";

}

</script>

</div><iframe id="fc-myFrame" iframe height="580" width="925" style="border: 0;

border-radius:5px 5px 5px 5px; box-shadow:0 0 8px rgba(0, 0, 0, 0.5);" scrolling="no" src=""></iframe></div>

</div>

</footer>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

custom_scale_example.html

Latest commit

History

custom_scale_example.html

File metadata and controls