/[escript]/trunk/pyvisi/py_src/warp.py
ViewVC logotype

Annotation of /trunk/pyvisi/py_src/warp.py

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1199 - (hide annotations)
Wed Jun 20 05:01:30 2007 UTC (12 years, 2 months ago) by jongui
File MIME type: text/x-python
File size: 1893 byte(s)
- Updated the epydocs and guide.
Deleted redundant files and methods.
Tidied up the codes.
1 ksteube 1147 """
2 jongui 1197 @var __author__: name of author
3     @var __copyright__: copyrights
4     @var __license__: licence agreement
5     @var __url__: url entry point on documentation
6     @var __version__: version
7     @var __date__: date of the version
8 ksteube 1147 """
9    
10 jongui 1197 __author__="John Ngui, john.ngui@uq.edu.au"
11     __copyright__=""" Copyright (c) 2006 by ACcESS MNRF
12     http://www.access.edu.au
13     Primary Business: Queensland, Australia"""
14     __license__="""Licensed under the Open Software License version 3.0
15     http://www.opensource.org/licenses/osl-3.0.php"""
16     __url__="http://www.iservo.edu.au/esys"
17     __version__="$Revision$"
18     __date__="$Date$"
19    
20    
21 ksteube 1147 import vtk
22     from constant import WarpMode
23    
24     class Warp:
25     """
26     Class that defines the deformation of a scalar field.
27     """
28    
29 jongui 1148 def __init__(self, warp_mode):
30 ksteube 1147 """
31     Initialise the warp scalar/vector.
32    
33     @type warp_mode: L{WarpMode <constant.WarpMode>} constant
34     @param warp_mode: Mode in which to deform the data
35     """
36    
37     if(warp_mode == WarpMode.SCALAR): # Deform data with scalar data.
38     self.__vtk_warp = vtk.vtkWarpScalar()
39     elif(warp_mode == WarpMode.VECTOR): # Deform data with vector data.
40     self.__vtk_warp = vtk.vtkWarpVector()
41    
42 jongui 1148 def _setupWarp(self, object):
43     """
44     Setup the warp.
45    
46     @type object: vtkPolyData, etc
47 jongui 1199 @param object: Input for the warp scalar or warp vector
48 jongui 1148 """
49    
50     self.__object = object
51 ksteube 1147 self.__setInput()
52    
53     def __setInput(self):
54     """
55     Set the input for the warp scalar/vector.
56     """
57    
58     self.__vtk_warp.SetInput(self.__object)
59    
60     def setScaleFactor(self, scale_factor):
61     """
62     Set the displacement scale factor.
63    
64     @type scale_factor: Number
65 jongui 1199 @param scale_factor: Scale factor for the displacement
66 ksteube 1147 """
67    
68     self.__vtk_warp.SetScaleFactor(scale_factor)
69    
70 jongui 1148 def _getWarpOutput(self):
71 ksteube 1147 """
72     Return the output of the deformed data.
73    
74     @rtype: vtkPointSet
75     @return: PointSet data
76     """
77    
78     return self.__vtk_warp.GetOutput()
79    

  ViewVC Help
Powered by ViewVC 1.1.26