VTK
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
vtkLookupTable Class Reference

map scalar values into colors via a lookup table More...

#include <vtkLookupTable.h>

Inheritance diagram for vtkLookupTable:
[legend]
Collaboration diagram for vtkLookupTable:
[legend]

Public Types

typedef vtkScalarsToColors Superclass
 
- Public Types inherited from vtkScalarsToColors
enum  VectorModes { MAGNITUDE = 0, COMPONENT = 1, RGBCOLORS = 2 }
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkLookupTableNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int IsOpaque () override
 Return true if all of the values defining the mapping have an opacity equal to 1. More...
 
int IsOpaque (vtkAbstractArray *scalars, int colorMode, int component) override
 
int Allocate (int sz=256, int ext=256)
 Allocate a color table of specified size. More...
 
void Build () override
 Generate lookup table from hue, saturation, value, alpha min/max values. More...
 
virtual void ForceBuild ()
 Force the lookup table to regenerate from hue, saturation, value, and alpha min/max values. More...
 
void BuildSpecialColors ()
 Copies the "special" colors into the given table. More...
 
virtual void SetRamp (int)
 Set the shape of the table ramp to either S-curve, linear, or sqrt. More...
 
void SetRampToLinear ()
 
void SetRampToSCurve ()
 
void SetRampToSQRT ()
 
virtual int GetRamp ()
 
void SetScale (int scale)
 Set the type of scale to use, linear or logarithmic. More...
 
void SetScaleToLinear ()
 
void SetScaleToLog10 ()
 
virtual int GetScale ()
 
virtual void SetTableRange (const double r[2])
 Set/Get the minimum/maximum scalar values for scalar mapping. More...
 
virtual void SetTableRange (double min, double max)
 
virtual double * GetTableRange ()
 
virtual void GetTableRange (double data[2])
 
virtual void SetHueRange (double, double)
 Set the range in hue (using automatic generation). More...
 
void SetHueRange (double[2])
 
virtual double * GetHueRange ()
 
virtual void GetHueRange (double &, double &)
 
virtual void GetHueRange (double[2])
 
virtual void SetSaturationRange (double, double)
 Set the range in saturation (using automatic generation). More...
 
void SetSaturationRange (double[2])
 
virtual double * GetSaturationRange ()
 
virtual void GetSaturationRange (double &, double &)
 
virtual void GetSaturationRange (double[2])
 
virtual void SetValueRange (double, double)
 Set the range in value (using automatic generation). More...
 
void SetValueRange (double[2])
 
virtual double * GetValueRange ()
 
virtual void GetValueRange (double &, double &)
 
virtual void GetValueRange (double[2])
 
virtual void SetAlphaRange (double, double)
 Set the range in alpha (using automatic generation). More...
 
void SetAlphaRange (double[2])
 
virtual double * GetAlphaRange ()
 
virtual void GetAlphaRange (double &, double &)
 
virtual void GetAlphaRange (double[2])
 
virtual void SetNanColor (double, double, double, double)
 Set the color to use when a NaN (not a number) is encountered. More...
 
virtual void SetNanColor (double[4])
 
virtual double * GetNanColor ()
 
virtual void GetNanColor (double &, double &, double &, double &)
 
virtual void GetNanColor (double[4])
 
unsigned char * GetNanColorAsUnsignedChars ()
 Return the NanColor as a pointer to 4 unsigned chars. More...
 
virtual void SetBelowRangeColor (double, double, double, double)
 Set the color to use when a value below the range is encountered. More...
 
virtual void SetBelowRangeColor (double[4])
 
virtual double * GetBelowRangeColor ()
 
virtual void GetBelowRangeColor (double &, double &, double &, double &)
 
virtual void GetBelowRangeColor (double[4])
 
virtual void SetUseBelowRangeColor (vtkTypeBool)
 Set whether the below range color should be used. More...
 
virtual vtkTypeBool GetUseBelowRangeColor ()
 
virtual void UseBelowRangeColorOn ()
 
virtual void UseBelowRangeColorOff ()
 
virtual void SetAboveRangeColor (double, double, double, double)
 Set the color to use when a value above the range is encountered. More...
 
virtual void SetAboveRangeColor (double[4])
 
virtual double * GetAboveRangeColor ()
 
virtual void GetAboveRangeColor (double &, double &, double &, double &)
 
virtual void GetAboveRangeColor (double[4])
 
virtual void SetUseAboveRangeColor (vtkTypeBool)
 Set whether the above range color should be used. More...
 
virtual vtkTypeBool GetUseAboveRangeColor ()
 
virtual void UseAboveRangeColorOn ()
 
virtual void UseAboveRangeColorOff ()
 
