API docs¶

Note that ipyvolume.pylab and ipyvolume.widgets are imported in the ipyvolume namespace, to you can access ipyvolume.scatter instead of ipyvolume.pylab.scatter.

Quick list for plotting.¶

`ipyvolume.pylab.volshow`(data[, lighting, …])	Visualize a 3d array using volume rendering.
`ipyvolume.pylab.scatter`(x, y, z[, color, …])	Plot many markers/symbols in 3d.
`ipyvolume.pylab.quiver`(x, y, z, u, v, w[, …])	Create a quiver plot, which is like a scatter plot but with arrows pointing in the direction given by u, v and w.
`ipyvolume.pylab.plot`(x, y, z[, color, …])	Plot a line in 3d.
`ipyvolume.pylab.plot_surface`(x, y, z[, …])	Draws a 2d surface in 3d, defined by the 2d ordered arrays x,y,z.
`ipyvolume.pylab.plot_trisurf`(x, y, z[, …])	Draw a polygon/triangle mesh defined by a coordinate and triangle indices.
`ipyvolume.pylab.plot_wireframe`(x, y, z[, …])	Draws a 2d wireframe in 3d, defines by the 2d ordered arrays x,y,z.
`ipyvolume.pylab.plot_mesh`(x, y, z[, color, …])	Draws a 2d wireframe+surface in 3d: generalization of `plot_wireframe` and `plot_surface`.
`ipyvolume.pylab.plot_isosurface`(data[, …])	Plot a surface at constant value (like a 2d contour).

Quick list for controlling the figure.¶

`ipyvolume.pylab.figure`([key, width, height, …])	Create a new figure if no key is given, or return the figure associated with key.
`ipyvolume.pylab.gcf`()	Get current figure, or create a new one.
`ipyvolume.pylab.gcc`()	Return the current container, that is the widget holding the figure and all the control widgets, buttons etc.
`ipyvolume.pylab.clear`()	Remove current figure (and container).
`ipyvolume.pylab.show`([extra_widgets])	Display (like in IPython.display.dispay(…)) the current figure.
`ipyvolume.pylab.view`([azimuth, elevation, …])	Set camera angles and distance and return the current.
`ipyvolume.pylab.xlim`(xmin, xmax)	Set limits of x axis.
`ipyvolume.pylab.ylim`(ymin, ymax)	Set limits of y axis.
`ipyvolume.pylab.zlim`(zmin, zmax)	Set limits of zaxis.
`ipyvolume.pylab.xyzlim`(vmin[, vmax])	Set limits or all axis the same, if vmax not given, use [-vmin, vmin].

Quick list for style and labels.¶

`ipyvolume.pylab.xlabel`(label)	Set the labels for the x-axis.
`ipyvolume.pylab.ylabel`(label)	Set the labels for the y-axis.
`ipyvolume.pylab.zlabel`(label)	Set the labels for the z-axis.
`ipyvolume.pylab.xyzlabel`(labelx, labely, labelz)	Set all labels at once.
`ipyvolume.pylab.style.use`(style)	Set the style of the current figure/visualization.
`ipyvolume.pylab.style.set_style_dark`()	Short for style.use(‘dark’)
`ipyvolume.pylab.style.set_style_light`()	Short for style.use(‘light’)
`ipyvolume.pylab.style.box_off`()	Do not draw the box around the visible volume.
`ipyvolume.pylab.style.box_on`()	Draw a box around the visible volume.
`ipyvolume.pylab.style.axes_off`([which])	Do not draw the axes, optionally give axis names, e.g.
`ipyvolume.pylab.style.axes_on`([which])	Draw the axes, optionally give axis names, e.g.
`ipyvolume.pylab.style.background_color`(color)	Set the background color.

Quick list for saving figures.¶

`ipyvolume.pylab.save`(filepath[, makedirs, …])	Save the current container to a HTML file.
`ipyvolume.pylab.savefig`(filename[, width, …])	Save the figure to an image file.
`ipyvolume.pylab.screenshot`([width, height, …])	Save the figure to a PIL.Image object.

ipyvolume.pylab¶

The pylab module of ipvyolume.

ipyvolume.pylab.scatter(x, y, z, color='red', size=2, size_selected=2.6, color_selected='white', marker='diamond', selection=None, grow_limits=True, cast_shadow=True, receive_shadow=True, description=None, **kwargs)[source]¶

Plot many markers/symbols in 3d.: Due to certain shader limitations, should not use with Spot Lights and Point Lights. Does not support shadow mapping.

Parameters:

