vispy.color.colormap module

class vispy.color.colormap.BaseColormap(colors=None)

Bases: object

Class representing a colormap:

t in [0, 1] –> rgba_color

Parameters

colorslist of lists, tuples, or ndarrays

The control colors used by the colormap (shape = (ncolors, 4)).

Notes

Must be overriden. Child classes need to implement:

glsl_mapstring

The GLSL function for the colormap. Use $color_0 to refer to the first color in colors, and so on. These are vec4 vectors.

map(item)function

Takes a (N, 1) vector of values in [0, 1], and returns a rgba array of size (N, 4).

colors = None

glsl_map = None

map(item)

Return a rgba array for the requested items.

This function must be overriden by child classes.

This function doesn’t need to implement argument checking on item. It can always assume that item is a (N, 1) array of values between 0 and 1.

Parameters

itemndarray

An array of values in [0,1].

Returns

rgbandarray

An array with rgba values, with one color per item. The shape should be item.shape + (4,).

Notes

Users are expected to use a colormap with __getitem__() rather than map() (which implements a lower-level API).

texture_map_data = None

class vispy.color.colormap.Colormap(colors, controls=None, interpolation='linear')

Bases: vispy.color.colormap.BaseColormap

A colormap defining several control colors and an interpolation scheme.

Parameters

colorslist of colors | ColorArray

The list of control colors. If not a ColorArray, a new ColorArray instance is created from this list. See the documentation of ColorArray.

controlsarray-like

The list of control points for the given colors. It should be an increasing list of floating-point number between 0.0 and 1.0. The first control point must be 0.0. The last control point must be 1.0. The number of control points depends on the interpolation scheme.

interpolationstr

The interpolation mode of the colormap. Default: ‘linear’. Can also be ‘zero’. If ‘linear’, ncontrols = ncolors (one color per control point). If ‘zero’, ncontrols = ncolors+1 (one color per bin).

Examples

Here is a basic example:

>>> from vispy.color import Colormap
>>> cm = Colormap(['r', 'g', 'b'])
>>> cm[0.], cm[0.5], cm[np.linspace(0., 1., 100)]

property interpolation

The interpolation mode of the colormap

map(x)

The Python mapping function from the [0,1] interval to a list of rgba colors

Parameters

xarray-like

The values to map.

Returns

colorslist

List of rgba colors.

texture_lut()

Return a texture2D object for LUT after its value is set.

class vispy.color.colormap.CubeHelixColormap(start=0.5, rot=1, gamma=1.0, reverse=True, nlev=32, minSat=1.2, maxSat=1.2, minLight=0.0, maxLight=1.0, **kwargs)

Bases: vispy.color.colormap.Colormap

class vispy.color.colormap.MatplotlibColormap(name)

Bases: vispy.color.colormap.Colormap

Use matplotlib colormaps if installed.

Parameters

namestring

Name of the colormap.

vispy.color.colormap.get_colormap(name, *args, **kwargs)

Obtain a colormap

Some colormaps can have additional configuration parameters. Refer to their corresponding documentation for more information.

Parameters

namestr | Colormap

Colormap name. Can also be a Colormap for pass-through.

Examples

>>> get_colormap('autumn')
>>> get_colormap('single_hue', hue=10)

vispy.color.colormap.get_colormaps()

Return the list of colormap names.

vispy.color.colormap.mix(colors, x, controls=None)

vispy.color.colormap.smoothstep(edge0, edge1, x)

performs smooth Hermite interpolation between 0 and 1 when edge0 < x < edge1.

vispy.color.colormap.step(colors, x, controls=None)

vispy.color.color_space module vispy.geometry package