const unsigned char * MapValue (double v) override
 Map one value through the lookup table, returning an RBGA[4] color. More...
 
void GetColor (double x, double rgb[3]) override
 Map one value through the lookup table and return the color as an RGB[3] array of doubles between 0 and 1. More...
 
double GetOpacity (double v) override
 Map one value through the lookup table and return the alpha value (the opacity) as a double between 0 and 1. More...
 
virtual vtkIdType GetIndex (double v)
 Return the table index associated with a particular value. More...
 
void SetNumberOfTableValues (vtkIdType number)
 Specify the number of values (i.e., colors) in the lookup table. More...
 
vtkIdType GetNumberOfTableValues ()
 
virtual void SetTableValue (vtkIdType indx, const double rgba[4])
 Directly load color into lookup table. More...
 
virtual void SetTableValue (vtkIdType indx, double r, double g, double b, double a=1.0)
 Directly load color into lookup table. More...
 
double * GetTableValue (vtkIdType id)
 Return an RGBA color value for the given index into the lookup table. More...
 
void GetTableValue (vtkIdType id, double rgba[4])
 Return an RGBA color value for the given index into the lookup table. More...
 
unsigned char * GetPointer (vtkIdType id)
 Get pointer to color table data. More...
 
unsigned char * WritePointer (vtkIdType id, int number)
 Get pointer to data. More...
 
double * GetRange () override
 Sets/Gets the range of scalars which will be mapped. More...
 
void SetRange (double min, double max) override
 
void SetRange (const double rng[2]) override
 
virtual void SetNumberOfColors (vtkIdType)
 Set the number of colors in the lookup table. More...
 
virtual vtkIdType GetNumberOfColors ()
 
void SetTable (vtkUnsignedCharArray *)
 Set/Get the internal table array that is used to map the scalars to colors. More...
 
virtual vtkUnsignedCharArrayGetTable ()
 
void MapScalarsThroughTable2 (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputIncrement) override
 Map a set of scalars through the lookup table. More...
 
void DeepCopy (vtkScalarsToColors *lut) override
 Copy the contents from another LookupTable. More...
 
int UsingLogScale () override
 This should return 1 if the subclass is using log scale for mapping scalars to colors. More...
 
vtkIdType GetNumberOfAvailableColors () override
 Get the number of available colors for mapping to. More...
 
void GetIndexedColor (vtkIdType idx, double rgba[4]) override
 Return a color given an integer index. More...
 
- Public Member Functions inherited from vtkScalarsToColors
vtkScalarsToColorsNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
double * GetColor (double v)
 Map one value through the lookup table and return the color as an RGB array of doubles between 0 and 1. More...
 
double GetLuminance (double x)
 Map one value through the lookup table and return the luminance 0.3*red + 0.59*green + 0.11*blue as a double between 0 and 1. More...
 
virtual void SetAlpha (double alpha)
 Specify an additional opacity (alpha) value to blend with. More...
 
virtual double GetAlpha ()
 
virtual vtkUnsignedCharArrayMapScalars (vtkDataArray *scalars, int colorMode, int component, int outputFormat=VTK_RGBA)
 Internal methods that map a data array into an unsigned char array. More...
 
virtual vtkUnsignedCharArrayMapScalars (vtkAbstractArray *scalars, int colorMode, int component, int outputFormat=VTK_RGBA)
 
virtual void SetVectorMode (int)
 Change mode that maps vectors by magnitude vs. More...
 
virtual int GetVectorMode ()
 
void SetVectorModeToMagnitude ()
 
void SetVectorModeToComponent ()
 
void SetVectorModeToRGBColors ()
 
virtual void SetVectorComponent (int)
 If the mapper does not select which component of a vector to map to colors, you can specify it here. More...
 
virtual int GetVectorComponent ()
 
virtual void SetVectorSize (int)
 When mapping vectors, consider only the number of components selected by VectorSize to be part of the vector, and ignore any other components. More...
 
virtual int GetVectorSize ()
 
void MapVectorsThroughTable (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat, int vectorComponent, int vectorSize)
 Map vectors through the lookup table. More...
 
void MapVectorsThroughTable (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat)
 
void MapScalarsThroughTable (vtkDataArray *scalars, unsigned char *output, int outputFormat)
 Map a set of scalars through the lookup table in a single operation. More...
 
void MapScalarsThroughTable (vtkDataArray *scalars, unsigned char *output)
 
void MapScalarsThroughTable (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat)
 
virtual void SetAnnotations (vtkAbstractArray *values, vtkStringArray *annotations)
 Set a list of discrete values, either as a categorical set of values (when IndexedLookup is true) or as a set of annotations to add to a scalar array (when IndexedLookup is false). More...
 
virtual vtkAbstractArrayGetAnnotatedValues ()
 