x – numpy array of shape (N,) or (S, N) with x positions. If an (S, N) array, the first dimension will be used for frames in an animation.
y – idem for y
z – idem for z
color – color for each point/vertex/symbol, can be string format, examples for red:’red’, ‘#f00’,’#ff0000’ or’rgb(1,0,0), or rgb array of shape (N, 3 or 4) or (S, N, 3 or 4) Color of the material, essentially a solid color unaffected by other lighting. Default is ‘red’
size – float representing the size of the glyph in percentage of the viewport, where 100 is the full size of the viewport
size_selected – like size, but for selected glyphs
color_selected – like color, but for selected glyphs
marker – name of the marker, options are: ‘arrow’, ‘box’, ‘diamond’, ‘sphere’, ‘point_2d’, ‘square_2d’, ‘triangle_2d’,
selection – numpy array of shape (N,) or (S, N) with indices of x,y,z arrays of the selected markers, which can have a different size and color
cast_shadow – If this object casts a shadown on other options (default) or not. Works only with Directional, Point and Spot lights.
receive_shadow – If this objects receives shadows (default) or not. Works only with Directional, Point and Spot lights.
kwargs –

Returns:

Scatter

ipyvolume.pylab.quiver(x, y, z, u, v, w, size=20, size_selected=26.0, color='red', color_selected='white', marker='arrow', cast_shadow=True, receive_shadow=True, **kwargs)[source]¶

Create a quiver plot, which is like a scatter plot but with arrows pointing in the direction given by u, v and w.

Parameters:

x – numpy array of shape (N,) or (S, N) with x positions. If an (S, N) array, the first dimension will be used for frames in an animation.
y – idem for y
z – idem for z
u – numpy array of shape (N,) or (S, N) indicating the x component of a vector. If an (S, N) array, the first dimension will be used for frames in an animation.
v – idem for y
w – idem for z
size – float representing the size of the glyph in percentage of the viewport, where 100 is the full size of the viewport
size_selected – like size, but for selected glyphs
color – color for each point/vertex/symbol, can be string format, examples for red:’red’, ‘#f00’,’#ff0000’ or’rgb(1,0,0), or rgb array of shape (N, 3 or 4) or (S, N, 3 or 4)
color_selected – like color, but for selected glyphs
marker – (currently only ‘arrow’ would make sense)
cast_shadow – If this object casts a shadown on other options (default) or not. Works only with Directional, Point and Spot lights.
receive_shadow – If this objects receives shadows (default) or not. Works only with Directional, Point and Spot lights.
kwargs – extra arguments passed on to the Scatter constructor

Returns:

Scatter

ipyvolume.pylab.plot(x, y, z, color='red', cast_shadow=True, receive_shadow=True, **kwargs)[source]¶

Plot a line in 3d.

Parameters:

x – numpy array of shape (N,) or (S, N) with x positions. If an (S, N) array, the first dimension will be used for frames in an animation.
y – idem for y
z – idem for z
color – color for each point/vertex/symbol, can be string format, examples for red:’red’, ‘#f00’,’#ff0000’ or’rgb(1,0,0), or rgb array of shape (N, 3 or 4) or (S, N, 3 or 4)
cast_shadow – If this object casts a shadown on other options (default) or not. Works only with Directional, Point and Spot lights.
receive_shadow – If this objects receives shadows (default) or not. Works only with Directional, Point and Spot lights.
kwargs – extra arguments passed to the Scatter constructor

Returns:

Scatter

ipyvolume.pylab.volshow(data, lighting=False, data_min=None, data_max=None, max_shape=256, tf=None, stereo=False, ambient_coefficient=0.5, diffuse_coefficient=0.8, specular_coefficient=0.5, specular_exponent=5, downscale=1, level=[0.1, 0.5, 0.9], opacity=[0.01, 0.05, 0.1], level_width=0.1, controls=True, max_opacity=0.2, memorder='C', extent=None, description=None)[source]¶

Visualize a 3d array using volume rendering.

Currently only 1 volume can be rendered.

Parap int max_shape:
Parameters:	data – 3d numpy array origin – origin of the volume data, this is to match meshes which have a different origin domain_size – domain size is the size of the volume lighting (bool) – use lighting or not, if set to false, lighting parameters will be overriden data_min (float) – minimum value to consider for data, if None, computed using np.nanmin data_max (float) – maximum value to consider for data, if None, computed using np.nanmax tf – transfer function (or a default one) stereo (bool) – stereo view for virtual reality (cardboard and similar VR head mount) ambient_coefficient – lighting parameter diffuse_coefficient – lighting parameter specular_coefficient – lighting parameter specular_exponent – lighting parameter downscale (float) – downscale the rendering for better performance, for instance when set to 2, a 512x512 canvas will show a 256x256 rendering upscaled, but it will render twice as fast. level – level(s) for the where the opacity in the volume peaks, maximum sequence of length 3 opacity – opacity(ies) for each level, scalar or sequence of max length 3 level_width – width of the (gaussian) bumps where the opacity peaks, scalar or sequence of max length 3 controls (bool) – add controls for lighting and transfer function or not max_opacity (float) – maximum opacity for transfer function controls extent – list of [[xmin, xmax], [ymin, ymax], [zmin, zmax]] values that define the bounds of the volume, otherwise the viewport is used description – Used in the legend and in popup to identify the object
	maximum shape for the 3d cube, if larger, the data is reduced by skipping/slicing (data[::N]), set to None to disable.
