matplotlib.github.com/3.4.2/api/cm_api.html at refs/heads/main · matplotlib/matplotlib.github.com

History

472 lines (431 loc) · 31.7 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

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

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

<head>

<title>matplotlib.cm — Matplotlib 3.4.2 documentation</title>

title="Search within Matplotlib 3.4.2 documentation"

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

</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="https://matplotlib.org/stable/api/cm_api.html">https://matplotlib.org/stable/api/cm_api.html</a></div>

<!--

</div>

-->

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

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

</div>

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

</form>

</li>

</ul>

</nav>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="collections_api.html" title="matplotlib.collections"

accesskey="N">next</a> |</li>

<a href="cbook_api.html" title="matplotlib.cbook"

accesskey="P">previous</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">matplotlib.cm</code></a></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>

<h1><code class="docutils literal notranslate">matplotlib.cm</code><a class="headerlink" href="#module-matplotlib.cm" title="Permalink to this headline">¶</a></h1>

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">ScalarMappable</code></a> mixin.

See also

<a class="reference internal" href="../gallery/color/colormap_reference.html">Colormap reference</a> for a list of builtin colormaps.

<a class="reference internal" href="../tutorials/colors/colormap-manipulation.html">Creating Colormaps in Matplotlib</a> for examples of how to

make colormaps.

<a class="reference internal" href="../tutorials/colors/colormaps.html">Choosing Colormaps in Matplotlib</a> an in-depth discussion of

choosing colormaps.

<a class="reference internal" href="../tutorials/colors/colormapnorms.html">Colormap Normalization</a> for more details about data

normalization.

</div>

class <code class="descclassname">matplotlib.cm.</code><code class="descname">ScalarMappable</code>(norm=None, cmap=None)<a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable">[source]</a><a class="headerlink" href="#matplotlib.cm.ScalarMappable" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate">object</code></a>

A mixin class to map scalar data to RGBA.

The ScalarMappable applies data normalization before returning RGBA colors

from the given colormap.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>norm<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">matplotlib.colors.Normalize</code></a> (or subclass thereof)</dt><dd>The normalizing object which scales data, typically into the

interval <code class="docutils literal notranslate">[0, 1]</code>.

If None, norm defaults to a colors.Normalize object which

initializes its scaling based on the first data processed.

</dd>

<dt>cmapstr 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">Colormap</code></a></dt><dd>The colormap used to map normalized data values to RGBA colors.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

<code class="descname">add_checker</code>(self, checker)<a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.add_checker">[source]</a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.add_checker" title="Permalink to this definition">¶</a></dt>

<dd>[Deprecated]

Notes

Deprecated since version 3.3:

</div>

</dd></dl>

<code class="descname">autoscale</code>(self)<a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.autoscale">[source]</a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.autoscale" title="Permalink to this definition">¶</a></dt>

<dd>Autoscale the scalar limits on the norm instance using the

current array

</dd></dl>

<code class="descname">autoscale_None</code>(self)<a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.autoscale_None">[source]</a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.autoscale_None" title="Permalink to this definition">¶</a></dt>

<dd>Autoscale the scalar limits on the norm instance using the

current array, changing only limits that are None

</dd></dl>

<code class="descname">changed</code>(self)<a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.changed">[source]</a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.changed" title="Permalink to this definition">¶</a></dt>

<dd>Call this whenever the mappable is changed to notify all the

callbackSM listeners to the 'changed' signal.

</dd></dl>

<code class="descname">check_update</code>(self, checker)<a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.check_update">[source]</a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.check_update" title="Permalink to this definition">¶</a></dt>

<dd>[Deprecated]

Notes

Deprecated since version 3.3:

</div>

</dd></dl>

<code class="descname">colorbar</code><a class="headerlink" href="#matplotlib.cm.ScalarMappable.colorbar" title="Permalink to this definition">¶</a></dt>