virtual vtkStringArrayGetAnnotations ()
 
virtual vtkIdType SetAnnotation (vtkVariant value, vtkStdString annotation)
 Add a new entry (or change an existing entry) to the list of annotated values. More...
 
virtual vtkIdType SetAnnotation (vtkStdString value, vtkStdString annotation)
 This variant of SetAnnotation accepts the value as a string so ParaView can treat annotations as string vector arrays. More...
 
vtkIdType GetNumberOfAnnotatedValues ()
 Return the annotated value at a particular index in the list of annotations. More...
 
vtkVariant GetAnnotatedValue (vtkIdType idx)
 Return the annotated value at a particular index in the list of annotations. More...
 
vtkStdString GetAnnotation (vtkIdType idx)
 Return the annotation at a particular index in the list of annotations. More...
 
virtual void GetAnnotationColor (const vtkVariant &val, double rgba[4])
 Obtain the color associated with a particular annotated value (or NanColor if unmatched). More...
 
vtkIdType GetAnnotatedValueIndex (vtkVariant val)
 Return the index of the given value in the list of annotated values (or -1 if not present). More...
 
vtkIdType GetAnnotatedValueIndexInternal (const vtkVariant &val)
 Look up an index into the array of annotations given a value. More...
 
virtual bool RemoveAnnotation (vtkVariant value)
 Remove an existing entry from the list of annotated values. More...
 
virtual void ResetAnnotations ()
 Remove all existing values and their annotations. More...
 
virtual void SetIndexedLookup (vtkTypeBool)
 Set/get whether the lookup table is for categorical or ordinal data. More...
 
virtual vtkTypeBool GetIndexedLookup ()
 
virtual void IndexedLookupOn ()
 
virtual void IndexedLookupOff ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkLookupTableNew ()
 Construct with range=[0,1]; and hsv ranges set up for rainbow color table (from red to blue). More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkLookupTableSafeDownCast (vtkObjectBase *o)
 
static void GetColorAsUnsignedChars (const double colorIn[4], unsigned char colorOut[4])
 Given an RGBA[4] color in the [0,1] range, convert it to RGBA[4] in the [0,255] range. More...
 
static void GetLogRange (const double range[2], double log_range[2])
 Returns the log of range in log_range. More...
 
static double ApplyLogScale (double v, const double range[2], const double log_range[2])
 Apply log to value, with appropriate constraints. More...
 
- Static Public Member Functions inherited from vtkScalarsToColors
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkScalarsToColorsSafeDownCast (vtkObjectBase *o)
 
static vtkScalarsToColorsNew ()
 
template<typename T >
static unsigned char ColorToUChar (T t)
 Converts a color from numeric type T to uchar. More...
 
template<typename T >
static void ColorToUChar (T t, unsigned char *dest)
 
template<>
unsigned char ColorToUChar (double t)
 Specializations of vtkScalarsToColors::ColorToUChar Converts from a color in a floating point type in range 0.0-1.0 to a uchar in range 0-255. More...
 
template<>
unsigned char ColorToUChar (float t)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Static Public Attributes

static const vtkIdType REPEATED_LAST_COLOR_INDEX
 Constants for offsets of special colors (e.g., NanColor, BelowRangeColor, AboveRangeColor) from the maximum index in the lookup table. More...
 
static const vtkIdType BELOW_RANGE_COLOR_INDEX
 
static const vtkIdType ABOVE_RANGE_COLOR_INDEX
 
static const vtkIdType NAN_COLOR_INDEX
 
static const vtkIdType NUMBER_OF_SPECIAL_COLORS
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkLookupTable (int sze=256, int ext=256)
 
 ~vtkLookupTable () override
 
void ResizeTableForSpecialColors ()
 Resize the LookupTable to have enough room for the out-of-range colors. More...
 
- Protected Member Functions inherited from vtkScalarsToColors
 vtkScalarsToColors ()
 
 ~vtkScalarsToColors () override
 
void MapColorsToColors (void *input, unsigned char *output, int inputDataType, int numberOfValues, int numberOfComponents, int vectorSize, int outputFormat)
 An internal method that assumes that the input already has the right colors, and only remaps the range to [0,255] and pads to the desired output format. More...
 
vtkUnsignedCharArrayConvertToRGBA (vtkDataArray *colors, int numComp, int numTuples)
 An internal method used to convert a color array to RGBA. More...
 
void MapVectorsToMagnitude (void *input, double *output, int inputDataType, int numberOfValues, int numberOfComponents, int vectorSize)
 An internal method for converting vectors to magnitudes, used as a preliminary step before doing magnitude mapping. More...
 
