pyvisi/py_src/warp.py

"""
@author: John NGUI
"""

import vtk
from constant import WarpMode

class Warp:
    """
    Class that defines the deformation of a scalar field.
    """

    def __init__(self,  warp_mode):
        """
        Initialise the warp scalar/vector.

        @type warp_mode: L{WarpMode <constant.WarpMode>} constant
        @param warp_mode: Mode in which to deform the data
        """

        if(warp_mode == WarpMode.SCALAR): # Deform data with scalar data.
            self.__vtk_warp = vtk.vtkWarpScalar()
        elif(warp_mode == WarpMode.VECTOR): # Deform data with vector data.
            self.__vtk_warp = vtk.vtkWarpVector()

    def _setupWarp(self, object):
        """
        Setup the warp.

        @type object: vtkPolyData, etc
        @param object: Input for the warp scalar/vector
        """

        self.__object = object
        self.__setInput()

    def __setInput(self):
        """
        Set the input for the warp scalar/vector.
        """

        self.__vtk_warp.SetInput(self.__object)

    def setScaleFactor(self, scale_factor):
        """
        Set the displacement scale factor.

        @type scale_factor: Number
        @param scale_factor: Scale factor of the displacement
        """

        self.__vtk_warp.SetScaleFactor(scale_factor)

    def _getWarpOutput(self):
        """
        Return the output of the deformed data. 
        
        @rtype: vtkPointSet
        @return: PointSet data
        """
        
        return self.__vtk_warp.GetOutput()

1	"""
2	@author: John NGUI
3	"""
4
5	import vtk
6	from constant import WarpMode
7
8	class Warp:
9	"""
10	Class that defines the deformation of a scalar field.
11	"""
12
13	def __init__(self, warp_mode):
14	"""
15	Initialise the warp scalar/vector.
16
17	@type warp_mode: L{WarpMode <constant.WarpMode>} constant
18	@param warp_mode: Mode in which to deform the data
19	"""
20
21	if(warp_mode == WarpMode.SCALAR): # Deform data with scalar data.
22	self.__vtk_warp = vtk.vtkWarpScalar()
23	elif(warp_mode == WarpMode.VECTOR): # Deform data with vector data.
24	self.__vtk_warp = vtk.vtkWarpVector()
25
26	def _setupWarp(self, object):
27	"""
28	Setup the warp.
29
30	@type object: vtkPolyData, etc
31	@param object: Input for the warp scalar/vector
32	"""
33
34	self.__object = object
35	self.__setInput()
36
37	def __setInput(self):
38	"""
39	Set the input for the warp scalar/vector.
40	"""
41
42	self.__vtk_warp.SetInput(self.__object)
43
44	def setScaleFactor(self, scale_factor):
45	"""
46	Set the displacement scale factor.
47
48	@type scale_factor: Number
49	@param scale_factor: Scale factor of the displacement
50	"""
51
52	self.__vtk_warp.SetScaleFactor(scale_factor)
53
54	def _getWarpOutput(self):
55	"""
56	Return the output of the deformed data.
57
58	@rtype: vtkPointSet
59	@return: PointSet data
60	"""
61
62	return self.__vtk_warp.GetOutput()
63