mne.viz.ui_events.ColormapRange

class mne.viz.ui_events.ColormapRange(kind: str, ch_type: str | None = None, fmin: float | None = None, fmid: float | None = None, fmax: float | None = None, alpha: bool | None = None, cmap: Colormap | str | None = None)

Indicates that the user has updated the bounds of the colormap.

Parameters:

kindstr

Kind of colormap being updated. The Notes section of the drawing routine publishing this event should mention the possible kinds.

ch_typestr

Type of sensor the data originates from.

fminfloat

Minimum value in colormap (uses real fmin if None).

fmidfloat

Intermediate value in colormap (fmid between fmin and fmax if None).

fmaxfloat

Maximum value in colormap (uses real max if None).

alphafloat in [0, 1]

Alpha level to control opacity.

cmapstr

The colormap to use. Either string or matplotlib.colors.Colormap instance.

Attributes:

kindstr

Kind of colormap being updated. The Notes section of the drawing routine publishing this event should mention the possible kinds.

ch_typestr

Type of sensor the data originates from.

unitstr

The unit of the values.

namestr

The name of the event, which is the class name in snake case.

sourcematplotlib.figure.Figure | Figure3D

The figure that published the event.

fminfloat

Minimum value in colormap (uses real fmin if None).

fmidfloat

Intermediate value in colormap (fmid between fmin and fmax if None).

fmaxfloat

Maximum value in colormap (uses real max if None).

alphafloat in [0, 1]

Alpha level to control opacity.

cmapstr

The colormap to use. Either string or matplotlib.colors.Colormap instance.

property name

The name of the event, which is the class name in snake case.