/[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

trunk/doc/user/pyvisi.tex revision 1210 by jongui, Tue Jul 3 05:47:34 2007 UTC temp_trunk_copy/doc/user/pyvisi.tex revision 1384 by phornby, Fri Jan 11 02:29:38 2008 UTC
# Line 1  Line 1 
1  \chapter{The module \pyvisi}  \chapter{The Module \pyvisi}
2  \label{PYVISI CHAP}  \label{PYVISI CHAP}
3  \declaremodule{extension}{esys.pyvisi}  \declaremodule{extension}{esys.pyvisi}
4  \modulesynopsis{Python Visualization Interface}  \modulesynopsis{Python Visualization Interface}
# Line 15  with interaction capability (i.e. zoom a Line 15  with interaction capability (i.e. zoom a
15  rendered off-screen (no pop-up window) and (3) Display - object is rendered  rendered off-screen (no pop-up window) and (3) Display - object is rendered
16  on-screen but with no interaction capability (on-the-fly  on-screen but with no interaction capability (on-the-fly
17  animation). All three approaches have the option to save the rendered object  animation). All three approaches have the option to save the rendered object
18  as an image (i.e. jpg).  as an image (i.e. jpg) and subsequently converting a series of images into a
19    movie (.mpg).
20    
21  The following outlines the general steps to use Pyvisi:  The following outlines the general steps to use Pyvisi:
22    
# Line 25  rendered on. Line 26  rendered on.
26  \item Create a data input instance (i.e. \DataCollector or \ImageReader) -  \item Create a data input instance (i.e. \DataCollector or \ImageReader) -
27  reads and loads the source data for visualization.  reads and loads the source data for visualization.
28  \item Create a data visualization instance (i.e. \Map, \Velocity, \Ellipsoid,  \item Create a data visualization instance (i.e. \Map, \Velocity, \Ellipsoid,
29  \Contour, \Carpet, \StreamLine or \Image) -  proccesses and manipulates  \Contour, \Carpet, \StreamLine or \Image) -  processes and manipulates
30  the source data.  the source data.
31  \item Create a \Camera or \Light instance - controls the viewing angle and  \item Create a \Camera or \Light instance - controls the viewing angle and
32  lighting effects.  lighting effects.
33  \item Render the object - using either the Online, Offline or Display approach.  \item Render the object - using either the Online, Offline or Display approach.
34    \item Generate movie - converts a series of images into a movie.
35  \end{enumerate}  \end{enumerate}
36  \begin{center}  \begin{center}
37  \begin{math}  \begin{math}
38  scene \rightarrow data \; input \rightarrow data \; visualization \rightarrow  scene \rightarrow data \; input \rightarrow data \; visualization \rightarrow
39  camera \, / \, light \rightarrow render  camera \, / \, light \rightarrow render \rightarrow movie
40  \end{math}  \end{math}
41  \end{center}  \end{center}
42    
# Line 244  inaccurate object may be rendered from c Line 246  inaccurate object may be rendered from c
246  viewport = Viewport.SOUTH_WEST, lut = Lut.COLOR, cell_to_point = False,  viewport = Viewport.SOUTH_WEST, lut = Lut.COLOR, cell_to_point = False,
247  outline = True}  outline = True}
248  Class that shows a scalar field on a domain surface. The domain surface  Class that shows a scalar field on a domain surface. The domain surface
249  can either be colored or grey-scaled, depending on the lookup table used.  can either be color or gray-scale, depending on the lookup table used.
250  \end{classdesc}  \end{classdesc}
251    
252  The following are some of the methods available:\\  The following are some of the methods available:\\
# Line 345  field clipped using a scalar value. Line 347  field clipped using a scalar value.
347  The following are some of the methods available:\\  The following are some of the methods available:\\
348  Methods from \ActorThreeD, \Clipper and \DataSetMapper.  Methods from \ActorThreeD, \Clipper and \DataSetMapper.
349    
350    \subsubsection{\MapOnScalarClipWithRotation class}
351    
352    \begin{classdesc}{MapOnScalarClipWithRotation}{scene, data_collector,
353    viewport = Viewport.SOUTH_WEST, lut = Lut.COLOR, cell_to_point = False}
354    This class works in a similar way to \Map except that it
355    shows a 2D scalar field clipped using a scalar value and subsequently
356    rotated around the z-axis to create a  3D looking effect. This class should
357    only be used with 2D data sets and NOT 3D.
358    \end{classdesc}
359    
360    The following are some of the methods available:\\
361    Methods from \ActorThreeD, \Clipper, \Rotation and \DataSetMapper.
362    
363  \subsubsection{\Velocity class}  \subsubsection{\Velocity class}
364    
365  \begin{classdesc}{Velocity}{scene, data_collector, arrow = Arrow.TWO_D,  \begin{classdesc}{Velocity}{scene, data_collector, arrow = Arrow.TWO_D,
366  color_mode = ColorMode.VECTOR, viewport = Viewport.SOUTH_WEST,    color_mode = ColorMode.VECTOR, viewport = Viewport.SOUTH_WEST,  
367  lut = Lut.COLOR, cell_to_point = False, outline = True}  lut = Lut.COLOR, cell_to_point = False, outline = True}
368  Class that shows a vector field using arrows. The arrows can either be  Class that shows a vector field using arrows. The arrows can either be
369  colored or grey-scaled, depending on the lookup table used. If the arrows  color or gray-scale, depending on the lookup table used. If the arrows
370  are colored, there are two possible coloring modes, either using vector data or  are colored, there are two possible coloring modes, either using vector data or
371  scalar data. Similarly, there are two possible types of arrows, either  scalar data. Similarly, there are two possible types of arrows, either
372  using two-dimensional or three-dimensional.  using two-dimensional or three-dimensional.
# Line 444  Methods from \ActorThreeD, \GlyphThreeD, Line 459  Methods from \ActorThreeD, \GlyphThreeD,
459  viewport = Viewport = SOUTH_WEST, lut = Lut.COLOR, cell_to_point = False,  viewport = Viewport = SOUTH_WEST, lut = Lut.COLOR, cell_to_point = False,
460  outline = True}  outline = True}
461  Class that shows a tensor field using ellipsoids. The ellipsoids can either be  Class that shows a tensor field using ellipsoids. The ellipsoids can either be
462  colored or grey-scaled, depending on the lookup table used.  color or gray-scale, depending on the lookup table used.
463  \end{classdesc}  \end{classdesc}
464    
465  The following are some of the methods available:\\  The following are some of the methods available:\\
# Line 532  s.render(image_name = os.path.join(PYVIS Line 547  s.render(image_name = os.path.join(PYVIS
547  viewport = Viewport.SOUTH_WEST, lut = Lut.COLOR, cell_to_point = False,  viewport = Viewport.SOUTH_WEST, lut = Lut.COLOR, cell_to_point = False,
548  outline = True}  outline = True}
549  Class that shows a scalar field using contour surfaces. The contour surfaces can  Class that shows a scalar field using contour surfaces. The contour surfaces can
550  either be colored or grey-scaled, depending on the lookup table used. This  either be color or gray-scale, depending on the lookup table used. This
551  class can also be used to generate iso surfaces.  class can also be used to generate iso surfaces.
552  \end{classdesc}  \end{classdesc}
553    
# Line 614  Methods from \ActorThreeD, \ContourModul Line 629  Methods from \ActorThreeD, \ContourModul
629  viewport = Viewport.SOUTH_WEST, color_mode = ColorMode.VECTOR, lut = Lut.COLOR,  viewport = Viewport.SOUTH_WEST, color_mode = ColorMode.VECTOR, lut = Lut.COLOR,
630  cell_to_point = False, outline = True}  cell_to_point = False, outline = True}
631  Class that shows the direction of particles of a vector field using streamlines.  Class that shows the direction of particles of a vector field using streamlines.
632  The streamlines can either be colored or grey-scaled, depending on the lookup  The streamlines can either be color or gray-scale, depending on the lookup
633  table used. If the streamlines are colored, there are two possible coloring  table used. If the streamlines are colored, there are two possible coloring
634  modes, either using vector data or scalar data.  modes, either using vector data or scalar data.
635  \end{classdesc}  \end{classdesc}
# Line 676  s.render(image_name = os.path.join(PYVIS Line 691  s.render(image_name = os.path.join(PYVIS
691  viewport = Viewport.Viewport.SOUTH_WEST, warp_mode = WarpMode.SCALAR,  viewport = Viewport.Viewport.SOUTH_WEST, warp_mode = WarpMode.SCALAR,
692  lut = Lut.COLOR, cell_to_point = False, outline = True}  lut = Lut.COLOR, cell_to_point = False, outline = True}
693  This class works in a similar way to \MapOnPlaneCut, except that it shows a  This class works in a similar way to \MapOnPlaneCut, except that it shows a
694  scalar field cut on a plane and deformated (warp) along the normal. The  scalar field cut on a plane and deformed (warped) along the normal. The
695  plane can either be colored or grey-scaled, depending on the lookup table used.  plane can either be color or gray-scale, depending on the lookup table used.
696  Similarly, the plane can be deformated either using scalar data or vector data.  Similarly, the plane can be deformed either using scalar data or vector data.
697  \end{classdesc}  \end{classdesc}
698    
699  The following are some of the methods available:\\  The following are some of the methods available:\\
# Line 735  s.render(image_name = os.path.join(PYVIS Line 750  s.render(image_name = os.path.join(PYVIS
750  \begin{classdesc}{Legend}{scene, data_collector,  \begin{classdesc}{Legend}{scene, data_collector,
751  viewport = Viewport.SOUTH_WEST, lut = Lut.COLOR, legend = LegendType.SCALAR}  viewport = Viewport.SOUTH_WEST, lut = Lut.COLOR, legend = LegendType.SCALAR}
752  Class that shows a scalar field on a domain surface. The domain surface  Class that shows a scalar field on a domain surface. The domain surface
753  can either be colored or grey-scaled, depending on the lookup table used  can either be color or gray-scale, depending on the lookup table used
754  \end{classdesc}  \end{classdesc}
755    
756  The following are some of the methods available:\\  The following are some of the methods available:\\
# Line 833  Methods from \ImageReslice and \ActorTwo Line 848  Methods from \ImageReslice and \ActorTwo
848    
849  \begin{classdesc}{Movie}{parameter_file = "make_movie"}  \begin{classdesc}{Movie}{parameter_file = "make_movie"}
850  Class that creates a file called 'make_movie' by default (if a parameter  Class that creates a file called 'make_movie' by default (if a parameter
851  file name is not speficied) which contains a list of parameters required  file name is not specified) which contains a list of parameters required
852  by the 'ppmtompeg' command to generate a movie from a series of images.  by the 'ppmtompeg' command to generate a movie from a series of images.
853  \end{classdesc}  \end{classdesc}
854    
# Line 944  inherited by the input (see Section \ref Line 959  inherited by the input (see Section \ref
959  visualization classes (see Section \ref{DATAVIS SEC}).  visualization classes (see Section \ref{DATAVIS SEC}).
960    
961  \subsubsection{\ActorThreeD class}  \subsubsection{\ActorThreeD class}
962    Class that defines a 3D actor. \\
963    
964  The following are some of the methods available:  The following are some of the methods available:
965    
# Line 960  Set the representation of the 3D actor t Line 976  Set the representation of the 3D actor t
976  \end{methoddesc}  \end{methoddesc}
977    
978  \subsubsection{\ActorTwoD class}  \subsubsection{\ActorTwoD class}
979    Class that defines a 2D actor. \\
980    
981  The following are some of the methods available:  The following are some of the methods available:
982    
# Line 969  corner of the window / viewport. Line 986  corner of the window / viewport.
986  \end{methoddesc}  \end{methoddesc}
987    
988  \subsubsection{\Clipper class}  \subsubsection{\Clipper class}
989    Class that defines a clipper. \\
990    
991  The following are some of the methods available:  The following are some of the methods available:
992    
# Line 985  Set the scalar clip value (instead of us Line 1003  Set the scalar clip value (instead of us
1003  \end{methoddesc}  \end{methoddesc}
1004    
1005  \subsubsection{\ContourModule class}  \subsubsection{\ContourModule class}
1006    Class that defines the contour module. \\
1007    
1008  The following are some of the methods available:  The following are some of the methods available:
1009    
# Line 996  must be equal. Line 1015  must be equal.
1015  \end{methoddesc}  \end{methoddesc}
1016    
1017  \subsubsection{\GlyphThreeD class}  \subsubsection{\GlyphThreeD class}
1018    Class that defines 3D glyphs. \\
1019    
1020  The following are some of the methods available:  The following are some of the methods available:
1021    
# Line 1012  Set the 3D glyph scale factor. Line 1032  Set the 3D glyph scale factor.
1032  \end{methoddesc}  \end{methoddesc}
1033    
1034  \subsubsection{\TensorGlyph class}  \subsubsection{\TensorGlyph class}
1035    Class that defines tensor glyphs. \\
1036    
1037  The following are some of the methods available:  The following are some of the methods available:
1038    
# Line 1024  Set the maximum allowable scale factor f Line 1045  Set the maximum allowable scale factor f
1045  \end{methoddesc}  \end{methoddesc}
1046    
1047  \subsubsection{\PlaneSource class}  \subsubsection{\PlaneSource class}
1048    Class that defines a plane source.  A plane source is defined by an origin
1049    and two other points, which form the axes (X and Y). \\
1050    
1051  The following are some of the methods available:  The following are some of the methods available:
1052    
# Line 1036  Set the second point from the origin of Line 1059  Set the second point from the origin of
1059  \end{methoddesc}  \end{methoddesc}
1060    
1061  \subsubsection{\PointSource class}  \subsubsection{\PointSource class}
1062    Class that defines the source (location) to generate points. The points are
1063    generated within the radius of a sphere. \\
1064    
1065  The following are some of the methods available:  The following are some of the methods available:
1066    
# Line 1053  number of points, the more streamlines a Line 1078  number of points, the more streamlines a
1078  \end{methoddesc}  \end{methoddesc}
1079    
1080  \subsubsection{\Sphere class}  \subsubsection{\Sphere class}
1081    Class that defines a sphere. \\
1082    
1083  The following are some of the methods available:  The following are some of the methods available:
1084    
# Line 1065  Set the phi resolution of the sphere. Line 1091  Set the phi resolution of the sphere.
1091  \end{methoddesc}  \end{methoddesc}
1092    
1093  \subsubsection{\StreamLineModule class}  \subsubsection{\StreamLineModule class}
1094    Class that defines the streamline module. \\
1095    
1096  The following are some of the methods available:  The following are some of the methods available:
1097    
# Line 1078  goes) and backward (where the streamline Line 1105  goes) and backward (where the streamline
1105  \end{methoddesc}  \end{methoddesc}
1106    
1107  \subsubsection{\Transform class}  \subsubsection{\Transform class}
1108    Class that defines the orientation of planes. \\
1109    
1110  The following are some of the methods available:  The following are some of the methods available:
1111    
# Line 1110  Set the plane orthogonal to the y-axis. Line 1138  Set the plane orthogonal to the y-axis.
1138  \end{methoddesc}  \end{methoddesc}
1139    
1140  \subsubsection{\Tube class}  \subsubsection{\Tube class}
1141    Class that defines the tube wrapped around the streamlines. \\
1142    
1143  The following are some of the methods available:  The following are some of the methods available:
1144    
# Line 1126  Set the radius of the tube to vary by sc Line 1155  Set the radius of the tube to vary by sc
1155  \end{methoddesc}  \end{methoddesc}
1156    
1157  \subsubsection{\Warp class}  \subsubsection{\Warp class}
1158    Class that defines the deformation of a scalar field. \\
1159    
1160  The following are some of the methods available:  The following are some of the methods available:
1161    
# Line 1134  Set the displacement scale factor. Line 1164  Set the displacement scale factor.
1164  \end{methoddesc}  \end{methoddesc}
1165    
1166  \subsubsection{\MaskPoints class}  \subsubsection{\MaskPoints class}
1167    Class that defines the masking of points
1168    every n'th point.  This is useful to prevent the rendered object
1169    from being cluttered with arrows or ellipsoids. \\
1170    
1171  The following are some of the methods available:  The following are some of the methods available:
1172    
# Line 1145  Mask every n'th point. Line 1178  Mask every n'th point.
1178  Enables the randomization of the points selected for masking.  Enables the randomization of the points selected for masking.
1179  \end{methoddesc}  \end{methoddesc}
1180    
   