<dd>The last colorbar associated with this ScalarMappable. May be None.

</dd></dl>

<code class="descname">get_alpha</code>(self)<a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.get_alpha">[source]</a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.get_alpha" title="Permalink to this definition">¶</a></dt>

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first last docutils">

<dt>float</dt><dd>Always returns 1.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">get_array</code>(self)<a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.get_array">[source]</a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.get_array" title="Permalink to this definition">¶</a></dt>

<dd>Return the data array.

</dd></dl>

<code class="descname">get_clim</code>(self)<a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.get_clim">[source]</a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.get_clim" title="Permalink to this definition">¶</a></dt>

<dd>Return the values (min, max) that are mapped to the colormap limits.

</dd></dl>

<code class="descname">get_cmap</code>(self)<a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.get_cmap">[source]</a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.get_cmap" title="Permalink to this definition">¶</a></dt>

<dd>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">Colormap</code></a> instance.

</dd></dl>

<code class="descname">set_array</code>(self, A)<a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.set_array">[source]</a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.set_array" title="Permalink to this definition">¶</a></dt>

<dd>Set the image array from numpy array A.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>Andarray or None</dt><dd></dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">set_clim</code>(self, vmin=None, vmax=None)<a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.set_clim">[source]</a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.set_clim" title="Permalink to this definition">¶</a></dt>

<dd>Set the norm limits for image scaling.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>vmin, vmaxfloat</dt><dd>The limits.

The limits may also be passed as a tuple (vmin, vmax) as a

single positional argument.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">set_cmap</code>(self, cmap)<a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.set_cmap">[source]</a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.set_cmap" title="Permalink to this definition">¶</a></dt>

<dd>Set the colormap for luminance data.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>cmap<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">Colormap</code></a> or str or None</dt><dd></dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">set_norm</code>(self, norm)<a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.set_norm">[source]</a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.set_norm" title="Permalink to this definition">¶</a></dt>

<dd>Set the normalization instance.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>norm<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">Normalize</code></a> or None</dt><dd></dd>

</dl>

</td>

</tr>

</tbody>

</table>

Notes

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.

</dd></dl>

<code class="descname">to_rgba</code>(self, x, alpha=None, bytes=False, norm=True)<a class="reference internal" href="../_modules/matplotlib/cm.html#ScalarMappable.to_rgba">[source]</a><a class="headerlink" href="#matplotlib.cm.ScalarMappable.to_rgba" title="Permalink to this definition">¶</a></dt>

<dd>Return a normalized rgba array corresponding to x.

In the normal case, x is a 1D or 2D sequence of scalars, and

the corresponding ndarray of rgba values will be returned,

based on the norm and colormap set for this ScalarMappable.

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 x 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 alpha kwarg (defaulting to 1)

will be used to fill in the transparency. If the last dimension

is 4, the alpha 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.

In either case, if bytes is False (default), the rgba

array will be floats in the 0-1 range; if it is True,

the returned rgba array will be uint8 in the 0 to 255 range.

If norm is False, no normalization of the input data is

performed, and it is assumed to be in the range (0-1).

</dd></dl>

property <code class="descname">update_dict</code><a class="headerlink" href="#matplotlib.cm.ScalarMappable.update_dict" title="Permalink to this definition">¶</a></dt>

</dd></dl>

<code class="descclassname">matplotlib.cm.</code><code class="descname">get_cmap</code>(name=None, lut=None)<a class="reference internal" href="../_modules/matplotlib/cm.html#get_cmap">[source]</a><a class="headerlink" href="#matplotlib.cm.get_cmap" title="Permalink to this definition">¶</a></dt>

<dd>Get a colormap instance, defaulting to rc values if name is None.

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">register_cmap()</code></a> take precedence over

built-in colormaps.

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>name<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">matplotlib.colors.Colormap</code></a> or str or None, default: None</dt><dd>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">Colormap</code></a> instance, it will be returned. Otherwise, the name of