virtual vtkIdType CheckForAnnotatedValue (vtkVariant value)
 Allocate annotation arrays if needed, then return the index of the given value or -1 if not present. More...
 
virtual void UpdateAnnotatedValueMap ()
 Update the map from annotated values to indices in the array of annotations. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkIdType NumberOfColors
 
vtkUnsignedCharArrayTable
 
double TableRange [2]
 
double HueRange [2]
 
double SaturationRange [2]
 
double ValueRange [2]
 
double AlphaRange [2]
 
double NanColor [4]
 
double BelowRangeColor [4]
 
vtkTypeBool UseBelowRangeColor
 
double AboveRangeColor [4]
 
vtkTypeBool UseAboveRangeColor
 
int Scale
 
int Ramp
 
vtkTimeStamp InsertTime
 
vtkTimeStamp BuildTime
 
double RGBA [4]
 
unsigned char NanColorChar [4]
 
int OpaqueFlag
 
vtkTimeStamp OpaqueFlagBuildTime
 
vtkTimeStamp SpecialColorsBuildTime
 
- Protected Attributes inherited from vtkScalarsToColors
vtkAbstractArrayAnnotatedValues
 
vtkStringArrayAnnotations
 
vtkInternalAnnotatedValueMap * AnnotatedValueMap
 
vtkTypeBool IndexedLookup
 
double Alpha
 
int VectorMode
 
int VectorComponent
 
int VectorSize
 
int UseMagnitude
 
unsigned char RGBABytes [4]
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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) color specification, or RGBA into scalar values. The color table can be created by direct insertion of color values, or by specifying a hue, saturation, value, and alpha range and generating a table.

A special color for NaN values in the data can be specified via SetNanColor(). In addition, a color for data values below the lookup table range minimum can be specified with SetBelowRangeColor(), and that color will be used for values below the range minimum when UseBelowRangeColor is on. Likewise, a color for data values above the lookup table range maximum can be specified with SetAboveRangeColor(), and it is used when UseAboveRangeColor is on.

This class behaves differently depending on how IndexedLookup is set. When true, vtkLookupTable enters a mode for representing categorical color maps. By setting IndexedLookup to true, you indicate that the annotated values are the only valid values for which entries in the color table should be returned. The colors in the lookup Table are assigned to annotated values by taking the modulus of their index in the list of annotations. IndexedLookup changes the behavior of GetIndex, which in turn changes the way MapScalarsThroughTable2 behaves; when IndexedLookup is true, MapScalarsThroughTable2 will search for scalar values in AnnotatedValues and use the resulting index to determine the color. If a scalar value is not present in AnnotatedValues, then NanColor will be used.

Warning
You need to explicitly call Build() when constructing the LUT by hand.
See also
vtkLogLookupTable vtkWindowLevelLookupTable

Definition at line 68 of file vtkLookupTable.h.

Member Typedef Documentation

◆ Superclass

Definition at line 90 of file vtkLookupTable.h.

Constructor & Destructor Documentation

◆ vtkLookupTable()

vtkLookupTable::vtkLookupTable ( int  sze = 256,
int  ext = 256 
)
protected

◆ ~vtkLookupTable()

vtkLookupTable::~vtkLookupTable ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkLookupTable* vtkLookupTable::New ( )
static

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

◆ IsTypeOf()

static vtkTypeBool vtkLookupTable::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool 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 vtkLookupTableWithEnabling, vtkWindowLevelLookupTable, and vtkLogLookupTable.

◆ SafeDownCast()

static vtkLookupTable* vtkLookupTable::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkLookupTable::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkLookupTable* vtkLookupTable::NewInstance ( ) const

◆ PrintSelf()

void vtkLookupTable::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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 vtkObjectBase.

Reimplemented in vtkLookupTableWithEnabling, vtkWindowLevelLookupTable, and vtkLogLookupTable.

◆ IsOpaque() [1/2]

int vtkLookupTable::IsOpaque ( )
overridevirtual

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

Reimplemented from vtkScalarsToColors.

◆ IsOpaque() [2/2]

int vtkLookupTable::IsOpaque ( vtkAbstractArray scalars,
int  colorMode,
int  component 
)
overridevirtual

Reimplemented from vtkScalarsToColors.

◆ Allocate()

int vtkLookupTable::Allocate ( int  sz = 256,
int  ext = 256 
)

Allocate a color table of specified size.

Note that ext is no longer used.

◆ Build()

void vtkLookupTable::Build ( )
overridevirtual

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.

◆ ForceBuild()

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.

◆ BuildSpecialColors()

void vtkLookupTable::BuildSpecialColors ( )

Copies the "special" colors into the given table.

◆ SetRamp()

virtual void vtkLookupTable::SetRamp ( int  )
virtual

