Note
This section is only a reference, please see chapter on Simple Scripting with mlab for an introduction to mlab.
Please see the section on Running mlab scripts for instructions on running the examples.
Creates axes for the current (or given) object.
Keyword arguments:
color: the color of the vtk object. Overides the colormap, if any, when specified. This is specified as a triplet of float ranging from 0 to 1, eg (1, 1, 1) for white. extent: [xmin, xmax, ymin, ymax, zmin, zmax] Default is the object’s extents. line_width: The with of the lines, if any used. Must be a float. Default: 2.0 name: the name of the vtk object created. opacity: The overall opacity of the vtk object. Must be a float. Default: 1.0 ranges: [xmin, xmax, ymin, ymax, zmin, zmax] Ranges of the labels displayed on the axes. Default is the object’s extents. x_axis_visibility: Whether or not the x axis is visible (boolean) xlabel: the label of the x axis y_axis_visibility: Whether or not the y axis is visible (boolean) ylabel: the label of the y axis z_axis_visibility: Whether or not the z axis is visible (boolean) zlabel: the label of the z axis
Start interacting with the figure.
By default, this function simply creates a GUI and starts its event loop if needed.
If it is used as a decorator, then it may be used to decorate a function which requires a UI. If the GUI event loop is already running it simply runs the function. If not the event loop is started and function is run in the toolkit’s event loop. The choice of UI is via ETSConfig.toolkit.
Adds a text on the figure.
Function signature:
text(x, y, text, ...)
x, and y are the position of the origin of the text on the 2D projection of the figure. If a z keyword argument is given, the text is positionned in 3D, in figure coordinnates.
Keyword arguments:
color: the color of the vtk object. Overides the colormap, if any, when specified. This is specified as a triplet of float ranging from 0 to 1, eg (1, 1, 1) for white. line_width: The with of the lines, if any used. Must be a float. Default: 2.0 name: the name of the vtk object created. opacity: The overall opacity of the vtk object. Must be a float. Default: 1.0 width: width of the text. z: Optional z position. When specified, the text is positioned in 3D
Creates an outline for the current (or given) object.
Keyword arguments:
color: the color of the vtk object. Overides the colormap, if any, when specified. This is specified as a triplet of float ranging from 0 to 1, eg (1, 1, 1) for white. extent: [xmin, xmax, ymin, ymax, zmin, zmax] Default is the object’s extents. line_width: The with of the lines, if any used. Must be a float. Default: 2.0 name: the name of the vtk object created. opacity: The overall opacity of the vtk object. Must be a float. Default: 1.0
Creates a title for the figure.
Function signature:
title(text, ...)
Keyword arguments:
color: the color of the vtk object. Overides the colormap, if any, when specified. This is specified as a triplet of float ranging from 0 to 1, eg (1, 1, 1) for white. height: height of the title, in portion of the figure height line_width: The with of the lines, if any used. Must be a float. Default: 2.0 name: the name of the vtk object created. opacity: The overall opacity of the vtk object. Must be a float. Default: 1.0 size: the size of the title
Applies the OrientationAxes mayavi module to the given VTK data object.
Keyword arguments:
color: the color of the vtk object. Overides the colormap, if any, when specified. This is specified as a triplet of float ranging from 0 to 1, eg (1, 1, 1) for white. line_width: The with of the lines, if any used. Must be a float. Default: 2.0 name: the name of the vtk object created. opacity: The overall opacity of the vtk object. Must be a float. Default: 1.0 xlabel: the label of the x axis ylabel: the label of the y axis zlabel: the label of the z axis