Logo Search packages:      
Sourcecode: mayavi version File versions  Download package

MayaVi Namespace Reference


Detailed Description

-1.4Base::DataVizManager

-1.4tools::imv

-1.4Sources::VtkXMLDataReader

-1.4Sources::VtkEnSightReader

-1.4Sources::VtkDataReader

-1.4Sources::VtkData

-1.4Sources::VRMLImporter

-1.4Sources::PLOT3DReader

-1.4Sources::mv3DSImporter

-1.4Modules::WarpVectorCutPlane

-1.4Modules::Volume

-1.4Modules::VelocityVector

-1.4Modules::VectorCutPlane

-1.4Modules::Text

-1.4Modules::TensorGlyphs

-1.4Modules::SurfaceMap

-1.4Modules::StructuredGridOutline

-1.4Modules::Streamlines

-1.4Modules::ScalarCutPlane

-1.4Modules::PolyData

-1.4Modules::Outline

-1.4Modules::Locator

-1.4Modules::Labels

-1.4Modules::IsoSurface

-1.4Modules::HedgeHog

-1.4Modules::GridPlane

-1.4Modules::Glyph

-1.4Modules::CustomGridPlane

-1.4Modules::ContourGridPlane

-1.4Modules::BandedSurfaceMap

-1.4Modules::Axes

-1.4Misc::RenderWindow

-1.4Misc::Picker

-1.4Misc::LutHandler

-1.4Misc::Lights

-1.4Main

-1.4ivtk

-1.4Filters::WarpVector

-1.4Filters::WarpScalar

-1.4Filters::UserDefined

-1.4Filters::Threshold

-1.4Filters::StructuredPointsProbe

-1.4Filters::PolyDataNormals

-1.4Filters::MaskPoints

-1.4Filters::ExtractVectorNorm

-1.4Filters::ExtractVectorComponents

-1.4Filters::ExtractUnstructuredGrid

-1.4Filters::ExtractTensorComponents

-1.4Filters::ExtractGrid

-1.4Filters::Delaunay3D

-1.4Filters::Delaunay2D

-1.4Filters::CutPlane

-1.4Filters::CellToPointData

-1.4Common

-1.4Base::Objects

-1.4Base::ModuleManager


This file defines the DataVizManager that controls a list of
ModuleManagers.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


This file defines the ModuleManager class that is responsible for
managing all the Modules and Filters for a particular data source.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


This module defines the basic classes used by MayaVi.  The debug
function enables a rudimentary debug support.  Using this one can in
theory fix bugs faster.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2003, Prabhu Ramachandran.


This module defines some useful classes and functions used by almost
all the code.  It also creates a few 'instance' variables that are
used for common access across all other files.

The debug function enables a rudimentary debug support.  Using this
one can in theory fix bugs faster.

Please note that this module *MUST* be imported before any other
mayavi modules.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


This class produces PointData given an input that contains CellData.
This is useful because many of VTK's algorithms work best with
PointData.  The filter basically wraps the vtkCellDataToPointData
class.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2002, Prabhu Ramachandran.


This filter takes a cut plane of any given input data set.  It
interpolates the attributes onto a plane.  The position and
orientation of the plane are configurable using a GUI.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2003, Prabhu Ramachandran.

This filter wraps around the vtkDelaunay2D filter and lets you do 2D
triangulation of a collection of points.  The key parameters are
Tolerance and the Alpha value.  Tolerance gives the criteria for
joining neighbouring data points and alpha is the threshold for the
circumference of a caluculated triangulated polygon.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2003, Prabhu Ramachandran.

This filter wraps around the vtkDelaunay3D filter and lets you do 3D
triangulation of a collection of points.  The key parameters are
Tolerance and the Alpha value.  Tolerance gives the criteria for
joining neighbouring data points and alpha is the threshold for the
circumference of a caluculated triangulated polygon.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2003, Prabhu Ramachandran.

Wraps vtkExtractGrid (structured grid), vtkExtractVOI
(imagedata/structured points) and vtkExtractRectilinearGrid
(rectilinear grids).  These filters enable one to select a portion of,
or subsample an input dataset.  Depending on the input data the
appropriate filter is used.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2003, Prabhu Ramachandran.