Set the shape of the table ramp to either S-curve, linear, or sqrt.

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, 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 linear ramp is simply y = x.

The equation for the SQRT is y = sqrt(x).

◆ SetRampToLinear()

void vtkLookupTable::SetRampToLinear ( )
inline

Definition at line 142 of file vtkLookupTable.h.

◆ SetRampToSCurve()

void vtkLookupTable::SetRampToSCurve ( )
inline

Definition at line 143 of file vtkLookupTable.h.

◆ SetRampToSQRT()

void vtkLookupTable::SetRampToSQRT ( )
inline

Definition at line 144 of file vtkLookupTable.h.

◆ GetRamp()

virtual int vtkLookupTable::GetRamp ( )
virtual

◆ SetScale()

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.

◆ SetScaleToLinear()

void vtkLookupTable::SetScaleToLinear ( )
inline

Definition at line 155 of file vtkLookupTable.h.

◆ SetScaleToLog10()

void vtkLookupTable::SetScaleToLog10 ( )
inline

Definition at line 156 of file vtkLookupTable.h.

◆ GetScale()

virtual int vtkLookupTable::GetScale ( )
virtual

◆ SetTableRange() [1/2]

virtual void vtkLookupTable::SetTableRange ( const double  r[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.

The TableRange values are only used when IndexedLookup is false.

◆ SetTableRange() [2/2]

virtual void vtkLookupTable::SetTableRange ( double  min,
double  max 
)
virtual

◆ GetTableRange() [1/2]

virtual double* vtkLookupTable::GetTableRange ( )
virtual

◆ GetTableRange() [2/2]

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

◆ SetHueRange() [1/2]

virtual void vtkLookupTable::SetHueRange ( double  ,
double   
)
virtual

Set the range in hue (using automatic generation).

Hue ranges between [0,1].

◆ SetHueRange() [2/2]

void vtkLookupTable::SetHueRange ( double  [2])

◆ GetHueRange() [1/3]

virtual double* vtkLookupTable::GetHueRange ( )
virtual

◆ GetHueRange() [2/3]

virtual void vtkLookupTable::GetHueRange ( double &  ,
double &   
)
virtual

◆ GetHueRange() [3/3]

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

◆ SetSaturationRange() [1/2]

virtual void vtkLookupTable::SetSaturationRange ( double  ,
double   
)
virtual

Set the range in saturation (using automatic generation).

Saturation ranges between [0,1].

◆ SetSaturationRange() [2/2]

void vtkLookupTable::SetSaturationRange ( double  [2])

◆ GetSaturationRange() [1/3]

virtual double* vtkLookupTable::GetSaturationRange ( )
virtual

◆ GetSaturationRange() [2/3]

virtual void vtkLookupTable::GetSaturationRange ( double &  ,
double &   
)
virtual

◆ GetSaturationRange() [3/3]

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

◆ SetValueRange() [1/2]

virtual void vtkLookupTable::SetValueRange ( double  ,
double   
)
virtual

Set the range in value (using automatic generation).

Value ranges between [0,1].

◆ SetValueRange() [2/2]

void vtkLookupTable::SetValueRange ( double  [2])

◆ GetValueRange() [1/3]

virtual double* vtkLookupTable::GetValueRange ( )
virtual

◆ GetValueRange() [2/3]

virtual void vtkLookupTable::GetValueRange ( double &  ,
double &   
)
virtual

◆ GetValueRange() [3/3]

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

◆ SetAlphaRange() [1/2]

virtual void vtkLookupTable::SetAlphaRange ( double  ,
double   
)
virtual

Set the range in alpha (using automatic generation).

Alpha ranges from [0,1].

◆ SetAlphaRange() [2/2]

void vtkLookupTable::SetAlphaRange ( double  [2])

◆ GetAlphaRange() [1/3]

virtual double* vtkLookupTable::GetAlphaRange ( )
virtual

◆ GetAlphaRange() [2/3]

virtual void vtkLookupTable::GetAlphaRange ( double &  ,
double &   
)
virtual

◆ GetAlphaRange() [3/3]

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

◆ SetNanColor() [1/2]

virtual void vtkLookupTable::SetNanColor ( double  ,
double  ,
double  ,
double   
)
virtual

Set the color to use when a NaN (not a number) is encountered.

This is an RGBA 4-tuple of doubles in the range [0,1].

◆ SetNanColor() [2/2]

virtual void vtkLookupTable::SetNanColor ( double  [4])
virtual

◆ GetNanColor() [1/3]

virtual double* vtkLookupTable::GetNanColor ( )
virtual

◆ GetNanColor() [2/3]

virtual void vtkLookupTable::GetNanColor ( double &  ,
double &  ,
double &  ,
double &   
)
virtual

◆ GetNanColor() [3/3]

virtual void vtkLookupTable::GetNanColor ( double  [4])
virtual

◆ GetNanColorAsUnsignedChars()

unsigned char* vtkLookupTable::GetNanColorAsUnsignedChars ( )

Return the NanColor as a pointer to 4 unsigned chars.

This will overwrite any data returned by previous calls to MapValue.

◆ GetColorAsUnsignedChars()

static void vtkLookupTable::GetColorAsUnsignedChars ( const double  colorIn[4],
unsigned char  colorOut[4] 
)
static

Given an RGBA[4] color in the [0,1] range, convert it to RGBA[4] in the [0,255] range.

◆ SetBelowRangeColor() [1/2]

virtual void vtkLookupTable::SetBelowRangeColor ( double  ,
double  ,
double  ,
double   
)
virtual

Set the color to use when a value below the range is encountered.

This is an RGBA 4-tuple of doubles in the range [0, 1].

◆ SetBelowRangeColor() [2/2]

virtual void vtkLookupTable::SetBelowRangeColor ( double  [4])
virtual

◆ GetBelowRangeColor() [1/3]

virtual double* vtkLookupTable::GetBelowRangeColor ( )
virtual

◆ GetBelowRangeColor() [2/3]

virtual void vtkLookupTable::GetBelowRangeColor ( double &  ,
double &  ,
double &  ,
double &   
)
virtual

◆ GetBelowRangeColor() [3/3]

virtual void vtkLookupTable::GetBelowRangeColor ( double  [4])
virtual

◆ SetUseBelowRangeColor()

virtual void vtkLookupTable::SetUseBelowRangeColor ( vtkTypeBool  )
virtual

Set whether the below range color should be used.

◆ GetUseBelowRangeColor()

virtual vtkTypeBool vtkLookupTable::GetUseBelowRangeColor ( )
virtual

◆ UseBelowRangeColorOn()

virtual void vtkLookupTable::UseBelowRangeColorOn ( )
virtual

◆ UseBelowRangeColorOff()

virtual void vtkLookupTable::UseBelowRangeColorOff ( )
virtual

◆ SetAboveRangeColor() [1/2]

virtual void vtkLookupTable::SetAboveRangeColor ( double  ,
double  ,
double  ,
double   
)
virtual

Set the color to use when a value above the range is encountered.

This is an RGBA 4-tuple of doubles in the range [0, 1].

◆ SetAboveRangeColor() [2/2]

virtual void vtkLookupTable::SetAboveRangeColor ( double  [4])
virtual

◆ GetAboveRangeColor() [1/3]

virtual double* vtkLookupTable::GetAboveRangeColor ( )
virtual

◆ GetAboveRangeColor() [2/3]

virtual void vtkLookupTable::GetAboveRangeColor ( double &  ,
double &  ,
double &  ,
double &   
)
virtual

◆ GetAboveRangeColor() [3/3]

virtual void vtkLookupTable::GetAboveRangeColor ( double  [4])
virtual

◆ SetUseAboveRangeColor()

virtual void vtkLookupTable::SetUseAboveRangeColor ( vtkTypeBool  )
virtual

Set whether the above range color should be used.

◆ GetUseAboveRangeColor()

virtual vtkTypeBool vtkLookupTable::GetUseAboveRangeColor ( )
virtual

◆ UseAboveRangeColorOn()

virtual void vtkLookupTable::UseAboveRangeColorOn ( )
virtual

◆ UseAboveRangeColorOff()

virtual void vtkLookupTable::UseAboveRangeColorOff ( )
virtual

◆ MapValue()

const unsigned char* vtkLookupTable::MapValue ( double  v)
overridevirtual

Map one value through the lookup table, returning an RBGA[4] color.

Reimplemented from vtkScalarsToColors.

◆ GetColor()

void vtkLookupTable::GetColor ( double  x,
double  rgb[3] 
)
overridevirtual

Map one value through the lookup table and return the color as an RGB[3] array of doubles between 0 and 1.

Note lack of alpha.

Reimplemented from vtkScalarsToColors.

◆ GetOpacity()

double vtkLookupTable::GetOpacity ( double  v)
overridevirtual

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

Reimplemented from vtkScalarsToColors.

◆ GetIndex()

virtual vtkIdType vtkLookupTable::GetIndex ( double  v)
virtual

Return the table index associated with a particular value.

Returns -1 if v is NaN.

Do not use this function when IndexedLookup is true: in that case, the set of values v may take on is exactly the integers from 0 to GetNumberOfTableValues() - 1; and v serves directly as an index into TableValues.

◆ SetNumberOfTableValues()

void vtkLookupTable::SetNumberOfTableValues ( vtkIdType  number)

Specify the number of values (i.e., colors) in the lookup table.

◆ GetNumberOfTableValues()

vtkIdType vtkLookupTable::GetNumberOfTableValues ( )
inline

Definition at line 299 of file vtkLookupTable.h.

◆ SetTableValue() [1/2]

virtual void vtkLookupTable::SetTableValue ( vtkIdType  indx,
const double  rgba[4] 
)
virtual

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.

◆ SetTableValue() [2/2]

virtual void vtkLookupTable::SetTableValue ( vtkIdType  indx,
double  r,
double  g,
double  b,
double  a = 1.0 
)
virtual

Directly load color into lookup table.

Use [0,1] double values for color component specification. Alpha defaults to 1 if unspecified.

◆ GetTableValue() [1/2]

double* vtkLookupTable::GetTableValue ( vtkIdType  id)

Return an RGBA color value for the given index into the lookup table.

Color components are expressed as [0,1] double values.

◆ GetTableValue() [2/2]

void vtkLookupTable::GetTableValue ( vtkIdType  id,
double  rgba[4] 
)

Return an RGBA color value for the given index into the lookup table.

Color components are expressed as [0,1] double values.

◆ GetPointer()

unsigned char* vtkLookupTable::GetPointer ( 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 332 of file vtkLookupTable.h.

◆ WritePointer()

unsigned char * vtkLookupTable::WritePointer ( vtkIdType  id,
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.

Warning
If you modify the table data via the pointer returned by this member function, you must call vtkLookupTable::BuildSpecialColors() afterwards to ensure that the special colors (below/above range and NaN value) are up-to-date.

Definition at line 462 of file vtkLookupTable.h.

◆ GetRange()

double* vtkLookupTable::GetRange ( )
inlineoverridevirtual

Sets/Gets the range of scalars which will be mapped.

This is a duplicate of Get/SetTableRange.

Reimplemented from vtkScalarsToColors.

Definition at line 351 of file vtkLookupTable.h.

◆ SetRange() [1/2]

void vtkLookupTable::SetRange ( double  min,
double  max 
)
inlineoverridevirtual

Reimplemented from vtkScalarsToColors.

Definition at line 352 of file vtkLookupTable.h.

◆ SetRange() [2/2]

void vtkLookupTable::SetRange ( const double  rng[2])
inlineoverridevirtual

Reimplemented from vtkScalarsToColors.

Definition at line 353 of file vtkLookupTable.h.

◆ GetLogRange()

static void vtkLookupTable::GetLogRange ( const double  range[2],
double  log_range[2] 
)
static

Returns the log of range in log_range.

There is a little more to this than simply taking the log10 of the two range values: we do conversion of negative ranges to positive ranges, and conversion of zero to a 'very small number'.

◆ ApplyLogScale()

static double vtkLookupTable::ApplyLogScale ( double  v,
const double  range[2],
const double  log_range[2] 
)
static

Apply log to value, with appropriate constraints.

◆ SetNumberOfColors()

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.

◆ GetNumberOfColors()

virtual vtkIdType vtkLookupTable::GetNumberOfColors ( )
virtual

◆ SetTable()

void vtkLookupTable::SetTable ( vtkUnsignedCharArray )

Set/Get the internal table array that is used to map the scalars to colors.

The table array is an unsigned char array with 4 components representing RGBA.

◆ GetTable()

virtual vtkUnsignedCharArray* vtkLookupTable::GetTable ( )
virtual

◆ MapScalarsThroughTable2()

void vtkLookupTable::MapScalarsThroughTable2 ( void *  input,
unsigned char *  output,
int  inputDataType,
int  numberOfValues,
int  inputIncrement,
int  outputIncrement 
)
overridevirtual

Map a set of scalars through the lookup table.

This member function is thread safe.

Reimplemented from vtkScalarsToColors.

Reimplemented in vtkLookupTableWithEnabling.

◆ DeepCopy()

void vtkLookupTable::DeepCopy ( vtkScalarsToColors lut)
overridevirtual

Copy the contents from another LookupTable.

Reimplemented from vtkScalarsToColors.

◆ UsingLogScale()

int vtkLookupTable::UsingLogScale ( )
inlineoverridevirtual

This should return 1 if the subclass is using log scale for mapping scalars to colors.

Returns 1 is scale == VTK_SCALE_LOG10.

Reimplemented from vtkScalarsToColors.

Definition at line 407 of file vtkLookupTable.h.

◆ GetNumberOfAvailableColors()

vtkIdType vtkLookupTable::GetNumberOfAvailableColors ( )
overridevirtual

Get the number of available colors for mapping to.

Reimplemented from vtkScalarsToColors.

◆ GetIndexedColor()

void vtkLookupTable::GetIndexedColor ( vtkIdType  idx,
double  rgba[4] 
)
overridevirtual

Return a color given an integer index.

This is used to assign colors to annotations (given an offset into the list of annotations). If the table is empty or idx < 0, then NanColor is returned.

Reimplemented from vtkScalarsToColors.

◆ ResizeTableForSpecialColors()

void vtkLookupTable::ResizeTableForSpecialColors ( )
protected

Resize the LookupTable to have enough room for the out-of-range colors.

Member Data Documentation

◆ REPEATED_LAST_COLOR_INDEX

const vtkIdType vtkLookupTable::REPEATED_LAST_COLOR_INDEX
static

Constants for offsets of special colors (e.g., NanColor, BelowRangeColor, AboveRangeColor) from the maximum index in the lookup table.

These should be considered private and not be used by clients of this class.

Definition at line 77 of file vtkLookupTable.h.

◆ BELOW_RANGE_COLOR_INDEX

const vtkIdType vtkLookupTable::BELOW_RANGE_COLOR_INDEX
static

Definition at line 78 of file vtkLookupTable.h.

◆ ABOVE_RANGE_COLOR_INDEX

const vtkIdType vtkLookupTable::ABOVE_RANGE_COLOR_INDEX
static

Definition at line 79 of file vtkLookupTable.h.

◆ NAN_COLOR_INDEX

const vtkIdType vtkLookupTable::NAN_COLOR_INDEX
static

Definition at line 80 of file vtkLookupTable.h.

◆ NUMBER_OF_SPECIAL_COLORS

const vtkIdType vtkLookupTable::NUMBER_OF_SPECIAL_COLORS
static

Definition at line 81 of file vtkLookupTable.h.

◆ NumberOfColors

vtkIdType vtkLookupTable::NumberOfColors
protected

Definition at line 427 of file vtkLookupTable.h.

◆ Table

vtkUnsignedCharArray* vtkLookupTable::Table
protected

Definition at line 428 of file vtkLookupTable.h.

◆ TableRange

double vtkLookupTable::TableRange[2]
protected

Definition at line 429 of file vtkLookupTable.h.

◆ HueRange

double vtkLookupTable::HueRange[2]
protected

Definition at line 430 of file vtkLookupTable.h.

◆ SaturationRange

double vtkLookupTable::SaturationRange[2]
protected

Definition at line 431 of file vtkLookupTable.h.

◆ ValueRange

double vtkLookupTable::ValueRange[2]
protected

Definition at line 432 of file vtkLookupTable.h.

◆ AlphaRange

double vtkLookupTable::AlphaRange[2]
protected

Definition at line 433 of file vtkLookupTable.h.

◆ NanColor

double vtkLookupTable::NanColor[4]
protected

Definition at line 434 of file vtkLookupTable.h.

◆ BelowRangeColor

double vtkLookupTable::BelowRangeColor[4]
protected

Definition at line 435 of file vtkLookupTable.h.

◆ UseBelowRangeColor

vtkTypeBool vtkLookupTable::UseBelowRangeColor
protected

Definition at line 436 of file vtkLookupTable.h.

◆ AboveRangeColor

double vtkLookupTable::AboveRangeColor[4]
protected

Definition at line 437 of file vtkLookupTable.h.

◆ UseAboveRangeColor

vtkTypeBool vtkLookupTable::UseAboveRangeColor
protected

Definition at line 438 of file vtkLookupTable.h.

◆ Scale

int vtkLookupTable::Scale
protected

Definition at line 440 of file vtkLookupTable.h.

◆ Ramp

int vtkLookupTable::Ramp
protected

Definition at line 441 of file vtkLookupTable.h.

◆ InsertTime

vtkTimeStamp vtkLookupTable::InsertTime
protected

Definition at line 442 of file vtkLookupTable.h.

◆ BuildTime

vtkTimeStamp vtkLookupTable::BuildTime
protected

Definition at line 443 of file vtkLookupTable.h.

◆ RGBA

double vtkLookupTable::RGBA[4]
protected

Definition at line 444 of file vtkLookupTable.h.

◆ NanColorChar

unsigned char vtkLookupTable::NanColorChar[4]
protected

Definition at line 445 of file vtkLookupTable.h.

◆ OpaqueFlag

int vtkLookupTable::OpaqueFlag
protected

Definition at line 447 of file vtkLookupTable.h.

◆ OpaqueFlagBuildTime

vtkTimeStamp vtkLookupTable::OpaqueFlagBuildTime
protected

Definition at line 448 of file vtkLookupTable.h.

◆ SpecialColorsBuildTime

vtkTimeStamp vtkLookupTable::SpecialColorsBuildTime
protected

Definition at line 449 of file vtkLookupTable.h.


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