visbrain.utils.Colormap¶

class visbrain.utils.Colormap(cmap='viridis', clim=None, vmin=None, under=None, vmax=None, over=None, translucent=None, alpha=1.0, lut_len=1024, interpolation=None)[source][source]¶

Main colormap class.

Parameters

cmapstring | inferno

Matplotlib colormap

climtuple/list | None

Limit of the colormap. The clim parameter must be a tuple / list of two float number each one describing respectively the (min, max) of the colormap. Every values under clim[0] or over clim[1] will peaked.

alphafloat | 1.0

The opacity to use. The alpha parameter must be between 0 and 1.

vminfloat | None

Threshold from which every color will have the color defined using the under parameter bellow.

undertuple/string | ‘dimgray’

Matplotlib color for values under vmin.

vmaxfloat | None

Threshold from which every color will have the color defined using the over parameter bellow.

overtuple/string | ‘darkred’

Matplotlib color for values over vmax.

translucenttuple | None

Set a specific range translucent. With f_1 and f_2 two floats, if translucent is :

(f_1, f_2) : values between f_1 and f_2 are set to translucent

(None, f_2) x <= f_2 are set to translucent

(f_1, None) f_1 <= x are set to translucent

lut_lenint | 1024

Number of levels for the colormap.

interpolation{None, ‘linear’, ‘cubic’}

Interpolation type. Default is None.

Attributes

dataarray_like: Get colormap data.
shapetuple: Get the shape of the data.
rarray_like: Get red levels.
garray_like: Get green levels.
barray_like: Get blue levels.
rgbarray_like: Get rgb levels.
alphaarray_like: Get transparency level.
glslvispy.colors.Colormap: Get a glsl version of the colormap.

__init__(self, cmap='viridis', clim=None, vmin=None, under=None, vmax=None, over=None, translucent=None, alpha=1.0, lut_len=1024, interpolation=None)[source][source]¶: Init.

Methods

`__init__`(self[, cmap, clim, vmin, under, …])	Init.
`to_rgba`(self, data)	Turn a data vector into colors using colormap properties.

Attributes

`alpha`	Get transparency level.
`b`	Get blue levels.
`data`	Get colormap data.
`g`	Get green levels.
`glsl`	Get a glsl version of the colormap.
`r`	Get red levels.
`rgb`	Get rgb levels.
`shape`	Get the shape of the data.

property alpha¶: Get transparency level.

property b¶: Get blue levels.

property data¶: Get colormap data.

property g¶: Get green levels.

property glsl¶: Get a glsl version of the colormap.

property r¶: Get red levels.

property rgb¶: Get rgb levels.

property shape¶: Get the shape of the data.

to_rgba(self, data)[source][source]¶

Turn a data vector into colors using colormap properties.

Parameters

dataarray_like: Vector of data of shape (n_data,).

Returns

colorarray_like: Array of colors of shape (n_data, 4)