Visuals

vispy.visuals

This module provides a library of Visual classes, which are drawable objects intended to encapsulate simple graphic objects such as lines, meshes, points, 2D shapes, images, text, etc.

These classes define only the OpenGL machinery and connot be used directly in a scenegraph. For scenegraph use, see the complementary Visual+Node classes defined in vispy.scene.

class vispy.visuals.ArrowVisual(pos=None, color=(0.5, 0.5, 0.5, 1), width=1, connect='strip', method='gl', antialias=False, arrows=None, arrow_type='stealth', arrow_size=None, arrow_color=(0.5, 0.5, 0.5, 1))

Bases: vispy.visuals.line.line.LineVisual

Arrow visual

A special line visual which can also draw optional arrow heads at the specified vertices.

You add an arrow head by specifying two vertices v1 and v2 which represent the arrow body. This visual will draw an arrow head using v2 as center point, and the orientation of the arrow head is automatically determined by calculating the direction vector between v1 and v2.

Parameters:

posarray

Array of shape (…, 2) or (…, 3) specifying vertex coordinates.

colorColor, tuple, or array

The color to use when drawing the line. If an array is given, it must be of shape (…, 4) and provide one rgba color per vertex. Can also be a colormap name, or appropriate Function.

width:

The width of the line in px. Line widths > 1px are only guaranteed to work when using ‘agg’ method.

connectstr or array

Determines which vertices are connected by lines.

• “strip” causes the line to be drawn with each vertex connected to the next.
• “segments” causes each pair of vertices to draw an independent line segment
• numpy arrays specify the exact set of segment pairs to connect.

methodstr

Mode to use for drawing.

• “agg” uses anti-grain geometry to draw nicely antialiased lines with proper joins and endcaps.
• “gl” uses OpenGL’s built-in line rendering. This is much faster, but produces much lower-quality results and is not guaranteed to obey the requested line width or join/endcap styles.

antialiasbool

Enables or disables antialiasing. For method=’gl’, this specifies whether to use GL’s line smoothing, which may be unavailable or inconsistent on some platforms.

arrowsarray

A (N, 4) or (N, 6) matrix where each row contains the (x, y) or the (x, y, z) coordinate of the first and second vertex of the arrow body. Remember that the second vertex is used as center point for the arrow head, and the first vertex is only used for determining the arrow head orientation.

arrow_typestring

Specify the arrow head type, the currently available arrow head types are:

• stealth
• curved
• triangle_30
• triangle_60
• triangle_90
• angle_30
• angle_60
• angle_90
• inhibitor_round

arrow_sizefloat

Specify the arrow size

arrow_colorColor, tuple, or array

The arrow head color. If an array is given, it must be of shape (…, 4) and provide one rgba color per arrow head. Can also be a colormap name, or appropriate Function.

set_data(pos=None, color=None, width=None, connect=None, arrows=None)

Set the data used for this visual

Parameters:

posarray

Array of shape (…, 2) or (…, 3) specifying vertex coordinates.

colorColor, tuple, or array

The color to use when drawing the line. If an array is given, it must be of shape (…, 4) and provide one rgba color per vertex. Can also be a colormap name, or appropriate Function.

width:

The width of the line in px. Line widths > 1px are only guaranteed to work when using ‘agg’ method.

connectstr or array

Determines which vertices are connected by lines.

• “strip” causes the line to be drawn with each vertex connected to the next.
• “segments” causes each pair of vertices to draw an independent line segment
• numpy arrays specify the exact set of segment pairs to connect.

arrowsarray

A (N, 4) or (N, 6) matrix where each row contains the (x, y) or the (x, y, z) coordinate of the first and second vertex of the arrow body. Remember that the second vertex is used as center point for the arrow head, and the first vertex is only used for determining the arrow head orientation.

class vispy.visuals.AxisVisual(pos=None, domain=(0.0, 1.0), tick_direction=(- 1.0, 0.0), scale_type='linear', axis_color=(1, 1, 1), tick_color=(0.7, 0.7, 0.7), text_color='w', minor_tick_length=5, major_tick_length=10, tick_width=2, tick_label_margin=12, tick_font_size=8, axis_width=3, axis_label=None, axis_label_margin=35, axis_font_size=10, font_size=None, anchors=None)

Bases: vispy.visuals.visual.CompoundVisual

Axis visual

Parameters:

posarray

Co-ordinates of start and end of the axis.

domaintuple

The data values at the beginning and end of the axis, used for tick labels. i.e. (5, 10) means the axis starts at 5 and ends at 10. Default is (0, 1).

tick_directionarray

The tick direction to use (in document coordinates).

scale_typestr

The type of scale. For now only ‘linear’ is supported.

axis_colortuple

RGBA values for the axis colour. Default is black.

tick_colortuple

RGBA values for the tick colours. The colour for the major and minor ticks is currently fixed to be the same. Default is a dark grey.

text_colorColor

The color to use for drawing tick and axis labels

minor_tick_lengthfloat

The length of minor ticks, in pixels

major_tick_lengthfloat

The length of major ticks, in pixels

tick_widthfloat

Line width for the ticks

tick_label_marginfloat

Margin between ticks and tick labels

tick_font_sizefloat

The font size to use for rendering tick labels.

axis_widthfloat

Line width for the axis

axis_labelstr

Text to use for the axis label

axis_label_marginfloat

Margin between ticks and axis labels

axis_font_sizefloat

The font size to use for rendering axis labels.

font_sizefloat

Font size for both the tick and axis labels. If this is set, tick_font_size and axis_font_size are ignored.

anchorsiterable

A 2-element iterable (tuple, list, etc.) giving the horizontal and vertical alignment of the tick labels. The first element should be one of ‘left’, ‘center’, or ‘right’, and the second element should be one of ‘bottom’, ‘middle’, or ‘top’. If this is not specified, it is determined automatically.

axis_label

Text to use for the axis label.

axis_label_margin

Margin between ticks and axis labels

domain

The data values at the beginning and end of the axis, used for tick labels.

major_tick_length

The length of major ticks, in pixels

minor_tick_length

The length of minor ticks, in pixels

pos

Co-ordinates of start and end of the axis.

tick_direction

The tick direction to use (in document coordinates).

tick_label_margin

Margin between ticks and tick labels

class vispy.visuals.BaseVisual(vshare=None)

Bases: vispy.util.frozen.Frozen

Superclass for all visuals.

This class provides:

• A TransformSystem.
• Two events: update and bounds_change.
• Minimal framework for creating views of the visual.
• A data structure that is shared between all views of the visual.
• Abstract draw, bounds, attach, and detach methods.

Parameters:

vshareinstance of VisualShare | None

The visual share.

Notes

When used in the scenegraph, all Visual classes are mixed with vispy.scene.Node in order to implement the methods, attributes and capabilities required for their usage within it.

This subclasses Frozen so that subclasses can easily freeze their properties.

attach(filt, view=None)

Attach a Filter to this visual.

Each filter modifies the appearance or behavior of the visual.

Parameters:

filtobject

The filter to attach.

viewinstance of VisualView | None

The view to use.

bounds(axis, view=None)

Get the bounds of the Visual

Parameters:

axisint

The axis.

viewinstance of VisualView

The view to use.

detach(filt, view=None)

Detach a filter.

Parameters:

filtobject

The filter to detach.

viewinstance of VisualView | None

The view to use.

get_transform(map_from='visual', map_to='render')

Return a transform mapping between any two coordinate systems.

Parameters:

map_fromstr

The starting coordinate system to map from. Must be one of: visual, scene, document, canvas, framebuffer, or render.

map_tostr

The ending coordinate system to map to. Must be one of: visual, scene, document, canvas, framebuffer, or render.

update()

Update the Visual

view()

Return a new view of this visual.

class vispy.visuals.BoxVisual(width=1, height=1, depth=1, width_segments=1, height_segments=1, depth_segments=1, planes=None, vertex_colors=None, face_colors=None, color=(0.5, 0.5, 1, 1), edge_color=None, **kwargs)

Bases: vispy.visuals.visual.CompoundVisual

Visual that displays a box.

Parameters:

widthfloat

Box width.

heightfloat

Box height.

depthfloat

Box depth.

width_segmentsint

Box segments count along the width.

height_segmentsfloat

Box segments count along the height.

depth_segmentsfloat

Box segments count along the depth.

planes: array_like

Any combination of {'-x', '+x', '-y', '+y', '-z', '+z'} Included planes in the box construction.

vertex_colorsndarray

Same as for MeshVisual class. See create_plane for vertex ordering.

face_colorsndarray

