Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Related Pages

vtkLookupTable Class Reference

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

#include <vtkLookupTable.h>

Inheritance diagram for vtkLookupTable:

[legend]Collaboration diagram for vtkLookupTable:

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
int	Allocate (int sz=256, int ext=256)
virtual void	Build ()
virtual void	SetNumberOfColors (int)
virtual int	GetNumberOfColors ()
void	SetTableRange (float r[2])
virtual void	SetTableRange (float min, float max)
virtual float *	GetTableRange ()
virtual void	GetTableRange (float data[2])
virtual void	SetHueRange (float, float)
void	SetHueRange (float[2])
virtual float *	GetHueRange ()
virtual void	GetHueRange (float data[2])
virtual void	SetSaturationRange (float, float)
void	SetSaturationRange (float[2])
virtual float *	GetSaturationRange ()
virtual void	GetSaturationRange (float data[2])
virtual void	SetValueRange (float, float)
void	SetValueRange (float[2])
virtual float *	GetValueRange ()
virtual void	GetValueRange (float data[2])
virtual void	SetAlphaRange (float, float)
void	SetAlphaRange (float[2])
virtual float *	GetAlphaRange ()
virtual void	GetAlphaRange (float data[2])
unsigned char *	MapValue (float v)
void	MapScalarsThroughTable2 (void input, unsigned char output, int inputDataType, int numberOfValues, int inputIncrement, int outputIncrement)
float *	GetColor (float x)
void	GetColor (float x, float rgb[3])
float	GetOpacity (float v)
void	SetNumberOfTableValues (int number)
void	SetTableValue (int indx, float rgba[4])
void	SetTableValue (int indx, float r, float g, float b, float a=1.0)
float *	GetTableValue (int id)
void	GetTableValue (int id, float rgba[4])
unsigned char *	GetPointer (const int id)
unsigned char *	WritePointer (const int id, const int number)
float *	GetRange ()
void	SetRange (float min, float max)
void	SetRange (float rng[2])
Static Public Methods
vtkLookupTable *	New ()
int	IsTypeOf (const char *type)
vtkLookupTable *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkLookupTable (int sze=256, int ext=256)
	~vtkLookupTable ()
	vtkLookupTable (const vtkLookupTable &)
void	operator= (const vtkLookupTable &)
Protected Attributes
int	NumberOfColors
vtkUnsignedCharArray *	Table
float	TableRange [2]
float	HueRange [2]
float	SaturationRange [2]
float	ValueRange [2]
float	AlphaRange [2]
vtkTimeStamp	InsertTime
vtkTimeStamp	BuildTime
float	RGBA [4]

Detailed Description

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

Date:: 2000/12/10 20:08:12

Revision:: 1.55

vtkLookupTable 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 hue, saturation, value, and alpha range and generating a table.

This class is designed as a base class for derivation by other classes. The Build(), MapValue(), MapValues(), and SetTableRange() methods are virtual and may require overloading in subclasses.

Warning:: vtkLookupTable 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 vtkWindowLevelLookupTable

Examples:: vtkLookupTable (examples)

Definition at line 74 of file vtkLookupTable.h.

Constructor & Destructor Documentation

vtkLookupTable::vtkLookupTable ( int sze = 256,

int ext = 256

) [protected]

vtkLookupTable::~vtkLookupTable ( ) [protected]

vtkLookupTable::vtkLookupTable ( const vtkLookupTable & ) [inline, protected]

Definition at line 186 of file vtkLookupTable.h.

Member Function Documentation

vtkLookupTable* vtkLookupTable::New ( ) [static]

Construct with range=(0,1); and hsv ranges set up for rainbow color table (from red to blue).
Reimplemented from vtkObject.
Reimplemented in vtkLogLookupTable, and vtkWindowLevelLookupTable.

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

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkScalarsToColors.
Reimplemented in vtkLogLookupTable, and vtkWindowLevelLookupTable.

int vtkLookupTable::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 vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkScalarsToColors.
Reimplemented in vtkLogLookupTable, and vtkWindowLevelLookupTable.

