/[escript]/trunk/doc/user/pyvisi.tex
ViewVC logotype

Diff of /trunk/doc/user/pyvisi.tex

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 961 by jongui, Tue Feb 13 01:58:48 2007 UTC revision 999 by gross, Tue Feb 27 08:12:37 2007 UTC
# Line 1  Line 1 
1  \chapter{The module \pyvisi}  \chapter{The module \pyvisi}
2  \label{PYVISI CHAP}  \label{PYVISI CHAP}
3    
4  \declaremodule{extension}{pyvisi}  \section{Introduction}
 \modulesynopsis{Python visualization interface}  
5    
6  \pyvisi provides an easy to use interface to the \VTK visualization  \pyvisi provides an easy to use interface to the \VTK visualization
7  tool. \pyvisi provides the following modules:  tool.  
8    
9  \begin{itemize}  \section{Rendering}
10  \item \Scene: Displays a scene in which objects are to be rendered on.  same word on rendering, off-line, on-line, how to rotate, zoom, close the window, ...
11  \item \DataCollector: Deals with the source of data for visualization.  
12  \item \Map: Displays a scalar field using a domain surface.  \section{How to Make a Movie}
13  \item \MapOnPlaneCut: Displays a scalar field using a domain surface cut on a plane.  
14  \item \MapOnPlaneClip: Displays a scalar field using a domain surface clipped  \section{\pyvisi Classes}
15    \declaremodule{extension}{esys.pyvisi}
16    \modulesynopsis{A simple Python visualization interface for \VTK}
17    
18    In this section we give a brief overview over the important classes and their methods. Please
19    check the \ReferenceGuide on details.
20    %=====================================================================================
21    \subsection{Scene Classes}
22    \begin{classdesc}{Scene}{}
23    Displays a scene in which objects are to be rendered on.
24    \end{classdesc}
25    
26    \begin{classdesc}{Camera}{}
27     Controls the camera manipulation.
28    \end{classdesc}
29    
30    \begin{classdesc}{Light}{}
31     Controls the light manipulation.
32    \end{classdesc}
33    
34    %============================================================================================================
35    \subsection{Input Classes}
36    
37    \begin{classdesc}{Image}{}
38     Displays an image.
39    \end{classdesc}
40    
41    \begin{classdesc}{Text}{}
42     Shows some 2D text.
43    \end{classdesc}
44    
45    \begin{classdesc}{DataCollector}{}
46    Deals with the source of data for visualization.
47    \end{classdesc}
48    
49    %============================================================================================================
50    \subsection{Data Visualization}
51    \begin{classdesc}{Map}{}
52     Displays a scalar field using a domain surface.
53    \end{classdesc}
54    
55    \begin{classdesc}{MapOnPlaneCut}{}
56     Displays a scalar field using a domain surface cut on a plane.
57    \end{classdesc}
58    
59    \begin{classdesc}{MapOnPlaneClip}{}
60     Displays a scalar field using a domain surface clipped
61          on a plane.          on a plane.
62  \item \MapOnScalarClip: Displays a scalar field using a domain surface clipped  \end{classdesc}
63    
64    \begin{classdesc}{MapOnScalarClip}{}
65     Displays a scalar field using a domain surface clipped
66          using a scalar value.          using a scalar value.
67  \item \Velocity: Displays a vector field using arrows.  \end{classdesc}
68  \item \VelocityOnPlaneCut: Displays a vector field using arrows cut on a plane.  
69  \item \VelocityOnPlaneClip: Displays a vector field using arrows clipped on a  \begin{classdesc}{Velocity}{}
70     Displays a vector field using arrows.
71    \end{classdesc}
72    
73    \begin{classdesc}{VelocityOnPlaneCut}{}
74     Displays a vector field using arrows cut on a plane.
75    \end{classdesc}
76    
77    \begin{classdesc}{VelocityOnPlaneClip}{}
78     Displays a vector field using arrows clipped on a
79          plane.          plane.
80  \item \Ellipsoid: Displays a tensor field using spheres.  \end{classdesc}
81  \item \EllipsoidOnPlaneCut: Displays a tensor field using spheres cut on a  
82    \begin{classdesc}{Ellipsoid}{}
83     Displays a tensor field using spheres.
84    \end{classdesc}
85    
86    \begin{classdesc}{EllipsoidOnPlaneCut}{}
87     Displays a tensor field using spheres cut on a
88          plane.          plane.
89  \item \EllipsoidOnPlaneClip: Displays a tensor field using spheres clipped  \end{classdesc}
90    
91    \begin{classdesc}{EllipsoidOnPlaneClip}{}
92     Displays a tensor field using spheres clipped
93          on a plane.          on a plane.
94    \end{classdesc}
95    
96                    
97  \item \Contour: Shows a scalar field by contour surfaces.  \begin{classdesc}{Contour}{}
98  \item \ContourOnPlane: Shows a scalar field by contour surfaces on   Shows a scalar field by contour surfaces.
99    \end{classdesc}
100    
101    \begin{classdesc}{ContourOnPlane}{}
102     Shows a scalar field by contour surfaces on
103  a given plane.  a given plane.
104  \item \ContourOnClip: Shows a scalar field by contour surfaces on  \end{classdesc}
105    
106    \begin{classdesc}{ContourOnClip}{}
107     Shows a scalar field by contour surfaces on
108  a given clip.  a given clip.
109    \end{classdesc}
110    
111  \item \Image: Displays an image.  \begin{classdesc}{IsoSurface}{}
112  \item \Text: Shows some 2D text.   Shows a scalar field for a given value by
 \item \Camera: Controls the camera manipulation.  
 \item \Light: Controls the light manipulation.  
 \item \IsoSurface: Shows a scalar field for a given value by  
113  an isosurface.  an isosurface.
114  \item \IsoSurfaceOnPlane: Shows a scalar field for a given value by  \end{classdesc}
115    
116    \begin{classdesc}{IsoSurfaceOnPlane}{}
117     Shows a scalar field for a given value by
118  an isosurfaceon a given plane.  an isosurfaceon a given plane.
119  \item \IsoSurfaceOnClip: Shows a scalar field for a given vlaue by  \end{classdesc}
120    
121    \begin{classdesc}{IsoSurfaceOnClip}{}
122     Shows a scalar field for a given vlaue by
123  an isosurface on a given clip.  an isosurface on a given clip.
124  \item \StreamLines: Shows the path of particles in a vector field.  \end{classdesc}
125  \item \Carpet: Shows a scalar field as plane deformated along  
126    \begin{classdesc}{StreamLines}{}
127     Shows the path of particles in a vector field.
128    \end{classdesc}
129    
130    \begin{classdesc}{Carpet}{}
131     Shows a scalar field as plane deformated along
132  the plane normal.  the plane normal.
133  \item \Position: Defines the x,y and z coordinates rendered object.  \end{classdesc}
134  \item \Transform: Defines the orientation of rendered object.  
135  \item \Style: Defines the style of text.  \section{Geometry}
136  \item \BlueToRed: Defines a map spectrum from blue to red.  \begin{classdesc}{Position}{}
137  \item \RedToBlue: Defines a map spectrum from red to blue.   Defines the x,y and z coordinates rendered object.
138  \item \Plane: Defines the cutting/clipping of rendered objects.  \end{classdesc}
139  \end{itemize}  
140    \begin{classdesc}{Transform}{}
141    Defines the orientation of rendered object.
142    \end{classdesc}
143    
144    \begin{classdesc}{Plane}{}
145    Defines the cutting/clipping of rendered objects.
146    \end{classdesc}
147    
148    
149    \subsection{Beautification}
150    \begin{classdesc}{Style}{}
151    Defines the style of text.
152    \end{classdesc}
153    
154    \begin{classdesc}{BlueToRed}{}
155     Defines a map spectrum from blue to red.
156    \end{classdesc}
157    
158    \begin{classdesc}{RedToBlue}{}
159     Defines a map spectrum from red to blue.
160    \end{classdesc}
161    
162    
Legend:
Removed from v.961  
changed lines
  Added in v.999
  ViewVC Help
Powered by ViewVC 1.1.26