Same as for MeshVisual class. See create_plane for vertex ordering.

colorColor

The Color to use when drawing the cube faces.

edge_colortuple or Color

The Color to use when drawing the cube edges. If None, then no cube edges are drawn.

property border

The vispy.visuals.MeshVisual that used to draw the border.

property mesh

The vispy.visuals.MeshVisual that used to fill in.

class vispy.visuals.ColorBarVisual(cmap, orientation, size, pos=[0, 0], label_str='', label_color='black', clim=(0.0, 1.0), border_width=1.0, border_color='black', **kwargs)

Bases: vispy.visuals.visual.CompoundVisual

Visual subclass displaying a colorbar

Parameters:

cmapstr | vispy.color.ColorMap

Either the name of the ColorMap to be used from the standard set of names (refer to vispy.color.get_colormap), or a custom ColorMap object. The ColorMap is used to apply a gradient on the colorbar.

orientation{‘left’, ‘right’, ‘top’, ‘bottom’}

The orientation of the colorbar, used for rendering. The orientation can be thought of as the position of the label relative to the color bar.

When the orientation is ‘left’ or ‘right’, the colorbar is vertically placed. When it is ‘top’ or ‘bottom’, the colorbar is horizontally placed.

• ‘top’: the colorbar is horizontal. Color is applied from left to right. Minimum corresponds to left and maximum to right. Label is to the top of the colorbar
• ‘bottom’: Same as top, except that label is to the bottom of the colorbar
• ‘left’: the colorbar is vertical. Color is applied from bottom to top. Minimum corresponds to bottom and maximum to top. Label is to the left of the colorbar
• ‘right’: Same as left, except that the label is placed to the right of the colorbar

size(major_axis_length, minor_axis_length)

lengths with respect to the major and minor axes. The minor axis is the shorter axis, while the major axis is the longer axis with respect to the orientation

For orientations ‘top’ and ‘bottom’, the major axis is along the length.

For orientations ‘left’ and ‘right’, the major axis is along the breadth

postuple (x, y)

Position where the colorbar is to be placed with respect to the center of the colorbar

label_strstr

The label that is to be drawn with the colorbar that provides information about the colorbar.

label_colorstr | vispy.color.Color

The color of the labels. This can either be a str as the color’s name or an actual instace of a vipy.color.Color

climtuple (min, max)

the minimum and maximum values of the data that is given to the colorbar. This is used to draw the scale on the side of the colorbar.

border_widthfloat (in px)

The width of the border the colormap should have. This measurement is given in pixels

border_colorstr | vispy.color.Color

The color of the border of the colormap. This can either be a str as the color’s name or an actual instace of a vipy.color.Color

property border_color

The color of the border around the ColorBar in pixels

property border_width

The width of the border around the ColorBar in pixels

property clim

The data limits of the Colorbar

Returns:

clim: tuple(min, max)

property cmap

The colormap of the Colorbar

property label

The vispy.visuals.TextVisual associated with the label

property orientation

The orientation of the ColorBar

property pos

The position of the text anchor in the local coordinate frame

property size

The size of the ColorBar

Returns:

size: (major_axis_length, minor_axis_length)

major and minor axis are defined by the orientation of the ColorBar

property ticks

The vispy.visuals.TextVisual associated with the ticks

Returns:

ticks: [vispy.visual.TextVisual]

The array is of length 2

class vispy.visuals.CompoundVisual(subvisuals)

Bases: vispy.visuals.visual.BaseVisual

Visual consisting entirely of sub-visuals.

To the user, a compound visual behaves exactly like a normal visual–it has a transform system, draw() and bounds() methods, etc. Internally, the compound visual automatically manages proxying these transforms and methods to its sub-visuals.

Parameters:

subvisualslist of BaseVisual instances

The list of visuals to be combined in this compound visual.

add_subvisual(visual)

Add a subvisual

Parameters:

visualinstance of Visual

The visual to add.

attach(filt, view=None)

Attach a Filter to this visual

Each filter modifies the appearance or behavior of the visual.

Parameters:

filtobject

The filter to attach.

viewinstance of VisualView | None

The view to use.

detach(filt, view=None)

Detach a filter.

Parameters:

filtobject

The filter to detach.

viewinstance of VisualView | None

The view to use.

draw()

Draw the visual

remove_subvisual(visual)

Remove a subvisual

Parameters:

visualinstance of Visual

The visual to remove.

set_gl_state(preset=None, **kwargs)

Define the set of GL state parameters to use when drawing

Parameters:

presetstr

Preset to use.

**kwargsdict

Keyword arguments to gloo.set_state.

update_gl_state(*args, **kwargs)

Modify the set of GL state parameters to use when drawing

Parameters:

*argstuple

Arguments.

**kwargsdict

Keyword argments.

class vispy.visuals.CubeVisual(size=1.0, vertex_colors=None, face_colors=None, color=(0.5, 0.5, 1, 1), edge_color=None, **kwargs)

Bases: vispy.visuals.box.BoxVisual

Visual that displays a cube or cuboid

Parameters:

sizefloat or tuple

The size of the cuboid. A float gives a cube, whereas tuples may specify the size of each axis (x, y, z) independently.

vertex_colorsndarray

Same as for MeshVisual class. See create_cube for vertex ordering.

face_colorsndarray

Same as for MeshVisual class. See create_cube for vertex ordering.

colorColor

The Color to use when drawing the cube faces.

edge_colortuple or Color

The Color to use when drawing the cube edges. If None, then no cube edges are drawn.

class vispy.visuals.EllipseVisual(center=None, color='black', border_color=None, border_width=1, radius=(0.1, 0.1), start_angle=0.0, span_angle=360.0, num_segments=100, **kwargs)

Bases: vispy.visuals.polygon.PolygonVisual

Displays a 2D ellipse

Parameters:

centerarray

Center of the ellipse

colorinstance of Color

The face color to use.

border_colorinstance of Color

The border color to use.

border_width: float

The width of the border in pixels Line widths > 1px are only guaranteed to work when using border_method=’agg’ method.

radiusfloat | tuple

Radius or radii of the ellipse Defaults to (0.1, 0.1)

start_anglefloat

Start angle of the ellipse in degrees Defaults to 0.

span_anglefloat

Span angle of the ellipse in degrees Defaults to 360.

num_segmentsint

Number of segments to be used to draw the ellipse Defaults to 100

**kwargsdict

Keyword arguments to pass to PolygonVisual.

property center

The center of the ellipse

property num_segments

The number of segments in the ellipse.

property radius

The start radii of the ellipse.

property span_angle

The angular span of the ellipse.

property start_angle

The start start_angle of the ellipse.

class vispy.visuals.GraphVisual(adjacency_mat=None, directed=False, layout=None, animate=False, line_color=None, line_width=None, arrow_type=None, arrow_size=None, node_symbol=None, node_size=None, border_color=None, face_color=None, border_width=None)

Bases: vispy.visuals.visual.CompoundVisual

Visual for displaying graphs or networks.

Parameters:

adjacency_matarray or sparse

The adjacency matrix of the graph.

directedbool

Whether the graph is directed or not. If True, then this visual will draw arrows for the directed edges.

layoutstr

They layout to use.

animatebool

Whether or not to animate.

line_colorstr or vispy.color.colormap.ColorMap

The color to use for the edges.

line_widthnumber

The edge thickness.

arrow_typestr

The kind of arrow head to use. See vispy.visuals.ArrowHead for more information.

arrow_sizenumber

The size of the arrow head.

node_symbolstring

The marker to use for nodes. See vispy.visuals.MarkersVisual for more information.

node_sizenumber

The size of the node

border_colorstr or vispy.color.colormap.ColorMap

The border color for nodes.

face_colorstr or vispy.color.colormap.ColorMap

The face color for nodes.

border_widthnumber

The border size for nodes.

See also

ArrowVisual, MarkersVisual

set_data(adjacency_mat=None, **kwargs)

Set the data

Parameters:

adjacency_matndarray | None

The adjacency matrix.

**kwargsdict

Keyword arguments to pass to the arrows.

class vispy.visuals.GridLinesVisual(scale=(1, 1), color='w')

Bases: vispy.visuals.image.ImageVisual

Displays regularly spaced grid lines in any coordinate system and at any scale.

Parameters:

scaletuple

The scale factors to apply when determining the spacing of grid lines.

colorColor

The base color for grid lines. The final color may have its alpha channel modified.

class vispy.visuals.GridMeshVisual(xs, ys, zs, colors=None, shading='smooth', **kwargs)

Bases: vispy.visuals.mesh.MeshVisual

Displays a mesh in a Cartesian grid about x,y,z coordinates.