Returns:

ipyvolume.pylab.plot_surface(x, y, z, color='red', wrapx=False, wrapy=False, cast_shadow=True, receive_shadow=True)[source]¶

Draws a 2d surface in 3d, defined by the 2d ordered arrays x,y,z.

Parameters:

x – numpy array of shape (N,M) or (S, N, M) with x positions. If an (S, N, M) array, the first dimension will be used for frames in an animation.
y – idem for y
z – idem for z
color – color for each point/vertex string format, examples for red:’red’, ‘#f00’, ‘#ff0000’ or ‘rgb(1,0,0), or rgb
wrapx (bool) – when True, the x direction is assumed to wrap, and polygons are drawn between the end end begin points
wrapy (bool) – simular for the y coordinate
cast_shadow – If this object casts a shadown on other options (default) or not. Works only with Directional, Point and Spot lights.
receive_shadow – If this objects receives shadows (default) or not. Works only with Directional, Point and Spot lights.

Returns:

Mesh

ipyvolume.pylab.plot_trisurf(x, y, z, triangles=None, lines=None, color='red', u=None, v=None, texture=None, cast_shadow=True, receive_shadow=True, description=None, **kwargs)[source]¶

Draw a polygon/triangle mesh defined by a coordinate and triangle indices.

The following example plots a rectangle in the z==2 plane, consisting of 2 triangles:

>>> plot_trisurf([0, 0, 3., 3.], [0, 4., 0, 4.], 2,
       triangles=[[0, 2, 3], [0, 3, 1]])

Note that the z value is constant, and thus not a list/array. For guidance, the triangles refer to the vertices in this manner:

^ ydir
|
2 3
0 1  ---> x dir

Note that if you want per face/triangle colors, you need to duplicate each vertex.

Parameters:

x – numpy array of shape (N,) or (S, N) with x positions. If an (S, N) array, the first dimension will be used for frames in an animation.
y – idem for y
z – idem for z
triangles – numpy array with indices referring to the vertices, defining the triangles, with shape (M, 3)
lines – numpy array with indices referring to the vertices, defining the lines, with shape (K, 2)
color – color for each point/vertex/symbol, can be string format, examples for red:’red’, ‘#f00’,’#ff0000’ or’rgb(1,0,0), or rgb array of shape (N, 3 or 4) or (S, N, 3 or 4) Color of the material, essentially a solid color unaffected by other lighting. Default is ‘red’
u – numpy array of shape (N,) or (S, N) indicating the u (x) coordinate for the texture. If an (S, N) array, the first dimension will be used for frames in an animation.
v – numpy array of shape (N,) or (S, N) indicating the v (y) coordinate for the texture. If an (S, N) array, the first dimension will be used for frames in an animation.
texture – PIL.Image object or ipywebrtc.MediaStream (can be a seqence)
cast_shadow – If this object casts a shadown on other options (default) or not. Works only with Directional, Point and Spot lights.
receive_shadow – If this objects receives shadows (default) or not. Works only with Directional, Point and Spot lights.
description – Used in the legend and in popup to identify the object

Returns:

Mesh

ipyvolume.pylab.plot_wireframe(x, y, z, color='red', wrapx=False, wrapy=False, cast_shadow=True, receive_shadow=True)[source]¶

Draws a 2d wireframe in 3d, defines by the 2d ordered arrays x,y,z.

See also ipyvolume.pylab.plot_mesh

Parameters:

x – numpy array of shape (N,M) or (S, N, M) with x positions. If an (S, N, M) array, the first dimension will be used for frames in an animation.
y – idem for y
z – idem for z
color – color for each point/vertex string format, examples for red:’red’, ‘#f00’, ‘#ff0000’ or ‘rgb(1,0,0), or rgb
wrapx (bool) – when True, the x direction is assumed to wrap, and polygons are drawn between the begin and end points
wrapy (bool) – idem for y
cast_shadow – If this object casts a shadown on other options (default) or not. Works only with Directional, Point and Spot lights.
receive_shadow – If this objects receives shadows (default) or not. Works only with Directional, Point and Spot lights.

