/[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 1315 by jongui, Thu Jul 5 00:41:19 2007 UTC revision 1316 by ksteube, Tue Sep 25 03:18:30 2007 UTC
# Line 26  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.
# Line 246  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 366  Methods from \ActorThreeD, \Clipper, \Ro Line 366  Methods from \ActorThreeD, \Clipper, \Ro
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 459  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 547  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 629  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 691  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 750  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 848  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 1232  Class that defines a data set mapper. \\ Line 1232  Class that defines a data set mapper. \\
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 souce defines  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  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  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  X length is 3, then the X length to the left and right of the center

Legend:
Removed from v.1315  
changed lines
  Added in v.1316

  ViewVC Help
Powered by ViewVC 1.1.26