pyvisi/py_src/lookuptable.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 LookupTable:
    """
    Class that defines a lookup table for mapping scalar values into colors.
    """

    def __init__(self):
        """
        Initialise the lookup table.
        """

        self.__vtk_lookup_table = vtk.vtkLookupTable()
        self.__vtk_inverse_lookup_table = vtk.vtkLookupTable()
        self.__build()

    def __build(self):
        """
        Generates the lookup table.
        """

        # NOTE: Build have to be executed prior to using SetTableValue (if any).
        self.__vtk_lookup_table.Build()
        self.__vtk_inverse_lookup_table.Build()

    def _setTableValue(self):
        """
        Setup the lookup table with colors.
        """

        # NOTE: The color values are inversed because VTK's default lookup
        # table is inversed by itself. SetTableValue have to be executed after
        # the Build.
        for i in range(256):
            self.__vtk_lookup_table.SetTableValue(
                    i, self.__vtk_inverse_lookup_table.GetTableValue(255 - i))

    def _setLookupTableToGreyScale(self):
        """
        Setup the lookup table with grey scale. 
        """

        self.__setHueRange(0,0)
        self.__setSaturationRange(0,0)
        self.__setValueRange(1,0)
        self.__setNumberOfTableValues(256)
        self.__setRampToSQRT()

    def __setValueRange(self, lower_range, upper_range):
        """
        Set the value range (brightness) for the lookup table (between 0 and 1).

        @type lower_range: Number
        @param lower_range:Lower value range 
        @type upper_range: Number
        @param upper_range: Upper value range
        """

        self.__vtk_lookup_table.SetValueRange(lower_range, upper_range)

    def __setHueRange(self, lower_range, upper_range):
        """
        Set the hue (color) range for the lookup table (between 0 and 1).

        @type lower_range: Number
        @param lower_range:Lower hue range 
        @type upper_range: Number
        @param upper_range: Upper hue range
        """

        self.__vtk_lookup_table.SetHueRange(lower_range, upper_range)

    def __setSaturationRange(self, lower_range, upper_range):
        """
        Set the saturation (vibrancy) range for the lookup table \
        (between 0 and 1).

        @type lower_range: Number
        @param lower_range:Lower saturantion range 
        @type upper_range: Number
        @param upper_range: Upper saturation range
        """

        self.__vtk_lookup_table.SetSaturationRange(lower_range, upper_range)
    
    def __setRampToSQRT(self):
        """
        Set the table ramp to SQRT. The default ramp is S-curve.    
        """

        self.__vtk_lookup_table.SetRampToSQRT()

    def __setNumberOfTableValues(self, table_values):
        """
        Set the number of values (i.e. colors) in the lookup table. 

        @type table_values: Number
        @param table_values: Number of colors in the lookup table.
        """

        self.__vtk_lookup_table.SetNumberOfTableValues(table_values)

    def _getLookupTable(self):
        """
        Return the lookup table.

        @rtype: vtkLookupTable
        @return: Lookup table
        """

        return self.__vtk_lookup_table
    

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 LookupTable:
24	"""
25	Class that defines a lookup table for mapping scalar values into colors.
26	"""
27
28	def __init__(self):
29	"""
30	Initialise the lookup table.
31	"""
32
33	self.__vtk_lookup_table = vtk.vtkLookupTable()
34	self.__vtk_inverse_lookup_table = vtk.vtkLookupTable()
35	self.__build()
36
37	def __build(self):
38	"""
39	Generates the lookup table.
40	"""
41
42	# NOTE: Build have to be executed prior to using SetTableValue (if any).
43	self.__vtk_lookup_table.Build()
44	self.__vtk_inverse_lookup_table.Build()
45
46	def _setTableValue(self):
47	"""
48	Setup the lookup table with colors.
49	"""
50
51	# NOTE: The color values are inversed because VTK's default lookup
52	# table is inversed by itself. SetTableValue have to be executed after
53	# the Build.
54	for i in range(256):
55	self.__vtk_lookup_table.SetTableValue(
56	i, self.__vtk_inverse_lookup_table.GetTableValue(255 - i))
57
58	def _setLookupTableToGreyScale(self):
59	"""
60	Setup the lookup table with grey scale.
61	"""
62
63	self.__setHueRange(0,0)
64	self.__setSaturationRange(0,0)
65	self.__setValueRange(1,0)
66	self.__setNumberOfTableValues(256)
67	self.__setRampToSQRT()
68
69	def __setValueRange(self, lower_range, upper_range):
70	"""
71	Set the value range (brightness) for the lookup table (between 0 and 1).
72
73	@type lower_range: Number
74	@param lower_range:Lower value range
75	@type upper_range: Number
76	@param upper_range: Upper value range
77	"""
78
79	self.__vtk_lookup_table.SetValueRange(lower_range, upper_range)
80
81	def __setHueRange(self, lower_range, upper_range):
82	"""
83	Set the hue (color) range for the lookup table (between 0 and 1).
84
85	@type lower_range: Number
86	@param lower_range:Lower hue range
87	@type upper_range: Number
88	@param upper_range: Upper hue range
89	"""
90
91	self.__vtk_lookup_table.SetHueRange(lower_range, upper_range)
92
93	def __setSaturationRange(self, lower_range, upper_range):
94	"""
95	Set the saturation (vibrancy) range for the lookup table \
96	(between 0 and 1).
97
98	@type lower_range: Number
99	@param lower_range:Lower saturantion range
100	@type upper_range: Number
101	@param upper_range: Upper saturation range
102	"""
103
104	self.__vtk_lookup_table.SetSaturationRange(lower_range, upper_range)
105
106	def __setRampToSQRT(self):
107	"""
108	Set the table ramp to SQRT. The default ramp is S-curve.
109	"""
110
111	self.__vtk_lookup_table.SetRampToSQRT()
112
113	def __setNumberOfTableValues(self, table_values):
114	"""
115	Set the number of values (i.e. colors) in the lookup table.
116
117	@type table_values: Number
118	@param table_values: Number of colors in the lookup table.
119	"""
120
121	self.__vtk_lookup_table.SetNumberOfTableValues(table_values)
122
123	def _getLookupTable(self):
124	"""
125	Return the lookup table.
126
127	@rtype: vtkLookupTable
128	@return: Lookup table
129	"""
130
131	return self.__vtk_lookup_table
132
133
134