a colormap known to Matplotlib, which will be resampled by lut. 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">rcParams["image.cmap"]</a></code> (default: <code class="docutils literal notranslate">'viridis'</code>).

</dd>

<dt>lutint or None, default: None</dt><dd>If name is not already a Colormap instance and lut is not None, the

colormap will be resampled to have lut entries in the lookup table.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

Notes

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.

</dd></dl>

<code class="descclassname">matplotlib.cm.</code><code class="descname">register_cmap</code>(name=None, cmap=None, *, override_builtin=False)<a class="reference internal" href="../_modules/matplotlib/cm.html#register_cmap">[source]</a><a class="headerlink" href="#matplotlib.cm.register_cmap" title="Permalink to this definition">¶</a></dt>

<dd>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">get_cmap()</code></a>.

Register a new colormap to be accessed by name

<div class="highlight-default notranslate"><div class="highlight"><pre>LinearSegmentedColormap('swirly', data, lut)

register_cmap(cmap=swirly_cmap)

</pre></div>

</div>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first last docutils">

<dt>namestr, optional</dt><dd>The name that can be used in <a class="reference internal" href="#matplotlib.cm.get_cmap" title="matplotlib.cm.get_cmap"><code class="xref py py-func docutils literal notranslate">get_cmap()</code></a> or <code class="docutils literal notranslate"><a class="reference external" href="../tutorials/introductory/customizing.html?highlight=image.cmap#a-sample-matplotlibrc-file">rcParams["image.cmap"]</a></code> (default: <code class="docutils literal notranslate">'viridis'</code>)

If absent, the name will be the <code class="xref py py-attr docutils literal notranslate">name</code>

attribute of the cmap.

</dd>

<dt>cmapmatplotlib.colors.Colormap</dt><dd>Despite being the second argument and having a default value, this

is a required argument.

</dd>

<dt>override_builtinbool</dt><dd>Allow built-in colormaps to be overridden by a user-supplied

colormap.

Please do not use this unless you are sure you need it.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

Notes

Registering a colormap stores a reference to the colormap object

which can currently be modified and inadvertently change the global

colormap state. This behavior is deprecated and in Matplotlib 3.5

the registered colormap will be immutable.

</dd></dl>

<code class="descclassname">matplotlib.cm.</code><code class="descname">unregister_cmap</code>(name)<a class="reference internal" href="../_modules/matplotlib/cm.html#unregister_cmap">[source]</a><a class="headerlink" href="#matplotlib.cm.unregister_cmap" title="Permalink to this definition">¶</a></dt>

<dd>Remove a colormap 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">get_cmap()</code></a>.

You may not remove built-in colormaps.

If the named colormap is not registered, returns with no error, raises

if you try to de-register a default colormap.

Warning

Colormap names are currently a shared namespace that may be used

by multiple packages. Use <a class="reference internal" href="#matplotlib.cm.unregister_cmap" title="matplotlib.cm.unregister_cmap"><code class="xref py py-obj docutils literal notranslate">unregister_cmap</code></a> only if you know you

have registered that name before. In particular, do not

unregister just in case to clean the name before registering a

new colormap.

</div>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><dl class="first docutils">

<dt>namestr</dt><dd>The name of the colormap to be un-registered

</dd>

</dl>

</td>

</tr>

<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="first docutils">

<dt>ColorMap or None</dt><dd>If the colormap was registered, return it if not return <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.9)"><code class="xref py py-obj docutils literal notranslate">None</code></a>

</dd>

</dl>

</td>

</tr>

<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><dl class="first last docutils">

<dt>ValueError</dt><dd>If you try to de-register a default built-in colormap.

</dd>

</dl>

</td>

</tr>

</tbody>

</table>

</dd></dl>

</div>

</div>

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>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

cm_api.html

Latest commit

History

cm_api.html

File metadata and controls