Returns:

Mesh

ipyvolume.pylab.plot_mesh(x, y, z, color='red', wireframe=True, surface=True, wrapx=False, wrapy=False, u=None, v=None, texture=None, cast_shadow=True, receive_shadow=True, description=None)[source]¶

Draws a 2d wireframe+surface in 3d: generalization of plot_wireframe and plot_surface.

Parameters:

x – numpy array of shape (N,M) or (S, N, M) with x positions. If an (S, N, M) array, the first dimension will be used for frames in an animation.
y – idem for y
z – idem for z
color – color for each point/vertex string format, examples for red:’red’, ‘#f00’, ‘#ff0000’ or ‘rgb(1,0,0), or rgb
wireframe (bool) – draw lines between the vertices
surface (bool) – draw faces/triangles between the vertices
wrapx (bool) – when True, the x direction is assumed to wrap, and polygons are drawn between the begin and end points
wrapy (boool) – idem for y
u – numpy array of shape (N,) or (S, N) indicating the u (x) coordinate for the texture. If an (S, N) array, the first dimension will be used for frames in an animation.
v – numpy array of shape (N,) or (S, N) indicating the v (y) coordinate for the texture. If an (S, N) array, the first dimension will be used for frames in an animation.
texture – PIL.Image object or ipywebrtc.MediaStream (can be a seqence)
cast_shadow – If this object casts a shadown on other options (default) or not. Works only with Directional, Point and Spot lights.
receive_shadow – If this objects receives shadows (default) or not. Works only with Directional, Point and Spot lights.
description – Used in the legend and in popup to identify the object

Returns:

Mesh

ipyvolume.pylab.plot_isosurface(data, level=None, color='red', wireframe=True, surface=True, controls=True, extent=None, description=None)[source]¶

Plot a surface at constant value (like a 2d contour).

Parameters:

data – 3d numpy array
level (float) – value where the surface should lie
color – color of the surface, although it can be an array, the length is difficult to predict beforehand, if per vertex color are needed, it is better to set them on the returned mesh afterwards.
wireframe (bool) – draw lines between the vertices
surface (bool) – draw faces/triangles between the vertices
controls (bool) – add controls to change the isosurface
extent – list of [[xmin, xmax], [ymin, ymax], [zmin, zmax]] values that define the bounding box of the mesh, otherwise the viewport is used
description – Used in the legend and in popup to identify the object

Returns:

Mesh

ipyvolume.pylab.xlim(xmin, xmax)[source]¶: Set limits of x axis.

ipyvolume.pylab.ylim(ymin, ymax)[source]¶: Set limits of y axis.

ipyvolume.pylab.zlim(zmin, zmax)[source]¶: Set limits of zaxis.

ipyvolume.pylab.xyzlim(vmin, vmax=None)[source]¶: Set limits or all axis the same, if vmax not given, use [-vmin, vmin].

ipyvolume.pylab.xlabel(label)[source]¶: Set the labels for the x-axis.

ipyvolume.pylab.ylabel(label)[source]¶: Set the labels for the y-axis.

ipyvolume.pylab.zlabel(label)[source]¶: Set the labels for the z-axis.

ipyvolume.pylab.xyzlabel(labelx, labely, labelz)[source]¶: Set all labels at once.

ipyvolume.pylab.view(azimuth=None, elevation=None, distance=None)[source]¶

Set camera angles and distance and return the current.

Parameters:	azimuth (float) – rotation around the axis pointing up in degrees elevation (float) – rotation where +90 means ‘up’, -90 means ‘down’, in degrees distance (float) – radial distance from the center to the camera.

ipyvolume.pylab.figure(key=None, width=400, height=500, lighting=True, controls=True, controls_vr=False, controls_light=False, debug=False, **kwargs)[source]¶

Create a new figure if no key is given, or return the figure associated with key.

Parameters:	key – Python object that identifies this figure width (int) – pixel width of WebGL canvas height (int) – lighting (bool) – use lighting or not controls (bool) – show controls or not controls_vr (bool) – show controls for VR or not debug (bool) – show debug buttons or not
Returns:	`Figure`

ipyvolume.pylab.gcf()[source]¶

Get current figure, or create a new one.

Returns:	`Figure`

ipyvolume.pylab.gcc()[source]¶: Return the current container, that is the widget holding the figure and all the control widgets, buttons etc.

ipyvolume.pylab.clear()[source]¶: Remove current figure (and container).

