matplotlib.colors.SegmentedBivarColormap

classmatplotlib.colors.SegmentedBivarColormap(patch, N=256, shape='square', origin=(0, 0), name='segmented bivariate colormap')[source]

Bases: BivarColormap

BivarColormap object generated by supersampling a regular grid.

Parameters:

patchnp.array

Patch is required to have a shape (k, l, 3), and will get supersampled to a lut of shape (N, N, 4).

Nint

The number of RGB quantization levels along each axis.

shape{'square', 'circle', 'ignore', 'circleignore'}

• If 'square' each variate is clipped to [0,1] independently
• If 'circle' the variates are clipped radially to the center of the colormap, and a circular mask is applied when the colormap is displayed
• If 'ignore' the variates are not clipped, but instead assigned the 'outside' color
• If 'circleignore' a circular mask is applied, but the data is not clipped

origin(float, float)

The relative origin of the colormap. Typically (0, 0), for colormaps that are linear on both axis, and (.5, .5) for circular colormaps. Used when getting 1D colormaps from 2D colormaps.

namestr, optional

The name of the colormap.

Parameters:

Nint, default: 256

The number of RGB quantization levels along the first axis.

Mint, default: 256

The number of RGB quantization levels along the second axis.

shape{'square', 'circle', 'ignore', 'circleignore'}

• 'square' each variate is clipped to [0,1] independently
• 'circle' the variates are clipped radially to the center of the colormap, and a circular mask is applied when the colormap is displayed
• 'ignore' the variates are not clipped, but instead assigned the 'outside' color
• 'circleignore' a circular mask is applied, but the data is not clipped and instead assigned the 'outside' color

origin(float, float), default: (0,0)

The relative origin of the colormap. Typically (0, 0), for colormaps that are linear on both axis, and (.5, .5) for circular colormaps. Used when getting 1D colormaps from 2D colormaps.

namestr, optional

The name of the colormap.