class visbrain.objects.ImageObj(name, data=None, xaxis=None, yaxis=None, cmap='viridis', clim=None, vmin=None, under='gray', vmax=None, over='red', interpolation='nearest', max_pts=-1, parent=None, transform=None, verbose=None, **kw)[source][source]

Create a single image object.


Array of data. If data.ndim in [1, 2] the color is inferred from the data. Otherwise, if data.ndim is 3, data is interpreted as color if the last dimension is either 3 (RGB) or 4 (RGBA).

xaxisarray_like | None

Vector to use for the x-axis (number of columns in the image). If None, xaxis is inferred from the second dimension of data.

yaxisarray_like | None

Vector to use for the y-axis (number of rows in the image). If None, yaxis is inferred from the first dimension of data.

climtuple | None

Colorbar limits. If None, clim=(data.min(), data.max())

cmapstring | None

Colormap name.

vminfloat | None

Minimum threshold of the colorbar.

understring/tuple/array_like | None

Color for values under vmin.

vmaxfloat | None

Maximum threshold of the colorbar.

understring/tuple/array_like | None

Color for values over vmax.

interpolationstring | ‘nearest’

Interpolation method for the image. See vispy.scene.visuals.Image for availables interpolation methods.

max_ptsint | -1

Maximum number of points of the image along the x or y axis. This parameter is essentially used to solve OpenGL issues with very large images.

transformVisPy.visuals.transforms | None

VisPy transformation to set to the parent node.

parentVisPy.parent | None

Markers object parent.


Verbosity level.

kwdict | {}

Optional arguments are used to control the colorbar (See ColorbarObj).


List of supported shortcuts :

  • s : save the figure

  • <delete> : reset camera


>>> import numpy as np
>>> from visbrain.objects import ImageObj
>>> n = 100
>>> time = np.r_[np.arange(n - 1), np.arange(n)[::-1]]
>>> time = time.reshape(-1, 1) + time.reshape(1, -1)
>>> im = ImageObj('im', time, cmap='Spectral_r', interpolation='bicubic')
>>> im.preview(axis=True)


__init__(self, name[, data, xaxis, yaxis, …])


animate(self[, step, interval, iterations])

Animate the object.


Get a copy of the object.


Tree description.

preview(self[, bgcolor, axis, xyz, show, …])

Previsualize the result.

record_animation(self, name[, n_pic, bgcolor])

Record an animated object and save as a *.gif file.


Render the canvas.

screenshot(self, saveas[, print_size, dpi, …])

Take a screeshot of the scene.

set_data(self, data[, xaxis, yaxis, clim, …])

Set data to the image.

set_shortcuts_to_canvas(self, canvas)

Set shortcuts to a VisbrainCanvas.


Return a dictionary of all colorbar args.

to_kwargs(self[, addisminmax])

Return a dictionary for input arguments.


Fonction to run when an update is needed.

update_from_dict(self, kwargs)

Update attributes from a dictionary.

animate(self, step=1.0, interval='auto', iterations=-1)[source]

Animate the object.

Note that this method can only be used with 3D objects.

stepfloat | 1.

Rotation step.

intervalfloat | ‘auto’

Time between events in seconds. The default is ‘auto’, which attempts to find the interval that matches the refresh rate of the current monitor. Currently this is simply 1/60.

iterationsint | -1

Number of iterations. Can be -1 for infinite.

property clim

Get the clim value.

property cmap

Get the cmap value.


Get a copy of the object.

property data_folder

Get the data_folder value.

property interpolation

Get the interpolation value.

property name

Get the name value.

property over

Get the over value.

property parent

Get the parent value.

preview(self, bgcolor='black', axis=False, xyz=False, show=True, obj=None, size=(1200, 800), mpl=False, **kwargs)[source]

Previsualize the result.

bgcolorarray_like/string/tuple | ‘black’

Background color for the preview.

axisbool | False

Add x and y axis with ticks.

xyzbool | False

Add an (x, y, z) axis to the scene.

objVisbrainObj | None

Pass a Visbrain object if you want to use the camera of an other object.

sizetuple | (1200, 800)

Default size of the window.

mplbool | False

Use Matplotlib to display the object. This result in a non interactive figure.

kwargsdict | {}

Optional arguments are passed to the VisbrainCanvas class.

record_animation(self, name, n_pic=10, bgcolor=None)[source]

Record an animated object and save as a *.gif file.

Note that this method :

  • Can only be used with 3D objects.

  • Requires the python package imageio


Name of the gif file (e.g ‘myfile.gif’)

n_picint | 10

Number of pictures to use to render the gif.

bgcolorstring, tuple, list | None

Background color.


Render the canvas.


Array of shape (n_rows, n_columns, 4) where 4 describes the RGBA components.

screenshot(self, saveas, print_size=None, dpi=300.0, unit='centimeter', factor=None, region=None, autocrop=False, bgcolor=None, transparent=False, obj=None, line_width=1.0, **kwargs)[source]

Take a screeshot of the scene.

By default, the rendered canvas will have the size of your screen. The screenshot() method provides two ways to increase to exported image resolution :

  • Using print_size, unit and dpi inputs : specify the size of the image at a specific dpi level. For example, you might want to have an (10cm, 15cm) image at 300 dpi.

  • Using the factor input : multiply the default image size by this factor. For example, if you have a (1920, 1080) monitor and if factor is 2, the exported image should have a shape of (3840, 2160) pixels.


The name of the file to be saved. This file must contains a extension like .png, .tiff, .jpg…

print_sizetuple | None

The desired print size. This argument should be used in association with the dpi and unit inputs. print_size describe should be a tuple of two floats describing (width, height) of the exported image for a specific dpi level. The final image might not have the exact desired size but will try instead to find a compromize regarding to the proportion of width/height of the original image.

dpifloat | 300.

Dots per inch for printing the image.

unit{‘centimeter’, ‘millimeter’, ‘pixel’, ‘inch’}

Unit of the printed size.

factorfloat | None

If you don’t want to use the print_size input, factor simply multiply the resolution of your screen.

regiontuple | None

Select a specific region. Must be a tuple of four integers each one describing (x_start, y_start, width, height).

autocropbool | False

Automaticaly crop the figure in order to have the smallest space between the brain and the border of the picture.

bgcolorarray_like/string | None

The background color of the image.

transparentbool | False

Specify if the exported figure have to contains a transparent background.

objVisbrainObj | None

Pass a Visbrain object if you want to use the camera of an other object for the sceen rendering.

kwargsdict | {}

Optional arguments are passed to the VisbrainCanvas class.

set_data(self, data, xaxis=None, yaxis=None, clim=None, cmap=None, vmin=None, under=None, vmax=None, over=None)[source][source]

Set data to the image.

property transform

Get the transform value.

property under

Get the under value.

property visible_obj

Get the visible_obj value.

property vmax

Get the vmax value.

property vmin

Get the vmin value.

Examples using visbrain.objects.ImageObj