ipyvolume.pylab.show(extra_widgets=[])[source]¶: Display (like in IPython.display.dispay(…)) the current figure.

ipyvolume.pylab.save(filepath, makedirs=True, title='IPyVolume Widget', all_states=False, offline=False, scripts_path='js', drop_defaults=False, template_options=(('extra_script_head', ''), ('body_pre', ''), ('body_post', '')), devmode=False, offline_cors=False)[source]¶

Save the current container to a HTML file.

By default the HTML file is not standalone and requires an internet connection to fetch a few javascript libraries. Use offline=True to download these and make the HTML file work without an internet connection.

Parameters:

filepath (str) – The file to write the HTML output to.
makedirs (bool) – whether to make directories in the filename path, if they do not already exist
title (str) – title for the html page
all_states (bool) – if True, the state of all widgets know to the widget manager is included, else only those in widgets
offline (bool) – if True, use local urls for required js/css packages and download all js/css required packages (if not already available), such that the html can be viewed with no internet connection
scripts_path (str) – the folder to save required js/css packages to (relative to the filepath)
drop_defaults (bool) – Whether to drop default values from the widget states
template_options – list or dict of additional template options
devmode (bool) – if True, attempt to get index.js from local js/dist folder
offline_cors (bool) – if True, sets crossorigin attribute of script tags to anonymous

ipyvolume.pylab.savefig(filename, width=None, height=None, fig=None, timeout_seconds=10, output_widget=None, headless=False, devmode=False)[source]¶

Save the figure to an image file.

Parameters:

filename (str) – must have extension .png, .jpeg or .svg
width (int) – the width of the image in pixels
height (int) – the height of the image in pixels
fig (ipyvolume.widgets.Figure or None) – if None use the current figure
timeout_seconds (float) – maximum time to wait for image data to return
output_widget (ipywidgets.Output) – a widget to use as a context manager for capturing the data
headless (bool) – if True, use headless chrome to save figure
devmode (bool) – if True, attempt to get index.js from local js/dist folder

ipyvolume.pylab.screenshot(width=None, height=None, format='png', fig=None, timeout_seconds=10, output_widget=None, headless=False, devmode=False)[source]¶

Save the figure to a PIL.Image object.

Parameters:

width (int) – the width of the image in pixels
height (int) – the height of the image in pixels
format – format of output data (png, jpeg or svg)
fig (ipyvolume.widgets.Figure or None) – if None use the current figure
timeout_seconds (int) – maximum time to wait for image data to return
output_widget (ipywidgets.Output) – a widget to use as a context manager for capturing the data
headless (bool) – if True, use headless chrome to take screenshot
devmode (bool) – if True, attempt to get index.js from local js/dist folder

Returns:

PIL.Image

ipyvolume.pylab.selector_default(output_widget=None)[source]¶

Capture selection events from the current figure, and apply the selections to Scatter objects.

Example:

>>> import ipyvolume as ipv
>>> ipv.figure()
>>> ipv.examples.gaussian()
>>> ipv.selector_default()
>>> ipv.show()

Now hold the control key to do selections, type

‘C’ for circle

‘R’ for rectangle

‘L’ for lasso

‘=’ for replace mode

‘&’ for logically and mode

‘|’ for logically or mode

‘-’ for subtract mode

ipyvolume.pylab.movie(f='movie.mp4', function=<function _change_azimuth_angle>, fps=30, frames=30, endpoint=False, cmd_template_ffmpeg='ffmpeg -y -r {fps} -i {tempdir}/frame-%5d.png -vcodec h264 -pix_fmt yuv420p {filename}', cmd_template_gif='convert -delay {delay} {loop} {tempdir}/frame-*.png {filename}', gif_loop=0)[source]¶

Create a movie out of many frames in e.g. mp4 or gif format.

If the filename ends in .gif, convert is used to convert all frames to an animated gif using the cmd_template_gif template. Otherwise ffmpeg is assumed to know the file format.

Example:

>>> def set_angles(fig, i, fraction):
>>>     fig.angley = fraction*np.pi*2
>>> # 4 second movie, that rotates around the y axis
>>> p3.movie('test2.gif', set_angles, fps=20, frames=20*4,
        endpoint=False)

Note that in the example above we use endpoint=False to avoid to first and last frame to be the same

Parameters:

f (str) – filename out output movie (e.g. ‘movie.mp4’ or ‘movie.gif’)
function – function called before each frame with arguments (figure, framenr, fraction)
fps – frames per seconds
frames (int) – total number of frames
endpoint (bool) – if fraction goes from [0, 1] (inclusive) or [0, 1) (endpoint=False is useful for loops/rotatations)
cmd_template_ffmpeg (str) – template command when running ffmpeg (non-gif ending filenames)
cmd_template_gif (str) – template command when running imagemagick’s convert (if filename ends in .gif)
gif_loop – None for no loop, otherwise the framenumber to go to after the last frame

