pyvisi/py_src/average.py

"""
@var __author__: name of author
@var __copyright__: copyrights
@var __license__: licence agreement
@var __url__: url entry point on documentation
@var __version__: version
@var __date__: date of the version
"""

__author__="John Ngui, john.ngui@uq.edu.au"
__copyright__="""  Copyright (c) 2006 by ACcESS MNRF
                    http://www.access.edu.au
                Primary Business: Queensland, Australia"""
__license__="""Licensed under the Open Software License version 3.0
             http://www.opensource.org/licenses/osl-3.0.php"""
__url__="http://www.iservo.edu.au/esys"
__version__="$Revision$"
__date__="$Date$"


import vtk

class CellDataToPointData:
    """
    Class that defines a filter to convert cell data to point data by 
    averaging the data values of all cells using a particular point.
    """

    def __init__(self, object):
        """
        Initialise the cell to point data filter.

        @type object: vtkUnstructuredGrid, etc
        @param object: Input for the cell to point data filter
        """

        self.__object = object
        self.__vtk_cell_to_point = vtk.vtkCellDataToPointData()

        self.__setInput()

    def __setInput(self):
        """
        Set the input for the cell to point data filter.
        """

        self.__vtk_cell_to_point.SetInput(self.__object)

    def _getCellToPointOutput(self):
        """
        Return the output of the cell to point data filter.

        @rtype: vtkDataSet
        @return: Data set
        """

        return self.__vtk_cell_to_point.GetOutput()

    
1	"""
2	@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	"""
9
10	__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	import vtk
22
23	class CellDataToPointData:
24	"""
25	Class that defines a filter to convert cell data to point data by
26	averaging the data values of all cells using a particular point.
27	"""
28
29	def __init__(self, object):
30	"""
31	Initialise the cell to point data filter.
32
33	@type object: vtkUnstructuredGrid, etc
34	@param object: Input for the cell to point data filter
35	"""
36
37	self.__object = object
38	self.__vtk_cell_to_point = vtk.vtkCellDataToPointData()
39
40	self.__setInput()
41
42	def __setInput(self):
43	"""
44	Set the input for the cell to point data filter.
45	"""
46
47	self.__vtk_cell_to_point.SetInput(self.__object)
48
49	def _getCellToPointOutput(self):
50	"""
51	Return the output of the cell to point data filter.
52
53	@rtype: vtkDataSet
54	@return: Data set
55	"""
56
57	return self.__vtk_cell_to_point.GetOutput()
58
59