matplotlib.github.com/cmocean/cmocean.html at plausible · matplotlib/matplotlib.github.com · GitHub

History

360 lines (329 loc) · 17 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

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

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

<head>

<title>cmocean package — cmocean 0.02 documentation</title>

</head><body>

<h1>cmocean package<a class="headerlink" href="#cmocean-package" title="Permalink to this headline">¶</a></h1>

<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>

</div>

<h2>cmocean.cmocean module<a class="headerlink" href="#cmocean-cmocean-module" title="Permalink to this headline">¶</a></h2>

</div>

<span id="cmocean-plots-module"></span><h2>cmocean.plots module<a class="headerlink" href="#module-cmocean.plots" title="Permalink to this headline">¶</a></h2>

<p>Plots with colormaps.</p>

<code class="descclassname">cmocean.plots.</code><code class="descname">plot_gallery</code><span class="sig-paren">(</span><em>saveplot=False</em><span class="sig-paren">)</span><a class="headerlink" href="#cmocean.plots.plot_gallery" title="Permalink to this definition">¶</a></dt>

<dd><p>Make plot of colormaps and labels, like in the matplotlib

gallery.</p>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>saveplot=False</strong> – Whether to save the plot or not.</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descclassname">cmocean.plots.</code><code class="descname">plot_lightness</code><span class="sig-paren">(</span><em>saveplot=False</em><span class="sig-paren">)</span><a class="headerlink" href="#cmocean.plots.plot_lightness" title="Permalink to this definition">¶</a></dt>

<dd><p>Plot lightness of colormaps together.</p>

</dd></dl>

<code class="descclassname">cmocean.plots.</code><code class="descname">quick_plot</code><span class="sig-paren">(</span><em>cmap</em>, <em>fname=None</em>, <em>fig=None</em>, <em>ax=None</em>, <em>N=10</em><span class="sig-paren">)</span><a class="headerlink" href="#cmocean.plots.quick_plot" title="Permalink to this definition">¶</a></dt>

<dd><p>Show quick test of a colormap.</p>

</dd></dl>

<code class="descclassname">cmocean.plots.</code><code class="descname">test</code><span class="sig-paren">(</span><em>cmap</em>, <em>fig=None</em>, <em>ax=None</em><span class="sig-paren">)</span><a class="headerlink" href="#cmocean.plots.test" title="Permalink to this definition">¶</a></dt>

<dd><p>Test colormap by plotting.</p>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cmap</strong> – A colormap instance. Use a named one with cm.get_cmap(colormap)</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descclassname">cmocean.plots.</code><code class="descname">wrap_viscm</code><span class="sig-paren">(</span><em>cmap</em>, <em>dpi=100</em>, <em>saveplot=False</em><span class="sig-paren">)</span><a class="headerlink" href="#cmocean.plots.wrap_viscm" title="Permalink to this definition">¶</a></dt>

<dd><p>Evaluate goodness of colormap using perceptual deltas.</p>

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

<li><strong>cmap</strong> – Colormap instance.</li>

<li><strong>dpi=100</strong> – dpi for saved image.</li>

<li><strong>saveplot=False</strong> – Whether to save the plot or not.</li>

</ul>

</td>

</tr>

</tbody>

</table>

</dd></dl>

</div>

<span id="cmocean-tools-module"></span><h2>cmocean.tools module<a class="headerlink" href="#module-cmocean.tools" title="Permalink to this headline">¶</a></h2>

<p>Plot up stuff with colormaps.</p>

<code class="descclassname">cmocean.tools.</code><code class="descname">cmap</code><span class="sig-paren">(</span><em>rgbin</em>, <em>N=256</em><span class="sig-paren">)</span><a class="headerlink" href="#cmocean.tools.cmap" title="Permalink to this definition">¶</a></dt>

<dd><p>Input an array of rgb values to generate a colormap.</p>

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

<li><strong>rgbin</strong> – An [mx3] array, where m is the number of input color triplets which

are interpolated between to make the colormap that is returned. hex values

can be input instead, as [mx1] in single quotes with a #.</li>

<li><strong>N=10</strong> – The number of levels to be interpolated to.</li>

</ul>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descclassname">cmocean.tools.</code><code class="descname">crop</code><span class="sig-paren">(</span><em>cmapin</em>, <em>vmin</em>, <em>vmax</em>, <em>pivot</em>, <em>N=None</em>, <em>dmax=None</em><span class="sig-paren">)</span><a class="headerlink" href="#cmocean.tools.crop" title="Permalink to this definition">¶</a></dt>