Returns:

the temp dir where the frames are stored

ipyvolume.pylab.animation_control(object, sequence_length=None, add=True, interval=200)[source]¶

Animate scatter, quiver or mesh by adding a slider and play button.

Parameters:

object – Scatter or Mesh object (having an sequence_index property), or a list of these to control multiple.
sequence_length – If sequence_length is None we try try our best to figure out, in case we do it badly, you can tell us what it should be. Should be equal to the S in the shape of the numpy arrays as for instance documented in scatter or plot_mesh.
add – if True, add the widgets to the container, else return a HBox with the slider and play button. Useful when you want to customise the layout of the widgets yourself.
interval – interval in msec between each frame

Returns:

If add is False, if returns the ipywidgets.HBox object containing the controls

ipyvolume.pylab.transfer_function(level=[0.1, 0.5, 0.9], opacity=[0.01, 0.05, 0.1], level_width=0.1, controls=True, max_opacity=0.2)[source]¶: Create a transfer function, see volshow.

class ipyvolume.pylab.style[source]¶

Bases: object

Static class that mimics a matplotlib module.

Example:

>>> import ipyvolume as ipv
>>> ipv.style.use('light'])
>>> ipv.style.use('seaborn-darkgrid'])
>>> ipv.style.use(['seaborn-darkgrid', {'axes.x.color':'orange'}])

Possible style values:

figure.facecolor: background color
axes.color: color of the box around the volume/viewport
xaxis.color: color of xaxis
yaxis.color: color of xaxis
zaxis.color: color of xaxis

static axes_off(which=None)[source]¶: Do not draw the axes, optionally give axis names, e.g. ‘xy’.

static axes_on(which=None)[source]¶: Draw the axes, optionally give axis names, e.g. ‘xy’.

static background_color(color)[source]¶: Set the background color.

static box_off()[source]¶: Do not draw the box around the visible volume.

static box_on()[source]¶: Draw a box around the visible volume.

static set_style_dark()¶: Short for style.use(‘dark’)

static set_style_demo()¶: Short for style.use(‘demo’)

static set_style_light()¶: Short for style.use(‘light’)

static set_style_nobox()¶: Short for style.use(‘nobox’)

static use(style)[source]¶

Set the style of the current figure/visualization.

Parameters:	style – matplotlib style name, or dict with values, or a sequence of these, where the last value overrides previous
Returns:

ipyvolume.widgets¶

Test pythreejs.Camera

The widgets module of ipvyolume.

ipyvolume.widgets.quickvolshow(data, lighting=False, data_min=None, data_max=None, max_shape=256, level=[0.1, 0.5, 0.9], opacity=[0.01, 0.05, 0.1], level_width=0.1, extent=None, memorder='C', **kwargs)[source]¶

Visualize a 3d array using volume rendering.

Parameters:

data – 3d numpy array
lighting – boolean, to use lighting or not, if set to false, lighting parameters will be overriden
data_min – minimum value to consider for data, if None, computed using np.nanmin
data_max – maximum value to consider for data, if None, computed using np.nanmax
max_shape (int) – maximum shape for the 3d cube, if larger, the data is reduced by skipping/slicing (data[::N]), set to None to disable.
extent – list of [[xmin, xmax], [ymin, ymax], [zmin, zmax]] values that define the bounds of the volume, otherwise the viewport is used
level – level(s) for the where the opacity in the volume peaks, maximum sequence of length 3
opacity – opacity(ies) for each level, scalar or sequence of max length 3
level_width – width of the (gaussian) bumps where the opacity peaks, scalar or sequence of max length 3
kwargs – extra argument passed to Volume and default transfer function

Returns:

ipyvolume.widgets.quickscatter(x, y, z, **kwargs)[source]¶

ipyvolume.widgets.quickquiver(x, y, z, u, v, w, **kwargs)[source]¶

ipyvolume.widgets.volshow(*args, **kwargs)[source]¶: Deprecated: please use ipyvolume.quickvolshow or use the ipyvolume.pylab interface.

class ipyvolume.widgets.Figure(**kwargs)[source]¶

Bases: ipywebrtc.webrtc.MediaStream

Widget class representing a volume (rendering) using three.js.

ambient_coefficient¶: A float trait.

animation¶: A float trait.

animation_exponent¶: A float trait.

box_center¶: An instance of a Python list.

box_size¶: An instance of a Python list.

camera¶: A pythreejs.Camera instance to control the camera

