API Reference for Enthought Tool Suite 3.0.1

>>> from enthought.tvtk.tools import mlab
>>> f = mlab.figure()
>>> mlab.test_surf(f) # Create a spherical harmonic.
>>> f.pop() # Remove it.
>>> mlab.test_molecule(f) # Show a caffeine molecule.
>>> f.renwin.reset_zoom() # Scale the view.
>>> f.pop() # Remove this.
>>> mlab.test_lines(f) # Show pretty lines.
>>> f.clear() # Remove all the stuff on screen.

Variables

• USE_LOD_ACTOR

  Set this to False to not use LOD Actors.

  USE_LOD_ACTOR = True
  
  

Classes

• Arrows
• Cones
• Contour3
• Cubes
• Cylinders
• FancyMesh
• FancyTriMesh - Shows a mesh of triangles and draws the edges as tubes and points as balls.
• Figure - A Figure manages varuous MLabBase objects
• Glyphs
• ImShow - Allows one to view a 2D numpy array as an image
• Line3
• LUTBase
• Mesh
• MLabBase
• Outline
• Points
• Spheres
• Surf
• SurfRegular
• SurfRegularC
• Title
• TriMesh

Function summary

• figure(outline = True, browser = True)
• main()
• make_surf_actor(x, y, z, warp = 1, scale = [ 1.0, 1.0, 1.0 ], make_actor = True, *args, **kwargs)
• make_triangle_polydata(triangles, points, scalars = None)
• make_triangles_points(x, y, z, scalars = None)
• sampler(xa, ya, func, *args, **kwargs)
• squeeze(a)
• test_arrows(fig)
• test_imshow(fig)
• test_lines(fig)
• test_mesh(fig)
• test_mesh_sphere(fig)
• test_molecule(fig)
• test_simple_surf(fig)
• test_surf(fig)
• test_surf_regular(fig, contour = 1)
• test_trimesh(fig)

Functions

• figure(outline = True, browser = True)

  Simple helper function that returns a usable figure.

  Parameters

  • outline : bool (default: True)

    If True, create an outline bounding box along with an axes marker for the scene.

  • browser : bool (default, True)

    If True, creates an IVTK scene with an embedded PipelineBrowser. If False, does not create it.

• main()
• make_surf_actor(x, y, z, warp = 1, scale = [ 1.0, 1.0, 1.0 ], make_actor = True, *args, **kwargs)

  Creates a surface given regularly spaced values of x, y and the corresponding z as arrays. Also works if z is a function. Currently works only for regular data - can be enhanced later.

  Parameters

  x -- Array of x points (regularly spaced)

  y -- Array if y points (regularly spaced)

  z -- A 2D array for the x and y points with x varying fastest and y next. Also will work if z is a callable which supports x and y arrays as the arguments.

  warp -- If true, warp the data to show a 3D surface (default = 1).

  scale -- Scale the x, y and z axis as per passed values. Defaults to [1.0, 1.0, 1.0].

  make_actor -- also create actors suitably (default True)

  args -- additional positional arguments for func() (default is empty)

  kwargs -- a dict of additional keyword arguments for func() (default is empty)

• make_triangle_polydata(triangles, points, scalars = None)
• make_triangles_points(x, y, z, scalars = None)

  Given x, y, and z co-ordinates made using numpy.mgrid and optional scalars. This function returns triangles and points corresponding to a mesh formed by them.

  Parameters

  • x : array

    A list of x coordinate values formed using numpy.mgrid.

  • y : array

    A list of y coordinate values formed using numpy.mgrid.

  • z : array

    A list of z coordinate values formed using numpy.mgrid.

  • scalars : array (optional)

    Scalars to associate with the points.

• sampler(xa, ya, func, *args, **kwargs)

  Samples a function at an array of ordered points (with equal spacing) and returns an array of scalars as per VTK's requirements for a structured points data set, i.e. x varying fastest and y varying next.

  Input Arguments:

  xa -- Array of x points.

  ya -- Array if y points.

  func -- function of x, and y to sample.

  args -- additional positional arguments for func() (default is empty)

  kwargs -- a dict of additional keyword arguments for func() (default is empty)

• squeeze(a)

  Returns a with any ones from the shape of a removed

• test_arrows(fig)
• test_imshow(fig)

  Show a large random array.

• test_lines(fig)

  Generates a pretty set of lines.

• test_mesh(fig)

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

• test_mesh_sphere(fig)

  Create a simple sphere and test the mesh.

• test_molecule(fig)

  Generates and shows a Caffeine molecule.

• test_simple_surf(fig)

  Test Surf with a simple collection of points.

• test_surf(fig)

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

• test_surf_regular(fig, contour = 1)

  Test Surf on regularly spaced co-ordinates like MayaVi.

• test_trimesh(fig)

  Test for simple triangle mesh.

Imported Names

© Copyright 2002-2008 Enthought, Inc.