/[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 1210 by jongui, Tue Jul 3 05:47:34 2007 UTC revision 1211 by jongui, Wed Jul 4 05:16:46 2007 UTC
# Line 345  field clipped using a scalar value. Line 345  field clipped using a scalar value.
345  The following are some of the methods available:\\  The following are some of the methods available:\\
346  Methods from \ActorThreeD, \Clipper and \DataSetMapper.  Methods from \ActorThreeD, \Clipper and \DataSetMapper.
347    
348    \subsubsection{\MapOnScalarClipWithRotation class}
349    
350    \begin{classdesc}{MapOnScalarClipWithRotation}{scene, data_collector,
351    viewport = Viewport.SOUTH_WEST, lut = Lut.COLOR, cell_to_point = False}
352    This class works in a similar way to \Map except that it
353    shows a 2D scalar field clipped using a scalar value and subsequently
354    rotated around the z-axis to create a  3D looking effect. This class should
355    only be used with 2D data sets and NOT 3D.
356    \end{classdesc}
357    
358    The following are some of the methods available:\\
359    Methods from \ActorThreeD, \Clipper, \Rotation and \DataSetMapper.
360    
361  \subsubsection{\Velocity class}  \subsubsection{\Velocity class}
362    
363  \begin{classdesc}{Velocity}{scene, data_collector, arrow = Arrow.TWO_D,  \begin{classdesc}{Velocity}{scene, data_collector, arrow = Arrow.TWO_D,
# Line 944  inherited by the input (see Section \ref Line 957  inherited by the input (see Section \ref
957  visualization classes (see Section \ref{DATAVIS SEC}).  visualization classes (see Section \ref{DATAVIS SEC}).
958    
959  \subsubsection{\ActorThreeD class}  \subsubsection{\ActorThreeD class}
960    Class that defines a 3D actor. \\
961    
962  The following are some of the methods available:  The following are some of the methods available:
963    
# Line 960  Set the representation of the 3D actor t Line 974  Set the representation of the 3D actor t
974  \end{methoddesc}  \end{methoddesc}
975    
976  \subsubsection{\ActorTwoD class}  \subsubsection{\ActorTwoD class}
977    Class that defines a 2D actor. \\
978    
979  The following are some of the methods available:  The following are some of the methods available:
980    
# Line 969  corner of the window / viewport. Line 984  corner of the window / viewport.
984  \end{methoddesc}  \end{methoddesc}
985    
986  \subsubsection{\Clipper class}  \subsubsection{\Clipper class}
987    Class that defines a clipper. \\
988    
989  The following are some of the methods available:  The following are some of the methods available:
990    
# Line 985  Set the scalar clip value (instead of us Line 1001  Set the scalar clip value (instead of us
1001  \end{methoddesc}  \end{methoddesc}
1002    
1003  \subsubsection{\ContourModule class}  \subsubsection{\ContourModule class}
1004    Class that defines the contour module. \\
1005    
1006  The following are some of the methods available:  The following are some of the methods available:
1007    
# Line 996  must be equal. Line 1013  must be equal.
1013  \end{methoddesc}  \end{methoddesc}
1014    
1015  \subsubsection{\GlyphThreeD class}  \subsubsection{\GlyphThreeD class}
1016    Class that defines 3D glyphs. \\
1017    
1018  The following are some of the methods available:  The following are some of the methods available:
1019    
# Line 1012  Set the 3D glyph scale factor. Line 1030  Set the 3D glyph scale factor.
1030  \end{methoddesc}  \end{methoddesc}
1031    
1032  \subsubsection{\TensorGlyph class}  \subsubsection{\TensorGlyph class}
1033    Class that defines tensor glyphs. \\
1034    
1035  The following are some of the methods available:  The following are some of the methods available:
1036    
# Line 1024  Set the maximum allowable scale factor f Line 1043  Set the maximum allowable scale factor f
1043  \end{methoddesc}  \end{methoddesc}
1044    
1045  \subsubsection{\PlaneSource class}  \subsubsection{\PlaneSource class}
1046    Class that defines a plane source.  A plane source is defined by an origin
1047    and two other points, which form the axes (X and Y). \\
1048    
1049  The following are some of the methods available:  The following are some of the methods available:
1050    
# Line 1036  Set the second point from the origin of Line 1057  Set the second point from the origin of
1057  \end{methoddesc}  \end{methoddesc}
1058    
1059  \subsubsection{\PointSource class}  \subsubsection{\PointSource class}
1060    Class that defines the source (location) to generate points. The points are
1061    generated within the radius of a sphere. \\
1062    
1063  The following are some of the methods available:  The following are some of the methods available:
1064    
# Line 1053  number of points, the more streamlines a Line 1076  number of points, the more streamlines a
1076  \end{methoddesc}  \end{methoddesc}
1077    
1078  \subsubsection{\Sphere class}  \subsubsection{\Sphere class}
1079    Class that defines a sphere. \\
1080    
1081  The following are some of the methods available:  The following are some of the methods available:
1082    
# Line 1065  Set the phi resolution of the sphere. Line 1089  Set the phi resolution of the sphere.
1089  \end{methoddesc}  \end{methoddesc}
1090    
1091  \subsubsection{\StreamLineModule class}  \subsubsection{\StreamLineModule class}
1092    Class that defines the streamline module. \\
1093    
1094  The following are some of the methods available:  The following are some of the methods available:
1095    
# Line 1078  goes) and backward (where the streamline Line 1103  goes) and backward (where the streamline
1103  \end{methoddesc}  \end{methoddesc}
1104    
1105  \subsubsection{\Transform class}  \subsubsection{\Transform class}
1106    Class that defines the orientation of planes. \\
1107    
1108  The following are some of the methods available:  The following are some of the methods available:
1109    
# Line 1110  Set the plane orthogonal to the y-axis. Line 1136  Set the plane orthogonal to the y-axis.
1136  \end{methoddesc}  \end{methoddesc}
1137    
1138  \subsubsection{\Tube class}  \subsubsection{\Tube class}
1139    Class that defines the tube wrapped around the streamlines. \\
1140    
1141  The following are some of the methods available:  The following are some of the methods available:
1142    
# Line 1126  Set the radius of the tube to vary by sc Line 1153  Set the radius of the tube to vary by sc
1153  \end{methoddesc}  \end{methoddesc}
1154    
1155  \subsubsection{\Warp class}  \subsubsection{\Warp class}
1156    Class that defines the deformation of a scalar field. \\
1157    
1158  The following are some of the methods available:  The following are some of the methods available:
1159    
# Line 1134  Set the displacement scale factor. Line 1162  Set the displacement scale factor.
1162  \end{methoddesc}  \end{methoddesc}
1163    
1164  \subsubsection{\MaskPoints class}  \subsubsection{\MaskPoints class}
1165    Class that defines the masking of points
1166    every n'th point.  This is useful to prevent the rendered object
1167    from being cluttered with arrows or ellipsoids. \\
1168    
1169  The following are some of the methods available:  The following are some of the methods available:
1170    
# Line 1145  Mask every n'th point. Line 1176  Mask every n'th point.
1176  Enables the randomization of the points selected for masking.  Enables the randomization of the points selected for masking.
1177  \end{methoddesc}  \end{methoddesc}
1178    
   
1179  \subsubsection{\ScalarBar class}  \subsubsection{\ScalarBar class}
1180    Class that defines a scalar bar. \\
1181    
1182  The following are some of the methods available:  The following are some of the methods available:
1183    
# Line 1183  Set the color of the scalar bar's title. Line 1214  Set the color of the scalar bar's title.
1214  \end{methoddesc}  \end{methoddesc}
1215    
1216  \subsubsection{\ImageReslice class}  \subsubsection{\ImageReslice class}
1217    Class that defines an image reslice used to resize static
1218    (no interaction capability) images (i.e. logo). \\
1219    
1220  The following are some of the methods available:  The following are some of the methods available:
1221    
# Line 1192  displays the image in its original size Line 1225  displays the image in its original size
1225  \end{methoddesc}  \end{methoddesc}
1226    
1227  \subsubsection{\DataSetMapper class}  \subsubsection{\DataSetMapper class}
1228    Class that defines a data set mapper. \\
1229    
1230  The following are some of the methods available:  The following are some of the methods available:
1231    
# Line 1202  Therefore, the scalar range read from th Line 1236  Therefore, the scalar range read from th
1236  \end{methoddesc}  \end{methoddesc}
1237    
1238  \subsubsection{\CubeSource class}  \subsubsection{\CubeSource class}
1239    Class that defines a cube source. The center of the cube souce defines
1240    the point from which the cube is to be generated and the X, Y
1241    and Z lengths define the length of the cube from the center point. If
1242    X length is 3, then the X length to the left and right of the center
1243    point is 1.5 respectively.\\
1244    
1245  The following are some of the methods available:  The following are some of the methods available:
1246    
# Line 1221  Set the cube source length along the y-a Line 1260  Set the cube source length along the y-a
1260  Set the cube source length along the z-axis.  Set the cube source length along the z-axis.
1261  \end{methoddesc}  \end{methoddesc}
1262    
1263    \subsubsection{\Rotation class}
1264    Class that sweeps 2D data around the z-axis to create a 3D looking effect. \\
1265    
1266    The following are some of the methods available:
1267    
1268    \begin{methoddesc}[Rotation]{setResolution}{resolution}
1269    Set the resolution of the sweep for the rotation, which controls the
1270    number of intermediate points
1271    \end{methoddesc}
1272    
1273    \begin{methoddesc}[Rotation]{setAngle}{angle}
1274    Set the angle of rotation.
1275    \end{methoddesc}
1276    
1277    
1278  % #############################################################################  % #############################################################################
1279    

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

  ViewVC Help
Powered by ViewVC 1.1.26