pyvisi/py_src/outline.py


########################################################
#
# Copyright (c) 2003-2010 by University of Queensland
# Earth Systems Science Computational Center (ESSCC)
# http://www.uq.edu.au/esscc
#
# Primary Business: Queensland, Australia
# Licensed under the Open Software License version 3.0
# http://www.opensource.org/licenses/osl-3.0.php
#
########################################################

__copyright__="""Copyright (c) 2003-2010 by University of Queensland
Earth Systems Science Computational Center (ESSCC)
http://www.uq.edu.au/esscc
Primary Business: Queensland, Australia"""
__license__="""Licensed under the Open Software License version 3.0
http://www.opensource.org/licenses/osl-3.0.php"""
__url__="https://launchpad.net/escript-finley"

"""
: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"


from esys.escript import getMPISizeWorld
if getMPISizeWorld()==1: import vtk

class Outline:
    """
    Class that defines an outline.
    """

    def __init__(self, object):
        """
        Initialise the outline.

        :type object: vtkUnstructuredGrid, etc
        :param object: Data source to the outline
        """
                if getMPISizeWorld()>1:
                     raise ValueError,"pyvisi.Outline is not running on more than one processor."
        self.__object = object
        self.__vtk_outline = vtk.vtkOutlineFilter()
        self.__setInput()

    def __setInput(self):
        """
        Set the input for the outline.
        """

        self.__vtk_outline.SetInput(self.__object)
    
    def _getOutlineOutput(self):
        """
        Return the output of the outline.

        :rtype: vtkPolyData
        :return: Polyognal data
        """

        return self.__vtk_outline.GetOutput()
    
1
2	########################################################
3	#
4	# Copyright (c) 2003-2010 by University of Queensland
5	# Earth Systems Science Computational Center (ESSCC)
6	# http://www.uq.edu.au/esscc
7	#
8	# Primary Business: Queensland, Australia
9	# Licensed under the Open Software License version 3.0
10	# http://www.opensource.org/licenses/osl-3.0.php
11	#
12	########################################################
13
14	__copyright__="""Copyright (c) 2003-2010 by University of Queensland
15	Earth Systems Science Computational Center (ESSCC)
16	http://www.uq.edu.au/esscc
17	Primary Business: Queensland, Australia"""
18	__license__="""Licensed under the Open Software License version 3.0
19	http://www.opensource.org/licenses/osl-3.0.php"""
20	__url__="https://launchpad.net/escript-finley"
21
22	"""
23	:var __author__: name of author
24	:var __copyright__: copyrights
25	:var __license__: licence agreement
26	:var __url__: url entry point on documentation
27	:var __version__: version
28	:var __date__: date of the version
29	"""
30
31	__author__="John Ngui, john.ngui@uq.edu.au"
32
33
34	from esys.escript import getMPISizeWorld
35	if getMPISizeWorld()==1: import vtk
36
37	class Outline:
38	"""
39	Class that defines an outline.
40	"""
41
42	def __init__(self, object):
43	"""
44	Initialise the outline.
45
46	:type object: vtkUnstructuredGrid, etc
47	:param object: Data source to the outline
48	"""
49	if getMPISizeWorld()>1:
50	raise ValueError,"pyvisi.Outline is not running on more than one processor."
51	self.__object = object
52	self.__vtk_outline = vtk.vtkOutlineFilter()
53	self.__setInput()
54
55	def __setInput(self):
56	"""
57	Set the input for the outline.
58	"""
59
60	self.__vtk_outline.SetInput(self.__object)
61
62	def _getOutlineOutput(self):
63	"""
64	Return the output of the outline.
65
66	:rtype: vtkPolyData
67	:return: Polyognal data
68	"""
69
70	return self.__vtk_outline.GetOutput()
71