This makes it simple to generate a mesh from e.g. the output of numpy.meshgrid.

All arguments are optional, though they can be changed individually later with the set_data method.

Parameters:

xsndarray

A 2d array of x coordinates for the vertices of the mesh. Must have the same dimensions as ys and zs.

ysndarray

A 2d array of y coordinates for the vertices of the mesh. Must have the same dimensions as xs and zs.

zsndarray

A 2d array of z coordinates for the vertices of the mesh. Must have the same dimensions as xs and ys.

colorsndarray | None

The colors of the points of the mesh. Should be either a (width, height, 4) array of rgba colors at each grid point or a (width, height, 3) array of rgb colors at each grid point. Defaults to None, in which case the default color of a MeshVisual is used.

shadingstr | None

Same as for the MeshVisual class. Defaults to ‘smooth’.

**kwargs :

Other arguments are passed directly to MeshVisual.

set_data(xs=None, ys=None, zs=None, colors=None)

Update the mesh data.

Parameters:

xsndarray | None

A 2d array of x coordinates for the vertices of the mesh.

ysndarray | None

A 2d array of y coordinates for the vertices of the mesh.

zsndarray | None

A 2d array of z coordinates for the vertices of the mesh.

colorsndarray | None

The color at each point of the mesh. Must have shape (width, height, 4) or (width, height, 3) for rgba or rgb color definitions respectively.

class vispy.visuals.HistogramVisual(data, bins=10, color='w', orientation='h')

Bases: vispy.visuals.mesh.MeshVisual

Visual that calculates and displays a histogram of data

Parameters:

dataarray-like

Data to histogram. Currently only 1D data is supported.

binsint | array-like

Number of bins, or bin edges.

colorinstance of Color

Color of the histogram.

orientation{‘h’, ‘v’}

Orientation of the histogram.

class vispy.visuals.ImageVisual(data=None, method='auto', grid=(1, 1), cmap='viridis', clim='auto', gamma=1.0, interpolation='nearest', **kwargs)

Bases: vispy.visuals.visual.Visual

Visual subclass displaying an image.

Parameters:

datandarray

ImageVisual data. Can be shape (M, N), (M, N, 3), or (M, N, 4).

methodstr

Selects method of rendering image in case of non-linear transforms. Each method produces similar results, but may trade efficiency and accuracy. If the transform is linear, this parameter is ignored and a single quad is drawn around the area of the image.

• ‘auto’: Automatically select ‘impostor’ if the image is drawn with a nonlinear transform; otherwise select ‘subdivide’.
• ‘subdivide’: ImageVisual is represented as a grid of triangles with texture coordinates linearly mapped.
• ‘impostor’: ImageVisual is represented as a quad covering the entire view, with texture coordinates determined by the transform. This produces the best transformation results, but may be slow.

grid: tuple (rows, cols)

If method=’subdivide’, this tuple determines the number of rows and columns in the image grid.

cmapstr | ColorMap

Colormap to use for luminance images.

climstr | tuple

Limits to use for the colormap. Can be ‘auto’ to auto-set bounds to the min and max of the data.

gammafloat

Gamma to use during colormap lookup. Final color will be cmap(val**gamma). by default: 1.

interpolationstr

Selects method of image interpolation. Makes use of the two Texture2D interpolation methods and the available interpolation methods defined in vispy/gloo/glsl/misc/spatial_filters.frag

• ‘nearest’: Default, uses ‘nearest’ with Texture2D interpolation.
• ‘bilinear’: uses ‘linear’ with Texture2D interpolation.

• ‘hanning’, ‘hamming’, ‘hermite’, ‘kaiser’, ‘quadric’, ‘bicubic’,

  ‘catrom’, ‘mitchell’, ‘spline16’, ‘spline36’, ‘gaussian’, ‘bessel’, ‘sinc’, ‘lanczos’, ‘blackman’

**kwargsdict

Keyword arguments to pass to Visual.

Notes

The colormap functionality through cmap and clim are only used if the data are 2D.

property clim_normalized

Normalize current clims between 0-1 based on last-used texture data range. In _build_texture(), the data is normalized (on the CPU) to 0-1 using clim. During rendering, the frag shader will apply the final contrast adjustment based on the current clim.

property gamma

The gamma used when rendering the image.

set_data(image)

Set the data

Parameters:

imagearray-like

The image data.

view()

Return a new view of this visual.

class vispy.visuals.InfiniteLineVisual(pos=None, color=(1.0, 1.0, 1.0, 1.0), vertical=True, **kwargs)

Bases: vispy.visuals.visual.Visual

Infinite horizontal or vertical line for 2D plots.

Parameters:

posfloat

Position of the line along the axis.

colorlist, tuple, or array

The color to use when drawing the line. If an array is given, it must be of shape (1, 4) and provide one rgba color per vertex.

vertical:

True for drawing a vertical line, False for an horizontal line

set_data(pos=None, color=None)

Set the data

Parameters:

posfloat

Position of the line along the axis.

colorlist, tuple, or array

The color to use when drawing the line. If an array is given, it must be of shape (1, 4) and provide one rgba color per vertex.

class vispy.visuals.IsocurveVisual(data=None, levels=None, color_lev=None, clim=None, **kwargs)

Bases: vispy.visuals.line.line.LineVisual

Displays an isocurve of a 2D scalar array.

Parameters:

datandarray | None

2D scalar array.

levelsndarray, shape (Nlev,) | None

The levels at which the isocurve is constructed from “data”.

color_levColor, colormap name, tuple, list or array

The color to use when drawing the line. If a list is given, it must be of shape (Nlev), if an array is given, it must be of shape (Nlev, …). and provide one color per level (rgba, colorname).

climtuple

(min, max) limits to apply when mapping level values through a colormap.

**kwargsdict

Keyword arguments to pass to LineVisual.

property levels

The threshold at which the isocurve is constructed from the 2D data.

set_data(data)

Set the scalar array data

Parameters:

datandarray

A 2D array of scalar values. The isocurve is constructed to show all locations in the scalar field equal to self.levels.

class vispy.visuals.IsolineVisual(vertices=None, tris=None, data=None, levels=None, color_lev=None, **kwargs)

Bases: vispy.visuals.line.line.LineVisual

Isocurves of a tri mesh with data at vertices at different levels.

Parameters:

verticesndarray, shape (Nv, 3) | None

Vertex coordinates.

trisndarray, shape (Nf, 3) | None

Indices into the vertex array.

datandarray, shape (Nv,) | None

scalar at vertices

levelsndarray, shape (Nlev,) | None

The levels at which the isocurve is constructed from “data”.

color_levColor, tuple, colormap name or array

The color to use when drawing the line. If an array is given, it must be of shape (Nlev, 4) and provide one rgba color by level.

**kwargsdict

Keyword arguments to pass to LineVisual.

property data

The mesh data

property levels

The threshold at which the isocurves are constructed from the data.

set_color(color)

Set the color

Parameters:

colorinstance of Color

The color to use.

set_data(vertices=None, tris=None, data=None)

Set the data

Parameters:

verticesndarray, shape (Nv, 3) | None

Vertex coordinates.

trisndarray, shape (Nf, 3) | None

Indices into the vertex array.

datandarray, shape (Nv,) | None

scalar at vertices

class vispy.visuals.IsosurfaceVisual(data=None, level=None, vertex_colors=None, face_colors=None, color=(0.5, 0.5, 1, 1), **kwargs)

Bases: vispy.visuals.mesh.MeshVisual

Displays an isosurface of a 3D scalar array.

Parameters:

datandarray | None

3D scalar array.

level: float | None

The level at which the isosurface is constructed from data.

vertex_colorsndarray | None

The vertex colors to use.

face_colorsndarray | None

The face colors to use.

colorndarray | None

The color to use.

**kwargsdict

Keyword arguments to pass to the mesh construction.

property level

The threshold at which the isosurface is constructed from the 3D data.

set_data(data=None, vertex_colors=None, face_colors=None, color=None)

Set the scalar array data

Parameters:

datandarray

A 3D array of scalar values. The isosurface is constructed to show all locations in the scalar field equal to self.level.

vertex_colorsarray-like | None

Colors to use for each vertex.

face_colorsarray-like | None

Colors to use for each face.

colorinstance of Color

The color to use.

class vispy.visuals.LinePlotVisual(data=None, color='k', symbol=None, line_kind='-', width=1.0, marker_size=10.0, edge_color='k', face_color='w', edge_width=1.0, connect='strip')

Bases: vispy.visuals.visual.CompoundVisual

Visual displaying a plot line with optional markers.

