/[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 1078 by jongui, Thu Apr 5 06:18:47 2007 UTC revision 1079 by jongui, Tue Apr 10 04:27:31 2007 UTC
# Line 259  Methods from \ActorThreeD. Line 259  Methods from \ActorThreeD.
259  viewport = Viewport.SOUTH_WEST, lut = Lut.COLOR, cell_to_point = False,  viewport = Viewport.SOUTH_WEST, lut = Lut.COLOR, cell_to_point = False,
260  outline = True}  outline = True}
261  This class works in a similar way to \Map, except that it shows a scalar  This class works in a similar way to \Map, except that it shows a scalar
262  field on a plane. The plane can be translated and rotated along the X, Y and  field cut using a plane. The plane can be translated and rotated along the
263  Z axes.  X, Y and Z axes.
264  \end{classdesc}  \end{classdesc}
265    
266  The following are some of the methods available:\\  The following are some of the methods available:\\
# Line 312  arrow = Arrow.TWO_D, color_mode = ColorM Line 312  arrow = Arrow.TWO_D, color_mode = ColorM
312  viewport = Viewport.SOUTH_WEST, lut = Lut.COLOR,  viewport = Viewport.SOUTH_WEST, lut = Lut.COLOR,
313  cell_to_point = False, outline = True}  cell_to_point = False, outline = True}
314  This class works in a similar way to \MapOnPlaneCut, except that  This class works in a similar way to \MapOnPlaneCut, except that
315  it shows a vector field using arrows on a plane.  it shows a vector field using arrows cut using a plane.
316  \end{classdesc}  \end{classdesc}
317    
318  The following are some of the methods available:\\  The following are some of the methods available:\\
# Line 335  Methods from \ActorThreeD, \GlyphThreeD, Line 335  Methods from \ActorThreeD, \GlyphThreeD,
335  \subsubsection{\Ellipsoid class}  \subsubsection{\Ellipsoid class}
336    
337  \begin{classdesc}{Ellipsoid}{scene, data_collector,  \begin{classdesc}{Ellipsoid}{scene, data_collector,
338  viewport = Viewport = SOUTH_WEST, lut = Lut.COLOR, outline = True}  viewport = Viewport = SOUTH_WEST, lut = Lut.COLOR, cell_to_point = False,
339    outline = True}
340  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
341  colored or grey-scaled, depending on the lookup table used.  colored or grey-scaled, depending on the lookup table used.
342  \end{classdesc}  \end{classdesc}
343    
344  The following are some of the methods available:\\  The following are some of the methods available:\\
345  Methods from \ActorThreeD, \Sphere, \TensorGlyph and \StructuredPoints.  Methods from \ActorThreeD, \Sphere, \TensorGlyph and \MaskPoints.
346    
347  \subsubsection{\EllipsoidOnPlaneCut class}  \subsubsection{\EllipsoidOnPlaneCut class}
348    
349  \begin{classdesc}{EllipsoidOnPlaneCut}{scene, data_collector,  \begin{classdesc}{EllipsoidOnPlaneCut}{scene, data_collector,
350  viewport = Viewport.SOUTH_WEST, lut = Lut.COLOR, outline = True}  viewport = Viewport.SOUTH_WEST, lut = Lut.COLOR, cell_to_point = False,
351    outline = True}
352  This class works in a similar way to \MapOnPlaneCut, except that it shows  This class works in a similar way to \MapOnPlaneCut, except that it shows
353  a tensor field using ellipsoids cut using a plane.  a tensor field using ellipsoids cut using a plane.
354  \end{classdesc}  \end{classdesc}
355    
356  The following are some of the methods available:\\  The following are some of the methods available:\\
357  Methods from \ActorThreeD, \Sphere, \TensorGlyph, \Transform and  Methods from \ActorThreeD, \Sphere, \TensorGlyph, \Transform and
358  \StructuredPoints.  \MaskPoints.
359    
360  \subsubsection{\EllipsoidOnPlaneClip class}  \subsubsection{\EllipsoidOnPlaneClip class}
361    
362  \begin{classdesc}{EllipsoidOnPlaneClip}{scene, data_collector,  \begin{classdesc}{EllipsoidOnPlaneClip}{scene, data_collector,
363  viewport = Viewport.SOUTH_WEST, lut = Lut.COLOR, outline = True}  viewport = Viewport.SOUTH_WEST, lut = Lut.COLOR, cell_to_point = False,
364    outline = True}
365  This class works in a similar way to \MapOnPlaneClip, except that it shows a  This class works in a similar way to \MapOnPlaneClip, except that it shows a
366  tensor field using ellipsoids clipped using a plane.  tensor field using ellipsoids clipped using a plane.
367  \end{classdesc}  \end{classdesc}
368                    
369  The following are some of the methods available:\\  The following are some of the methods available:\\
370  Methods from \ActorThreeD, \Sphere, \TensorGlyph, \Transform, \Clipper  Methods from \ActorThreeD, \Sphere, \TensorGlyph, \Transform, \Clipper
371  and \StructuredPoints.  and \MaskPoints.
372    
373  \subsubsection{\Contour class}  \subsubsection{\Contour class}
374    
375  \begin{classdesc}{Contour}{scene, data_collector,  \begin{classdesc}{Contour}{scene, data_collector,
376  viewport = Viewport.SOUTH_WEST, lut = Lut.COLOR, cell_to_point = False,  viewport = Viewport.SOUTH_WEST, lut = Lut.COLOR, cell_to_point = False,
377  outline = True}  outline = True}
378  Class that shows a scalar field by contour surfaces. The contour surfaces can  Class that shows a scalar field using contour surfaces. The contour surfaces can
379  either be colored or grey-scaled, depending on the lookup table used. This  either be colored or grey-scaled, depending on the lookup table used. This
380  class can also be used to generate iso surfaces.  class can also be used to generate iso surfaces.
381  \end{classdesc}  \end{classdesc}
# Line 386  Methods from \ActorThreeD and \ContourMo Line 389  Methods from \ActorThreeD and \ContourMo
389  viewport = Viewport.SOUTH_WEST, lut = Lut.COLOR, cell_to_point = False,  viewport = Viewport.SOUTH_WEST, lut = Lut.COLOR, cell_to_point = False,
390  outline = True}  outline = True}
391  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
392  scalar field by contour surfaces on a plane.  scalar field using contour surfaces cut using a plane.
393  \end{classdesc}  \end{classdesc}
394    
395  The following are some of the methods available:\\  The following are some of the methods available:\\
# Line 398  Methods from \ActorThreeD, \ContourModul Line 401  Methods from \ActorThreeD, \ContourModul
401  viewport = Viewport.SOUTH_WEST, lut = Lut.COLOR, cell_to_point = False,  viewport = Viewport.SOUTH_WEST, lut = Lut.COLOR, cell_to_point = False,
402  outline = True}  outline = True}
403  This class works in a similar way to \MapOnPlaneClip, except that it shows a  This class works in a similar way to \MapOnPlaneClip, except that it shows a
404  scalar field by contour surfaces clipped using a plane.  scalar field using contour surfaces clipped using a plane.
405  \end{classdesc}  \end{classdesc}
406    
407  The following are some of the methods available:\\  The following are some of the methods available:\\
# Line 424  Methods from \ActorThreeD, \PointSource, Line 427  Methods from \ActorThreeD, \PointSource,
427  viewport = Viewport.Viewport.SOUTH_WEST, warp_mode = WarpMode.SCALAR,  viewport = Viewport.Viewport.SOUTH_WEST, warp_mode = WarpMode.SCALAR,
428  lut = Lut.COLOR, outline = True}  lut = Lut.COLOR, outline = True}
429  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
430  scalar field on a plane deformated (warp) along the normal. The plane can  scalar field cut on a plane and deformated (warp) along the normal. The
431  either be colored or grey-scaled, depending on the lookup table used.  plane can either be colored or grey-scaled, depending on the lookup table used.
432  Similarly, the plane can be deformated either using scalar data or vector data.  Similarly, the plane can be deformated either using scalar data or vector data.
433  \end{classdesc}  \end{classdesc}
434    
# Line 463  Class that defines the global positionin Line 466  Class that defines the global positionin
466    
467  \subsection{Supporting Classes}  \subsection{Supporting Classes}
468  This subsection details the supporting classes inherited by the data  This subsection details the supporting classes inherited by the data
469  visualization classes. These supporting  visualization classes and their available methods.
470    
471  \subsubsection{\ActorThreeD class}  \subsubsection{\ActorThreeD class}
472    
# Line 503  Clips the other side of the rendered obj Line 506  Clips the other side of the rendered obj
506  \end{methoddesc}  \end{methoddesc}
507    
508  \begin{methoddesc}[Clipper]{setClipValue}{value}  \begin{methoddesc}[Clipper]{setClipValue}{value}
509  Set the scalar clip value.  Set the scalar clip value (instead of using a plane) for the clipper.
510  \end{methoddesc}  \end{methoddesc}
511    
512  \subsubsection{\ContourModule class}  \subsubsection{\ContourModule class}
# Line 513  The following are some of the methods av Line 516  The following are some of the methods av
516  \begin{methoddesc}[ContourModule]{generateContours}{contours,  \begin{methoddesc}[ContourModule]{generateContours}{contours,
517  lower_range = None, upper_range = None}  lower_range = None, upper_range = None}
518  Generate the specified number of contours within the specified range.  Generate the specified number of contours within the specified range.
519    In order to generate an iso surface, the 'lower_range' and 'upper_range'
520    must be equal.
521  \end{methoddesc}  \end{methoddesc}
522    
523  \subsubsection{\GlyphThreeD class}  \subsubsection{\GlyphThreeD class}
# Line 539  The following are some of the methods av Line 544  The following are some of the methods av
544  Set the scale factor for the tensor glyph.  Set the scale factor for the tensor glyph.
545  \end{methoddesc}  \end{methoddesc}
546    
547    \begin{methoddesc}[TensorGlyph]{setMaxScaleFactor}{max_scale_factor}
548    Set the maximum allowable scale factor for the tensor glyph.
549    \end{methoddesc}
550    
551  \subsubsection{\PlaneSource class}  \subsubsection{\PlaneSource class}
552    
553  The following are some of the methods available:  The following are some of the methods available:
# Line 559  The following are some of the methods av Line 568  The following are some of the methods av
568  Set the radius of the sphere.  Set the radius of the sphere.
569  \end{methoddesc}  \end{methoddesc}
570    
571    \begin{methoddesc}[PointSource]{setPointSourceCenter}{position}
572    Set the center of the sphere.
573    \end{methoddesc}
574    
575  \begin{methoddesc}[PointSource]{setPointSourceNumberOfPoints}{points}  \begin{methoddesc}[PointSource]{setPointSourceNumberOfPoints}{points}
576  Set the number of points to generate within the sphere (the larger the  Set the number of points to generate within the sphere (the larger the
577  number of points, the more streamlines are generated).  number of points, the more streamlines are generated).
578  \end{methoddesc}  \end{methoddesc}
579    
 \subsubsection{\StructuredPoints class}  
   
 The following are some of the methods available:  
   
 \begin{methoddesc}[StructuredPoints]{setDimension}{x, y, z}  
 Set the dimension on the x, y and z axes. The smaller the dimension,  
 the more points are populated.  
 \end{methoddesc}  
   
580  \subsubsection{\Sphere class}  \subsubsection{\Sphere class}
581    
582  The following are some of the methods available:  The following are some of the methods available:
# Line 648  Set the radius of the tube to vary by sc Line 652  Set the radius of the tube to vary by sc
652  Set the displacement scale factor.  Set the displacement scale factor.
653  \end{methoddesc}  \end{methoddesc}
654    
655    \subsubsection{\MaskPoints class}
656    
657    \begin{methoddesc}[MaskPoints]{setRatio}{ratio}
658    Mask every nth point.
659    \end{methoddesc}
660    
661    \begin{methoddesc}[MaskPoints]{randomOn}{}
662    Enables the randomization of the points selected for masking.
663    \end{methoddesc}
664    
665    
666    
667    
668    
669  \section{Online Rendering Mechnism}  \section{Online Rendering Mechnism}
670    

Legend:
Removed from v.1078  
changed lines
  Added in v.1079

  ViewVC Help
Powered by ViewVC 1.1.26