pyvisi/py_src/imagereslice.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 ImageReslice:
    """
    Class that defines an image reslice used to resize static 
    (no interaction capability) images (i.e. logo).
    """

    def __init__(self):
        """
        Initialise the image reslice.
        """

        self.__vtk_image_reslice = vtk.vtkImageReslice()

    def _setupImageReslice(self, object):
        """
        Setup the image reslice.

        @type object: vtkImageData
        @param object: Image Data
        """

        self.__object = object
        self.__setInput()

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

        self.__vtk_image_reslice.SetInput(self.__object)        

    def setSize(self, size):
        """
        Set the size of the image, between 0 and 2. 
        Size 1 (one) displays the image in its original size 
        (which is the default).  

        @type size: Number
        @param size: Size of the static image
        """

        # By default, with image reslice, the larger the output spacing, the
        # smaller the image. Similarly, the smaller the output spacing, the 
        # larger the image. This behaviour is reversed so that the larger the 
        # size the larger the image. Similarly, the smaller the size, the 
        # smaller the image.
        if(size > 1):
            size = 1 - (size - 1)
            self.__vtk_image_reslice.SetOutputSpacing(size, size, size)
        elif(size < 1):
            size = (1 - size) + 1
            self.__vtk_image_reslice.SetOutputSpacing(size, size, size)

    def _getImageResliceOutput(self):
        """
        Return the output of the image reslice.

        @rtype: vtkImageData
        @return: Image data
        """

        return self.__vtk_image_reslice.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 ImageReslice:
24	"""
25	Class that defines an image reslice used to resize static
26	(no interaction capability) images (i.e. logo).
27	"""
28
29	def __init__(self):
30	"""
31	Initialise the image reslice.
32	"""
33
34	self.__vtk_image_reslice = vtk.vtkImageReslice()
35
36	def _setupImageReslice(self, object):
37	"""
38	Setup the image reslice.
39
40	@type object: vtkImageData
41	@param object: Image Data
42	"""
43
44	self.__object = object
45	self.__setInput()
46
47	def __setInput(self):
48	"""
49	Set the input for the image reslice.
50	"""
51
52	self.__vtk_image_reslice.SetInput(self.__object)
53
54	def setSize(self, size):
55	"""
56	Set the size of the image, between 0 and 2.
57	Size 1 (one) displays the image in its original size
58	(which is the default).
59
60	@type size: Number
61	@param size: Size of the static image
62	"""
63
64	# By default, with image reslice, the larger the output spacing, the
65	# smaller the image. Similarly, the smaller the output spacing, the
66	# larger the image. This behaviour is reversed so that the larger the
67	# size the larger the image. Similarly, the smaller the size, the
68	# smaller the image.
69	if(size > 1):
70	size = 1 - (size - 1)
71	self.__vtk_image_reslice.SetOutputSpacing(size, size, size)
72	elif(size < 1):
73	size = (1 - size) + 1
74	self.__vtk_image_reslice.SetOutputSpacing(size, size, size)
75
76	def _getImageResliceOutput(self):
77	"""
78	Return the output of the image reslice.
79
80	@rtype: vtkImageData
81	@return: Image data
82	"""
83
84	return self.__vtk_image_reslice.GetOutput()