1181  \subsubsection{\ScalarBar class}  \subsubsection{\ScalarBar class}
1182    Class that defines a scalar bar. \\
1183    
1184  The following are some of the methods available:  The following are some of the methods available:
1185    
# Line 1183  Set the color of the scalar bar's title. Line 1216  Set the color of the scalar bar's title.
1216  \end{methoddesc}  \end{methoddesc}
1217    
1218  \subsubsection{\ImageReslice class}  \subsubsection{\ImageReslice class}
1219    Class that defines an image reslice used to resize static
1220    (no interaction capability) images (i.e. logo). \\
1221    
1222  The following are some of the methods available:  The following are some of the methods available:
1223    
# Line 1192  displays the image in its original size Line 1227  displays the image in its original size
1227  \end{methoddesc}  \end{methoddesc}
1228    
1229  \subsubsection{\DataSetMapper class}  \subsubsection{\DataSetMapper class}
1230    Class that defines a data set mapper. \\
1231    
1232  The following are some of the methods available:  The following are some of the methods available:
1233    
1234  \begin{methoddesc}[DataSetMapper]{setScalarRange}{lower_range, upper_range}  \begin{methoddesc}[DataSetMapper]{setScalarRange}{lower_range, upper_range}
1235  Set the minimum and maximium scalar range for the data set mapper. This  Set the minimum and maximum scalar range for the data set mapper. This
1236  method is called when the range has been specified by the user.  method is called when the range has been specified by the user.
1237  Therefore, the scalar range read from the source will be ignored.  Therefore, the scalar range read from the source will be ignored.
1238  \end{methoddesc}  \end{methoddesc}
1239    
1240  \subsubsection{\CubeSource class}  \subsubsection{\CubeSource class}
1241    Class that defines a cube source. The center of the cube source defines
1242    the point from which the cube is to be generated and the X, Y
1243    and Z lengths define the length of the cube from the center point. If
1244    X length is 3, then the X length to the left and right of the center
1245    point is 1.5 respectively.\\
1246    
1247  The following are some of the methods available:  The following are some of the methods available:
1248    
# Line 1221  Set the cube source length along the y-a Line 1262  Set the cube source length along the y-a
1262  Set the cube source length along the z-axis.  Set the cube source length along the z-axis.
1263  \end{methoddesc}  \end{methoddesc}
1264    
1265    \subsubsection{\Rotation class}
1266    Class that sweeps 2D data around the z-axis to create a 3D looking effect. \\
1267    
1268    The following are some of the methods available:
1269    
1270    \begin{methoddesc}[Rotation]{setResolution}{resolution}
1271    Set the resolution of the sweep for the rotation, which controls the
1272    number of intermediate points
1273    \end{methoddesc}
1274    
1275    \begin{methoddesc}[Rotation]{setAngle}{angle}
1276    Set the angle of rotation.
1277    \end{methoddesc}
1278    
1279    
1280  % #############################################################################  % #############################################################################
1281    
# Line 1465  This section displays some of the sample Line 1520  This section displays some of the sample
1520  \includegraphics[width=\thumbnailwidth]{figures/Map} &  \includegraphics[width=\thumbnailwidth]{figures/Map} &
1521  \includegraphics[width=\thumbnailwidth]{figures/MapOnPlaneCut} &  \includegraphics[width=\thumbnailwidth]{figures/MapOnPlaneCut} &
1522  \includegraphics[width=\thumbnailwidth]{figures/MapOnPlaneClip} \\  \includegraphics[width=\thumbnailwidth]{figures/MapOnPlaneClip} \\
1523  Map & MapOnPlaneCut & MapOnPlaneClip \\  Map & MapOnPlaneCut & MapOnPlaneClip \\
1524  \includegraphics[width=\thumbnailwidth]{figures/MapOnScalarClip} &  \includegraphics[width=\thumbnailwidth]{figures/MapOnScalarClip} &
1525  \includegraphics[width=\thumbnailwidth]{figures/Velocity} &  \includegraphics[width=\thumbnailwidth]{figures/MapOnScalarClipWithRotation} &
1526  \includegraphics[width=\thumbnailwidth]{figures/VelocityOnPlaneCut}  \\  \includegraphics[width=\thumbnailwidth]{figures/Velocity} \\
1527  MapOnScalarClip & Velocity & VelocityOnPlaneCut \\  MapOnScalarClip & MapOnScalarClipWithRotation & Velocity \\ \\ \\ \\
1528    \includegraphics[width=\thumbnailwidth]{figures/VelocityOnPlaneCut} &
1529  \includegraphics[width=\thumbnailwidth]{figures/VelocityOnPlaneClip} &  \includegraphics[width=\thumbnailwidth]{figures/VelocityOnPlaneClip} &
1530  \includegraphics[width=\thumbnailwidth]{figures/Ellipsoid} &  \includegraphics[width=\thumbnailwidth]{figures/Ellipsoid} \\
1531  \includegraphics[width=\thumbnailwidth]{figures/EllipsoidOnPlaneCut}  \\  VelocityOnPlaneCut & VelocityOnPlaneClip & Ellipsoid \\ \\ \\ \\
1532  VelocityOnPlaneClip & Ellipsoid & EllipsoidOnPlaneCut \\  \includegraphics[width=\thumbnailwidth]{figures/EllipsoidOnPlaneCut} &
1533  \includegraphics[width=\thumbnailwidth]{figures/EllipsoidOnPlaneClip} &  \includegraphics[width=\thumbnailwidth]{figures/EllipsoidOnPlaneClip} \\
1534  \includegraphics[width=\thumbnailwidth]{figures/Contour} &  EllipsoidOnPlaneCut & EllipsoidOnPlaneClip \\ \\ \\ \\
 \includegraphics[width=\thumbnailwidth]{figures/ContourOnPlaneCut}  \\  
 EllipsoidOnPlaneClip & Contour & ContourOnPlaneCut \\  
