API Reference for Enthought Tool Suite 3.2.0

Variables

• application

  application = get_application()
  
  

• mayavi

  mayavi = None
  
  

Classes

• ImageActor

Function summary

• axes(color = None, xlabel = None, ylabel = None, zlabel = None, object = None, name = 'Axes')
• clf()
• colorbar(object = None, title = None, orientation = None)
• contour3d(*args, **kwargs)
• contour_surf(*args, **kwargs)
• figure()
• gcf()
• glyph(data_obj, color = None, name = 'Glyph', mode = 'sphere', scale_factor = 1.0)
• imshow(arr, extent = None, interpolate = False, lut_mode = 'blue-red', file_name = '', name = 'ImShow')
• isosurface(data_obj, name = 'IsoSurface', transparent = True, contours = 5)
• outline(object = None, color = None, name = 'Outline')
• plot3d(x, y, z, radius = 0.01, use_tubes = True, color = (1.0, 0.0, 0.0), name = 'Plot3D')
• points3d(*args, **kwargs)
• quiver3d(*args, **kwargs)
• savefig(filename, size = None, **kwargs)
• scalarbar(object = None, title = None, orientation = None)
• scalarfield(*args, **kwargs)
• scalarscatter(*args, **kwargs)
• streamline(data_obj, color = None, name = 'Streamline')
• surf(*args, **kwargs)
• test_contour3d()
• test_imshow()
• test_mesh()
• test_mesh_sphere()
• test_molecule()
• test_plot3d()
• test_quiver3d()
• test_quiver3d_2d_data()
• test_simple_surf()
• test_surf()
• test_surf_lattice()
• text(x = 0, y = 0, text = '', color = None, size = None, name = 'Text')
• title(text = None, color = None, size = None, name = 'Title')
• vectorbar(object = None, title = None, orientation = None)
• vectorfield(*args, **kwargs)
• vectors(data_obj, color = None, name = 'Vectors', mode = '2d', scale_factor = 1.0)
• vectorscatter(*args, **kwargs)
• xlabel(text)
• ylabel(text)
• zlabel(text)

Functions

• axes(color = None, xlabel = None, ylabel = None, zlabel = None, object = None, name = 'Axes')

  Creates an axes for the current data.

  Keyword arguments

  color -- The color triplet, eg: (1., 0., 0.)

  xlabel -- the label of the x axis, default: ''

  ylabel -- the label of the y axis, default: ''

  zlabel -- the label of the z axis, default: ''

  object -- the object for which we create the axes.

• clf()

  Clear the current figure.

• colorbar(object = None, title = None, orientation = None)

  Adds a colorbar for the color mapping of the given object.

  If the object has scalar data, the scalar color mapping is represented. Elsewhere the vector color mapping is represented, if available. If no object is specified, the first object with a color map in the scene is used.

  Keyword arguments

  object -- Optional object to get the vector lut from

  title -- The title string

  orientation -- Can be 'horizontal' or 'vertical'

• contour3d(*args, **kwargs)

  Plots iso-surfaces for a 3D volume of data suplied as arguments.

  Function signatures

  contour3d(scalars, ...) contour3d(scalarfield, ...)

  Arguments

  scalars -- A 3D array giving the value of the scalar on a grid.

  scalarfield -- VTK data object with scalar field data, such as

  created by scalarfield.

  Keyword arguments

  name -- The name of the vtk object created. Default: 'Contour3D'

  transpose_scalars -- If the additional argument

  transpose_scalars is passed, then the input scalar array is suitably transposed. By default transpose_scalars is True so that the array is in the correct format that VTK expects. However, a transposed array is not contiguous and thus a copy is made, this also means that any changes to the users input array will will not be reflected in the renderered object (provided you know how to do this). Thus, sometimes users might want to provide already transposed data suitably formatted. In these cases one should set transpose_scalars to False. Default value: True

  contours -- Integer/list specifying number/list of

  iso-surfaces. Specifying 0 shows no contours. Specifying a list of values will only give the requested contours asked for. Default: 3

  extent -- [xmin, xmax, ymin, ymax, zmin, zmax]

  Default is the shape of the scalars

  transparent -- Boolean to make the opacity of the isosurfaces depend

  on the scalar. Default: True

• contour_surf(*args, **kwargs)

  Plots the contours of a surface using grid spaced data supplied as 2D arrays.

  Function signatures:

  contour_surf(z, scalars=z, ...)
  contour_surf(surf_object, ...)
  contour_surf(x, y, z, scalars=z, ...)
  

  If only one array z is passed the x and y arrays are assumed to be made of the indices of z. z is the elevation matrix. If no scalars argument is passed the contours are contour lines of the elevation, elsewhere they are contour lines of the scalar array. A surf object can also be passed in which case the function adds contours to the existing surf.

  Arguments

  x

  x coordinates of the points of the mesh (optional).

  y

  y coordinates of the points of the mesh (optional).

  z

  A 2D array giving the elevation of the mesh. Also will work if z is a callable which supports x and y arrays as the arguments, but x and y must then be supplied.

  Keyword arguments

  extent : [xmin, xmax, ymin, ymax, zmin, zmax]

  Default is the x, y, z arrays extents.

  contours

  Integer/list specifying number/list of iso-surfaces. Specifying 0 shows no contours. Specifying a list of values will only give the requested contours asked for. Default: 10

  scalars

  An array of the same shape as z that gives the scalar data to plot the contours of. This can also be a function that takes x and y as arguments.

  color

  The color of the contour lines. If None, this is given by the scalars.

  contour_z

  If this argument is given the contours are drawn on a plane at the altitude specified by this argument instead of on the surface. Currently this cannot be used when a surf_object is passed as an argument.

  name

  The name of the vtk object created. Default is "Contour Surf"

• figure()

  If you are running from IPython this will start up mayavi for you! This returns the current running MayaVi script instance.

• gcf()

  Return a handle to the current figure.

• glyph(data_obj, color = None, name = 'Glyph', mode = 'sphere', scale_factor = 1.0)

  Applies the Glyph mayavi module to the given VTK data object.

• imshow(arr, extent = None, interpolate = False, lut_mode = 'blue-red', file_name = '', name = 'ImShow')

  Allows one to view a 2D Numeric array as an image. This works best for very large arrays (like 1024x1024 arrays).

  Arguments

  arr -- Array to be viewed.

  Keyword arguments

  scale -- Scale the x, y and z axis as per passed values.

  Defaults to [1.0, 1.0, 1.0].

  extent -- [xmin, xmax, ymin, ymax]

  Default is the x, y arrays extents

  interpolate -- Boolean to interpolate the data in the image.

• isosurface(data_obj, name = 'IsoSurface', transparent = True, contours = 5)

  Applies the IsoSsurface mayavi module to the given VTK data object.

• outline(object = None, color = None, name = 'Outline')

  Creates an outline for the current data.

  Keyword arguments

  object -- the object for which we create the outline

  (default None).

  color -- The color triplet, eg: ( 1., 0., 0.)

• plot3d(x, y, z, radius = 0.01, use_tubes = True, color = (1.0, 0.0, 0.0), name = 'Plot3D')

  Draws lines between points.

  Arguments

  x -- x coordinates of the points of the line

  y -- y coordinates of the points of the line

  z -- z coordinates of the points of the line

  Keyword arguments

  color -- color of the line. Default: (1., 0., 0.)

  use_tubes -- Enables the drawing of the lines as tubes. Default: True

  radius -- radius of the tubes created. Default: 0.01

  name -- The name of the vtk object created. Default: 'Plot3D'

