matplotlib.github.com/1.3.1/api/cm_api.html at main · matplotlib/matplotlib.github.com · GitHub

History

380 lines (341 loc) · 20.5 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

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

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

<head>

<title>cm (colormap) — Matplotlib 1.3.1 documentation</title>

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '1.3.1',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true

};

</script>

title="Search within Matplotlib 1.3.1 documentation"

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

</head>

<body>

<div id="unreleased-message"> You are reading an old version of the documentation (v1.3.1). 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>

if ("matplotlib.sourceforge.net" == document.location.hostname ||

"matplotlib.sf.net" == document.location.hostname) {

var pkBaseURL = (("https:" == document.location.protocol) ? "https://apps.sourceforge.net/piwik/matplotlib/" : "http://apps.sourceforge.net/piwik/matplotlib/");

document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));

}

</script>

if ("matplotlib.sourceforge.net" == document.location.hostname ||

"matplotlib.sf.net" == document.location.hostname) {

piwik_action_name = '';

piwik_idsite = 1;

piwik_url = pkBaseURL + "piwik.php";

piwik_log(piwik_action_name, piwik_idsite, piwik_url);

document.write(unescape('%3Cobject%3E%3Cnoscript%3E%3Cp%3E%3Cimg src="http://apps.sourceforge.net/piwik/matplotlib/piwik.php?idsite=1" alt="piwik"/%3E%3C/p%3E%3C/noscript%3E%3C/object%3E'));

}

</script>

</map>

</div>

<h3>Navigation</h3>

<ul>

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

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

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

>modules</a> |</li>

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

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

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

accesskey="P">previous</a> |</li>

<li><a href="../examples/index.html">examples</a>| </li>

<li><a href="../gallery.html">gallery</a>| </li>

<li><a href="pyplot_summary.html">pyplot</a>| </li>

<li><a href="index.html" accesskey="U">The Matplotlib API</a> »</li>

</ul>

</div>

<h3><a href="../contents.html">Table Of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#">cm (colormap)</a><ul>

<li><a class="reference internal" href="#module-matplotlib.cm"><tt class="docutils literal"><span class="pre">matplotlib.cm</span></tt></a></li>

</ul>

</li>

</ul>

<h4>Previous topic</h4>

<p class="topless"><a href="cbook_api.html"

title="previous chapter">cbook</a></p>

<h4>Next topic</h4>

<p class="topless"><a href="collections_api.html"

title="next chapter">collections</a></p>

<li><a href="../_sources/api/cm_api.txt"

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

</ul>

<h3>Quick search</h3>

</form>

Enter search terms or a module, class or function name.

</p>

</div>

</div>

<h1>cm (colormap)<a class="headerlink" href="#cm-colormap" title="Permalink to this headline">¶</a></h1>

<span id="matplotlib-cm"></span><h2><a class="reference internal" href="#module-matplotlib.cm" title="matplotlib.cm"><tt class="xref py py-mod docutils literal"><span class="pre">matplotlib.cm</span></tt></a><a class="headerlink" href="#module-matplotlib.cm" title="Permalink to this headline">¶</a></h2>

<p>This module provides a large set of colormaps, functions for

registering new colormaps and for getting a colormap by name,

and a mixin class for adding color mapping functionality.</p>

<em class="property">class </em><tt class="descclassname">matplotlib.cm.</tt><tt class="descname">ScalarMappable</tt><big>(</big><em>norm=None</em>, <em>cmap=None</em><big>)</big><a class="headerlink" href="#matplotlib.cm.ScalarMappable" title="Permalink to this definition">¶</a></dt>

<dd><p>This is a mixin class to support scalar data to RGBA mapping.

The ScalarMappable makes use of data normalization before returning

RGBA colors from the given colormap.</p>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>norm</strong> : <a class="reference internal" href="colors_api.html#matplotlib.colors.Normalize" title="matplotlib.colors.Normalize"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.colors.Normalize</span></tt></a> instance</p>

<div><p>The normalizing object which scales data, typically into the

interval <tt class="docutils literal"><span class="pre">[0,</span> <span class="pre">1]</span></tt>.</p>

</div></blockquote>

<p><strong>cmap</strong> : str or <a class="reference internal" href="colors_api.html#matplotlib.colors.Colormap" title="matplotlib.colors.Colormap"><tt class="xref py py-class docutils literal"><span class="pre">Colormap</span></tt></a> instance</p>

<div><p>The colormap used to map normalized data values to RGBA colors.</p>

</div></blockquote>

</td>

</tr>

</tbody>

</table>

<tt class="descname">add_checker</tt><big>(</big><em>checker</em><big>)</big><a class="headerlink" href="#matplotlib.cm.ScalarMappable.add_checker" title="Permalink to this definition">¶</a></dt>

<dd><p>Add an entry to a dictionary of boolean flags

that are set to True when the mappable is changed.</p>

</dd></dl>

<tt class="descname">autoscale</tt><big>(</big><big>)</big><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>

<tt class="descname">autoscale_None</tt><big>(</big><big>)</big><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>

<tt class="descname">changed</tt><big>(</big><big>)</big><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>

<tt class="descname">check_update</tt><big>(</big><em>checker</em><big>)</big><a class="headerlink" href="#matplotlib.cm.ScalarMappable.check_update" title="Permalink to this definition">¶</a></dt>

