vtkWindowLevelLookupTable Class Reference

#include <vtkWindowLevelLookupTable.h>

Inheritance diagram for vtkWindowLevelLookupTable:

[legend]Collaboration diagram for vtkWindowLevelLookupTable:

[legend]List of all members.

Detailed Description

map scalar values into colors or colors to scalars; generate color table

vtkWindowLevelLookupTable is an object that is used by mapper objects to map scalar values into rgba (red-green-blue-alpha transparency) color specification, or rgba into scalar values. The color table can be created by direct insertion of color values, or by specifying a window and level. Window / Level is used in medical imaging to specify a linear greyscale ramp. The Level is the center of the ramp. The Window is the width of the ramp.

Warning:: vtkWindowLevelLookupTable is a reference counted object. Therefore, you should always use operator "new" to construct new objects. This procedure will avoid memory problems (see text).

See also:: vtkLogLookupTable

Created by:

Lorensen, Bill

CVS contributions (if > 5%):

Lorensen, Bill (42%)
Gobbi, David (32%)
Martin, Ken (8%)
Schroeder, Will (6%)

CVS logs (CVSweb):

.cxx (/Common/vtkWindowLevelLookupTable.cxx)
.h (/Common/vtkWindowLevelLookupTable.h)

Definition at line 53 of file vtkWindowLevelLookupTable.h.

Public Types

typedef vtkLookupTable Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

void Build ()

void SetWindow (double window)

virtual double GetWindow ()

void SetLevel (double level)

virtual double GetLevel ()

void SetInverseVideo (int iv)

virtual int GetInverseVideo ()

virtual void InverseVideoOn ()

virtual void InverseVideoOff ()

virtual void SetMinimumTableValue (double, double, double, double)

virtual void SetMinimumTableValue (double[4])

virtual double * GetMinimumTableValue ()

virtual void GetMinimumTableValue (double &, double &, double &, double &)

virtual void GetMinimumTableValue (double[4])

virtual void SetMaximumTableValue (double, double, double, double)

virtual void SetMaximumTableValue (double[4])

virtual double * GetMaximumTableValue ()

virtual void GetMaximumTableValue (double &, double &, double &, double &)

virtual void GetMaximumTableValue (double[4])

void SetMinimumColor (int r, int g, int b, int a)

void SetMinimumColor (const unsigned char rgba[4])

void GetMinimumColor (unsigned char rgba[4])

unsigned char * GetMinimumColor ()

void SetMaximumColor (int r, int g, int b, int a)

void SetMaximumColor (const unsigned char rgba[4])

void GetMaximumColor (unsigned char rgba[4])

unsigned char * GetMaximumColor ()

Static Public Member Functions

vtkWindowLevelLookupTable * New ()

int IsTypeOf (const char *type)

vtkWindowLevelLookupTable * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkWindowLevelLookupTable (int sze=256, int ext=256)

~vtkWindowLevelLookupTable ()

Protected Attributes

double Window

double Level

int InverseVideo

double MaximumTableValue [4]

double MinimumTableValue [4]

unsigned char MinimumColor [4]

unsigned char MaximumColor [4]

Member Typedef Documentation

typedef vtkLookupTable vtkWindowLevelLookupTable::Superclass

Reimplemented from vtkLookupTable.
Definition at line 57 of file vtkWindowLevelLookupTable.h.

Constructor & Destructor Documentation

vtkWindowLevelLookupTable::vtkWindowLevelLookupTable ( int sze = 256,

int ext = 256

) [protected]

vtkWindowLevelLookupTable::~vtkWindowLevelLookupTable ( ) [inline, protected]

Definition at line 145 of file vtkWindowLevelLookupTable.h.

Member Function Documentation

vtkWindowLevelLookupTable* vtkWindowLevelLookupTable::New ( ) [static]

Construct with range=[0,1]; and hsv ranges set up for rainbow color table (from red to blue).
Reimplemented from vtkLookupTable.

virtual const char* vtkWindowLevelLookupTable::GetClassName ( ) [virtual]

Reimplemented from vtkLookupTable.

