You are reading documentation for the unreleased version of Matplotlib. Try searching for the released version of this page instead?
Version 3.1.0.post1213+g63d96d286
matplotlib
Fork me on GitHub

Table of Contents

matplotlib.colors.Colormap

class matplotlib.colors.Colormap(name, N=256)[source]

Bases: object

Baseclass for all scalar to RGBA mappings.

Typically Colormap instances are used to convert data values (floats) from the interval [0, 1] to the RGBA color that the respective Colormap represents. For scaling of data into the [0, 1] interval see matplotlib.colors.Normalize. It is worth noting that matplotlib.cm.ScalarMappable subclasses make heavy use of this data->normalize->map-to-color processing chain.

Parameters:
name : str

The name of the colormap.

N : int

The number of rgb quantization levels.

colorbar_extend = None

When this colormap exists on a scalar mappable and colorbar_extend is not False, colorbar creation will pick up colorbar_extend as the default value for the extend keyword in the matplotlib.colorbar.Colorbar constructor.

is_gray(self)[source]
reversed(self, name=None)[source]

Make a reversed instance of the Colormap.

Note

Function not implemented for base class.

Parameters:
name : str, optional

The name for the reversed colormap. If it's None the name will be the name of the parent colormap + "_r".

set_bad(self, color='k', alpha=None)[source]

Set color to be used for masked values.

set_over(self, color='k', alpha=None)[source]

Set the color for high out-of-range values when norm.clip = False.

set_under(self, color='k', alpha=None)[source]

Set the color for low out-of-range values when norm.clip = False.

Examples using matplotlib.colors.Colormap