• points3d(*args, **kwargs)

  Plots glyphs (like points) at the position of the supplied data.

  Function signatures

  points3d(scalardata, ...) points3d(x, y, z...) points3d(x, y, z, s, ...) points3d(x, y, z, f, ...)

  If only one positional argument is passed, it should be VTK data object with scalar data.

  If only 3 arrays x, y, z all the points are drawn with the same size and color

  If 4 positional arguments are passed the last one can be an array s or a callable f that gives the size and color of the glyph.

  Arguments

  scalardata -- VTK data object with scalar data, such as created

  by scalarscatter.

  x -- x coordinates of the points.

  y -- y coordinates of the points.

  z -- z coordinates of the points.

  s -- array giving the color and size of the glyphs (optional).

  f -- callable that returns the scalar associated with the points

  as a function of position.

  Keyword arguments

  name -- The name of the vtk object created. Default: 'Points3D'

  mode -- This should be one of ['2d' (2d arrows),

  'arrow', 'cone', 'cylinder', 'sphere', 'cube', 'point'] and depending on what is passed shows an appropriate glyph. It defaults to a sphere.

  extent -- [xmin, xmax, ymin, ymax, zmin, zmax]

  Default is the x, y, z arrays extents.

  scalars -- The scalars used to display the color of the glyphs.

  color -- The color of the glyphs. Overrides the scalar array.

  Default: (1., 0., 0.).

  autoscale -- Autoscale the size of the glyph.

  Default: True

  scale_factor -- Default 1

• quiver3d(*args, **kwargs)

  Plots glyphs (like arrows) indicating the direction of the vectors for a 3D volume of data supplied as arguments.

  Function signatures

  quiver3d(vectordata, ...) quiver3d(u, v, w, ...) quiver3d(x, y, z, u, v, w, ...) quiver3d(x, y, z, f, ...)

  If only one positional argument is passed, it should be VTK data object with vector data.

  If only 3 arrays u, v, w are passed the x, y and z arrays are assumed to be made from the indices of vectors.

  If 4 positional arguments are passed the last one must be a callable, f, that returns vectors.

  Arguments

  vectordata -- VTK data object with vector data, such as created

  by vectorscatter of vectorfield.

  x -- x coordinates of the points of the mesh (optional).

  y -- y coordinates of the points of the mesh (optional).

  z -- z coordinates of the points of the mesh (optional).

  u -- x coordinnate of the vector field

  v -- y coordinnate of the vector field

  w -- z coordinnate of the vector field

  f -- callable that is used to build the vector field (only if 4

  positional arguments are passed).

  Keyword arguments

  name -- The name of the vtk object created. Default: 'Quiver3D'

  mode -- This should be one of ['2d' (2d arrows),

  'arrow', 'cone', 'cylinder', 'sphere', 'cube', 'point'] and depending on what is passed shows an appropriate glyph. It defaults to a 3d arrow.

  extent -- [xmin, xmax, ymin, ymax, zmin, zmax]

  Default is the x, y, z arrays extents.

  scalars -- The scalars used to display the color of the glyphs.

  Defaults to the norm of the vectors.

  color -- The color of the glyphs in the absence of scalars.

  Default: (1., 0., 0.)

  autoscale -- Autoscale the size of the glyph.

  Default: True

  scale_factor -- Default 1

• savefig(filename, size = None, **kwargs)

  Save the current scene. The output format are deduced by the extension to filename. Possibilities are png, jpg, bmp, tiff, ps, eps, pdf, rib (renderman), oogl (geomview), iv (OpenInventor), vrml, obj (wavefront)

  If an additional size (2-tuple) argument is passed the window is resized to the specified size in order to produce a suitably sized output image. Please note that when the window is resized, the window may be obscured by other widgets and the camera zoom is not reset which is likely to produce an image that does not reflect what is seen on screen.

  Any extra keyword arguments are passed along to the respective image format's save method.

• scalarbar(object = None, title = None, orientation = None)

  Adds a colorbar for the scalar color mapping of the given object.

  If no object is specified, the first object with scalar data in the scene is used.

  Keyword arguments

  title -- The title string

  orientation -- Can be 'horizontal' or 'vertical'