<dd><p>If mappable has changed since the last check,

return True; else return False</p>

</dd></dl>

<dd><p>The Colormap instance of this ScalarMappable.</p>

</dd></dl>

<tt class="descname">colorbar</tt><em class="property"> = None</em><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>

<tt class="descname">get_array</tt><big>(</big><big>)</big><a class="headerlink" href="#matplotlib.cm.ScalarMappable.get_array" title="Permalink to this definition">¶</a></dt>

<dd><p>Return the array</p>

</dd></dl>

<dd><p>return the min, max of the color limits for image scaling</p>

</dd></dl>

<dd><p>return the colormap</p>

</dd></dl>

<dd><p>The Normalization instance of this ScalarMappable.</p>

</dd></dl>

<tt class="descname">set_array</tt><big>(</big><em>A</em><big>)</big><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>

</dd></dl>

<dd><p>set the norm limits for image scaling; if <em>vmin</em> is a length2

sequence, interpret it as <tt class="docutils literal"><span class="pre">(vmin,</span> <span class="pre">vmax)</span></tt> which is used to

support setp</p>

<p>ACCEPTS: a length 2 sequence of floats</p>

</dd></dl>

<dd><p>set the colormap for luminance data</p>

<p>ACCEPTS: a colormap or registered colormap name</p>

</dd></dl>

<tt class="descname">set_colorbar</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#matplotlib.cm.ScalarMappable.set_colorbar" title="Permalink to this definition">¶</a></dt>

<p><span>Deprecated since version 1.3: </span>The set_colorbar function was deprecated in version 1.3. Use the colorbar attribute instead.</p>

</div>

<p>set the colorbar and axes instances associated with mappable</p>

</dd></dl>

<dd><p>set the normalization instance</p>

</dd></dl>

<tt class="descname">to_rgba</tt><big>(</big><em>x</em>, <em>alpha=None</em>, <em>bytes=False</em><big>)</big><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.

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>Note: this method assumes the input is well-behaved; it does

not check for anomalies such as <em>x</em> being a masked rgba

array, or being an integer type other than uint8, or being

a floating point rgba array with values outside the 0-1 range.</p>

</dd></dl>

<tt class="descclassname">matplotlib.cm.</tt><tt class="descname">get_cmap</tt><big>(</big><em>name=None</em>, <em>lut=None</em><big>)</big><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"><tt class="xref py py-func docutils literal"><span class="pre">register_cmap()</span></tt></a> take precedence over

built-in colormaps.</p>

<p>If <em>name</em> is a <a class="reference internal" href="colors_api.html#matplotlib.colors.Colormap" title="matplotlib.colors.Colormap"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.colors.Colormap</span></tt></a> instance, it will be

returned.</p>

<p>If <em>lut</em> is not None it must be an integer giving the number of

entries desired in the lookup table, and <em>name</em> must be a

standard mpl colormap name with a corresponding data dictionary

in <em>datad</em>.</p>

</dd></dl>

<tt class="descclassname">matplotlib.cm.</tt><tt class="descname">register_cmap</tt><big>(</big><em>name=None</em>, <em>cmap=None</em>, <em>data=None</em>, <em>lut=None</em><big>)</big><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"><tt class="xref py py-func docutils literal"><span class="pre">get_cmap()</span></tt></a>.</p>

<div class="highlight-python"><div class="highlight"><pre><span class="n">register_cmap</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s">'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="s">'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="colors_api.html#matplotlib.colors.Colormap" title="matplotlib.colors.Colormap"><tt class="xref py py-class docutils literal"><span class="pre">matplotlib.colors.Colormap</span></tt></a>

instance. The <em>name</em> is optional; if absent, the name will

be the <tt class="xref py py-attr docutils literal"><span class="pre">name</span></tt> attribute of the <em>cmap</em>.</p>

<p>In the second case, the three arguments are passed to

the <a class="reference internal" href="colors_api.html#matplotlib.colors.LinearSegmentedColormap" title="matplotlib.colors.LinearSegmentedColormap"><tt class="xref py py-class docutils literal"><span class="pre">LinearSegmentedColormap</span></tt></a> initializer,

and the resulting colormap is registered.</p>

</dd></dl>

<tt class="descclassname">matplotlib.cm.</tt><tt class="descname">revcmap</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#matplotlib.cm.revcmap" title="Permalink to this definition">¶</a></dt>

<dd><p>Can only handle specification <em>data</em> in dictionary format.</p>

</dd></dl>

</div>

</div>

<h3>Navigation</h3>

<ul>

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

>index</a></li>

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

>modules</a> |</li>

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

>next</a> |</li>

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

>previous</a> |</li>

<li><a href="../examples/index.html">examples</a>| </li>

<li><a href="../gallery.html">gallery</a>| </li>

<li><a href="pyplot_summary.html">pyplot</a>| </li>

<li><a href="index.html" >The Matplotlib API</a> »</li>

</ul>

</div>

Last updated on Oct 10, 2013.

Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b2.

</div>

</body>

</html>

matplotlib.github.com/1.3.1/api/cm_api.html at main · matplotlib/matplotlib.github.com · GitHub

Expand file tree

Breadcrumbs

cm_api.html

Latest commit

History

Breadcrumbs

cm_api.html

File metadata and controls