vtkLookupTable Class Reference

#include <vtkLookupTable.h>

Inheritance diagram for vtkLookupTable:

[legend]

Collaboration diagram for vtkLookupTable:

[legend]

List of all members.

Detailed Description

map scalar values into colors via a lookup table

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.

Warning:: You need to explicitly call Build() when constructing the LUT by hand.

See also:: vtkLogLookupTable vtkWindowLevelLookupTable

Examples:: vtkLookupTable (Examples)

Tests:: vtkLookupTable (Tests)

Definition at line 50 of file vtkLookupTable.h.


Public Types
typedef vtkScalarsToColors	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	IsOpaque ()
int	Allocate (int sz=256, int ext=256)
virtual void	Build ()
virtual void	ForceBuild ()
unsigned char *	MapValue (double v)
void	GetColor (double x, double rgb[3])
double	GetOpacity (double v)
virtual vtkIdType	GetIndex (double v)
void	SetTableValue (vtkIdType indx, double rgba[4])
void	SetTableValue (vtkIdType indx, double r, double g, double b, double a=1.0)
double *	GetTableValue (vtkIdType id)
void	GetTableValue (vtkIdType id, double rgba[4])
unsigned char *	WritePointer (const vtkIdType id, const int number)
void	DeepCopy (vtkLookupTable *lut)
virtual vtkIdType	GetNumberOfAvailableColors ()

virtual void	SetRamp (int)
void	SetRampToLinear ()
void	SetRampToSCurve ()
void	SetRampToSQRT ()
virtual int	GetRamp ()

void	SetScale (int scale)
void	SetScaleToLinear ()
void	SetScaleToLog10 ()
virtual int	GetScale ()

void	SetTableRange (double r[2])
virtual void	SetTableRange (double min, double max)
virtual double *	GetTableRange ()
virtual void	GetTableRange (double data[2])

virtual void	SetHueRange (double, double)
void	SetHueRange (double[2])
virtual double *	GetHueRange ()
virtual void	GetHueRange (double &, double &)
virtual void	GetHueRange (double[2])

virtual void	SetSaturationRange (double, double)
void	SetSaturationRange (double[2])
virtual double *	GetSaturationRange ()
virtual void	GetSaturationRange (double &, double &)
virtual void	GetSaturationRange (double[2])

virtual void	SetValueRange (double, double)
void	SetValueRange (double[2])
virtual double *	GetValueRange ()
virtual void	GetValueRange (double &, double &)
virtual void	GetValueRange (double[2])

virtual void	SetAlphaRange (double, double)
void	SetAlphaRange (double[2])
virtual double *	GetAlphaRange ()
virtual void	GetAlphaRange (double &, double &)
virtual void	GetAlphaRange (double[2])

virtual void	SetNanColor (double, double, double, double)
virtual void	SetNanColor (double[4])
virtual double *	GetNanColor ()
virtual void	GetNanColor (double &, double &, double &, double &)
virtual void	GetNanColor (double[4])

void	SetNumberOfTableValues (vtkIdType number)
vtkIdType	GetNumberOfTableValues ()

unsigned char *	GetPointer (const vtkIdType id)

double *	GetRange ()
void	SetRange (double min, double max)
void	SetRange (double rng[2])

virtual void	SetNumberOfColors (vtkIdType)
virtual vtkIdType	GetNumberOfColors ()

void	SetTable (vtkUnsignedCharArray *)
virtual vtkUnsignedCharArray *	GetTable ()

void	MapScalarsThroughTable2 (void input, unsigned char output, int inputDataType, int numberOfValues, int inputIncrement, int outputIncrement)

virtual int	UsingLogScale ()
Static Public Member Functions
static vtkLookupTable *	New ()
static int	IsTypeOf (const char *type)
static vtkLookupTable *	SafeDownCast (vtkObject *o)
static void	GetLogRange (const double range[2], double log_range[2])