1535  \end{tabular}  \end{tabular}
1536  \caption{Sample output}  \caption{Sample output}
1537  \end{table}  \end{table}
1538    
1539  \begin{table}[t]  \begin{table}[t]
1540  \begin{tabular}{c c c}  \begin{tabular}{c c c}
1541  \includegraphics[width=\thumbnailwidth]{figures/ContourOnPlaneClip} &  \includegraphics[width=\thumbnailwidth]{figures/Contour} &
1542    \includegraphics[width=\thumbnailwidth]{figures/ContourOnPlaneCut} &
1543    \includegraphics[width=\thumbnailwidth]{figures/ContourOnPlaneClip} \\
1544    Contour & ContourOnPlaneCut & ContourOnPlaneClip\\ \\  
1545  \includegraphics[width=\thumbnailwidth]{figures/StreamLine} &  \includegraphics[width=\thumbnailwidth]{figures/StreamLine} &
1546  \includegraphics[width=\thumbnailwidth]{figures/Carpet}  \\  \includegraphics[width=\thumbnailwidth]{figures/Carpet} &
1547  ContourOnPlaneClip & StreamLine & Carpet \\  \includegraphics[width=\thumbnailwidth]{figures/Rectangle} \\
1548  \includegraphics[width=\thumbnailwidth]{figures/Rectangle} &  Streamline & Carpet & Rectangle \\ \\ \\
1549  \includegraphics[width=\thumbnailwidth]{figures/Text} &  \includegraphics[width=\thumbnailwidth]{figures/Text} &
1550  \includegraphics[width=\thumbnailwidth]{figures/Logo} \\  \includegraphics[width=\thumbnailwidth]{figures/Logo} &
1551  Rectangle & Text & Logo \\  \includegraphics[width=\thumbnailwidth]{figures/Image} \\
1552  \includegraphics[width=\thumbnailwidth]{figures/Image} &  Text & Logo & Image \\ \\
1553  \includegraphics[width=\thumbnailwidth]{figures/Legend} \\  \includegraphics[width=\thumbnailwidth]{figures/Legend} \\
1554  Image & Legend \\  Legend \\ \\
1555  \end{tabular}  \end{tabular}
1556  \caption{Sample Output}  \caption{Sample Output}
1557  \end{table}  \end{table}

Legend:
Removed from v.1210  
changed lines
  Added in v.1384

  ViewVC Help
Powered by ViewVC 1.1.26