virtual int vtkLookupTable::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 vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkScalarsToColors.
Reimplemented in vtkLogLookupTable, and vtkWindowLevelLookupTable.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkScalarsToColors.
Reimplemented in vtkLogLookupTable, and vtkWindowLevelLookupTable.

void vtkLookupTable::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 vtkObject.
Reimplemented in vtkLogLookupTable, and vtkWindowLevelLookupTable.

int vtkLookupTable::Allocate ( int sz = 256,

int ext = 256

)

Allocate a color table of specified size.

virtual void vtkLookupTable::Build ( ) [virtual]

Generate lookup table from hue, saturation, value, alpha min/max values. Table is built from linear ramp of each value.
Reimplemented from vtkScalarsToColors.
Reimplemented in vtkWindowLevelLookupTable.

virtual void vtkLookupTable::SetNumberOfColors ( int ) [virtual]

Set the number of colors in the lookup table. Use this method before building the lookup table. Use SetNumberOfTableValues() to change the table size after the lookup table has been built.

virtual int vtkLookupTable::GetNumberOfColors ( ) [virtual]

void vtkLookupTable::SetTableRange ( float r[2] )

Set/Get the minimum/maximum scalar values for scalar mapping. Scalar values less than minimum range value are clamped to minimum range value. Scalar values greater than maximum range value are clamped to maximum range value.
Reimplemented in vtkLogLookupTable.
Referenced by vtkLogLookupTable::SetTableRange().

virtual void vtkLookupTable::SetTableRange ( float min,

float max

) [virtual]

Reimplemented in vtkLogLookupTable.

virtual float* vtkLookupTable::GetTableRange ( ) [virtual]

virtual void vtkLookupTable::GetTableRange ( float data[2] ) [virtual]

virtual void vtkLookupTable::SetHueRange ( float ,

float

) [virtual]

Set the range in hue (using automatic generation). Hue ranges between (0,1).

void vtkLookupTable::SetHueRange ( float [2] )

virtual float* vtkLookupTable::GetHueRange ( ) [virtual]

virtual void vtkLookupTable::GetHueRange ( float data[2] ) [virtual]

virtual void vtkLookupTable::SetSaturationRange ( float ,

float

) [virtual]

Set the range in saturation (using automatic generation). Saturation ranges between (0,1).

void vtkLookupTable::SetSaturationRange ( float [2] )

virtual float* vtkLookupTable::GetSaturationRange ( ) [virtual]

virtual void vtkLookupTable::GetSaturationRange ( float data[2] ) [virtual]

virtual void vtkLookupTable::SetValueRange ( float ,

float

) [virtual]

Set the range in value (using automatic generation). Value ranges between (0,1).

void vtkLookupTable::SetValueRange ( float [2] )

virtual float* vtkLookupTable::GetValueRange ( ) [virtual]

virtual void vtkLookupTable::GetValueRange ( float data[2] ) [virtual]

virtual void vtkLookupTable::SetAlphaRange ( float ,

float

) [virtual]

Set the range in alpha (using automatic generation). Alpha ranges from (0,1).

void vtkLookupTable::SetAlphaRange ( float [2] )

virtual float* vtkLookupTable::GetAlphaRange ( ) [virtual]

virtual void vtkLookupTable::GetAlphaRange ( float data[2] ) [virtual]

unsigned char* vtkLookupTable::MapValue ( float v ) [virtual]

Map one value through the lookup table.
Reimplemented from vtkScalarsToColors.
Reimplemented in vtkLogLookupTable.

void vtkLookupTable::MapScalarsThroughTable2 ( void * input,

unsigned char * output,

int inputDataType,

int numberOfValues,

int inputIncrement,

int outputIncrement

) [virtual]

map a set of scalars through the lookup table
Reimplemented from vtkScalarsToColors.
Reimplemented in vtkLogLookupTable.

float* vtkLookupTable::GetColor ( float x ) [inline]

Map one value through the lookup table and return the color as an RGB array of floats between 0 and 1.
Reimplemented from vtkScalarsToColors.
Definition at line 136 of file vtkLookupTable.h.