static double	ApplyLogScale (double v, const double range[2], const double log_range[2])
Protected Member Functions
	vtkLookupTable (int sze=256, int ext=256)
	~vtkLookupTable ()
Protected Attributes
vtkIdType	NumberOfColors
vtkUnsignedCharArray *	Table
double	TableRange [2]
double	HueRange [2]
double	SaturationRange [2]
double	ValueRange [2]
double	AlphaRange [2]
double	NanColor [4]
int	Scale
int	Ramp
vtkTimeStamp	InsertTime
vtkTimeStamp	BuildTime
double	RGBA [4]
int	OpaqueFlag
vtkTimeStamp	OpaqueFlagBuildTime

Member Typedef Documentation

typedef vtkScalarsToColors vtkLookupTable::Superclass

Reimplemented from vtkScalarsToColors.

Reimplemented in vtkLogLookupTable, vtkLookupTableWithEnabling, and vtkWindowLevelLookupTable.

Definition at line 57 of file vtkLookupTable.h.

Constructor & Destructor Documentation

vtkLookupTable::vtkLookupTable	(	int	sze = `256`,
		int	ext = `256`
	)			`[protected]`

vtkLookupTable::~vtkLookupTable ( ) [protected]

Member Function Documentation

static 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, vtkLookupTableWithEnabling, and vtkWindowLevelLookupTable.

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

Reimplemented from vtkScalarsToColors.

Reimplemented in vtkLogLookupTable, vtkLookupTableWithEnabling, and vtkWindowLevelLookupTable.