This wraps the vtkExtractTensorComponents filter and allows one to
select any of the nine components or the effective stress or the
determinant from an input tensor data set.  This will work for any
dataset.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


This wraps the vtkExtractUnstructuredGrid filter.  From the VTK docs:
vtkExtractUnstructuredGrid is a general-purpose filter to extract
geometry (and associated data) from an unstructured grid dataset. The
extraction process is controlled by specifying a range of point ids,
cell ids, or a bounding box (referred to as 'Extent').  Those cells
lying within these regions are sent to the output.  The user has the
choice of merging coincident points (Merging is on) or using the
original point set (Merging is off).

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


This wraps the vtkExtractVectorComponents filter and allows one to
select any of the three components of an input vector data
attribute.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


This wraps the vtkVectorNorm filter and produces an output scalar data
with the magnitude of the vector.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


This wraps the vtkMaskPoints filter.  The problem with this filter is
that its output is Polygonal data.  This means that if you add this
filter to a ModuleManager with visualizations apart from HedgeHog or
other velocity vector data you won't see anything!  If that happens
create another ModuleManager and show the other visualizations
there. Also, this means that this filter should be typically inserted
at the end of the list of filters.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


This wraps the vtkPolyDataNormals filter.  vtkPolyDataNormals is a
filter that computes point normals for a polygonal mesh.  This filter
tries its best to massage the input data to a suitable form.  Its
output is a vtkPolyData object.  Computing the normals is very useful
when one wants a smoother looking surface.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


A useful filter that can be used to probe any dataset using a
Structured Points dataset.  The filter also allows one to convert the
scalar data to an unsigned short array so that the scalars can be used
for volume visualization.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2003, Prabhu Ramachandran.


This wraps the vtkThreshold filter.  The problem with this filter is
that its output is an Unstructured Grid.  This means that if you add
this filter to a ModuleManager of a gridded dataset and you have a few
grid planes, then your grid planes won't show anymore.  If that
happens create another ModuleManager and show the grid planes there
acting on unfiltered data.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


This filter wraps around a user specified filter and lets one
experiment with VTK filters that are not yet part of MayaVi.  By
default if the class is instantiated it will ask the user for the VTK
class to wrap around.  If passed a valid VTK class name it will try to
use that particular class.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2003, Prabhu Ramachandran.


This wraps the vtkWarpScalar filter.  vtkWarpScalar is a filter that
modifies point coordinates by moving points along point normals by the
scalar amount times the scale factor.  Useful for creating carpet or
x-y-z plots.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


Warps the geometry using the vtkWarpVector filter.  vtkWarpVector is a
filter that modifies point coordinates by moving points along vector
times the scale factor.  Useful for showing flow profiles or
mechanical deformation.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.

ivtk - Interactive VTK.

A simple utility module that makes VTK easier to use from the Python
interpreter.  It requires that MayaVi be installed.  It provides the
following:

  (1) An easy to use VTK actor viewer that has menus to save the
  scene, change background, help browser, pipeline browser etc.

  (2) A simple class documentation search tool that lets you search
  for arbitrary strings in the VTK class documentation and lets you
  browse the VTK class documentation.

  (3) Easy GUI to configure VTK objects using the
  vtkPipeline.ConfigVtkObj module.

All of this makes using VTK from Python much easier and much more fun.

Example session:

  >>> import ivtk
  >>> from vtkpython import *
  >>> c = vtkConeSource()
  >>> m = vtkPolyDataMapper()
  >>> m.SetInput(c.GetOutput())
  >>> a = vtkActor()
  >>> a.SetMapper(m)
  >>> v = ivtk.create_viewer() # or ivtk.viewer()
  # this creates the easy to use render window that can be used from
  # the interpreter.  It has several useful menus.

  >>> v.AddActors(a)    # add actor(s) to viewer
  >>> v.config(c)       # pops up a GUI configuration for object.
  >>> v.doc(c)          # pops up class documentation for object.
  >>> v.help_browser()  # pops up a help browser where you can search!
  >>> v.RemoveActors(a) # remove actor(s) from viewer.

  Even without the viewer you can do the following:

  >>> import ivtk
  >>> d = ivtk.doc_browser()
  # pops up a standalone searcheable VTK class help browser.
  >>> from vtkpython import *
  >>> c = vtkConeSource()
  >>> ivtk.doc(c)            # pops up class documentation for c
  >>> ivtk.doc('vtkObject')  # class documentation for vtkObject.
  >>> ivtk.config(c)         # configure object with GUI.