• scalarfield(*args, **kwargs)

  Creates a scalar field data.

  Function signatures

  scalarfield(s, ...) scalarfield(x, y, z, s, ...) scalarfield(x, y, z, f, ...)

  If only 1 array s is passed the x, y and z arrays are assumed to be made from the indices of the s array.

  If the x, y and z arrays are passed they are supposed to have been generated by numpy.mgrid. The function builds a scalar field assuming the points are regularily spaced.

  Arguments

  x -- x coordinates of the points of the mesh (optional).

  y -- y coordinates of the points of the mesh (optional).

  z -- z coordinates of the points of the mesh (optional).

  s -- scalar values.

  f -- callable that is used to build the scalar field (only if 4

  positional arguments are passed).

  Keyword arguments

  name -- The name of the vtk object created. Default: 'Scalar field'

  extent -- [xmin, xmax, ymin, ymax, zmin, zmax]

  Default is the x, y, z arrays extents.

• scalarscatter(*args, **kwargs)

  Creates scattered scalar data.

  Function signatures

  scalarscatter(s, ...) scalarscatter(x, y, z, s, ...) scalarscatter(x, y, z, f, ...)

  If only 1 array s is passed the x, y and z arrays are assumed to be made from the indices of vectors.

  If 4 positional arguments are passed the last one must be an array s, or acallable, f, that returns an array.

  Arguments

  x -- x coordinates of the points of the mesh (optional).

  y -- y coordinates of the points of the mesh (optional).

  z -- z coordinates of the points of the mesh (optional).

  s -- scalar value

  f -- callable that is used to build the scalar data (only if 4

  positional arguments are passed).

  Keyword arguments

  name -- The name of the vtk object created. Default: 'Scattered scalars'

  extent -- [xmin, xmax, ymin, ymax, zmin, zmax]

  Default is the x, y, z arrays extents.

• streamline(data_obj, color = None, name = 'Streamline')

  Applies the Streamline mayavi module to the given VTK data object.

• surf(*args, **kwargs)

  Plots a surface using grid spaced data supplied as 2D arrays.

  Function signatures

  surf(z, scalars=z, ...) surf(x, y, z, scalars=z, ...)

  If only one array z is passed the x and y arrays are assumed to be made of the indices of z. z is the elevation matrix. If no scalars argument is passed the color of the surface also represents the z matrix. Setting the scalars argument to None prevents this.

  Arguments

  x -- x coordinates of the points of the mesh (optional).

  y -- y coordinates of the points of the mesh (optional).

  z -- A 2D array giving the elevation of the mesh.

  Also will work if z is a callable which supports x and y arrays as the arguments, but x and y must then be supplied.

  Keyword arguments

  extent -- [xmin, xmax, ymin, ymax, zmin, zmax]

  Default is the x, y, z arrays extents.

  scalars -- An array of the same shape as z that gives the color of the

  surface. This can also be a function that takes x and y as arguments.

  represention -- can be 'surface', 'wireframe', 'points', or 'mesh'

  Default is 'surface'

  color -- The color of the mesh in the absence of scalars.

  name -- The name of the vtk object created. Default is "Surf"

• test_contour3d()
• test_imshow()

  Show a large random array.

• test_mesh()

  Create a fancy looking mesh (example taken from octaviz).

• test_mesh_sphere()

  Create a simple sphere and test the mesh.

• test_molecule()

  Generates and shows a Caffeine molecule.

• test_plot3d()

  Generates a pretty set of lines.

• test_quiver3d()
• test_quiver3d_2d_data()
• test_simple_surf()

  Test Surf with a simple collection of points.

• test_surf()

  A very pretty picture of spherical harmonics translated from the octaviz example.

• test_surf_lattice()

  Test Surf on regularly spaced co-ordinates like MayaVi.

