Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathcm_api.html
More file actions
438 lines (396 loc) · 30.6 KB
/
Copy pathcm_api.html
File metadata and controls
438 lines (396 loc) · 30.6 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
<!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.3.2 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css?3.3.2" 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/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.3.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="next" title="matplotlib.collections" href="collections_api.html" />
<link rel="prev" title="matplotlib.cbook" href="cbook_api.html" />
<link rel="top" title="Matplotlib 3.3.2 documentation" href="#" />
<link rel="canonical" href="https://matplotlib.org/stable/api/cm_api.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.3.2). For the latest version see <a href="https://matplotlib.org/stable/api/cm_api.html">https://matplotlib.org/stable/api/cm_api.html</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.3.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 class="right" >
<a href="collections_api.html" title="matplotlib.collections"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="cbook_api.html" title="matplotlib.cbook"
accesskey="P">previous</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" accesskey="U">API Overview</a> »</li>
<li class="nav-item nav-item-this"><a href=""><code class="docutils literal notranslate"><span class="pre">matplotlib.cm</span></code></a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">API Overview</a><ul>
<li>Previous: <a href="cbook_api.html" title="previous chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.cbook</span></code></a></li>
<li>Next: <a href="collections_api.html" title="next chapter"><code class="docutils literal notranslate"><span class="pre">matplotlib.collections</span></code></a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="sidebar-pagesource" role="note" aria-label="source link"
style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">
<a href="../_sources/api/cm_api.rst.txt"
style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-matplotlib.cm">
<span id="matplotlib-cm"></span><h1><code class="docutils literal notranslate"><span class="pre">matplotlib.cm</span></code><a class="headerlink" href="#module-matplotlib.cm" title="Permalink to this headline">¶</a></h1>
<p>Builtin colormaps, colormap handling utilities, and the <a class="reference internal" href="#matplotlib.cm.ScalarMappable" title="matplotlib.cm.ScalarMappable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ScalarMappable</span></code></a> mixin.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p><a class="reference internal" href="../gallery/color/colormap_reference.html"><span class="doc">Colormap reference</span></a> for a list of builtin colormaps.</p>
<p><a class="reference internal" href="../tutorials/colors/colormap-manipulation.html"><span class="doc">Creating Colormaps in Matplotlib</span></a> for examples of how to
make colormaps.</p>
<p><a class="reference internal" href="../tutorials/colors/colormaps.html"><span class="doc">Choosing Colormaps in Matplotlib</span></a> an in-depth discussion of
choosing colormaps.</p>
<p class="last"><a class="reference internal" href="../tutorials/colors/colormapnorms.html"><span class="doc">Colormap Normalization</span></a> for more details about data
normalization.</p>
</div>
<dl class="py class">
<dt id="matplotlib.cm.ScalarMappable">
<em class="property">class </em><code class="descclassname">matplotlib.cm.</code><code class="descname">ScalarMappable</code><span class="sig-paren">(</span><em><span class="n">norm</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">cmap</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cm.ScalarMappable" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>A mixin class to map scalar data to RGBA.</p>
<p>The ScalarMappable applies data normalization before returning RGBA colors
from the given colormap.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>norm</strong><span class="classifier"><a class="reference internal" href="_as_gen/matplotlib.colors.Normalize.html#matplotlib.colors.Normalize" title="matplotlib.colors.Normalize"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.colors.Normalize</span></code></a> (or subclass thereof)</span></dt><dd><p>The normalizing object which scales data, typically into the
interval <code class="docutils literal notranslate"><span class="pre">[0,</span> <span class="pre">1]</span></code>.
If <em>None</em>, <em>norm</em> defaults to a <em>colors.Normalize</em> object which
initializes its scaling based on the first data processed.</p>
</dd>
<dt><strong>cmap</strong><span class="classifier">str or <a class="reference internal" href="_as_gen/matplotlib.colors.Colormap.html#matplotlib.colors.Colormap" title="matplotlib.colors.Colormap"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Colormap</span></code></a></span></dt><dd><p>The colormap used to map normalized data values to RGBA colors.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<dl class="py method">
<dt id="matplotlib.cm.ScalarMappable.add_checker">
<code class="descname">add_checker</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">checker</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.add_checker"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.add_checker" title="Permalink to this definition">¶</a></dt>
<dd><p>[<em>Deprecated</em>]</p>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.3: </span></p>
</div>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.cm.ScalarMappable.autoscale">
<code class="descname">autoscale</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.autoscale"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.autoscale" title="Permalink to this definition">¶</a></dt>
<dd><p>Autoscale the scalar limits on the norm instance using the
current array</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.cm.ScalarMappable.autoscale_None">
<code class="descname">autoscale_None</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.autoscale_None"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.autoscale_None" title="Permalink to this definition">¶</a></dt>
<dd><p>Autoscale the scalar limits on the norm instance using the
current array, changing only limits that are None</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.cm.ScalarMappable.changed">
<code class="descname">changed</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.changed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.changed" title="Permalink to this definition">¶</a></dt>
<dd><p>Call this whenever the mappable is changed to notify all the
callbackSM listeners to the 'changed' signal.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.cm.ScalarMappable.check_update">
<code class="descname">check_update</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">checker</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.check_update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.check_update" title="Permalink to this definition">¶</a></dt>
<dd><p>[<em>Deprecated</em>]</p>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.3: </span></p>
</div>
</dd></dl>
<dl class="py attribute">
<dt id="matplotlib.cm.ScalarMappable.colorbar">
<code class="descname">colorbar</code><a class="headerlink" href="#matplotlib.cm.ScalarMappable.colorbar" title="Permalink to this definition">¶</a></dt>
<dd><p>The last colorbar associated with this ScalarMappable. May be None.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.cm.ScalarMappable.get_alpha">
<code class="descname">get_alpha</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.get_alpha"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.get_alpha" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">
<dt>float</dt><dd><p>Always returns 1.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.cm.ScalarMappable.get_array">
<code class="descname">get_array</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.get_array"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.get_array" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the data array.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.cm.ScalarMappable.get_clim">
<code class="descname">get_clim</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.get_clim"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.get_clim" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the values (min, max) that are mapped to the colormap limits.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.cm.ScalarMappable.get_cmap">
<code class="descname">get_cmap</code><span class="sig-paren">(</span><em><span class="n">self</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.get_cmap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.get_cmap" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the <a class="reference internal" href="_as_gen/matplotlib.colors.Colormap.html#matplotlib.colors.Colormap" title="matplotlib.colors.Colormap"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Colormap</span></code></a> instance.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.cm.ScalarMappable.set_array">
<code class="descname">set_array</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">A</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.set_array"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.set_array" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the image array from numpy array <em>A</em>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>A</strong><span class="classifier">ndarray</span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.cm.ScalarMappable.set_clim">
<code class="descname">set_clim</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">vmin</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">vmax</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.set_clim"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.set_clim" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the norm limits for image scaling.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>vmin, vmax</strong><span class="classifier">float</span></dt><dd><p>The limits.</p>
<p>The limits may also be passed as a tuple (<em>vmin</em>, <em>vmax</em>) as a
single positional argument.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.cm.ScalarMappable.set_cmap">
<code class="descname">set_cmap</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">cmap</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.set_cmap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.set_cmap" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the colormap for luminance data.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>cmap</strong><span class="classifier"><a class="reference internal" href="_as_gen/matplotlib.colors.Colormap.html#matplotlib.colors.Colormap" title="matplotlib.colors.Colormap"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Colormap</span></code></a> or str or None</span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.cm.ScalarMappable.set_norm">
<code class="descname">set_norm</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">norm</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.set_norm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.set_norm" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the normalization instance.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>norm</strong><span class="classifier"><a class="reference internal" href="_as_gen/matplotlib.colors.Normalize.html#matplotlib.colors.Normalize" title="matplotlib.colors.Normalize"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Normalize</span></code></a> or None</span></dt><dd></dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>If there are any colorbars using the mappable for this norm, setting
the norm of the mappable will reset the norm, locator, and formatters
on the colorbar to default.</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.cm.ScalarMappable.to_rgba">
<code class="descname">to_rgba</code><span class="sig-paren">(</span><em><span class="n">self</span></em>, <em><span class="n">x</span></em>, <em><span class="n">alpha</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">bytes</span><span class="o">=</span><span class="default_value">False</span></em>, <em><span class="n">norm</span><span class="o">=</span><span class="default_value">True</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.to_rgba"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.to_rgba" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a normalized rgba array corresponding to <em>x</em>.</p>
<p>In the normal case, <em>x</em> is a 1-D or 2-D sequence of scalars, and
the corresponding ndarray of rgba values will be returned,
based on the norm and colormap set for this ScalarMappable.</p>
<p>There is one special case, for handling images that are already
rgb or rgba, such as might have been read from an image file.
If <em>x</em> is an ndarray with 3 dimensions,
and the last dimension is either 3 or 4, then it will be
treated as an rgb or rgba array, and no mapping will be done.
The array can be uint8, or it can be floating point with
values in the 0-1 range; otherwise a ValueError will be raised.
If it is a masked array, the mask will be ignored.
If the last dimension is 3, the <em>alpha</em> kwarg (defaulting to 1)
will be used to fill in the transparency. If the last dimension
is 4, the <em>alpha</em> kwarg is ignored; it does not
replace the pre-existing alpha. A ValueError will be raised
if the third dimension is other than 3 or 4.</p>
<p>In either case, if <em>bytes</em> is <em>False</em> (default), the rgba
array will be floats in the 0-1 range; if it is <em>True</em>,
the returned rgba array will be uint8 in the 0 to 255 range.</p>
<p>If norm is False, no normalization of the input data is
performed, and it is assumed to be in the range (0-1).</p>
</dd></dl>
<dl class="py method">
<dt id="matplotlib.cm.ScalarMappable.update_dict">
<em class="property">property </em><code class="descname">update_dict</code><a class="headerlink" href="#matplotlib.cm.ScalarMappable.update_dict" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.cm.get_cmap">
<code class="descclassname">matplotlib.cm.</code><code class="descname">get_cmap</code><span class="sig-paren">(</span><em><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">lut</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cm.html#get_cmap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cm.get_cmap" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a colormap instance, defaulting to rc values if <em>name</em> is None.</p>
<p>Colormaps added with <a class="reference internal" href="#matplotlib.cm.register_cmap" title="matplotlib.cm.register_cmap"><code class="xref py py-func docutils literal notranslate"><span class="pre">register_cmap()</span></code></a> take precedence over
built-in colormaps.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">
<dt><strong>name</strong><span class="classifier"><a class="reference internal" href="_as_gen/matplotlib.colors.Colormap.html#matplotlib.colors.Colormap" title="matplotlib.colors.Colormap"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.colors.Colormap</span></code></a> or str or None, default: None</span></dt><dd><p>If a <a class="reference internal" href="_as_gen/matplotlib.colors.Colormap.html#matplotlib.colors.Colormap" title="matplotlib.colors.Colormap"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Colormap</span></code></a> instance, it will be returned. Otherwise, the name of
a colormap known to Matplotlib, which will be resampled by <em>lut</em>. The
default, None, means <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=image.cmap#a-sample-matplotlibrc-file"><span class="pre">rcParams["image.cmap"]</span></a></code> (default: <code class="docutils literal notranslate"><span class="pre">'viridis'</span></code>).</p>
</dd>
<dt><strong>lut</strong><span class="classifier">int or None, default: None</span></dt><dd><p>If <em>name</em> is not already a Colormap instance and <em>lut</em> is not None, the
colormap will be resampled to have <em>lut</em> entries in the lookup table.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>Currently, this returns the global colormap object, which is deprecated.
In Matplotlib 3.5, you will no longer be able to modify the global
colormaps in-place.</p>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.cm.register_cmap">
<code class="descclassname">matplotlib.cm.</code><code class="descname">register_cmap</code><span class="sig-paren">(</span><em><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">cmap</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">data</span><span class="o">=</span><span class="default_value">None</span></em>, <em><span class="n">lut</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cm.html#register_cmap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cm.register_cmap" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a colormap to the set recognized by <a class="reference internal" href="#matplotlib.cm.get_cmap" title="matplotlib.cm.get_cmap"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_cmap()</span></code></a>.</p>
<p>It can be used in two ways:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">register_cmap</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">'swirly'</span><span class="p">,</span> <span class="n">cmap</span><span class="o">=</span><span class="n">swirly_cmap</span><span class="p">)</span>
<span class="n">register_cmap</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">'choppy'</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">choppydata</span><span class="p">,</span> <span class="n">lut</span><span class="o">=</span><span class="mi">128</span><span class="p">)</span>
</pre></div>
</div>
<p>In the first case, <em>cmap</em> must be a <a class="reference internal" href="_as_gen/matplotlib.colors.Colormap.html#matplotlib.colors.Colormap" title="matplotlib.colors.Colormap"><code class="xref py py-class docutils literal notranslate"><span class="pre">matplotlib.colors.Colormap</span></code></a>
instance. The <em>name</em> is optional; if absent, the name will
be the <code class="xref py py-attr docutils literal notranslate"><span class="pre">name</span></code> attribute of the <em>cmap</em>.</p>
<p>The second case is deprecated. Here, the three arguments are passed to
the <a class="reference internal" href="_as_gen/matplotlib.colors.LinearSegmentedColormap.html#matplotlib.colors.LinearSegmentedColormap" title="matplotlib.colors.LinearSegmentedColormap"><code class="xref py py-class docutils literal notranslate"><span class="pre">LinearSegmentedColormap</span></code></a> initializer,
and the resulting colormap is registered. Instead of this implicit
colormap creation, create a <a class="reference internal" href="_as_gen/matplotlib.colors.LinearSegmentedColormap.html#matplotlib.colors.LinearSegmentedColormap" title="matplotlib.colors.LinearSegmentedColormap"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LinearSegmentedColormap</span></code></a> and use the first
case: <code class="docutils literal notranslate"><span class="pre">register_cmap(cmap=LinearSegmentedColormap(name,</span> <span class="pre">data,</span> <span class="pre">lut))</span></code>.</p>
<p class="rubric">Notes</p>
<p>Registering a colormap stores a reference to the colormap object
which can currently be modified and inadvertantly change the global
colormap state. This behavior is deprecated and in Matplotlib 3.5
the registered colormap will be immutable.</p>
</dd></dl>
<dl class="py function">
<dt id="matplotlib.cm.revcmap">
<code class="descclassname">matplotlib.cm.</code><code class="descname">revcmap</code><span class="sig-paren">(</span><em><span class="n">data</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matplotlib/cm.html#revcmap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#matplotlib.cm.revcmap" title="Permalink to this definition">¶</a></dt>
<dd><p>[<em>Deprecated</em>] Can only handle specification <em>data</em> in dictionary format.</p>
<p class="rubric">Notes</p>
<div class="deprecated">
<p><span class="versionmodified deprecated">Deprecated since version 3.2.</span></p>
</div>
</dd></dl>
</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 - 2020 The Matplotlib development team.
<br />
Last updated on Sep 15, 2020.
Created using
<a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1.
Doc version 3.3.2.
</div>
</footer>
</body>
</html>
You can’t perform that action at this time.