Parameters:

dataarray-like

Arguments can be passed as (Y,), (X, Y), (X, Y, Z) or np.array((X, Y)), np.array((X, Y, Z)).

colorinstance of Color

Color of the line.

symbolstr

Marker symbol to use.

line_kindstr

Kind of line to draw. For now, only solid lines ('-') are supported.

widthfloat

Line width.

marker_sizefloat

Marker size. If size == 0 markers will not be shown.

edge_colorinstance of Color

Color of the marker edge.

face_colorinstance of Color

Color of the marker face.

edge_widthfloat

Edge width of the marker.

connectstr | array

See LineVisual.

**kwargskeyword arguments

Argements to pass to the super class.

See also

LineVisual, MarkersVisual, marker_types

Examples

All of these syntaxes will work:

>>> LinePlotVisual(y_vals)
>>> LinePlotVisual(x_vals, y_vals)
>>> LinePlotVisual(xy_vals)

set_data(data=None, **kwargs)

Set the line data

Parameters:

dataarray-like

The data.

**kwargsdict

Keywoard arguments to pass to MarkerVisual and LineVisal.

class vispy.visuals.LineVisual(pos=None, color=(0.5, 0.5, 0.5, 1), width=1, connect='strip', method='gl', antialias=False)

Bases: vispy.visuals.visual.CompoundVisual

Line visual

Parameters:

posarray

Array of shape (…, 2) or (…, 3) specifying vertex coordinates.

colorColor, tuple, or array

The color to use when drawing the line. If an array is given, it must be of shape (…, 4) and provide one rgba color per vertex. Can also be a colormap name, or appropriate Function.

width:

The width of the line in px. Line widths > 1px are only guaranteed to work when using ‘agg’ method.

connectstr or array

Determines which vertices are connected by lines.

• “strip” causes the line to be drawn with each vertex connected to the next.
• “segments” causes each pair of vertices to draw an independent line segment
• numpy arrays specify the exact set of segment pairs to connect.

methodstr

Mode to use for drawing.

• “agg” uses anti-grain geometry to draw nicely antialiased lines with proper joins and endcaps.
• “gl” uses OpenGL’s built-in line rendering. This is much faster, but produces much lower-quality results and is not guaranteed to obey the requested line width or join/endcap styles.

antialiasbool

Enables or disables antialiasing. For method=’gl’, this specifies whether to use GL’s line smoothing, which may be unavailable or inconsistent on some platforms.

property method

The current drawing method

set_data(pos=None, color=None, width=None, connect=None)

Set the data used to draw this visual.

Parameters:

posarray

Array of shape (…, 2) or (…, 3) specifying vertex coordinates.

colorColor, tuple, or array

The color to use when drawing the line. If an array is given, it must be of shape (…, 4) and provide one rgba color per vertex.

width:

The width of the line in px. Line widths < 1 px will be rounded up to 1 px when using the ‘gl’ method.

connectstr or array

Determines which vertices are connected by lines.

• “strip” causes the line to be drawn with each vertex connected to the next.
• “segments” causes each pair of vertices to draw an independent line segment
• int numpy arrays specify the exact set of segment pairs to connect.
• bool numpy arrays specify which _adjacent_ pairs to connect.

class vispy.visuals.LinearRegionVisual(pos=None, color=[1.0, 1.0, 1.0, 1.0], vertical=True, **kwargs)

Bases: vispy.visuals.visual.Visual

Infinite horizontal or vertical region for 2D plots.

Parameters:

poslist, tuple or numpy array

Bounds of the region along the axis. len(pos) must be >=2.

colorlist, tuple, or array

The color to use when drawing the line. It must have a shape of (1, 4) for a single color region or (len(pos), 4) for a multicolor region.

vertical:

True for drawing a vertical region, False for an horizontal region

set_data(pos=None, color=None)

Set the data

Parameters:

poslist, tuple or numpy array

Bounds of the region along the axis. len(pos) must be >=2.

colorlist, tuple, or array

The color to use when drawing the line. It must have a shape of (1, 4) for a single color region or (len(pos), 4) for a multicolor region.

class vispy.visuals.MarkersVisual(**kwargs)

Bases: vispy.visuals.visual.Visual

Visual displaying marker symbols.

set_data(pos=None, symbol='o', size=10.0, edge_width=1.0, edge_width_rel=None, edge_color='black', face_color='white', scaling=False)

Set the data used to display this visual.

Parameters:

posarray

The array of locations to display each symbol.

symbolstr

The style of symbol to draw (see Notes).

sizefloat or array

The symbol size in px.

edge_widthfloat | None

The width of the symbol outline in pixels.

edge_width_relfloat | None

The width as a fraction of marker size. Exactly one of edge_width and edge_width_rel must be supplied.

edge_colorColor | ColorArray

The color used to draw each symbol outline.

face_colorColor | ColorArray

The color used to draw each symbol interior.

scalingbool

If set to True, marker scales when rezooming.

Notes

Allowed style strings are: disc, arrow, ring, clobber, square, diamond, vbar, hbar, cross, tailed_arrow, x, triangle_up, triangle_down, and star.

class vispy.visuals.MeshVisual(vertices=None, faces=None, vertex_colors=None, face_colors=None, color=(0.5, 0.5, 1, 1), vertex_values=None, meshdata=None, shading=None, mode='triangles', **kwargs)

Bases: vispy.visuals.visual.Visual

Mesh visual

Parameters:

verticesarray-like | None

The vertices.

facesarray-like | None

The faces.

vertex_colorsarray-like | None

Colors to use for each vertex.

face_colorsarray-like | None

Colors to use for each face.

colorinstance of Color

The color to use.

vertex_valuesarray-like | None

The values to use for each vertex (for colormapping).

meshdatainstance of MeshData | None

The meshdata.

shadingstr | None

Shading to use.

modestr

The drawing mode.

**kwargsdict

Keyword arguments to pass to Visual.

property ambient_light_color

The ambient light color

property color

The uniform color for this mesh

property light_dir

The light direction

property mesh_data

The mesh data

property mode

The triangle mode used to draw this mesh.

Options are:

