Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathcm.html
More file actions
636 lines (523 loc) · 61.8 KB
/
Copy pathcm.html
File metadata and controls
636 lines (523 loc) · 61.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>matplotlib.cm — Matplotlib 3.4.2 documentation</title>
<link rel="stylesheet" href="../../_static/mpl.css?v3.4.2-2-gf801f04d09-dirty" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../_static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../../_static/gallery.css" />
<link rel="stylesheet" type="text/css" href="../../_static/gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="../../_static/gallery-dataframe.css" />
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/language_data.js"></script>
<script src="../../_static/clipboard.min.js"></script>
<script src="../../_static/copybutton.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.4.2 documentation"
href="../../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="top" title="Matplotlib 3.4.2 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/3.4.3/_modules/matplotlib/cm.html" />
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head><body>
<div id="unreleased-message"> You are reading an old version of the documentation (v3.4.2). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</a> </div>
<!--
<div id="annc-banner">
</div>
-->
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 3.4.2</span></div>
<img src="../../_static/logo2_compressed.svg" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<nav class="main-nav">
<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>
<li class="nav-right">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" placeholder="Search"/>
</form>
</li>
</ul>
</nav>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../index.html">home</a>| </li>
<li><a href="../../contents.html">contents</a> »</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li>
<li class="nav-item nav-item-2"><a href="../matplotlib.html" accesskey="U">matplotlib</a> »</li>
<li class="nav-item nav-item-this"><a href="">matplotlib.cm</a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for matplotlib.cm</h1><div class="highlight"><pre>
<span></span><span class="sd">"""</span>
<span class="sd">Builtin colormaps, colormap handling utilities, and the `ScalarMappable` mixin.</span>
<span class="sd">.. seealso::</span>
<span class="sd"> :doc:`/gallery/color/colormap_reference` for a list of builtin colormaps.</span>
<span class="sd"> :doc:`/tutorials/colors/colormap-manipulation` for examples of how to</span>
<span class="sd"> make colormaps.</span>
<span class="sd"> :doc:`/tutorials/colors/colormaps` an in-depth discussion of</span>
<span class="sd"> choosing colormaps.</span>
<span class="sd"> :doc:`/tutorials/colors/colormapnorms` for more details about data</span>
<span class="sd"> normalization.</span>
<span class="sd">"""</span>
<span class="kn">from</span> <span class="nn">collections.abc</span> <span class="kn">import</span> <span class="n">MutableMapping</span>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">from</span> <span class="nn">numpy</span> <span class="kn">import</span> <span class="n">ma</span>
<span class="kn">import</span> <span class="nn">matplotlib</span> <span class="k">as</span> <span class="nn">mpl</span>
<span class="kn">from</span> <span class="nn">matplotlib</span> <span class="kn">import</span> <span class="n">_api</span><span class="p">,</span> <span class="n">colors</span><span class="p">,</span> <span class="n">cbook</span>
<span class="kn">from</span> <span class="nn">matplotlib._cm</span> <span class="kn">import</span> <span class="n">datad</span>
<span class="kn">from</span> <span class="nn">matplotlib._cm_listed</span> <span class="kn">import</span> <span class="n">cmaps</span> <span class="k">as</span> <span class="n">cmaps_listed</span>
<span class="n">LUTSIZE</span> <span class="o">=</span> <span class="n">mpl</span><span class="o">.</span><span class="n">rcParams</span><span class="p">[</span><span class="s1">'image.lut'</span><span class="p">]</span>
<span class="k">def</span> <span class="nf">_gen_cmap_registry</span><span class="p">():</span>
<span class="sd">"""</span>
<span class="sd"> Generate a dict mapping standard colormap names to standard colormaps, as</span>
<span class="sd"> well as the reversed colormaps.</span>
<span class="sd"> """</span>
<span class="n">cmap_d</span> <span class="o">=</span> <span class="p">{</span><span class="o">**</span><span class="n">cmaps_listed</span><span class="p">}</span>
<span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">spec</span> <span class="ow">in</span> <span class="n">datad</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">cmap_d</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span> <span class="c1"># Precache the cmaps at a fixed lutsize..</span>
<span class="n">colors</span><span class="o">.</span><span class="n">LinearSegmentedColormap</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">spec</span><span class="p">,</span> <span class="n">LUTSIZE</span><span class="p">)</span>
<span class="k">if</span> <span class="s1">'red'</span> <span class="ow">in</span> <span class="n">spec</span> <span class="k">else</span>
<span class="n">colors</span><span class="o">.</span><span class="n">ListedColormap</span><span class="p">(</span><span class="n">spec</span><span class="p">[</span><span class="s1">'listed'</span><span class="p">],</span> <span class="n">name</span><span class="p">)</span>
<span class="k">if</span> <span class="s1">'listed'</span> <span class="ow">in</span> <span class="n">spec</span> <span class="k">else</span>
<span class="n">colors</span><span class="o">.</span><span class="n">LinearSegmentedColormap</span><span class="o">.</span><span class="n">from_list</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">spec</span><span class="p">,</span> <span class="n">LUTSIZE</span><span class="p">))</span>
<span class="c1"># Generate reversed cmaps.</span>
<span class="k">for</span> <span class="n">cmap</span> <span class="ow">in</span> <span class="nb">list</span><span class="p">(</span><span class="n">cmap_d</span><span class="o">.</span><span class="n">values</span><span class="p">()):</span>
<span class="n">rmap</span> <span class="o">=</span> <span class="n">cmap</span><span class="o">.</span><span class="n">reversed</span><span class="p">()</span>
<span class="n">cmap</span><span class="o">.</span><span class="n">_global</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">rmap</span><span class="o">.</span><span class="n">_global</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">cmap_d</span><span class="p">[</span><span class="n">rmap</span><span class="o">.</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">rmap</span>
<span class="k">return</span> <span class="n">cmap_d</span>
<span class="k">class</span> <span class="nc">_DeprecatedCmapDictWrapper</span><span class="p">(</span><span class="n">MutableMapping</span><span class="p">):</span>
<span class="sd">"""Dictionary mapping for deprecated _cmap_d access."""</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmap_registry</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_cmap_registry</span> <span class="o">=</span> <span class="n">cmap_registry</span>
<span class="k">def</span> <span class="fm">__delitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_warn_deprecated</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_cmap_registry</span><span class="o">.</span><span class="fm">__delitem__</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
<span class="k">def</span> <span class="fm">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_warn_deprecated</span><span class="p">()</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cmap_registry</span><span class="o">.</span><span class="fm">__getitem__</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
<span class="k">def</span> <span class="fm">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_warn_deprecated</span><span class="p">()</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cmap_registry</span><span class="o">.</span><span class="fm">__iter__</span><span class="p">()</span>
<span class="k">def</span> <span class="fm">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_warn_deprecated</span><span class="p">()</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cmap_registry</span><span class="o">.</span><span class="fm">__len__</span><span class="p">()</span>
<span class="k">def</span> <span class="fm">__setitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">val</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_warn_deprecated</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_cmap_registry</span><span class="o">.</span><span class="fm">__setitem__</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">val</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_warn_deprecated</span><span class="p">()</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cmap_registry</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">default</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_warn_deprecated</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">_api</span><span class="o">.</span><span class="n">warn_deprecated</span><span class="p">(</span>
<span class="s2">"3.3"</span><span class="p">,</span>
<span class="n">message</span><span class="o">=</span><span class="s2">"The global colormaps dictionary is no longer "</span>
<span class="s2">"considered public API."</span><span class="p">,</span>
<span class="n">alternative</span><span class="o">=</span><span class="s2">"Please use register_cmap() and get_cmap() to "</span>
<span class="s2">"access the contents of the dictionary."</span>
<span class="p">)</span>
<span class="n">_cmap_registry</span> <span class="o">=</span> <span class="n">_gen_cmap_registry</span><span class="p">()</span>
<span class="nb">globals</span><span class="p">()</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">_cmap_registry</span><span class="p">)</span>
<span class="c1"># This is no longer considered public API</span>
<span class="n">cmap_d</span> <span class="o">=</span> <span class="n">_DeprecatedCmapDictWrapper</span><span class="p">(</span><span class="n">_cmap_registry</span><span class="p">)</span>
<span class="n">__builtin_cmaps</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">_cmap_registry</span><span class="p">)</span>
<span class="c1"># Continue with definitions ...</span>
<div class="viewcode-block" id="register_cmap"><a class="viewcode-back" href="../../api/cm_api.html#matplotlib.cm.register_cmap">[docs]</a><span class="k">def</span> <span class="nf">register_cmap</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">cmap</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">override_builtin</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Add a colormap to the set recognized by :func:`get_cmap`.</span>
<span class="sd"> Register a new colormap to be accessed by name ::</span>
<span class="sd"> LinearSegmentedColormap('swirly', data, lut)</span>
<span class="sd"> register_cmap(cmap=swirly_cmap)</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> name : str, optional</span>
<span class="sd"> The name that can be used in :func:`get_cmap` or :rc:`image.cmap`</span>
<span class="sd"> If absent, the name will be the :attr:`~matplotlib.colors.Colormap.name`</span>
<span class="sd"> attribute of the *cmap*.</span>
<span class="sd"> cmap : matplotlib.colors.Colormap</span>
<span class="sd"> Despite being the second argument and having a default value, this</span>
<span class="sd"> is a required argument.</span>
<span class="sd"> override_builtin : bool</span>
<span class="sd"> Allow built-in colormaps to be overridden by a user-supplied</span>
<span class="sd"> colormap.</span>
<span class="sd"> Please do not use this unless you are sure you need it.</span>
<span class="sd"> Notes</span>
<span class="sd"> -----</span>
<span class="sd"> Registering a colormap stores a reference to the colormap object</span>
<span class="sd"> which can currently be modified and inadvertently change the global</span>
<span class="sd"> colormap state. This behavior is deprecated and in Matplotlib 3.5</span>
<span class="sd"> the registered colormap will be immutable.</span>
<span class="sd"> """</span>
<span class="n">_api</span><span class="o">.</span><span class="n">check_isinstance</span><span class="p">((</span><span class="nb">str</span><span class="p">,</span> <span class="kc">None</span><span class="p">),</span> <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">)</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">cmap</span><span class="o">.</span><span class="n">name</span>
<span class="k">except</span> <span class="ne">AttributeError</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Arguments must include a name or a "</span>
<span class="s2">"Colormap"</span><span class="p">)</span> <span class="kn">from</span> <span class="nn">err</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">_cmap_registry</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">override_builtin</span> <span class="ow">and</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">__builtin_cmaps</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Trying to re-register the builtin cmap </span><span class="si">{</span><span class="n">name</span><span class="si">!r}</span><span class="s2">."</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Trying to register the cmap </span><span class="si">{</span><span class="n">name</span><span class="si">!r}</span><span class="s2"> which already exists."</span>
<span class="n">_api</span><span class="o">.</span><span class="n">warn_external</span><span class="p">(</span><span class="n">msg</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">cmap</span><span class="p">,</span> <span class="n">colors</span><span class="o">.</span><span class="n">Colormap</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"You must pass a Colormap instance. "</span>
<span class="sa">f</span><span class="s2">"You passed </span><span class="si">{</span><span class="n">cmap</span><span class="si">}</span><span class="s2"> a </span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="n">cmap</span><span class="p">)</span><span class="si">}</span><span class="s2"> object."</span><span class="p">)</span>
<span class="n">cmap</span><span class="o">.</span><span class="n">_global</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">_cmap_registry</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">cmap</span>
<span class="k">return</span></div>
<div class="viewcode-block" id="get_cmap"><a class="viewcode-back" href="../../api/cm_api.html#matplotlib.cm.get_cmap">[docs]</a><span class="k">def</span> <span class="nf">get_cmap</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">lut</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Get a colormap instance, defaulting to rc values if *name* is None.</span>
<span class="sd"> Colormaps added with :func:`register_cmap` take precedence over</span>
<span class="sd"> built-in colormaps.</span>
<span class="sd"> Notes</span>
<span class="sd"> -----</span>
<span class="sd"> Currently, this returns the global colormap object, which is deprecated.</span>
<span class="sd"> In Matplotlib 3.5, you will no longer be able to modify the global</span>
<span class="sd"> colormaps in-place.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> name : `matplotlib.colors.Colormap` or str or None, default: None</span>
<span class="sd"> If a `.Colormap` instance, it will be returned. Otherwise, the name of</span>
<span class="sd"> a colormap known to Matplotlib, which will be resampled by *lut*. The</span>
<span class="sd"> default, None, means :rc:`image.cmap`.</span>
<span class="sd"> lut : int or None, default: None</span>
<span class="sd"> If *name* is not already a Colormap instance and *lut* is not None, the</span>
<span class="sd"> colormap will be resampled to have *lut* entries in the lookup table.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">mpl</span><span class="o">.</span><span class="n">rcParams</span><span class="p">[</span><span class="s1">'image.cmap'</span><span class="p">]</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">colors</span><span class="o">.</span><span class="n">Colormap</span><span class="p">):</span>
<span class="k">return</span> <span class="n">name</span>
<span class="n">_api</span><span class="o">.</span><span class="n">check_in_list</span><span class="p">(</span><span class="nb">sorted</span><span class="p">(</span><span class="n">_cmap_registry</span><span class="p">),</span> <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">)</span>
<span class="k">if</span> <span class="n">lut</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="n">_cmap_registry</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">_cmap_registry</span><span class="p">[</span><span class="n">name</span><span class="p">]</span><span class="o">.</span><span class="n">_resample</span><span class="p">(</span><span class="n">lut</span><span class="p">)</span></div>
<div class="viewcode-block" id="unregister_cmap"><a class="viewcode-back" href="../../api/cm_api.html#matplotlib.cm.unregister_cmap">[docs]</a><span class="k">def</span> <span class="nf">unregister_cmap</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Remove a colormap recognized by :func:`get_cmap`.</span>
<span class="sd"> You may not remove built-in colormaps.</span>
<span class="sd"> If the named colormap is not registered, returns with no error, raises</span>
<span class="sd"> if you try to de-register a default colormap.</span>
<span class="sd"> .. warning ::</span>
<span class="sd"> Colormap names are currently a shared namespace that may be used</span>
<span class="sd"> by multiple packages. Use `unregister_cmap` only if you know you</span>
<span class="sd"> have registered that name before. In particular, do not</span>
<span class="sd"> unregister just in case to clean the name before registering a</span>
<span class="sd"> new colormap.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> name : str</span>
<span class="sd"> The name of the colormap to be un-registered</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> ColorMap or None</span>
<span class="sd"> If the colormap was registered, return it if not return `None`</span>
<span class="sd"> Raises</span>
<span class="sd"> ------</span>
<span class="sd"> ValueError</span>
<span class="sd"> If you try to de-register a default built-in colormap.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">_cmap_registry</span><span class="p">:</span>
<span class="k">return</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">__builtin_cmaps</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">"cannot unregister </span><span class="si">{</span><span class="n">name</span><span class="si">!r}</span><span class="s2"> which is a builtin "</span>
<span class="s2">"colormap."</span><span class="p">)</span>
<span class="k">return</span> <span class="n">_cmap_registry</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">name</span><span class="p">)</span></div>
<div class="viewcode-block" id="ScalarMappable"><a class="viewcode-back" href="../../api/cm_api.html#matplotlib.cm.ScalarMappable">[docs]</a><span class="k">class</span> <span class="nc">ScalarMappable</span><span class="p">:</span>
<span class="sd">"""</span>
<span class="sd"> A mixin class to map scalar data to RGBA.</span>
<span class="sd"> The ScalarMappable applies data normalization before returning RGBA colors</span>
<span class="sd"> from the given colormap.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">norm</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">cmap</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> norm : `matplotlib.colors.Normalize` (or subclass thereof)</span>
<span class="sd"> The normalizing object which scales data, typically into the</span>
<span class="sd"> interval ``[0, 1]``.</span>
<span class="sd"> If *None*, *norm* defaults to a *colors.Normalize* object which</span>
<span class="sd"> initializes its scaling based on the first data processed.</span>
<span class="sd"> cmap : str or `~matplotlib.colors.Colormap`</span>
<span class="sd"> The colormap used to map normalized data values to RGBA colors.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_A</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">norm</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># So that the setter knows we're initializing.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_norm</span><span class="p">(</span><span class="n">norm</span><span class="p">)</span> <span class="c1"># The Normalize instance of this ScalarMappable.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cmap</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># So that the setter knows we're initializing.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_cmap</span><span class="p">(</span><span class="n">cmap</span><span class="p">)</span> <span class="c1"># The Colormap instance of this ScalarMappable.</span>
<span class="c1">#: The last colorbar associated with this ScalarMappable. May be None.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">colorbar</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">callbacksSM</span> <span class="o">=</span> <span class="n">cbook</span><span class="o">.</span><span class="n">CallbackRegistry</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_update_dict</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'array'</span><span class="p">:</span> <span class="kc">False</span><span class="p">}</span>
<span class="k">def</span> <span class="nf">_scale_norm</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">norm</span><span class="p">,</span> <span class="n">vmin</span><span class="p">,</span> <span class="n">vmax</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Helper for initial scaling.</span>
<span class="sd"> Used by public functions that create a ScalarMappable and support</span>
<span class="sd"> parameters *vmin*, *vmax* and *norm*. This makes sure that a *norm*</span>
<span class="sd"> will take precedence over *vmin*, *vmax*.</span>
<span class="sd"> Note that this method does not set the norm.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">vmin</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">vmax</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_clim</span><span class="p">(</span><span class="n">vmin</span><span class="p">,</span> <span class="n">vmax</span><span class="p">)</span>
<span class="k">if</span> <span class="n">norm</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">_api</span><span class="o">.</span><span class="n">warn_deprecated</span><span class="p">(</span>
<span class="s2">"3.3"</span><span class="p">,</span>
<span class="n">message</span><span class="o">=</span><span class="s2">"Passing parameters norm and vmin/vmax "</span>
<span class="s2">"simultaneously is deprecated since </span><span class="si">%(since)s</span><span class="s2"> and "</span>
<span class="s2">"will become an error </span><span class="si">%(removal)s</span><span class="s2">. Please pass "</span>
<span class="s2">"vmin/vmax directly to the norm when creating it."</span><span class="p">)</span>
<span class="c1"># always resolve the autoscaling so we have concrete limits</span>
<span class="c1"># rather than deferring to draw time.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">autoscale_None</span><span class="p">()</span>
<div class="viewcode-block" id="ScalarMappable.to_rgba"><a class="viewcode-back" href="../../api/cm_api.html#matplotlib.cm.ScalarMappable.to_rgba">[docs]</a> <span class="k">def</span> <span class="nf">to_rgba</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="n">alpha</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="nb">bytes</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">norm</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return a normalized rgba array corresponding to *x*.</span>
<span class="sd"> In the normal case, *x* is a 1D or 2D sequence of scalars, and</span>
<span class="sd"> the corresponding ndarray of rgba values will be returned,</span>
<span class="sd"> based on the norm and colormap set for this ScalarMappable.</span>
<span class="sd"> There is one special case, for handling images that are already</span>
<span class="sd"> rgb or rgba, such as might have been read from an image file.</span>
<span class="sd"> If *x* is an ndarray with 3 dimensions,</span>
<span class="sd"> and the last dimension is either 3 or 4, then it will be</span>
<span class="sd"> treated as an rgb or rgba array, and no mapping will be done.</span>
<span class="sd"> The array can be uint8, or it can be floating point with</span>
<span class="sd"> values in the 0-1 range; otherwise a ValueError will be raised.</span>
<span class="sd"> If it is a masked array, the mask will be ignored.</span>
<span class="sd"> If the last dimension is 3, the *alpha* kwarg (defaulting to 1)</span>
<span class="sd"> will be used to fill in the transparency. If the last dimension</span>
<span class="sd"> is 4, the *alpha* kwarg is ignored; it does not</span>
<span class="sd"> replace the pre-existing alpha. A ValueError will be raised</span>
<span class="sd"> if the third dimension is other than 3 or 4.</span>
<span class="sd"> In either case, if *bytes* is *False* (default), the rgba</span>
<span class="sd"> array will be floats in the 0-1 range; if it is *True*,</span>
<span class="sd"> the returned rgba array will be uint8 in the 0 to 255 range.</span>
<span class="sd"> If norm is False, no normalization of the input data is</span>
<span class="sd"> performed, and it is assumed to be in the range (0-1).</span>
<span class="sd"> """</span>
<span class="c1"># First check for special case, image input:</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="n">x</span><span class="o">.</span><span class="n">ndim</span> <span class="o">==</span> <span class="mi">3</span><span class="p">:</span>
<span class="k">if</span> <span class="n">x</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="o">==</span> <span class="mi">3</span><span class="p">:</span>
<span class="k">if</span> <span class="n">alpha</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">alpha</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="n">x</span><span class="o">.</span><span class="n">dtype</span> <span class="o">==</span> <span class="n">np</span><span class="o">.</span><span class="n">uint8</span><span class="p">:</span>
<span class="n">alpha</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">uint8</span><span class="p">(</span><span class="n">alpha</span> <span class="o">*</span> <span class="mi">255</span><span class="p">)</span>
<span class="n">m</span><span class="p">,</span> <span class="n">n</span> <span class="o">=</span> <span class="n">x</span><span class="o">.</span><span class="n">shape</span><span class="p">[:</span><span class="mi">2</span><span class="p">]</span>
<span class="n">xx</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">empty</span><span class="p">(</span><span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="n">m</span><span class="p">,</span> <span class="n">n</span><span class="p">,</span> <span class="mi">4</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">x</span><span class="o">.</span><span class="n">dtype</span><span class="p">)</span>
<span class="n">xx</span><span class="p">[:,</span> <span class="p">:,</span> <span class="p">:</span><span class="mi">3</span><span class="p">]</span> <span class="o">=</span> <span class="n">x</span>
<span class="n">xx</span><span class="p">[:,</span> <span class="p">:,</span> <span class="mi">3</span><span class="p">]</span> <span class="o">=</span> <span class="n">alpha</span>
<span class="k">elif</span> <span class="n">x</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> <span class="o">==</span> <span class="mi">4</span><span class="p">:</span>
<span class="n">xx</span> <span class="o">=</span> <span class="n">x</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Third dimension must be 3 or 4"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">xx</span><span class="o">.</span><span class="n">dtype</span><span class="o">.</span><span class="n">kind</span> <span class="o">==</span> <span class="s1">'f'</span><span class="p">:</span>
<span class="k">if</span> <span class="n">norm</span> <span class="ow">and</span> <span class="p">(</span><span class="n">xx</span><span class="o">.</span><span class="n">max</span><span class="p">()</span> <span class="o">></span> <span class="mi">1</span> <span class="ow">or</span> <span class="n">xx</span><span class="o">.</span><span class="n">min</span><span class="p">()</span> <span class="o"><</span> <span class="mi">0</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Floating point image RGB values "</span>
<span class="s2">"must be in the 0..1 range."</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">bytes</span><span class="p">:</span>
<span class="n">xx</span> <span class="o">=</span> <span class="p">(</span><span class="n">xx</span> <span class="o">*</span> <span class="mi">255</span><span class="p">)</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">uint8</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">xx</span><span class="o">.</span><span class="n">dtype</span> <span class="o">==</span> <span class="n">np</span><span class="o">.</span><span class="n">uint8</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">bytes</span><span class="p">:</span>
<span class="n">xx</span> <span class="o">=</span> <span class="n">xx</span><span class="o">.</span><span class="n">astype</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span> <span class="o">/</span> <span class="mi">255</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Image RGB array must be uint8 or "</span>
<span class="s2">"floating point; found </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">xx</span><span class="o">.</span><span class="n">dtype</span><span class="p">)</span>
<span class="k">return</span> <span class="n">xx</span>
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
<span class="c1"># e.g., x is not an ndarray; so try mapping it</span>
<span class="k">pass</span>
<span class="c1"># This is the normal case, mapping a scalar array:</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">ma</span><span class="o">.</span><span class="n">asarray</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
<span class="k">if</span> <span class="n">norm</span><span class="p">:</span>
<span class="n">x</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">norm</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
<span class="n">rgba</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cmap</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">alpha</span><span class="o">=</span><span class="n">alpha</span><span class="p">,</span> <span class="nb">bytes</span><span class="o">=</span><span class="nb">bytes</span><span class="p">)</span>
<span class="k">return</span> <span class="n">rgba</span></div>
<div class="viewcode-block" id="ScalarMappable.set_array"><a class="viewcode-back" href="../../api/cm_api.html#matplotlib.cm.ScalarMappable.set_array">[docs]</a> <span class="k">def</span> <span class="nf">set_array</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">A</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Set the image array from numpy array *A*.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> A : ndarray or None</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_A</span> <span class="o">=</span> <span class="n">A</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_update_dict</span><span class="p">[</span><span class="s1">'array'</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="ScalarMappable.get_array"><a class="viewcode-back" href="../../api/cm_api.html#matplotlib.cm.ScalarMappable.get_array">[docs]</a> <span class="k">def</span> <span class="nf">get_array</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Return the data array."""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_A</span></div>
<div class="viewcode-block" id="ScalarMappable.get_cmap"><a class="viewcode-back" href="../../api/cm_api.html#matplotlib.cm.ScalarMappable.get_cmap">[docs]</a> <span class="k">def</span> <span class="nf">get_cmap</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Return the `.Colormap` instance."""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">cmap</span></div>
<div class="viewcode-block" id="ScalarMappable.get_clim"><a class="viewcode-back" href="../../api/cm_api.html#matplotlib.cm.ScalarMappable.get_clim">[docs]</a> <span class="k">def</span> <span class="nf">get_clim</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return the values (min, max) that are mapped to the colormap limits.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">norm</span><span class="o">.</span><span class="n">vmin</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">norm</span><span class="o">.</span><span class="n">vmax</span></div>
<div class="viewcode-block" id="ScalarMappable.set_clim"><a class="viewcode-back" href="../../api/cm_api.html#matplotlib.cm.ScalarMappable.set_clim">[docs]</a> <span class="k">def</span> <span class="nf">set_clim</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">vmin</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">vmax</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Set the norm limits for image scaling.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> vmin, vmax : float</span>
<span class="sd"> The limits.</span>
<span class="sd"> The limits may also be passed as a tuple (*vmin*, *vmax*) as a</span>
<span class="sd"> single positional argument.</span>
<span class="sd"> .. ACCEPTS: (vmin: float, vmax: float)</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">vmax</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">vmin</span><span class="p">,</span> <span class="n">vmax</span> <span class="o">=</span> <span class="n">vmin</span>
<span class="k">except</span> <span class="p">(</span><span class="ne">TypeError</span><span class="p">,</span> <span class="ne">ValueError</span><span class="p">):</span>
<span class="k">pass</span>
<span class="k">if</span> <span class="n">vmin</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">norm</span><span class="o">.</span><span class="n">vmin</span> <span class="o">=</span> <span class="n">colors</span><span class="o">.</span><span class="n">_sanitize_extrema</span><span class="p">(</span><span class="n">vmin</span><span class="p">)</span>
<span class="k">if</span> <span class="n">vmax</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">norm</span><span class="o">.</span><span class="n">vmax</span> <span class="o">=</span> <span class="n">colors</span><span class="o">.</span><span class="n">_sanitize_extrema</span><span class="p">(</span><span class="n">vmax</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">changed</span><span class="p">()</span></div>
<div class="viewcode-block" id="ScalarMappable.get_alpha"><a class="viewcode-back" href="../../api/cm_api.html#matplotlib.cm.ScalarMappable.get_alpha">[docs]</a> <span class="k">def</span> <span class="nf">get_alpha</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> float</span>
<span class="sd"> Always returns 1.</span>
<span class="sd"> """</span>
<span class="c1"># This method is intended to be overridden by Artist sub-classes</span>
<span class="k">return</span> <span class="mf">1.</span></div>
<div class="viewcode-block" id="ScalarMappable.set_cmap"><a class="viewcode-back" href="../../api/cm_api.html#matplotlib.cm.ScalarMappable.set_cmap">[docs]</a> <span class="k">def</span> <span class="nf">set_cmap</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cmap</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Set the colormap for luminance data.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> cmap : `.Colormap` or str or None</span>
<span class="sd"> """</span>
<span class="n">in_init</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cmap</span> <span class="ow">is</span> <span class="kc">None</span>
<span class="n">cmap</span> <span class="o">=</span> <span class="n">get_cmap</span><span class="p">(</span><span class="n">cmap</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cmap</span> <span class="o">=</span> <span class="n">cmap</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">in_init</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">changed</span><span class="p">()</span> <span class="c1"># Things are not set up properly yet.</span></div>
<div class="viewcode-block" id="ScalarMappable.set_norm"><a class="viewcode-back" href="../../api/cm_api.html#matplotlib.cm.ScalarMappable.set_norm">[docs]</a> <span class="k">def</span> <span class="nf">set_norm</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">norm</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Set the normalization instance.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> norm : `.Normalize` or None</span>
<span class="sd"> Notes</span>
<span class="sd"> -----</span>
<span class="sd"> If there are any colorbars using the mappable for this norm, setting</span>
<span class="sd"> the norm of the mappable will reset the norm, locator, and formatters</span>
<span class="sd"> on the colorbar to default.</span>
<span class="sd"> """</span>
<span class="n">_api</span><span class="o">.</span><span class="n">check_isinstance</span><span class="p">((</span><span class="n">colors</span><span class="o">.</span><span class="n">Normalize</span><span class="p">,</span> <span class="kc">None</span><span class="p">),</span> <span class="n">norm</span><span class="o">=</span><span class="n">norm</span><span class="p">)</span>
<span class="n">in_init</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">norm</span> <span class="ow">is</span> <span class="kc">None</span>
<span class="k">if</span> <span class="n">norm</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">norm</span> <span class="o">=</span> <span class="n">colors</span><span class="o">.</span><span class="n">Normalize</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">norm</span> <span class="o">=</span> <span class="n">norm</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">in_init</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">changed</span><span class="p">()</span> <span class="c1"># Things are not set up properly yet.</span></div>
<div class="viewcode-block" id="ScalarMappable.autoscale"><a class="viewcode-back" href="../../api/cm_api.html#matplotlib.cm.ScalarMappable.autoscale">[docs]</a> <span class="k">def</span> <span class="nf">autoscale</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Autoscale the scalar limits on the norm instance using the</span>
<span class="sd"> current array</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_A</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'You must first set_array for mappable'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">norm</span><span class="o">.</span><span class="n">autoscale</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_A</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">changed</span><span class="p">()</span></div>
<div class="viewcode-block" id="ScalarMappable.autoscale_None"><a class="viewcode-back" href="../../api/cm_api.html#matplotlib.cm.ScalarMappable.autoscale_None">[docs]</a> <span class="k">def</span> <span class="nf">autoscale_None</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Autoscale the scalar limits on the norm instance using the</span>
<span class="sd"> current array, changing only limits that are None</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_A</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'You must first set_array for mappable'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">norm</span><span class="o">.</span><span class="n">autoscale_None</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_A</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">changed</span><span class="p">()</span></div>
<span class="k">def</span> <span class="nf">_add_checker</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">checker</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Add an entry to a dictionary of boolean flags</span>
<span class="sd"> that are set to True when the mappable is changed.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_update_dict</span><span class="p">[</span><span class="n">checker</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">def</span> <span class="nf">_check_update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">checker</span><span class="p">):</span>
<span class="sd">"""Return whether mappable has changed since the last check."""</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_update_dict</span><span class="p">[</span><span class="n">checker</span><span class="p">]:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_update_dict</span><span class="p">[</span><span class="n">checker</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">return</span> <span class="kc">False</span>
<div class="viewcode-block" id="ScalarMappable.changed"><a class="viewcode-back" href="../../api/cm_api.html#matplotlib.cm.ScalarMappable.changed">[docs]</a> <span class="k">def</span> <span class="nf">changed</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Call this whenever the mappable is changed to notify all the</span>
<span class="sd"> callbackSM listeners to the 'changed' signal.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">callbacksSM</span><span class="o">.</span><span class="n">process</span><span class="p">(</span><span class="s1">'changed'</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span>
<span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_update_dict</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_update_dict</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stale</span> <span class="o">=</span> <span class="kc">True</span></div>
<span class="n">update_dict</span> <span class="o">=</span> <span class="n">_api</span><span class="o">.</span><span class="n">deprecate_privatize_attribute</span><span class="p">(</span><span class="s2">"3.3"</span><span class="p">)</span>
<div class="viewcode-block" id="ScalarMappable.add_checker"><a class="viewcode-back" href="../../api/cm_api.html#matplotlib.cm.ScalarMappable.add_checker">[docs]</a> <span class="nd">@_api</span><span class="o">.</span><span class="n">deprecated</span><span class="p">(</span><span class="s2">"3.3"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">add_checker</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">checker</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_add_checker</span><span class="p">(</span><span class="n">checker</span><span class="p">)</span></div>
<div class="viewcode-block" id="ScalarMappable.check_update"><a class="viewcode-back" href="../../api/cm_api.html#matplotlib.cm.ScalarMappable.check_update">[docs]</a> <span class="nd">@_api</span><span class="o">.</span><span class="n">deprecated</span><span class="p">(</span><span class="s2">"3.3"</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">check_update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">checker</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_check_update</span><span class="p">(</span><span class="n">checker</span><span class="p">)</span></div></div>
</pre></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<footer>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2021 The Matplotlib development team.
<br />
Last updated on May 08, 2021.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 3.2.1.
Doc version v3.4.2-2-gf801f04d09-dirty.
</div>
</footer>
</body>
</html>
You can’t perform that action at this time.