Read the code for more details - most things are reasonably
documented.

License:

  This code is distributed under the conditions of the BSD license.
  See LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


This module defines the main application classes for MayaVi and the Tk
GUI for it.

Bugs:

  This file is *way* too big and complex.  Need to clean it up and
  possibly split it into smaller parts?

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2005, Prabhu Ramachandran.


A VTK light manipulation tool for Tkinter.  This is sufficiently
general that it can be used by non-MayaVi applications.  It basically
creates 8 different lights which can be configured using a GUI.  The
lights can be saved and reloaded as with any other MayaVi module.

This module was entirely written by Raymond Maple.  It was later
modified by Prabhu and made suitable for inclusion in MayaVi.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2002, Raymond C. Maple and Prabhu Ramachandran.


This file defines a class LutHandler that creates and manages a lookup
table and a scalar bar (legend) for it.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.

This module creates a 'Picker', that can interactively select a point
and/or a cell in the data.  It also can use a world point picker
(i.e. a generic point in space) and will probe for the data at that
point.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2002, Prabhu Ramachandran.


Defines a simple wrapper for the vtkRenderWindow.  This the class
which is responsible for all the actual rendering. It is also
responsible for saving the scene to a image.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2003, Prabhu Ramachandran.
 


This module creates and manages a set of three axes for your data.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


Displays a surface map with special contouring using the
vtkBandedPolyDataContourFilter.  This contour filter produces filled
contours of the same color between two contour lines rather than
either a continuous color distribution or just individual contour
lines.  It should work for any input dataset.  It is best used for 2d
surfaces.  Note that one can either specify a total number of contours
between the minimum and maximum values by entering a single integer or
specify the individual contours by specifying a Python list/tuple in
the GUI. 

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2003, Prabhu Ramachandran.


This module shows a grid plane of the given input structured,
rectilinear or structured points grid with the scalar data either as a
color map or as contour lines.  This works only for structured grid,
structured point and rectilinear grid data.  Note that one can either
specify a total number of contours between the minimum and maximum
values by entering a single integer or specify the individual contours
by specifying a Python list/tuple in the GUI.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2003, Prabhu Ramachandran.


This module shows a grid plane of the given input grid.  The plane can
be shown as a wireframe or coloured surface with or without scalar
visibility and contour lines.  The module basically wraps around the
vtk*GeometryFilters.  This module enables one to completely configure
the grid plane.  It works only for structured grid, structured point
and rectilinear grid datasets.  Note that one can either specify a
total number of contours between the minimum and maximum values by
entering a single integer or specify the individual contours by
specifying a Python list/tuple in the GUI.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


This module displays glyphs scaled and colored as per the input data.
This will work for any dataset and can be used for both scalar and
vector data.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2003, Prabhu Ramachandran.


This module shows a grid plane of the given input grid.  The plane can
be shown as a wireframe or coloured surface with or without scalar
visibility.  This works only for structured grid, structured point and
rectilinear grid data.  Useful for debugging and displaying your
created grid.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


This module shows the given vector data as a 'hedge hog' plot.  The
lines can be colored based on the input scalar data.  This class
should work with any dataset.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


This module shows an iso-surface of scalar data. This will work for
any dataset.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


Displays text labels of input data.  When instantiated, the class can
be given a module name (the same name as listed in the Modules GUI) or
an index of the module (starting from 0) in the current module
manager.  If this is not provided the module will ask the user to
choose a particular module or choose filtered data.  The module will
then generate text lables for the data in the chosen module and
display it.  The module provides many configuration options.  It also
lets one turn on and off the use of a vtkSelectVisiblePoints filter.
Using this filter will cause the module to only display visible
points.  Note that if the module that is being labeled has changed
significantly or is deleted this Labels module will have to be updated
by changing one of the settings (like the RandomModeOn check button)
to a different value and then back to the original one.
Alternatively, choose the module to be labeled again.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2003, Prabhu Ramachandran.


This module creates a 'Locator' axis, that can be used to mark a three
dimensional point in your data.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


Displays an Outline for any data input.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


Displays any input polydata, nothing fancy.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


This module plots scalar data on a cut plane either as a color map or
with contour lines.  This will work for any dataset.  Note that one
can either specify a total number of contours between the minimum and
maximum values by entering a single integer or specify the individual
contours by specifying a Python list/tuple in the GUI.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2003, Prabhu Ramachandran.


This module makes it possible to view streamlines, streamtubes, and
stream ribbons for any type of vector data.  Any number of point
sources can be added and deleted.  A fairly powerful UI is provided.
This module should work with any dataset.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


Displays an Outline for a structured grid.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


Displays a surface map of any data.  It should work for any dataset
but is best if used for 2d surfaces (polydata and unstructured
surfaces).  Note that one can either specify a total number of
contours between the minimum and maximum values by entering a single
integer or specify the individual contours by specifying a Python
list/tuple in the GUI.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


This module displays glyphs scaled and colored as per the tensor data.
This will work for any dataset.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


Displays simple text on the screen.  The text properties and position
are configurable.  The text can also be multi-line if newlines are
embedded in it.
    
This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2003, Prabhu Ramachandran.


This module displays cone glyphs scaled and colored as per the
vector or scalar data on a cut plane.  This will work for any
dataset.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


This module displays cone or arrow glyphs scaled and colored as per
the vector data.  This will work for any dataset.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.

This Volume module allows one to view a structured points dataset with
either unsigned char or short data as a volume.  The module also
provides a powerful GUI to edit the Color Transfer Function (CTF).
You can drag the mouse with different buttons to change the colors.
The following are the mouse buttons and key combinations that can be
used to edit the CTF -- red curve: Button-1, green curve:
Button-2/Control-Button-1, blue curve: Button-3/Control-Button-2,
alpha/opacity: Shift-Button-1.

It is possible to use either the vtkVolumeRayCastMapper or the
vtkVolumeTextureMapper2D.  It is also possible to choose among various
ray cast functions.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2003, Prabhu Ramachandran.


This module takes a cut plane and warps it using a vtkWarpVector as
per the vector times a scale factor.  This will work for any dataset.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


This file defines a simple class that handles a vtk3DSImporter.  The
class handles the deletion of the actors generated by the
vtk3DSImporter.  The vtk3DSImporter class imports a 3D Studio scene
into VTK.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


This file provides access to a vtkPLOT3DReader.  Currently the
vtkPLOT3DReader only suports binary structured grid files.  Vector and
scalar data are supported.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


This file defines a simple class that handles a vtkVRMLImporter.
The class handles the deletion of the actors generated by the
vtkVRMLImporter.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2002, Prabhu Ramachandran.


This Source object allows one to create a vtkData object
vtkStructuredGrid, vtkStructuredPoints, vtkRectilinearGrid,
vtkPolyData, vtkUnstructuredGrid or a corresponding reader object and
use MayaVi to visualize it.  This makes it easy to create data on the
fly and then use MayaVi for visualization.  The class handles
save_visualization requests intelligently by dumping the used data to
a file that can be used subsequently.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2003, Prabhu Ramachandran.


This file provides a highly general VTK data file reader.  Currently
this class handles the various types of VTK data as per the old
(non-XML) format.  Unstructured grids, structured grids, rectilinear
grids, structured points and polydata are supported.  Scalar, vector
and tensor data are supported.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2001-2003, Prabhu Ramachandran.

This file provides a wrapper for VTK's EnSight reader.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2003, Prabhu Ramachandran.

This file provides a reader for VTK's new XML data format.  It should
support any of the standard VTK XML data files.

This code is distributed under the conditions of the BSD license.  See
LICENSE.txt for details.

Copyright (c) 2003, Prabhu Ramachandran.

This creates matlab like one liners that make it easy to visualize
data from the Python interpreter.

Right now this provides the following useful functions.

 1. surf(x, y, f) -- samples f along x, y and plots a surface.

 2. view(arr) -- Views array as structured points.

 3. viewi(arr) -- Views array as an image.

 4. sampler(xa, ya, func) -- Samples func along array of ordered
 points (xa, ya).

Author:
  Prabhu Ramachandran <prabhu_r@users.sf.net>

License:
  BSD --  http://www.opensource.org/licenses/bsd-license.html


Generated by  Doxygen 1.6.0   Back to index