void vtkLookupTable::GetColor ( float x,

float rgb[3]

) [virtual]

Map one value through the lookup table and return the color as an RGB array of floats between 0 and 1.
Reimplemented from vtkScalarsToColors.

float vtkLookupTable::GetOpacity ( float v )

Map one value through the lookup table and return the alpha value (the opacity) as a float between 0 and 1.

void vtkLookupTable::SetNumberOfTableValues ( int number )

Specify the number of values (i.e., colors) in the lookup table. This method simply allocates memory and prepares the table for use with SetTableValue(). It differs from Build() method in that the allocated memory is not initialized according to HSVA ramps.

void vtkLookupTable::SetTableValue ( int indx,

float rgba[4]

)

Directly load color into lookup table. Use [0,1] float values for color component specification. Make sure that you've either used the Build() method or used SetNumberOfTableValues() prior to using this method.

void vtkLookupTable::SetTableValue ( int indx,

float r,

float g,

float b,

float a = 1.0

)

Directly load color into lookup table. Use [0,1] float values for color component specification.

float* vtkLookupTable::GetTableValue ( int id )

Return a rgba color value for the given index into the lookup table. Color components are expressed as [0,1] float values.

void vtkLookupTable::GetTableValue ( int id,

float rgba[4]

)

Return a rgba color value for the given index into the lookup table. Color components are expressed as [0,1] float values.

unsigned char* vtkLookupTable::GetPointer ( const int id ) [inline]

Get pointer to color table data. Format is array of unsigned char r-g-b-a-r-g-b-a...
Definition at line 170 of file vtkLookupTable.h.

unsigned char * vtkLookupTable::WritePointer ( const int id,

const int number

) [inline]

Get pointer to data. Useful for direct writes into object. MaxId is bumped by number (and memory allocated if necessary). Id is the location you wish to write into; number is the number of rgba values to write.
Definition at line 201 of file vtkLookupTable.h.

float* vtkLookupTable::GetRange ( ) [inline, virtual]

Sets/Gets the range of scalars which will be mapped.
Reimplemented from vtkScalarsToColors.
Definition at line 179 of file vtkLookupTable.h.

void vtkLookupTable::SetRange ( float min,

float max

) [inline, virtual]

Reimplemented from vtkScalarsToColors.
Definition at line 180 of file vtkLookupTable.h.

void vtkLookupTable::SetRange ( float rng[2] ) [inline]

Reimplemented from vtkScalarsToColors.
Definition at line 181 of file vtkLookupTable.h.

void vtkLookupTable::operator= ( const vtkLookupTable & ) [inline, protected]

Definition at line 187 of file vtkLookupTable.h.

Member Data Documentation

int vtkLookupTable::NumberOfColors [protected]

Definition at line 189 of file vtkLookupTable.h.

vtkUnsignedCharArray* vtkLookupTable::Table [protected]

Definition at line 190 of file vtkLookupTable.h.

float vtkLookupTable::TableRange[2] [protected]

Definition at line 191 of file vtkLookupTable.h.

float vtkLookupTable::HueRange[2] [protected]

Definition at line 192 of file vtkLookupTable.h.

float vtkLookupTable::SaturationRange[2] [protected]

Definition at line 193 of file vtkLookupTable.h.

float vtkLookupTable::ValueRange[2] [protected]

Definition at line 194 of file vtkLookupTable.h.

float vtkLookupTable::AlphaRange[2] [protected]

Definition at line 195 of file vtkLookupTable.h.

vtkTimeStamp vtkLookupTable::InsertTime [protected]

Definition at line 196 of file vtkLookupTable.h.

vtkTimeStamp vtkLookupTable::BuildTime [protected]

Definition at line 197 of file vtkLookupTable.h.

float vtkLookupTable::RGBA[4] [protected]

Definition at line 198 of file vtkLookupTable.h.

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

common/vtkLookupTable.h

Generated on Wed Nov 21 12:52:51 2001 for VTK by

vtkLookupTable Class Reference

Public Methods

Static Public Methods

Protected Methods

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation