Skip to content

Commit

Permalink
Updated VTK documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rexissimus committed Apr 2, 2015
1 parent fff3ad7 commit 4006baf
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions doc/usersguide/example_guide.rst
Expand Up @@ -9,6 +9,13 @@ Module Descriptions and Examples
VisTrails VTK modules
=====================

Most VTK modules in VisTrails represents VTK classes. Inputs and outputs are based on class methods. A warning, in VTK it is sometimes important to call input methods in the correct order. This order is not preserved in the parameter list in VisTrails, but will still be used during execution. Method names may differ in VisTrails:

* Most Set/Get prefixes have been removed.
* SetXToY-style methods are reduced to single SetX names with a list selection.
* Methods without parameters are replaced by booleans (that need to be set to True).
* VTK6's SetInputData-style names are used even for VTK5.

Although most VTK modules in VisTrails would be familiar to vtk users, or at least in the vtk documentation, there are a few modules that VisTrails introduces. They are used as follows:

* **PythonSource** - Although a PythonSource is in the Basic Modules list rather than VTK, it is mentioned here for convenience. This module allows you write python statements to be executed as part of the workflow. See Section :ref:`sec-pythonsource` for more information.
Expand All @@ -17,8 +24,6 @@ Although most VTK modules in VisTrails would be familiar to vtk users, or at lea

* **VTKRenderOffscreen** - Takes the output of a vtkRenderer and produces a PNG image of size width X height. Default values of width and height are 512. The output can then be written to a file using a FileSink.

* **VTKViewCell** - This is similar to the VTKCell except that you pass it a vtkRenderView.

* **vtkInspectors: vtkDataArrayInspector, vtkDataSetAttributesInspector, vtkDataSetInspector, vtkPolyDataInspector** - These inspectors were created to allow easy access to information that is not otherwise exposed by module ports, but would be accessible through vtk objects. This information includes: normals, scalars, tensors, and vectors as well as statistical information such as bounds, center, length, max, min. Looking at the output ports of these inspectors gives an idea of the information available.

.. index:: vtkInteractionHandler
Expand Down Expand Up @@ -47,6 +52,8 @@ Modules and Corresponding Examples

Here we provide a list of the .vt files in the examples directory that use the following modules:

Warning, this list is out-of-date and some examples may have been removed.

.. index::
pair: modules; list of examples

Expand Down

0 comments on commit 4006baf

Please sign in to comment.