camera_center¶: An instance of a Python list.

camera_control¶: A trait for unicode strings.

camera_fov¶: A casting version of the float trait.

capture_fps¶: A casting version of the float trait.

controls¶: A pythreejs.Controls instance to control the camera

cube_resolution¶: A casting version of the int trait.

diffuse_coefficient¶: A float trait.

displayscale¶: A casting version of the float trait.

eye_separation¶: A casting version of the float trait.

height¶: A casting version of the int trait.

lights¶: An instance of a Python list.

matrix_projection¶: An instance of a Python list.

matrix_world¶: An instance of a Python list.

meshes¶: An instance of a Python list.

mouse_mode¶: A trait for unicode strings.

on_screenshot(callback, remove=False)[source]¶

on_selection(callback, remove=False)[source]¶

orientation_control¶: A boolean (True, False) trait.

panorama_mode¶: An enum whose value must be in a given sequence.

pixel_ratio¶: Pixel ratio of the WebGL canvas (2 on retina screens). Set to 1 for better performance, but less crispedges. If set to None it will use the browser’s window.devicePixelRatio.

popup_debouce¶: Debouce popup in miliseconds

project(x, y, z)[source]¶

render_continuous¶: A boolean (True, False) trait.

scales¶

An instance of a Python dict.

One or more traits can be passed to the constructor to validate the keys and/or values of the dict. If you need more detailed validation, you may use a custom validator method.

Changed in version 5.0: Added key_trait for validating dict keys.

Changed in version 5.0: Deprecated ambiguous trait, traits args in favor of value_trait, per_key_traits.

scatters¶: An instance of a Python list.

scene¶

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

Subclasses can declare default classes by overriding the klass attribute

screenshot(width=None, height=None, mime_type='image/png')[source]¶

selection_mode¶: A trait for unicode strings.

selector¶: A trait for unicode strings.

show¶: A trait for unicode strings.

slice_x¶: A float trait.

slice_y¶: A float trait.

slice_z¶: A float trait.

specular_coefficient¶: A float trait.

specular_exponent¶: A float trait.

stereo¶: A boolean (True, False) trait.

style¶

An instance of a Python dict.

One or more traits can be passed to the constructor to validate the keys and/or values of the dict. If you need more detailed validation, you may use a custom validator method.

Changed in version 5.0: Added key_trait for validating dict keys.

Changed in version 5.0: Deprecated ambiguous trait, traits args in favor of value_trait, per_key_traits.

volumes¶: An instance of a Python list.

width¶: A casting version of the int trait.

xlabel¶: A trait for unicode strings.

xlim¶

ylabel¶: A trait for unicode strings.

ylim¶

zlabel¶: A trait for unicode strings.

zlim¶

class ipyvolume.widgets.Volume(**kwargs)[source]¶

Bases: ipywidgets.widgets.widget.Widget, ipyvolume.widgets.LegendData

Widget class representing a volume (rendering) using three.js.

brightness¶: A casting version of the float trait.

clamp_max¶: A casting version of the boolean trait.

clamp_min¶: A casting version of the boolean trait.

data¶: A numpy array trait type.

data_max¶: A casting version of the float trait.

data_max_shape¶: A casting version of the int trait.

data_min¶: A casting version of the float trait.

data_original¶: A numpy array trait type.

extent¶: A trait which allows any value.

extent_original¶: A trait which allows any value.

icon¶: A trait for unicode strings.

lighting¶: A boolean (True, False) trait.

material¶: A pythreejs.MeshPhongMaterial that is used for the shading of the volume

opacity_scale¶: A casting version of the float trait.

ray_steps¶: defines the length of the ray (1/ray_steps) for each step, in normalized coordintes.

rendering_method¶: An enum whose value must be in a given sequence.

show_max¶: A casting version of the float trait.

show_min¶: A casting version of the float trait.

tf¶

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

Subclasses can declare default classes by overriding the klass attribute

update_data(change=None)[source]¶

visible¶: A casting version of the boolean trait.

class ipyvolume.widgets.Scatter(**kwargs)[source]¶

Bases: ipywidgets.widgets.widget.Widget, ipyvolume.widgets.LegendData

aux¶: A numpy array trait type.

aux_scale¶

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

Subclasses can declare default classes by overriding the klass attribute

cast_shadow¶: A casting version of the boolean trait.

clicked¶: A boolean (True, False) trait.

clicked_index¶: An int trait.

color¶: A numpy array trait type.

color_scale¶

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

Subclasses can declare default classes by overriding the klass attribute

color_selected¶: A trait type representing a Union type.

connected¶: A casting version of the boolean trait.

geo¶: A trait for unicode strings.