static int vtkLookupTable::IsTypeOf ( const char * name ) [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, vtkLookupTableWithEnabling, and vtkWindowLevelLookupTable.

virtual int vtkLookupTable::IsA ( const char * name ) [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, vtkLookupTableWithEnabling, and vtkWindowLevelLookupTable.

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

Reimplemented from vtkScalarsToColors.

Reimplemented in vtkLogLookupTable, vtkLookupTableWithEnabling, 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 vtkScalarsToColors.

Reimplemented in vtkLogLookupTable, vtkLookupTableWithEnabling, and vtkWindowLevelLookupTable.

virtual int vtkLookupTable::IsOpaque ( ) [virtual]

Return true if all of the values defining the mapping have an opacity equal to 1. Default implementation return true.

Reimplemented from vtkScalarsToColors.

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::ForceBuild ( ) [virtual]

Force the lookup table to regenerate from hue, saturation, value, and alpha min/max values. Table is built from a linear ramp of each value. ForceBuild() is useful if a lookup table has been defined manually (using SetTableValue) and then an application decides to rebuild the lookup table using the implicit process.

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

Set the shape of the table ramp to either linear or S-curve. The default is S-curve, which tails off gradually at either end. The equation used for the S-curve is y = (sin((x - 1/2)*pi) + 1)/2, while the equation for the linear ramp is simply y = x. For an S-curve greyscale ramp, you should set NumberOfTableValues to 402 (which is 256*pi/2) to provide room for the tails of the ramp. The equation for the SQRT is y = sqrt(x).

void vtkLookupTable::SetRampToLinear ( ) [inline]

Set the shape of the table ramp to either linear or S-curve. The default is S-curve, which tails off gradually at either end. The equation used for the S-curve is y = (sin((x - 1/2)*pi) + 1)/2, while the equation for the linear ramp is simply y = x. For an S-curve greyscale ramp, you should set NumberOfTableValues to 402 (which is 256*pi/2) to provide room for the tails of the ramp. The equation for the SQRT is y = sqrt(x).

Definition at line 87 of file vtkLookupTable.h.

void vtkLookupTable::SetRampToSCurve ( ) [inline]

Set the shape of the table ramp to either linear or S-curve. The default is S-curve, which tails off gradually at either end. The equation used for the S-curve is y = (sin((x - 1/2)*pi) + 1)/2, while the equation for the linear ramp is simply y = x. For an S-curve greyscale ramp, you should set NumberOfTableValues to 402 (which is 256*pi/2) to provide room for the tails of the ramp. The equation for the SQRT is y = sqrt(x).

Definition at line 88 of file vtkLookupTable.h.

void vtkLookupTable::SetRampToSQRT ( ) [inline]

Set the shape of the table ramp to either linear or S-curve. The default is S-curve, which tails off gradually at either end. The equation used for the S-curve is y = (sin((x - 1/2)*pi) + 1)/2, while the equation for the linear ramp is simply y = x. For an S-curve greyscale ramp, you should set NumberOfTableValues to 402 (which is 256*pi/2) to provide room for the tails of the ramp. The equation for the SQRT is y = sqrt(x).

Definition at line 89 of file vtkLookupTable.h.

virtual int vtkLookupTable::GetRamp ( ) [virtual]

Set the shape of the table ramp to either linear or S-curve. The default is S-curve, which tails off gradually at either end. The equation used for the S-curve is y = (sin((x - 1/2)*pi) + 1)/2, while the equation for the linear ramp is simply y = x. For an S-curve greyscale ramp, you should set NumberOfTableValues to 402 (which is 256*pi/2) to provide room for the tails of the ramp. The equation for the SQRT is y = sqrt(x).

void vtkLookupTable::SetScale ( int scale )

Set the type of scale to use, linear or logarithmic. The default is linear. If the scale is logarithmic, then the TableRange must not cross the value zero.

void vtkLookupTable::SetScaleToLinear ( ) [inline]

Set the type of scale to use, linear or logarithmic. The default is linear. If the scale is logarithmic, then the TableRange must not cross the value zero.

Definition at line 98 of file vtkLookupTable.h.

void vtkLookupTable::SetScaleToLog10 ( ) [inline]

Set the type of scale to use, linear or logarithmic. The default is linear. If the scale is logarithmic, then the TableRange must not cross the value zero.

Definition at line 99 of file vtkLookupTable.h.

virtual int vtkLookupTable::GetScale ( ) [virtual]

Set the type of scale to use, linear or logarithmic. The default is linear. If the scale is logarithmic, then the TableRange must not cross the value zero.

void vtkLookupTable::SetTableRange ( double 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.

virtual void vtkLookupTable::SetTableRange	(	double	min,
		double	max
	)			`[virtual]`

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.

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

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.

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

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.

virtual void vtkLookupTable::SetHueRange	(	double	,
		double
	)			`[virtual]`

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

void vtkLookupTable::SetHueRange ( double [2] )

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

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

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

virtual void vtkLookupTable::GetHueRange	(	double &	,
		double &
	)			`[virtual]`

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

virtual void vtkLookupTable::GetHueRange ( double [2] ) [virtual]

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

virtual void vtkLookupTable::SetSaturationRange	(	double	,
		double
	)			`[virtual]`

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

void vtkLookupTable::SetSaturationRange ( double [2] )

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

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

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

virtual void vtkLookupTable::GetSaturationRange	(	double &	,
		double &
	)			`[virtual]`

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

virtual void vtkLookupTable::GetSaturationRange ( double [2] ) [virtual]

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

virtual void vtkLookupTable::SetValueRange	(	double	,
		double
	)			`[virtual]`

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

void vtkLookupTable::SetValueRange ( double [2] )

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

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

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

virtual void vtkLookupTable::GetValueRange	(	double &	,
		double &
	)			`[virtual]`

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

virtual void vtkLookupTable::GetValueRange ( double [2] ) [virtual]

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

virtual void vtkLookupTable::SetAlphaRange	(	double	,
		double
	)			`[virtual]`

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

void vtkLookupTable::SetAlphaRange ( double [2] )

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

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

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

virtual void vtkLookupTable::GetAlphaRange	(	double &	,
		double &
	)			`[virtual]`

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

virtual void vtkLookupTable::GetAlphaRange ( double [2] ) [virtual]

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

virtual void vtkLookupTable::SetNanColor	(	double	,
		double	,
		double	,
		double
	)			`[virtual]`