• ‘triangles’: Draw one triangle for every three vertices (eg, [1,2,3], [4,5,6], [7,8,9)
• ‘triangle_strip’: Draw one strip for every vertex excluding the first two (eg, [1,2,3], [2,3,4], [3,4,5])
• ‘triangle_fan’: Draw each triangle from the first vertex and the last two vertices (eg, [1,2,3], [1,3,4], [1,4,5])

set_data(vertices=None, faces=None, vertex_colors=None, face_colors=None, color=None, vertex_values=None, meshdata=None)

Set the mesh data

Parameters:

verticesarray-like | None

The vertices.

facesarray-like | None

The faces.

vertex_colorsarray-like | None

Colors to use for each vertex.

face_colorsarray-like | None

Colors to use for each face.

colorinstance of Color

The color to use.

vertex_valuesarray-like | None

Values for each vertex.

meshdatainstance of MeshData | None

The meshdata.

property shading

The shading method used.

property shininess

The shininess

class vispy.visuals.PlaneVisual(width=1, height=1, width_segments=1, height_segments=1, direction='+z', vertex_colors=None, face_colors=None, color=(0.5, 0.5, 1, 1), edge_color=None)

Bases: vispy.visuals.visual.CompoundVisual

Visual that displays a plane.

Parameters:

widthfloat

Plane width.

heightfloat

Plane height.

width_segmentsint

Plane segments count along the width.

height_segmentsfloat

Plane segments count along the height.

direction: unicode

{'-x', '+x', '-y', '+y', '-z', '+z'} Direction the plane will be facing.

vertex_colorsndarray

Same as for MeshVisual class. See create_plane for vertex ordering.

face_colorsndarray

Same as for MeshVisual class. See create_plane for vertex ordering.

colorColor

The Color to use when drawing the cube faces.

edge_colortuple or Color

The Color to use when drawing the cube edges. If None, then no cube edges are drawn.

class vispy.visuals.PolygonVisual(pos=None, color='black', border_color=None, border_width=1, border_method='gl', triangulate=True, **kwargs)

Bases: vispy.visuals.visual.CompoundVisual

Displays a 2D polygon

Parameters:

posarray

Set of vertices defining the polygon.

colorstr | tuple | list of colors

Fill color of the polygon.

border_colorstr | tuple | list of colors

Border color of the polygon.

border_widthint

Border width in pixels. Line widths > 1px are only guaranteed to work when using border_method=’agg’ method.

border_methodstr

Mode to use for drawing the border line (see LineVisual).

• “agg” uses anti-grain geometry to draw nicely antialiased lines with proper joins and endcaps.
• “gl” uses OpenGL’s built-in line rendering. This is much faster, but produces much lower-quality results and is not guaranteed to obey the requested line width or join/endcap styles.

triangulateboolean

Triangulate the set of vertices

**kwargsdict

Keyword arguments to pass to CompoundVisual.

property border

The vispy.visuals.LineVisual that is owned by the PolygonVisual. It is used to draw the border of the polygon

property border_color

The border color of the polygon.

property color

The color of the polygon.

property mesh

The vispy.visuals.MeshVisual that is owned by the PolygonVisual. It is used to fill in the polygon

property pos

The vertex position of the polygon.

class vispy.visuals.RectangleVisual(center=None, color='black', border_color=None, border_width=1, height=1.0, width=1.0, radius=[0.0, 0.0, 0.0, 0.0], **kwargs)

Bases: vispy.visuals.polygon.PolygonVisual

Displays a 2D rectangle with optional rounded corners

Parameters:

centerarray

Center of the rectangle

colorinstance of Color

The fill color to use.

border_colorinstance of Color

The border color to use.

border_widthint

Border width in pixels. Line widths > 1px are only guaranteed to work when using border_method=’agg’ method.

heightfloat

Length of the rectangle along y-axis Defaults to 1.0

widthfloat

Length of the rectangle along x-axis Defaults to 1.0

radiusfloat | array

Radii of curvatures of corners in clockwise order from top-left Defaults to 0.

**kwargsdict

Keyword arguments to pass to PolygonVisual.

property center

The center of the ellipse

property height

The height of the rectangle.

property radius

The radius of curvature of rounded corners.

property width

The width of the rectangle.

class vispy.visuals.RegularPolygonVisual(center=None, color='black', border_color=None, border_width=1, radius=0.1, sides=4, **kwargs)

Bases: vispy.visuals.ellipse.EllipseVisual

Displays a regular polygon

Parameters:

centerarray-like (x, y)

Center of the regular polygon

colorstr | tuple | list of colors

Fill color of the polygon

border_colorstr | tuple | list of colors

Border color of the polygon

border_width: float

The width of the border in pixels

radiusfloat

Radius of the regular polygon Defaults to 0.1

sidesint

Number of sides of the regular polygon

property sides

The number of sides in the regular polygon.

class vispy.visuals.ScrollingLinesVisual(n_lines, line_size, dx, color=None, pos_offset=None, columns=None, cell_size=None)

Bases: vispy.visuals.visual.Visual

Displays many line strips of equal length, with the option to add new vertex data to one end of the lines.

Parameters:

n_linesint

The number of independent line strips to draw.

line_sizeint

The number of samples in each line strip.

dxfloat

The x distance between samples

colorarray-like

An array of colors to assign to each line strip.

pos_offsetarray-like

An array of x, y position offsets to apply to each line strip.

columnsint

Arrange line strips into a grid with this number of columns. This option is not compatible with pos_offset.

cell_sizetuple

The x, y distance between cells in the grid.

roll_data(data)

Append new data to the right side of every line strip and remove as much data from the left.

Parameters:

dataarray-like

A data array to append.

set_color(color)

Set the array of colors for each line strip.

Parameters:

colorarray-like

An array of rgba values.

set_data(index, data)

Set the complete data for a single line strip.

Parameters:

indexint

The index of the line strip to be replaced.

dataarray-like

The data to assign to the selected line strip.

set_pos_offset(po)

Set the array of position offsets for each line strip.

Parameters:

poarray-like

An array of xy offset values.

class vispy.visuals.SpectrogramVisual(x=None, n_fft=256, step=None, fs=1.0, window='hann', normalize=False, color_scale='log', cmap='cubehelix', clim='auto')

Bases: vispy.visuals.image.ImageVisual

Calculate and show a spectrogram

Parameters:

xarray-like

1D signal to operate on. If len(x) < n_fft, x will be zero-padded to length n_fft.

n_fftint

Number of FFT points. Much faster for powers of two.

stepint | None

Step size between calculations. If None, n_fft // 2 will be used.

fsfloat

The sample rate of the data.

windowstr | None

Window function to use. Can be 'hann' for Hann window, or None for no windowing.

normalizebool

Normalization of spectrogram values across frequencies.

color_scale{‘linear’, ‘log’}

Scale to apply to the result of the STFT. 'log' will use 10 * log10(power).

cmapstr

Colormap name.

climstr | tuple

Colormap limits. Should be 'auto' or a two-element tuple of min and max values.

property color_scale

The color scale

property freqs

The spectrogram frequencies

property fs

The sampling frequency

property n_fft

The length of fft window

property normalize

The normalization setting

property step

The step of fft window

property window

The used window function

property x

The original signal

class vispy.visuals.SphereVisual(radius=1.0, cols=30, rows=30, depth=30, subdivisions=3, method='latitude', vertex_colors=None, face_colors=None, color=(0.5, 0.5, 1, 1), edge_color=None, shading=None, **kwargs)

Bases: vispy.visuals.visual.CompoundVisual

Visual that displays a sphere

Parameters:

radiusfloat

The size of the sphere.

colsint

Number of cols that make up the sphere mesh (for method=’latitude’ and ‘cube’).

rowsint

Number of rows that make up the sphere mesh (for method=’latitude’ and ‘cube’).

depthint

Number of depth segments that make up the sphere mesh (for method=’cube’).

subdivisionsint

Number of subdivisions to perform (for method=’ico’).

methodstr

Method for generating sphere. Accepts ‘latitude’ for latitude-longitude, ‘ico’ for icosahedron, and ‘cube’ for cube based tessellation.

vertex_colorsndarray

Same as for MeshVisual class. See create_sphere for vertex ordering.

face_colorsndarray

Same as for MeshVisual class. See create_sphere for vertex ordering.

colorColor

The Color to use when drawing the sphere faces.

edge_colortuple or Color

The Color to use when drawing the sphere edges. If None, then no sphere edges are drawn.

shadingstr | None

Shading to use.

property border

The vispy.visuals.MeshVisual that used to draw the border.

property mesh

The vispy.visuals.MeshVisual that used to fil in.

class vispy.visuals.SurfacePlotVisual(x=None, y=None, z=None, colors=None, **kwargs)

Bases: vispy.visuals.mesh.MeshVisual

Displays a surface plot on a regular x,y grid

Parameters:

xndarray | None

1D/2D array of values specifying the x positions of vertices in the grid. In case 1D array given as input, the values will be replicated to fill the 2D array of size(z). If None, values will be assumed to be integers.

yndarray | None

1D/2D array of values specifying the y positions of vertices in the grid. In case 1D array given as input, the values will be replicated to fill the 2D array of size(z). If None, values will be assumed to be integers.

zndarray

2D array of height values for each grid vertex.

colorsndarray

(width, height, 4) array of vertex colors.

Notes

All arguments are optional.

Note that if vertex positions are updated, the normal vectors for each triangle must be recomputed. This is somewhat expensive if the surface was initialized with smooth=False and very expensive if smooth=True. For faster performance, initialize with compute_normals=False and use per-vertex colors or a material that does not require normals.

set_data(x=None, y=None, z=None, colors=None)

Update the data in this surface plot.

Parameters:

xndarray | None

1D/2D array of values specifying the x positions of vertices in the grid. In case 1D array given as input, the values will be replicated to fill the 2D array of size(z). If None, values will be assumed to be integers.

yndarray | None

1D/2D array of values specifying the x positions of vertices in the grid. In case 1D array given as input, the values will be replicated to fill the 2D array of size(z). If None, values will be assumed to be integers.

zndarray

2D array of height values for each grid vertex.

colorsndarray

(width, height, 4) array of vertex colors.

class vispy.visuals.TextVisual(text=None, color='black', bold=False, italic=False, face='OpenSans', font_size=12, pos=[0, 0, 0], rotation=0.0, anchor_x='center', anchor_y='center', method='cpu', font_manager=None)

Bases: vispy.visuals.visual.Visual

Visual that displays text

Note: SDF GPU is not currently supported in WebGL without additional

extensions (see comments in fragment shader below).

Parameters:

textstr | list of str

Text to display. Can also be a list of strings. Note: support for list of str might be removed soon in favor of text collections.

colorinstance of Color

Color to use.

boldbool

Bold face.

italicbool

Italic face.

facestr

Font face to use.

font_sizefloat

Point size to use.

postuple | list of tuple

Position (x, y) or (x, y, z) of the text. Can also be a list of tuple if text is a list.

rotationfloat

Rotation (in degrees) of the text clockwise.

anchor_xstr

Horizontal text anchor.

anchor_ystr

Vertical text anchor.

methodstr

Rendering method for text characters. Either ‘cpu’ (default) or ‘gpu’. The ‘cpu’ method should perform better on remote backends like those based on WebGL. The ‘gpu’ method should produce higher quality results.

font_managerobject | None

Font manager to use (can be shared if the GLContext is shared).

property color

The color of the text

property font_size

The font size (in points) of the text

property pos

The position of the text anchor in the local coordinate frame

property rotation

The rotation of the text (clockwise, in degrees)

property text

The text string

class vispy.visuals.TubeVisual(points, radius=1.0, closed=False, color='purple', tube_points=8, shading='smooth', vertex_colors=None, face_colors=None, mode='triangles')

Bases: vispy.visuals.mesh.MeshVisual

Displays a tube around a piecewise-linear path.

The tube mesh is corrected following its Frenet curvature and torsion such that it varies smoothly along the curve, including if the tube is closed.

Parameters:

pointsndarray

An array of (x, y, z) points describing the path along which the tube will be extruded.

radiusfloat | ndarray

The radius of the tube. Use array of floats as input to set radii of points individually. Defaults to 1.0.

closedbool

Whether the tube should be closed, joining the last point to the first. Defaults to False.

colorColor | ColorArray

The color(s) to use when drawing the tube. The same color is applied to each vertex of the mesh surrounding each point of the line. If the input is a ColorArray, the argument will be cycled; for instance if ‘red’ is passed then the entire tube will be red, or if [‘green’, ‘blue’] is passed then the points will alternate between these colours. Defaults to ‘purple’.

tube_pointsint

The number of points in the circle-approximating polygon of the tube’s cross section. Defaults to 8.

shadingstr | None

Same as for the MeshVisual class. Defaults to ‘smooth’.

vertex_colors: ndarray | None

Same as for the MeshVisual class.

face_colors: ndarray | None

Same as for the MeshVisual class.

modestr

Same as for the MeshVisual class. Defaults to ‘triangles’.

class vispy.visuals.Visual(vcode='', fcode='', gcode=None, program=None, vshare=None)

Bases: vispy.visuals.visual.BaseVisual

Base class for all visuals that can be drawn using a single shader program.

This class creates a MultiProgram, which is an object that behaves like a normal shader program (you can assign shader code, upload values, set template variables, etc.) but internally manages multiple ModularProgram instances, one per view.

Subclasses generally only need to reimplement _compute_bounds, _prepare_draw, and _prepare_transforms.

Parameters:

vcodestr

Vertex shader code.

fcodestr

Fragment shader code.

gcodestr or None

Optional geometry shader code.

programinstance of Program | None

The program to use. If None, a program will be constructed using vcode and fcode.

vshareinstance of VisualShare | None

The visual share, if necessary.

attach(filt, view=None)

Attach a Filter to this visual

Each filter modifies the appearance or behavior of the visual.

Parameters:

filtobject

The filter to attach.

viewinstance of VisualView | None

The view to use.

detach(filt, view=None)

Detach a filter.

Parameters:

filtobject

The filter to detach.

viewinstance of VisualView | None

The view to use.

set_gl_state(preset=None, **kwargs)

Define the set of GL state parameters to use when drawing

Parameters:

presetstr

Preset to use.

**kwargsdict

Keyword arguments to gloo.set_state.

update_gl_state(*args, **kwargs)

Modify the set of GL state parameters to use when drawing

Parameters:

*argstuple

Arguments.

**kwargsdict

Keyword argments.

class vispy.visuals.VolumeVisual(vol, clim=None, method='mip', threshold=None, relative_step_size=0.8, cmap='grays', gamma=1.0, clim_range_threshold=0.2, emulate_texture=False, interpolation='linear')

Bases: vispy.visuals.visual.Visual

Displays a 3D Volume

Parameters:

volndarray

The volume to display. Must be ndim==3.

climtuple of two floats | None

The contrast limits. The values in the volume are mapped to black and white corresponding to these values. Default maps between min and max.

method{‘mip’, ‘translucent’, ‘additive’, ‘iso’}

The render method to use. See corresponding docs for details. Default ‘mip’.

thresholdfloat

The threshold to use for the isosurface render method. By default the mean of the given volume is used.

relative_step_sizefloat

The relative step size to step through the volume. Default 0.8. Increase to e.g. 1.5 to increase performance, at the cost of quality.

cmapstr

Colormap to use.

gammafloat

Gamma to use during colormap lookup. Final color will be cmap(val**gamma). by default: 1.

clim_range_thresholdfloat

When changing the clims, if the new clim range is smaller than this fraction of the last-used texture data range, then it will trigger a rescaling of the texture data. For instance: if the texture data was last scaled from 0-1, and the clims are set to 0.4-0.5, then a texture rescale will be triggered if clim_range_threshold < 0.1. To prevent rescaling, set this value to 0. To always rescale, set the value to >= 1. By default, 0.2

emulate_texturebool

Use 2D textures to emulate a 3D texture. OpenGL ES 2.0 compatible, but has lower performance on desktop platforms.

interpolation{‘linear’, ‘nearest’}

Selects method of image interpolation.

property clim

The contrast limits that were applied to the volume data.

Volume display is mapped from black to white with these values. Settable via set_data() as well as @clim.setter.

property clim_normalized

Normalize current clims between 0-1 based on last-used texture data range.

In set_data(), the data is normalized (on the CPU) to 0-1 using clim. During rendering, the frag shader will apply the final contrast adjustment based on the current clim.

property gamma

The gamma used when rendering the image.

property interpolation

The interpolation method to use

Current options are:

• linear: this method is appropriate for most volumes as it creates nice looking visuals.
• nearest: this method is appropriate for volumes with discrete data where additional interpolation does not make sense.

property method

The render method to use

Current options are:

• translucent: voxel colors are blended along the view ray until the result is opaque.
• mip: maxiumum intensity projection. Cast a ray and display the maximum value that was encountered.
• additive: voxel colors are added along the view ray until the result is saturated.
• iso: isosurface. Cast a ray until a certain threshold is encountered. At that location, lighning calculations are performed to give the visual appearance of a surface.

property relative_step_size

The relative step size used during raycasting.

Larger values yield higher performance at reduced quality. If set > 2.0 the ray skips entire voxels. Recommended values are between 0.5 and 1.5. The amount of quality degredation depends on the render method.

rescale_data()

Force rescaling of data to the current contrast limits and texture upload.

Because Textures are currently 8-bits, and contrast adjustment is done during rendering by scaling the values retrieved from the texture on the GPU (provided that the new contrast limits settings are within the range of the clims used when the last texture was uploaded), posterization may become visible if the contrast limits become too small of a fraction of the clims used to normalize the texture. This function is a convenience to “force” rescaling of the Texture data to the current contrast limits range.

set_data(vol, clim=None, copy=True)

Set the volume data.

Parameters:

volndarray

The 3D volume.

climtuple | None

Colormap limits to use. None will use the min and max values.

copybool | True

Whether to copy the input volume prior to applying clim normalization.

property threshold

The threshold value to apply for the isosurface render method.

class vispy.visuals.WindbarbVisual(**kwargs)

Bases: vispy.visuals.visual.Visual

Visual displaying windbarbs.

set_data(pos=None, wind=None, trig=True, size=50.0, antialias=1.0, edge_width=1.0, edge_color='black', face_color='white')

Set the data used to display this visual.

Parameters:

posarray

The array of locations to display each windbarb.

windarray

The array of wind vector components to display each windbarb. in m/s. For knots divide by two.

trigbool

True - wind contains (mag, ang) False - wind contains (u, v) defaults to True

sizefloat or array

The windbarb size in px.

antialiasfloat

The antialiased area (in pixels).

edge_widthfloat | None

The width of the windbarb outline in pixels.

edge_colorColor | ColorArray

The color used to draw each symbol outline.

face_colorColor | ColorArray

The color used to draw each symbol interior.

class vispy.visuals.XYZAxisVisual(**kwargs)

Bases: vispy.visuals.line.line.LineVisual

Simple 3D axis for indicating coordinate system orientation. Axes are x=red, y=green, z=blue.

---

vispy.visuals.filters

class vispy.visuals.filters.Alpha(alpha=1.0)

Bases: vispy.visuals.filters.base_filter.Filter

class vispy.visuals.filters.Clipper(bounds=(0, 0, 1, 1), transform=None)

Bases: vispy.visuals.filters.base_filter.Filter

Clips visual output to a rectangular region.

property bounds

The clipping boundaries.

This must be a tuple (x, y, w, h) in a clipping coordinate system that is defined by the transform property.

property transform

The transform that maps from framebuffer coordinates to clipping coordinates.

class vispy.visuals.filters.ColorFilter(filter=(1.0, 1.0, 1.0, 1.0))

Bases: vispy.visuals.filters.base_filter.Filter

class vispy.visuals.filters.Filter(vcode=None, vhook='post', vpos=5, fcode=None, fhook='post', fpos=5)

Bases: vispy.visuals.filters.base_filter.BaseFilter

Base class for all filters that use fragment and/or vertex shaders.

Parameters:

vcodestr | Function | None

Vertex shader code. If None, vhook and vpos will be ignored.

vhook{‘pre’, ‘post’}

Hook name to attach the vertex shader to.

vposint

Position in the hook to attach the vertex shader.

fcodestr | Function | None

Fragment shader code. If None, fhook and fpos will be ignored.

fhook{‘pre’, ‘post’}

Hook name to attach the fragment shader to.

fposint

Position in the hook to attach the fragment shader.

Attributes:

vshaderFunction | None

Vertex shader.

fshaderFunction | None

Fragment shader.

class vispy.visuals.filters.IsolineFilter(level=2.0, width=2.0, antialias=1.0, color='black')

Bases: vispy.visuals.filters.base_filter.Filter

class vispy.visuals.filters.PickingFilter(id_=None)

Bases: vispy.visuals.filters.base_filter.Filter

Filter used to color visuals by a picking ID.

Note that the ID color uses the alpha channel, so this may not be used with blending enabled.

property color

The RGBA color that will be drawn to the framebuffer for visuals that use this filter.

class vispy.visuals.filters.TextureFilter(texture, texcoords, enabled=True)

Bases: vispy.visuals.filters.base_filter.Filter

Filter to apply a texture to a mesh.

Note the texture is applied by multiplying the texture color by the Visual’s produced color. By specifying color=”white” when creating a MeshVisual the result will be the unaltered texture value. Any other color, including the default, will result in a blending of that color and the color of the texture.

property enabled

True to display the texture, False to disable.

property texcoords

The texture coordinates as an (N, 2) array of floats.

property texture

The texture image.

class vispy.visuals.filters.ZColormapFilter(cmap, zrange=(0.0, 1.0))

Bases: vispy.visuals.filters.base_filter.Filter

---

vispy.visuals.transforms

Provides classes representing different transform types suitable for use with visuals and scenes.

class vispy.visuals.transforms.ChainTransform(*transforms)

Bases: vispy.visuals.transforms.base_transform.BaseTransform

BaseTransform subclass that performs a sequence of transformations in order. Internally, this class uses shaders.FunctionChain to generate its glsl_map and glsl_imap functions.

Arguments:

transformslist of BaseTransform instances

See transforms property.

append(tr)

Add a new transform to the end of this chain.

Parameters:

trinstance of Transform

The transform to use.

imap(coords)

Inverse map coordinates

Parameters:

coordsarray-like

Coordinates to inverse map.

Returns:

coordsndarray

Coordinates.

map(coords)

Map coordinates

Parameters:

coordsarray-like

Coordinates to map.

Returns:

coordsndarray

Coordinates.

prepend(tr)

Add a new transform to the beginning of this chain.

Parameters:

trinstance of Transform

The transform to use.

shader_imap()

see shader_map.

shader_map()

Return a shader Function that accepts only a single vec4 argument and defines new attributes / uniforms supplying the Function with any static input.

property simplified

A simplified representation of the same transformation.

property transforms

The list of transform that make up the transform chain.

The order of transforms is given such that the last transform in the list is the first to be invoked when mapping coordinates through the chain.

For example, the following two mappings are equivalent:

# Map coordinates through individual transforms:
trans1 = STTransform(scale=(2, 3), translate=(0, 1))
trans2 = PolarTransform()
mapped = trans1.map(trans2.map(coords))

# Equivalent mapping through chain:
chain = ChainTransform([trans1, trans2])
mapped = chain.map(coords)

class vispy.visuals.transforms.LogTransform(base=None)

Bases: vispy.visuals.transforms.base_transform.BaseTransform

Transform perfoming logarithmic transformation on three axes.

Maps (x, y, z) => (log(base.x, x), log(base.y, y), log(base.z, z))

No transformation is applied for axes with base == 0.

If base < 0, then the inverse function is applied: x => base.x ** x

Parameters:

basearray-like

Base for the X, Y, Z axes.

property base

base is a tuple (x, y, z) containing the log base that should be applied to each axis of the input vector. If any axis has a base <= 0, then that axis is not affected.

imap(arg, *args, **kwargs)

Function

Parameters:

argarray-like

Argument to convert.

*argstuple

Arguments.

**kwargsdict

Keyword arguments.

Returns:

valueobject

The return value of the function.

map(arg, *args, **kwargs)

Function

Parameters:

argarray-like

Argument to convert.

*argstuple

Arguments.

**kwargsdict

Keyword arguments.

Returns:

valueobject

The return value of the function.

shader_imap()

see shader_map.

shader_map()

Return a shader Function that accepts only a single vec4 argument and defines new attributes / uniforms supplying the Function with any static input.

class vispy.visuals.transforms.MatrixTransform(matrix=None)

Bases: vispy.visuals.transforms.base_transform.BaseTransform

Affine transformation class

Parameters:

matrixarray-like | None

4x4 array to use for the transform.

imap(coords)

Inverse map coordinates

Parameters:

coordsarray-like

Coordinates to inverse map.

Returns:

coordsndarray

Coordinates.

map(coords)

Map coordinates

Parameters:

coordsarray-like

Coordinates to map.

Returns:

coordsndarray

Coordinates.

rotate(angle, axis)

Rotate the matrix by some angle about a given axis.

The rotation is applied after the transformations already present in the matrix.

Parameters:

anglefloat

The angle of rotation, in degrees.

axisarray-like

The x, y and z coordinates of the axis vector to rotate around.

scale(scale, center=None)

Scale the matrix about a given origin.

The scaling is applied after the transformations already present in the matrix.

Parameters:

scalearray-like

Scale factors along x, y and z axes.

centerarray-like or None

The x, y and z coordinates to scale around. If None, (0, 0, 0) will be used.

set_frustum(l, r, b, t, n, f)

Set the frustum

Parameters:

lfloat

Left.

rfloat

Right.

bfloat

Bottom.

tfloat

Top.

nfloat

Near.

ffloat

Far.

set_mapping(points1, points2)

Set to a 3D transformation matrix that maps points1 onto points2.

Parameters:

points1array-like, shape (4, 3)

Four starting 3D coordinates.

points2array-like, shape (4, 3)

Four ending 3D coordinates.

set_ortho(l, r, b, t, n, f)

Set ortho transform

Parameters:

lfloat

Left.

rfloat

Right.

bfloat

Bottom.

tfloat

Top.

nfloat

Near.

ffloat

Far.

set_perspective(fov, aspect, near, far)

Set the perspective

Parameters:

fovfloat

Field of view.

aspectfloat

Aspect ratio.

nearfloat

Near location.

farfloat

Far location.

shader_imap()

see shader_map.

shader_map()

Return a shader Function that accepts only a single vec4 argument and defines new attributes / uniforms supplying the Function with any static input.

translate(pos)

Translate the matrix

The translation is applied after the transformations already present in the matrix.

Parameters:

posarrayndarray

Position to translate by.

class vispy.visuals.transforms.NullTransform

Bases: vispy.visuals.transforms.base_transform.BaseTransform

Transform having no effect on coordinates (identity transform).

imap(coords)

Inverse map coordinates

Parameters:

coordsarray-like

Coordinates to inverse map.

map(coords)

Map coordinates

Parameters:

coordsarray-like

Coordinates to map.

class vispy.visuals.transforms.PanZoomTransform(canvas=None, aspect=None, **kwargs)

Bases: vispy.visuals.transforms.linear.STTransform

Pan-zoom transform

Parameters:

canvasinstance of Canvas | None

The canvas to attch to.

aspectfloat | None

The aspect ratio to apply.

**kwargsdict

Keyword arguments to pass to the underlying STTransform.

attach(canvas)

Attach this tranform to a canvas

Parameters:

canvasinstance of Canvas

The canvas.

on_mouse_move(event)

Mouse move handler

Parameters:

eventinstance of Event

The event.

on_mouse_wheel(event)

Mouse wheel handler

Parameters:

eventinstance of Event

The event.

on_resize(event)

Resize handler

Parameters:

eventinstance of Event

The event.

class vispy.visuals.transforms.PolarTransform

Bases: vispy.visuals.transforms.base_transform.BaseTransform

Polar transform

Maps (theta, r, z) to (x, y, z), where x = r*cos(theta) and y = r*sin(theta).

imap(arg, *args, **kwargs)

Function

Parameters:

argarray-like

Argument to convert.

*argstuple

Arguments.

**kwargsdict

Keyword arguments.

Returns:

valueobject

The return value of the function.

map(arg, *args, **kwargs)

Function

Parameters:

argarray-like

Argument to convert.

*argstuple

Arguments.

**kwargsdict

Keyword arguments.

Returns:

valueobject

The return value of the function.

class vispy.visuals.transforms.STTransform(scale=None, translate=None)

Bases: vispy.visuals.transforms.base_transform.BaseTransform

Transform performing only scale and translate, in that order.

Parameters:

scalearray-like

Scale factors for X, Y, Z axes.

translatearray-like

Scale factors for X, Y, Z axes.

classmethod from_mapping(x0, x1)

Create an STTransform from the given mapping

See set_mapping for details.

Parameters:

x0array-like

Start.

x1array-like

End.

Returns:

tinstance of STTransform

The transform.

imap(coords)

Invert map coordinates

Parameters:

coordsarray-like

Coordinates to inverse map.

Returns:

coordsndarray

Coordinates.

map(coords)

Map coordinates

Parameters:

coordsarray-like

Coordinates to map.

Returns:

coordsndarray

Coordinates.

move(move)

Change the translation of this transform by the amount given.

Parameters:

movearray-like

The values to be added to the current translation of the transform.

set_mapping(x0, x1, update=True)

Configure this transform such that it maps points x0 => x1

Parameters:

x0array-like, shape (2, 2) or (2, 3)

Start location.

x1array-like, shape (2, 2) or (2, 3)

End location.

updatebool

If False, then the update event is not emitted.

Examples

For example, if we wish to map the corners of a rectangle:

>>> p1 = [[0, 0], [200, 300]]

onto a unit cube:

>>> p2 = [[-1, -1], [1, 1]]

then we can generate the transform as follows:

>>> tr = STTransform()
>>> tr.set_mapping(p1, p2)
>>> assert tr.map(p1)[:,:2] == p2  # test

shader_imap()

see shader_map.

shader_map()

Return a shader Function that accepts only a single vec4 argument and defines new attributes / uniforms supplying the Function with any static input.

zoom(zoom, center=(0, 0, 0), mapped=True)

Update the transform such that its scale factor is changed, but the specified center point is left unchanged.

Parameters:

zoomarray-like

Values to multiply the transform’s current scale factors.

centerarray-like

The center point around which the scaling will take place.

mappedbool

Whether center is expressed in mapped coordinates (True) or unmapped coordinates (False).

class vispy.visuals.transforms.TransformSystem(canvas=None, dpi=None)

Bases: object

TransformSystem encapsulates information about the coordinate systems needed to draw a Visual.

Visual rendering operates in six coordinate systems:

• Visual - arbitrary local coordinate frame of the visual. Vertex buffers used by the visual are usually specified in this coordinate system.
• Scene - This is an isometric coordinate system used mainly for lighting calculations.
• Document - This coordinate system has units of _logical_ pixels, and should usually represent the pixel coordinates of the canvas being drawn to. Visuals use this coordinate system to make measurements for font size, line width, and in general anything that is specified in physical units (px, pt, mm, in, etc.). In most circumstances, this is exactly the same as the canvas coordinate system.
• Canvas - This coordinate system represents the logical pixel coordinates of the canvas. It has its origin in the top-left corner of the canvas, and is typically the coordinate system that mouse and touch events are reported in. Note that, by convention, _logical_ pixels are not necessarily the same size as the _physical_ pixels in the framebuffer that is being rendered to.
• Framebuffer - The buffer coordinate system has units of _physical_ pixels, and should usually represent the coordinates of the current framebuffer (on the canvas or an FBO) being rendered to. Visuals use this coordinate system primarily for antialiasing calculations. It is also the coorinate system used by glFragCoord. In most cases, this will have the same scale as the document and canvas coordinate systems because the active framebuffer is the back buffer of the canvas, and the canvas will have _logical_ and _physical_ pixels of the same size. However, the scale may be different in the case of high-resolution displays, or when rendering to an off-screen framebuffer with different scaling or boundaries than the canvas.
• Render - This coordinate system is the obligatory system for vertices returned by a vertex shader. It has coordinates (-1, -1) to (1, 1) across the current glViewport. In OpenGL terminology, this is called clip coordinates.

Parameters:

canvasCanvas

The canvas being drawn to.

dpifloat

The dot-per-inch resolution of the document coordinate system. By default this is set to the resolution of the canvas.

Notes

By default, TransformSystems are configured such that the document coordinate system matches the logical pixels of the canvas,

Examples

1. To convert local vertex coordinates to normalized device coordinates in the vertex shader, we first need a vertex shader that supports configurable transformations:

vec4 a_position;
void main() {
    gl_Position = $transform(a_position);
}

Next, we supply the complete chain of transforms when drawing the visual:

def draw(tr_sys):

tr = tr_sys.get_full_transform() self.program[‘transform’] = tr.shader_map() self.program[‘a_position’] = self.vertex_buffer self.program.draw(‘triangles’)

2. Draw a line whose width is given in mm. To start, we need normal vectors for each vertex, which tell us the direction the vertex should move in order to set the line width:

vec4 a_position;
vec4 a_normal;
float u_line_width;
float u_dpi;
void main() {
    // map vertex position and normal vector to the document cs
    vec4 doc_pos = $visual_to_doc(a_position);
    vec4 doc_normal = $visual_to_doc(a_position + a_normal) - doc_pos;

    // Use DPI to convert mm line width to logical pixels
    float px_width = (u_line_width / 25.4) * dpi;

    // expand by line width
    doc_pos += normalize(doc_normal) * px_width;

    // finally, map the remainder of the way to normalized device
    // coordinates.
    gl_Position = $doc_to_render(a_position);
}

In this case, we need to access the transforms independently, so get_full_transform() is not useful here:

def draw(tr_sys):
    # Send two parts of the full transform separately
    self.program['visual_to_doc'] = tr_sys.visual_to_doc.shader_map()
    doc_to_render = (tr_sys.framebuffer_transform *
                     tr_sys.document_transform)
    self.program['visual_to_doc'] = doc_to_render.shader_map()

    self.program['u_line_width'] = self.line_width
    self.program['u_dpi'] = tr_sys.dpi
    self.program['a_position'] = self.vertex_buffer
    self.program['a_normal'] = self.normal_buffer
    self.program.draw('triangles')

3. Draw a triangle with antialiasing at the edge.
4. Using inverse transforms in the fragment shader

property canvas

The Canvas being drawn to.

property canvas_transform

Transform mapping from canvas coordinate frame to framebuffer coordinate frame.

configure(viewport=None, fbo_size=None, fbo_rect=None, canvas=None)

Automatically configure the TransformSystem:

• canvas_transform maps from the Canvas logical pixel coordinate system to the framebuffer coordinate system, taking into account the logical/physical pixel scale factor, current FBO position, and y-axis inversion.
• framebuffer_transform maps from the current GL viewport on the framebuffer coordinate system to clip coordinates (-1 to 1).

Parameters:

viewporttuple or None

The GL viewport rectangle (x, y, w, h). If None, then it is assumed to cover the entire canvas.

fbo_sizetuple or None

The size of the active FBO. If None, then it is assumed to have the same size as the canvas’s framebuffer.

fbo_recttuple or None

The position and size (x, y, w, h) of the FBO in the coordinate system of the canvas’s framebuffer. If None, then the bounds are assumed to cover the entire active framebuffer.

canvasCanvas instance

Optionally set the canvas for this TransformSystem. See the canvas property.

property document_transform

Transform mapping from document coordinate frame to the framebuffer (physical pixel) coordinate frame.

property dpi

Physical resolution of the document coordinate system (dots per inch).

property framebuffer_transform

Transform mapping from pixel coordinate frame to rendering coordinate frame.

get_transform(map_from='visual', map_to='render')

Return a transform mapping between any two coordinate systems.

Parameters:

map_fromstr

The starting coordinate system to map from. Must be one of: visual, scene, document, canvas, framebuffer, or render.

map_tostr

The ending coordinate system to map to. Must be one of: visual, scene, document, canvas, framebuffer, or render.

property scene_transform

Transform mapping from scene coordinate frame to document coordinate frame.

property visual_transform

Transform mapping from visual local coordinate frame to scene coordinate frame.