geo_matrix¶: A trait for a 16-tuple corresponding to a three.js Matrix4.

hovered¶: A boolean (True, False) trait.

hovered_index¶: An int trait.

line_material¶: A pythreejs.Material that is used for the lines/wireframe

material¶: A pythreejs.Material that is used for the mesh

popup¶

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

Subclasses can declare default classes by overriding the klass attribute

receive_shadow¶: A casting version of the boolean trait.

selected¶: A numpy array trait type.

sequence_index¶: An int trait.

shader_snippets¶

An instance of a Python dict.

One or more traits can be passed to the constructor to validate the keys and/or values of the dict. If you need more detailed validation, you may use a custom validator method.

Changed in version 5.0: Added key_trait for validating dict keys.

Changed in version 5.0: Deprecated ambiguous trait, traits args in favor of value_trait, per_key_traits.

size¶: A trait type representing a Union type.

size_selected¶: A trait type representing a Union type.

size_x_scale¶

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

Subclasses can declare default classes by overriding the klass attribute

size_y_scale¶

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

Subclasses can declare default classes by overriding the klass attribute

size_z_scale¶

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

Subclasses can declare default classes by overriding the klass attribute

texture¶: A trait type representing a Union type.

visible¶: A casting version of the boolean trait.

vx¶: A numpy array trait type.

vy¶: A numpy array trait type.

vz¶: A numpy array trait type.

x¶: A numpy array trait type.

y¶: A numpy array trait type.

z¶: A numpy array trait type.

class ipyvolume.widgets.Mesh(**kwargs)[source]¶

Bases: ipywidgets.widgets.widget.Widget, ipyvolume.widgets.LegendData

cast_shadow¶: A casting version of the boolean trait.

clicked¶: A boolean (True, False) trait.

color¶: A numpy array trait type.

color_scale¶

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

Subclasses can declare default classes by overriding the klass attribute

hovered¶: A boolean (True, False) trait.

icon¶: A trait for unicode strings.

line_material¶: A pythreejs.Material that is used for the lines/wireframe

lines¶: A numpy array trait type.

material¶: A pythreejs.Material that is used for the mesh

popup¶

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

Subclasses can declare default classes by overriding the klass attribute

receive_shadow¶: A casting version of the boolean trait.

sequence_index¶: An int trait.

texture¶: A trait type representing a Union type.

triangles¶: A numpy array trait type.

u¶: A numpy array trait type.

v¶: A numpy array trait type.

visible¶: A casting version of the boolean trait.

volume¶

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

Subclasses can declare default classes by overriding the klass attribute

x¶: A numpy array trait type.

x_offset¶: A float trait.

y¶: A numpy array trait type.

y_offset¶: A float trait.

z¶: A numpy array trait type.

z_offset¶: A float trait.

ipyvolume.examples¶

Some examples for quick testing/demonstrations.

All function accept show and draw arguments

If draw is True it will return the widgets (Scatter, Volume, Mesh)

If draw is False, it will return the data

if show is False, ipv.show() will not be called.

ipyvolume.examples.ball(rmax=3, rmin=0, shape=128, limits=[-4, 4], draw=True, show=True, **kwargs)[source]¶: Show a ball.

ipyvolume.examples.brain(draw=True, show=True, fiducial=True, flat=True, inflated=True, subject='S1', interval=1000, uv=True, color=None)[source]¶

Show a human brain model.

Requirement:

$ pip install https://github.com/gallantlab/pycortex

ipyvolume.examples.example_ylm(m=0, n=2, shape=128, limits=[-4, 4], draw=True, show=True, **kwargs)[source]¶: Show a spherical harmonic.

ipyvolume.examples.gaussian(N=1000, draw=True, show=True, seed=42, color=None, marker='sphere', description='Gaussian blob', **kwargs)[source]¶: Show N random gaussian distributed points using a scatter plot.

ipyvolume.examples.head(draw=True, show=True, max_shape=256, description='Male head')[source]¶: Show a volumetric rendering of a human male head.

ipyvolume.examples.klein_bottle(draw=True, show=True, figure8=False, endpoint=True, uv=True, wireframe=False, texture=None, both=False, interval=1000, **kwargs)[source]¶: Show one or two Klein bottles.

ipyvolume.examples.xyz(shape=128, limits=[-3, 3], spherical=False, sparse=True, centers=False)[source]¶

API docs¶

Quick list for plotting.¶

Quick list for controlling the figure.¶

Quick list for style and labels.¶

Quick list for saving figures.¶

ipyvolume.pylab¶

ipyvolume.widgets¶

ipyvolume.examples¶

ipyvolume.headless¶