• text(x = 0, y = 0, text = '', color = None, size = None, name = 'Text')

  Adds a text on the figure.

  Keyword arguments

  x -- x position on the screen of the origin of the text, default: 0

  y -- y position on the screen of the origin of the text, default: 0

  text -- The text, default: ''

  color -- The color triplet, eg: ( 1., 0., 0.)

  size -- The size, default: 1

• title(text = None, color = None, size = None, name = 'Title')

  Creates a title for the figure.

  Keyword arguments

  text -- The text of the title, default: ''

  color -- The color triplet, eg: ( 1., 0., 0.)

  size -- The size, default: 1

• vectorbar(object = None, title = None, orientation = None)

  Adds a colorbar for the vector color mapping of the given object.

  If no object is specified, the first object with vector data in the scene is used.

  Keyword arguments

  object -- Optional object to get the vector lut from

  title -- The title string

  orientation -- Can be 'horizontal' or 'vertical'

• vectorfield(*args, **kwargs)

  Creates a vector field data.

  Function signatures

  vectorfield(u, v, w, ...) vectorfield(x, y, z, u, v, w, ...) vectorfield(x, y, z, f, ...)

  If only 3 arrays u, v, w are passed the x, y and z arrays are assumed to be made from the indices of the u, v, w arrays.

  If the x, y and z arrays are passed they are supposed to have been generated by numpy.mgrid. The function builds a vector field assuming the points are regularily spaced.

  Arguments

  x -- x coordinates of the points of the mesh (optional).

  y -- y coordinates of the points of the mesh (optional).

  z -- z coordinates of the points of the mesh (optional).

  u -- x coordinnate of the vector field

  v -- y coordinnate of the vector field

  w -- z coordinnate of the vector field

  f -- callable that is used to build the vector field (only if 4

  positional arguments are passed).

  Keyword arguments

  name -- The name of the vtk object created. Default: 'Vector field'

  extent -- [xmin, xmax, ymin, ymax, zmin, zmax]

  Default is the x, y, z arrays extents.

  scalars -- The scalars associated to the vectors. Defaults to none.

  transpose_vectors -- If the additional argument

  transpose_vectors is passed, then the input vectors array is suitably transposed. By default transpose_vectors is True so that the array is in the correct format that VTK expects. However, a transposed array is not contiguous and thus a copy is made, this also means that any changes to the users input array will will not be reflected in the renderered object (provided you know how to do this). Thus, sometimes users might want to provide already transposed data suitably formatted. In these cases one should set transpose_vectors to False. Default value: True

• vectors(data_obj, color = None, name = 'Vectors', mode = '2d', scale_factor = 1.0)

  Applies the Vectors mayavi module to the given VTK data object.

• vectorscatter(*args, **kwargs)

  Creates scattered vector data.

  Function signatures

  vectorscatter(u, v, w, ...) vectorscatter(x, y, z, u, v, w, ...) vectorscatter(x, y, z, f, ...)

  If only 3 arrays u, v, w are passed the x, y and z arrays are assumed to be made from the indices of vectors.

  If 4 positional arguments are passed the last one must be a callable, f, that returns vectors.

  Arguments

  x -- x coordinates of the points of the mesh (optional).

  y -- y coordinates of the points of the mesh (optional).

  z -- z coordinates of the points of the mesh (optional).

  u -- x coordinnate of the vector field

  v -- y coordinnate of the vector field

  w -- z coordinnate of the vector field

  f -- callable that is used to build the vector field (only if 4

  positional arguments are passed).

  Keyword arguments

  name -- The name of the vtk object created. Default: 'Scattered vector'

  extent -- [xmin, xmax, ymin, ymax, zmin, zmax]

  Default is the x, y, z arrays extents.

  scalars -- The scalars associated to the vectors. Defaults to none.

• xlabel(text)

  Creates a set of axes if there isn't already one, and sets the x label

• ylabel(text)

  Creates a set of axes if there isn't already one, and sets the y label

• zlabel(text)

  Creates a set of axes if there isn't already one, and sets the z label

Imported Names

© Copyright 2002-2009 Enthought, Inc.