int vtkWindowLevelLookupTable::IsTypeOf ( const char * type ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkLookupTable.

virtual int vtkWindowLevelLookupTable::IsA ( const char * type ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkLookupTable.

vtkWindowLevelLookupTable* vtkWindowLevelLookupTable::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkLookupTable.

void vtkWindowLevelLookupTable::PrintSelf ( ostream & os,

vtkIndent indent

) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkLookupTable.

void vtkWindowLevelLookupTable::Build ( ) [virtual]

Generate lookup table as a linear ramp between MinimumTableValue and MaximumTableValue.
Reimplemented from vtkLookupTable.

void vtkWindowLevelLookupTable::SetWindow ( double window ) [inline]

Set the window for the lookup table. The window is the difference between TableRange[0] and TableRange[1].
Definition at line 67 of file vtkWindowLevelLookupTable.h.
References vtkLookupTable::SetTableRange().

virtual double vtkWindowLevelLookupTable::GetWindow ( ) [virtual]

Set the window for the lookup table. The window is the difference between TableRange[0] and TableRange[1].

void vtkWindowLevelLookupTable::SetLevel ( double level ) [inline]

Set the Level for the lookup table. The level is the average of TableRange[0] and TableRange[1].
Definition at line 78 of file vtkWindowLevelLookupTable.h.
References vtkLookupTable::SetTableRange().

virtual double vtkWindowLevelLookupTable::GetLevel ( ) [virtual]

Set the Level for the lookup table. The level is the average of TableRange[0] and TableRange[1].

void vtkWindowLevelLookupTable::SetInverseVideo ( int iv )

Set inverse video on or off. You can achieve the same effect by switching the MinimumTableValue and the MaximumTableValue.

virtual int vtkWindowLevelLookupTable::GetInverseVideo ( ) [virtual]

Set inverse video on or off. You can achieve the same effect by switching the MinimumTableValue and the MaximumTableValue.

virtual void vtkWindowLevelLookupTable::InverseVideoOn ( ) [virtual]

Set inverse video on or off. You can achieve the same effect by switching the MinimumTableValue and the MaximumTableValue.

virtual void vtkWindowLevelLookupTable::InverseVideoOff ( ) [virtual]

Set inverse video on or off. You can achieve the same effect by switching the MinimumTableValue and the MaximumTableValue.

virtual void vtkWindowLevelLookupTable::SetMinimumTableValue ( double ,

double ,

double ,

double

) [virtual]

Set the minimum table value. All lookup table entries below the start of the ramp will be set to this color. After you change this value, you must re-build the lookup table.

virtual void vtkWindowLevelLookupTable::SetMinimumTableValue ( double [4] ) [virtual]

Set the minimum table value. All lookup table entries below the start of the ramp will be set to this color. After you change this value, you must re-build the lookup table.

virtual double* vtkWindowLevelLookupTable::GetMinimumTableValue ( ) [virtual]

Set the minimum table value. All lookup table entries below the start of the ramp will be set to this color. After you change this value, you must re-build the lookup table.

virtual void vtkWindowLevelLookupTable::GetMinimumTableValue ( double & ,

double & ,

double & ,

double &

) [virtual]

Set the minimum table value. All lookup table entries below the start of the ramp will be set to this color. After you change this value, you must re-build the lookup table.

virtual void vtkWindowLevelLookupTable::GetMinimumTableValue ( double [4] ) [virtual]

Set the minimum table value. All lookup table entries below the start of the ramp will be set to this color. After you change this value, you must re-build the lookup table.

virtual void vtkWindowLevelLookupTable::SetMaximumTableValue ( double ,

double ,

double ,

double

) [virtual]

Set the maximum table value. All lookup table entries above the end of the ramp will be set to this color. After you change this value, you must re-build the lookup table.

virtual void vtkWindowLevelLookupTable::SetMaximumTableValue ( double [4] ) [virtual]

Set the maximum table value. All lookup table entries above the end of the ramp will be set to this color. After you change this value, you must re-build the lookup table.

virtual double* vtkWindowLevelLookupTable::GetMaximumTableValue ( ) [virtual]

Set the maximum table value. All lookup table entries above the end of the ramp will be set to this color. After you change this value, you must re-build the lookup table.

virtual void vtkWindowLevelLookupTable::GetMaximumTableValue ( double & ,

double & ,

double & ,

double &

) [virtual]

Set the maximum table value. All lookup table entries above the end of the ramp will be set to this color. After you change this value, you must re-build the lookup table.

virtual void vtkWindowLevelLookupTable::GetMaximumTableValue ( double [4] ) [virtual]

Set the maximum table value. All lookup table entries above the end of the ramp will be set to this color. After you change this value, you must re-build the lookup table.

void vtkWindowLevelLookupTable::SetMinimumColor ( int r,

int g,

int b,

int a

) [inline]

For backwards compatibility: specify the color using integers in the range [0,255]. Deprecated: use SetMinimumTableValue() instead.
Definition at line 112 of file vtkWindowLevelLookupTable.h.

void vtkWindowLevelLookupTable::SetMinimumColor ( const unsigned char rgba[4] ) [inline]

For backwards compatibility: specify the color using integers in the range [0,255]. Deprecated: use SetMinimumTableValue() instead.
Definition at line 114 of file vtkWindowLevelLookupTable.h.

void vtkWindowLevelLookupTable::GetMinimumColor ( unsigned char rgba[4] ) [inline]

For backwards compatibility: specify the color using integers in the range [0,255]. Deprecated: use SetMinimumTableValue() instead.
Definition at line 116 of file vtkWindowLevelLookupTable.h.

unsigned char* vtkWindowLevelLookupTable::GetMinimumColor ( ) [inline]

For backwards compatibility: specify the color using integers in the range [0,255]. Deprecated: use SetMinimumTableValue() instead.
Definition at line 121 of file vtkWindowLevelLookupTable.h.

void vtkWindowLevelLookupTable::SetMaximumColor ( int r,

int g,

int b,

int a

) [inline]

For backwards compatibility: specify the color using integers in the range [0,255]. Deprecated: use SetMaximumTableValue() instead.
Definition at line 129 of file vtkWindowLevelLookupTable.h.

void vtkWindowLevelLookupTable::SetMaximumColor ( const unsigned char rgba[4] ) [inline]

For backwards compatibility: specify the color using integers in the range [0,255]. Deprecated: use SetMaximumTableValue() instead.
Definition at line 131 of file vtkWindowLevelLookupTable.h.

void vtkWindowLevelLookupTable::GetMaximumColor ( unsigned char rgba[4] ) [inline]

For backwards compatibility: specify the color using integers in the range [0,255]. Deprecated: use SetMaximumTableValue() instead.
Definition at line 133 of file vtkWindowLevelLookupTable.h.

unsigned char* vtkWindowLevelLookupTable::GetMaximumColor ( ) [inline]

For backwards compatibility: specify the color using integers in the range [0,255]. Deprecated: use SetMaximumTableValue() instead.
Definition at line 138 of file vtkWindowLevelLookupTable.h.

Member Data Documentation

double vtkWindowLevelLookupTable::Window [protected]

Definition at line 147 of file vtkWindowLevelLookupTable.h.

double vtkWindowLevelLookupTable::Level [protected]

Definition at line 148 of file vtkWindowLevelLookupTable.h.

int vtkWindowLevelLookupTable::InverseVideo [protected]

Definition at line 149 of file vtkWindowLevelLookupTable.h.

double vtkWindowLevelLookupTable::MaximumTableValue[4] [protected]

Definition at line 150 of file vtkWindowLevelLookupTable.h.

double vtkWindowLevelLookupTable::MinimumTableValue[4] [protected]

Definition at line 151 of file vtkWindowLevelLookupTable.h.

unsigned char vtkWindowLevelLookupTable::MinimumColor[4] [protected]

Definition at line 152 of file vtkWindowLevelLookupTable.h.

unsigned char vtkWindowLevelLookupTable::MaximumColor[4] [protected]

Definition at line 153 of file vtkWindowLevelLookupTable.h.

The documentation for this class was generated from the following file:

dox/Common/vtkWindowLevelLookupTable.h


Public Types
typedef vtkLookupTable	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	Build ()

void	SetWindow (double window)
virtual double	GetWindow ()

void	SetLevel (double level)
virtual double	GetLevel ()

void	SetInverseVideo (int iv)
virtual int	GetInverseVideo ()
virtual void	InverseVideoOn ()
virtual void	InverseVideoOff ()

virtual void	SetMinimumTableValue (double, double, double, double)
virtual void	SetMinimumTableValue (double[4])
virtual double *	GetMinimumTableValue ()
virtual void	GetMinimumTableValue (double &, double &, double &, double &)
virtual void	GetMinimumTableValue (double[4])

virtual void	SetMaximumTableValue (double, double, double, double)
virtual void	SetMaximumTableValue (double[4])
virtual double *	GetMaximumTableValue ()
virtual void	GetMaximumTableValue (double &, double &, double &, double &)
virtual void	GetMaximumTableValue (double[4])

void	SetMinimumColor (int r, int g, int b, int a)
void	SetMinimumColor (const unsigned char rgba[4])
void	GetMinimumColor (unsigned char rgba[4])
unsigned char *	GetMinimumColor ()

void	SetMaximumColor (int r, int g, int b, int a)
void	SetMaximumColor (const unsigned char rgba[4])
void	GetMaximumColor (unsigned char rgba[4])
unsigned char *	GetMaximumColor ()
Static Public Member Functions
vtkWindowLevelLookupTable *	New ()
int	IsTypeOf (const char *type)
vtkWindowLevelLookupTable *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkWindowLevelLookupTable (int sze=256, int ext=256)
	~vtkWindowLevelLookupTable ()
Protected Attributes
double	Window
double	Level
int	InverseVideo
double	MaximumTableValue [4]
double	MinimumTableValue [4]
unsigned char	MinimumColor [4]
unsigned char	MaximumColor [4]