<dd><p>Crop end or ends of a diverging colormap by vmin/vmax values.</p>

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

<li><strong>cmap</strong> – A colormap object, like cmocean.cm.matter.</li>

<li><strong>vmin/vmax</strong> – vmin/vmax for use in plot with colormap.</li>

<li><strong>pivot</strong> – center point to be used in plot with diverging colormap.</li>

<li><strong>N=None</strong> – User can specify the number of rows for the outgoing colormap.

If unspecified, N from incoming colormap will be used and values will

be interpolated as needed to fill in rows.</li>

<li><strong>dmax=None</strong> – dmax is the highest number to be included in a plot with

the colormap; values higher in magnitude than dmax are removed from both

ends of colormap. It should be less than abs(vmin) and abs(vmax), which

should be equal for this parameter to be used.</li>

</ul>

</td>

</tr>

</tbody>

</table>

<p>Outputs resultant colormap object.</p>

<dt>This function can be used for sequential and other non-diverging colormaps</dt>

<dd>but it is easier to use that way through crop_by_percent().</dd>

<dt>This should be useful for plotting bathymetry and topography data with the</dt>

<dd>topo colormap when max bathymetry value is different from max topography.</dd>

<dt>Example usage:</dt>

<dd><p class="first"># example for crop on min end of diverging colormap

vmin = -2; vmax = 5; pivot = 0

newcmap = crop(cmocean.cm.curl, vmin, vmax, pivot)

A = np.random.randint(vmin, vmax, (5,5))

plt.pcolormesh(A, vmin=vmin, vmax=vmax, cmap=newcmap)

plt.colorbar()</p>

<p class="last"># example for crop on max end of diverging colormap

vmin = -10; vmax = 8; pivot = 0

newcmap = crop(cmocean.cm.delta, vmin, vmax, pivot)

A = np.random.randint(vmin, vmax, (5,5))

plt.pcolormesh(A, vmin=vmin, vmax=vmax, cmap=newcmap)

plt.colorbar()</p>

</dd>

</dl>

</dd></dl>

<code class="descclassname">cmocean.tools.</code><code class="descname">crop_by_percent</code><span class="sig-paren">(</span><em>cmap</em>, <em>per</em>, <em>which='both'</em>, <em>N=None</em><span class="sig-paren">)</span><a class="headerlink" href="#cmocean.tools.crop_by_percent" title="Permalink to this definition">¶</a></dt>

<dd><p>Crop end or ends of a colormap by per percent.</p>

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

<li><strong>cmap</strong> – A colormap object, like cmocean.cm.matter.</li>

<li><strong>per</strong> – Percent of colormap to remove. If which==’both’, take this

percent off both ends of colormap. If which==’min’ or which==’max’,

take percent only off the specified end of colormap.</li>

<li><strong>which='both'</strong> – which end or ends of colormap to cut off. which=’both’

removes from both ends, which=’min’ from bottom end, and which=’max’

from top end.</li>

<li><strong>N=None</strong> – User can specify the number of rows for the outgoing colormap.

If unspecified, N from incoming colormap will be used and values will

be interpolated as needed to fill in rows.</li>

</ul>

</td>

</tr>

</tbody>

</table>

<p>Outputs resultant colormap object.</p>

<dt>This is a wrapper around crop() to make it easier to use for cropping</dt>

<dd>based on percent.</dd>

<dt>Examples:</dt>

<dd><p class="first"># example with oxy map: cut off yellow part which is top 20%

# compare with full colormap

vmin = 0; vmax = 10; pivot = 5

A = np.random.randint(vmin, vmax, (5,5))

fig, axes = plt.subplots(1, 2)

mappable = axes[0].pcolormesh(A, vmin=vmin, vmax=vmax, cmap=cmocean.cm.oxy)

fig.colorbar(mappable, ax=axes[0])

vmin = 0; vmax = 8; pivot = 5

newcmap = crop_by_percent(cmocean.cm.oxy, 20, which=’max’, N=None)

plt.figure()

plt.pcolormesh(A, vmin=vmin, vmax=vmax, cmap=newcmap)

plt.colorbar()</p>

<p># example with oxy map: cut off red part which is bottom 20%

# compare with full colormap

vmin = 0; vmax = 10; pivot = 5

A = np.random.randint(vmin, vmax, (5,5))

fig, axes = plt.subplots(1, 2)

mappable = axes[0].pcolormesh(A, vmin=vmin, vmax=vmax, cmap=cmocean.cm.oxy)

fig.colorbar(mappable, ax=axes[0])

vmin = 2; vmax = 10; pivot = 5

A = np.random.randint(vmin, vmax, (5,5))

newcmap = crop_by_percent(cmocean.cm.oxy, 20, which=’min’, N=None)

plt.figure()

plt.pcolormesh(A, vmin=vmin, vmax=vmax, cmap=newcmap)

plt.colorbar()</p>

<p class="last"># crop both dark ends off colormap to reduce range

newcmap = crop_by_percent(cmocean.cm.balance, 10, which=’both’, N=None)

plt.figure()

A = np.random.randint(-5, 5, (5,5))

plt.pcolormesh(A, vmin=vmin, vmax=vmax, cmap=newcmap)

plt.colorbar()</p>

</dd>

</dl>

</dd></dl>

<code class="descclassname">cmocean.tools.</code><code class="descname">get_dict</code><span class="sig-paren">(</span><em>cmap</em>, <em>N=256</em><span class="sig-paren">)</span><a class="headerlink" href="#cmocean.tools.get_dict" title="Permalink to this definition">¶</a></dt>

<dd><p>Change from rgb to dictionary that LinearSegmentedColormap expects.

Code from <a class="reference external" href="https://mycarta.wordpress.com/2014/04/25/convert-color-palettes-to-python-matplotlib-colormaps/">https://mycarta.wordpress.com/2014/04/25/convert-color-palettes-to-python-matplotlib-colormaps/</a>

and <a class="reference external" href="http://nbviewer.ipython.org/github/kwinkunks/notebooks/blob/master/Matteo_colourmaps.ipynb">http://nbviewer.ipython.org/github/kwinkunks/notebooks/blob/master/Matteo_colourmaps.ipynb</a></p>

</dd></dl>

<code class="descclassname">cmocean.tools.</code><code class="descname">lighten</code><span class="sig-paren">(</span><em>cmapin</em>, <em>alpha</em><span class="sig-paren">)</span><a class="headerlink" href="#cmocean.tools.lighten" title="Permalink to this definition">¶</a></dt>

<dd><p>Lighten a colormap by adding alpha < 1.</p>

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

<li><strong>cmap</strong> – A colormap object, like cmocean.cm.matter.</li>

<li><strong>alpha</strong> – An alpha or transparency value to assign the colormap. Alpha

of 1 is opaque and of 1 is fully transparent.</li>

</ul>

</td>

</tr>

</tbody>

</table>

<p>Outputs resultant colormap object.</p>

<dt>This will lighten the appearance of a plot you make using the output</dt>

<dd>colormap object. It is also possible to lighten many plots in the

plotting function itself (e.g. pcolormesh or contourf).</dd>

</dl>

</dd></dl>

<code class="descclassname">cmocean.tools.</code><code class="descname">print_colormaps</code><span class="sig-paren">(</span><em>cmaps</em>, <em>N=256</em>, <em>returnrgb=True</em>, <em>savefiles=False</em><span class="sig-paren">)</span><a class="headerlink" href="#cmocean.tools.print_colormaps" title="Permalink to this definition">¶</a></dt>

<dd><p>Print colormaps in 256 RGB colors to text files.</p>

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>returnrgb=False</strong> – Whether or not to return the rgb array. Only makes sense to do if print one colormaps’ rgb.</td>

</tr>

</tbody>

</table>

</dd></dl>

</div>

<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cmocean" title="Permalink to this headline">¶</a></h2>

<p>cmocean is a package to help standardize colormaps for commonly-plotted

oceanographic properties.</p>

<p>See README.md for an overview on instructions.</p>

</div>

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

<ul>

<li><a class="reference internal" href="#">cmocean package</a><ul>

<li><a class="reference internal" href="#submodules">Submodules</a></li>

<li><a class="reference internal" href="#cmocean-cmocean-module">cmocean.cmocean module</a></li>

<li><a class="reference internal" href="#module-cmocean.plots">cmocean.plots module</a></li>

<li><a class="reference internal" href="#module-cmocean.tools">cmocean.tools module</a></li>

<li><a class="reference internal" href="#module-cmocean">Module contents</a></li>

</ul>

</li>

</ul>

<h3>Related Topics</h3>

<ul>

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

</ul></li>

</ul>

</div>

<li><a href="_sources/cmocean.rst.txt"

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

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

</div>

</div>

& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>

<a href="_sources/cmocean.rst.txt"

rel="nofollow">Page source</a>

</div>

</body>

</html>

matplotlib.github.com/cmocean/cmocean.html at plausible · matplotlib/matplotlib.github.com · GitHub

Expand file tree

Breadcrumbs

cmocean.html

Latest commit

History

Breadcrumbs

cmocean.html

File metadata and controls