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.
- See also:
- vtkLogLookupTable vtkWindowLevelLookupTable
- Examples:
- vtkLookupTable (Examples)
- Tests:
- vtkLookupTable (Tests)
Definition at line 47 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) |
int | Allocate (int sz=256, int ext=256) |
virtual void | Build () |
virtual void | ForceBuild () |
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]) |
unsigned char * | MapValue (double v) |
double * | GetColor (double x) |
void | GetColor (double x, double rgb[3]) |
double | GetOpacity (double v) |
virtual vtkIdType | GetIndex (double v) |
void | SetNumberOfTableValues (vtkIdType number) |
vtkIdType | GetNumberOfTableValues () |
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 * | GetPointer (const vtkIdType id) |
unsigned char * | WritePointer (const vtkIdType id, const int number) |
double * | GetRange () |
void | SetRange (double min, double max) |
void | SetRange (double rng[2]) |
virtual void | SetNumberOfColors (vtkIdType) |
virtual vtkIdType | GetNumberOfColors () |
void | MapScalarsThroughTable2 (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputIncrement) |
void | DeepCopy (vtkLookupTable *lut) |
Static Public Member Functions |
static vtkLookupTable * | New () |
static int | IsTypeOf (const char *type) |
static vtkLookupTable * | SafeDownCast (vtkObject *o) |
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] |
int | Scale |
int | Ramp |
vtkTimeStamp | InsertTime |
vtkTimeStamp | BuildTime |
double | RGBA [4] |
Member Typedef Documentation
Constructor & Destructor Documentation
vtkLookupTable::vtkLookupTable |
( |
int |
sze = 256 , |
|
|
int |
ext = 256 |
|
) |
[protected] |
|
vtkLookupTable::~vtkLookupTable |
( |
|
) |
[protected] |
|
Member Function Documentation
virtual const char* vtkLookupTable::GetClassName |
( |
|
) |
[virtual] |
|
static int vtkLookupTable::IsTypeOf |
( |
const char * |
type |
) |
[static] |
|
virtual int vtkLookupTable::IsA |
( |
const char * |
type |
) |
[virtual] |
|
void vtkLookupTable::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
[virtual] |
|
int vtkLookupTable::Allocate |
( |
int |
sz = 256 , |
|
|
int |
ext = 256 |
|
) |
|
|
|
Allocate a color table of specified size. |
virtual void vtkLookupTable::Build |
( |
|
) |
[virtual] |
|
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] |
|
void vtkLookupTable::SetRampToSCurve |
( |
|
) |
[inline] |
|
void vtkLookupTable::SetRampToSQRT |
( |
|
) |
[inline] |
|
virtual int vtkLookupTable::GetRamp |
( |
|
) |
[virtual] |
|
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] |
|
void vtkLookupTable::SetScaleToLog10 |
( |
|
) |
[inline] |
|
virtual int vtkLookupTable::GetScale |
( |
|
) |
[virtual] |
|
void vtkLookupTable::SetTableRange |
( |
double |
r[2] |
) |
|
|
virtual void vtkLookupTable::SetTableRange |
( |
double |
min, |
|
|
double |
max |
|
) |
[virtual] |
|
virtual double* vtkLookupTable::GetTableRange |
( |
|
) |
[virtual] |
|
virtual void vtkLookupTable::GetTableRange |
( |
double |
data[2] |
) |
[virtual] |
|
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] |
) |
|
|
virtual double* vtkLookupTable::GetHueRange |
( |
|
) |
[virtual] |
|
virtual void vtkLookupTable::GetHueRange |
( |
double & |
, |
|
|
double & |
|
|
) |
[virtual] |
|
virtual void vtkLookupTable::GetHueRange |
( |
double |
[2] |
) |
[virtual] |
|
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] |
) |
|
|
virtual double* vtkLookupTable::GetSaturationRange |
( |
|
) |
[virtual] |
|
virtual void vtkLookupTable::GetSaturationRange |
( |
double & |
, |
|
|
double & |
|
|
) |
[virtual] |
|
virtual void vtkLookupTable::GetSaturationRange |
( |
double |
[2] |
) |
[virtual] |
|
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] |
) |
|
|
virtual double* vtkLookupTable::GetValueRange |
( |
|
) |
[virtual] |
|
virtual void vtkLookupTable::GetValueRange |
( |
double & |
, |
|
|
double & |
|
|
) |
[virtual] |
|
virtual void vtkLookupTable::GetValueRange |
( |
double |
[2] |
) |
[virtual] |
|
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] |
) |
|
|
virtual double* vtkLookupTable::GetAlphaRange |
( |
|
) |
[virtual] |
|
virtual void vtkLookupTable::GetAlphaRange |
( |
double & |
, |
|
|
double & |
|
|
) |
[virtual] |
|
virtual void vtkLookupTable::GetAlphaRange |
( |
double |
[2] |
) |
[virtual] |
|
unsigned char* vtkLookupTable::MapValue |
( |
double |
v |
) |
[virtual] |
|
double* vtkLookupTable::GetColor |
( |
double |
x |
) |
[inline] |
|
void vtkLookupTable::GetColor |
( |
double |
x, |
|
|
double |
rgb[3] |
|
) |
[virtual] |
|
|
Map one value through the lookup table and return the color as an RGB array of doubles between 0 and 1.
Implements vtkScalarsToColors. |
double vtkLookupTable::GetOpacity |
( |
double |
v |
) |
|
|
|
Map one value through the lookup table and return the alpha value (the opacity) as a double between 0 and 1. |
virtual vtkIdType vtkLookupTable::GetIndex |
( |
double |
v |
) |
[virtual] |
|
|
Return the table index associated with a particular value. |
void vtkLookupTable::SetNumberOfTableValues |
( |
vtkIdType |
number |
) |
|
|
|
Specify the number of values (i.e., colors) in the lookup table. |
vtkIdType vtkLookupTable::GetNumberOfTableValues |
( |
|
) |
[inline] |
|
void vtkLookupTable::SetTableValue |
( |
vtkIdType |
indx, |
|
|
double |
rgba[4] |
|
) |
|
|
|
Directly load color into lookup table. Use [0,1] double 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 |
( |
vtkIdType |
indx, |
|
|
double |
r, |
|
|
double |
g, |
|
|
double |
b, |
|
|
double |
a = 1.0 |
|
) |
|
|
|
Directly load color into lookup table. Use [0,1] double values for color component specification. |
double* vtkLookupTable::GetTableValue |
( |
vtkIdType |
id |
) |
|
|
|
Return a rgba color value for the given index into the lookup table. Color components are expressed as [0,1] double values. |
void vtkLookupTable::GetTableValue |
( |
vtkIdType |
id, |
|
|
double |
rgba[4] |
|
) |
|
|
|
Return a rgba color value for the given index into the lookup table. Color components are expressed as [0,1] double values. |
unsigned char* vtkLookupTable::GetPointer |
( |
const vtkIdType |
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 178 of file vtkLookupTable.h. |
unsigned char * vtkLookupTable::WritePointer |
( |
const vtkIdType |
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 237 of file vtkLookupTable.h.
References Table, and vtkUnsignedCharArray::WritePointer(). |
double* vtkLookupTable::GetRange |
( |
|
) |
[inline, virtual] |
|
void vtkLookupTable::SetRange |
( |
double |
min, |
|
|
double |
max |
|
) |
[inline, virtual] |
|
void vtkLookupTable::SetRange |
( |
double |
rng[2] |
) |
[inline] |
|
virtual void vtkLookupTable::SetNumberOfColors |
( |
vtkIdType |
|
) |
[virtual] |
|
|
Set the number of colors in the lookup table. Use SetNumberOfTableValues() instead, it can be used both before and after the table has been built whereas SetNumberOfColors() has no effect after the table has been built. |
virtual vtkIdType vtkLookupTable::GetNumberOfColors |
( |
|
) |
[virtual] |
|
void vtkLookupTable::MapScalarsThroughTable2 |
( |
void * |
input, |
|
|
unsigned char * |
output, |
|
|
int |
inputDataType, |
|
|
int |
numberOfValues, |
|
|
int |
inputIncrement, |
|
|
int |
outputIncrement |
|
) |
[virtual] |
|
|
Copy the contents from another LookupTable |
Member Data Documentation
The documentation for this class was generated from the following file: