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

Superclass for mapping scalar values to colors. More...

#include <vtkScalarsToColors.h>

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

Public Types

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

Public Member Functions

virtual int IsA (const char *type)
 
vtkScalarsToColorsNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int IsOpaque ()
 
virtual void Build ()
 
virtual unsigned char * MapValue (double v)
 
virtual void GetColor (double v, double rgb[3])
 
virtual double GetOpacity (double v)
 
virtual void DeepCopy (vtkScalarsToColors *o)
 
virtual vtkIdType GetNumberOfAvailableColors ()
 
virtual vtkIdType SetAnnotation (vtkVariant value, vtkStdString annotation)
 
virtual vtkIdType SetAnnotation (vtkStdString value, vtkStdString annotation)
 
vtkIdType GetNumberOfAnnotatedValues ()
 
vtkVariant GetAnnotatedValue (vtkIdType idx)
 
vtkStdString GetAnnotation (vtkIdType idx)
 
virtual void GetAnnotationColor (const vtkVariant &val, double rgba[4])
 
vtkIdType GetAnnotatedValueIndex (vtkVariant val)
 
vtkIdType GetAnnotatedValueIndexInternal (vtkVariant &val)
 
virtual void GetIndexedColor (vtkIdType i, double rgba[4])
 
virtual bool RemoveAnnotation (vtkVariant value)
 
virtual void ResetAnnotations ()
 
virtual doubleGetRange ()
 
virtual void SetRange (double min, double max)
 
void SetRange (double rng[2])
 
doubleGetColor (double v)
 
double GetLuminance (double x)
 
virtual void SetAlpha (double alpha)
 
virtual double GetAlpha ()
 
virtual vtkUnsignedCharArrayMapScalars (vtkDataArray *scalars, int colorMode, int component)
 
virtual vtkUnsignedCharArrayMapScalars (vtkAbstractArray *scalars, int colorMode, int component)
 
virtual void SetVectorMode (int)
 
virtual int GetVectorMode ()
 
void SetVectorModeToMagnitude ()
 
void SetVectorModeToComponent ()
 
void SetVectorModeToRGBColors ()
 
virtual void SetVectorComponent (int)
 
virtual int GetVectorComponent ()
 
virtual void SetVectorSize (int)
 
virtual int GetVectorSize ()
 
void MapVectorsThroughTable (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat, int vectorComponent, int vectorSize)
 
void MapVectorsThroughTable (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat)
 
void MapScalarsThroughTable (vtkDataArray *scalars, unsigned char *output, int outputFormat)
 
void MapScalarsThroughTable (vtkDataArray *scalars, unsigned char *output)
 
void MapScalarsThroughTable (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat)
 
virtual void MapScalarsThroughTable2 (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat)
 
virtual int UsingLogScale ()
 
virtual void SetAnnotations (vtkAbstractArray *values, vtkStringArray *annotations)
 
virtual vtkAbstractArrayGetAnnotatedValues ()
 
virtual vtkStringArrayGetAnnotations ()
 
virtual void SetIndexedLookup (int)
 
virtual int GetIndexedLookup ()
 
virtual void IndexedLookupOn ()
 
virtual void IndexedLookupOff ()
 
template<>
unsigned char ColorToUChar (double t)
 
template<>
unsigned char ColorToUChar (float t)
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
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)
 
int InvokeEvent (unsigned long event, void *callData)
 
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
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkScalarsToColorsSafeDownCast (vtkObjectBase *o)
 
static vtkScalarsToColorsNew ()
 
template<typename T >
static unsigned char ColorToUChar (T t)
 
template<typename T >
static void ColorToUChar (T t, unsigned char *dest)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkScalarsToColors ()
 
 ~vtkScalarsToColors ()
 
virtual vtkIdType CheckForAnnotatedValue (vtkVariant value)
 
virtual void UpdateAnnotatedValueMap ()
 
void MapColorsToColors (void *input, unsigned char *output, int inputDataType, int numberOfValues, int numberOfComponents, int vectorSize, int outputFormat)
 
vtkUnsignedCharArrayConvertToRGBA (vtkDataArray *colors, int numComp, int numTuples)
 
void MapVectorsToMagnitude (void *input, double *output, int inputDataType, int numberOfValues, int numberOfComponents, int vectorSize)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
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

vtkAbstractArrayAnnotatedValues
 
vtkStringArrayAnnotations
 
vtkInternalAnnotatedValueMap * AnnotatedValueMap
 
int 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
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Superclass for mapping scalar values to colors.

vtkScalarsToColors is a general-purpose base class for objects that convert scalars to colors. This include vtkLookupTable classes and color transfer functions. By itself, this class will simply rescale the scalars.

The scalar-to-color mapping can be augmented with an additional uniform alpha blend. This is used, for example, to blend a vtkActor's opacity with the lookup table values.

Specific scalar values may be annotated with text strings that will be included in color legends using SetAnnotations, SetAnnotation, GetNumberOfAnnotatedValues, GetAnnotatedValue, GetAnnotation, RemoveAnnotation, and ResetAnnotations.

This class also has a method for indicating that the set of annotated values form a categorical color map; 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. In this mode, subclasses should then assign colors to annotated values by taking the modulus of an annotated value's index in the list of annotations with the number of colors in the table.

See also
vtkLookupTable vtkColorTransferFunction
Tests:
vtkScalarsToColors (Tests)

Definition at line 62 of file vtkScalarsToColors.h.

Member Typedef Documentation

Definition at line 65 of file vtkScalarsToColors.h.

Member Enumeration Documentation

Enumerator
MAGNITUDE 
COMPONENT 
RGBCOLORS 

Definition at line 156 of file vtkScalarsToColors.h.

Constructor & Destructor Documentation

vtkScalarsToColors::vtkScalarsToColors ( )
protected
vtkScalarsToColors::~vtkScalarsToColors ( )
protected

Member Function Documentation

static int vtkScalarsToColors::IsTypeOf ( const char *  type)
static
virtual int vtkScalarsToColors::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 vtkObject.

Reimplemented in vtkLookupTable, vtkColorTransferFunction, vtkDiscretizableColorTransferFunction, vtkLookupTableWithEnabling, vtkWindowLevelLookupTable, and vtkLogLookupTable.

static vtkScalarsToColors* vtkScalarsToColors::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkScalarsToColors::NewInstanceInternal ( ) const
protectedvirtual
vtkScalarsToColors* vtkScalarsToColors::NewInstance ( ) const
void vtkScalarsToColors::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 vtkColorTransferFunction, vtkDiscretizableColorTransferFunction, vtkLookupTableWithEnabling, vtkWindowLevelLookupTable, and vtkLogLookupTable.

static vtkScalarsToColors* vtkScalarsToColors::New ( )
static
virtual int vtkScalarsToColors::IsOpaque ( )
virtual

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

Reimplemented in vtkLookupTable, and vtkDiscretizableColorTransferFunction.

virtual void vtkScalarsToColors::Build ( )
inlinevirtual

Perform any processing required (if any) before processing scalars. Default implementation does nothing.

Reimplemented in vtkLookupTable, vtkDiscretizableColorTransferFunction, and vtkWindowLevelLookupTable.

Definition at line 75 of file vtkScalarsToColors.h.

virtual double* vtkScalarsToColors::GetRange ( )
virtual

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

Reimplemented in vtkLookupTable, and vtkColorTransferFunction.

virtual void vtkScalarsToColors::SetRange ( double  min,
double  max 
)
virtual

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

Reimplemented in vtkColorTransferFunction, and vtkLookupTable.

void vtkScalarsToColors::SetRange ( double  rng[2])
inline

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

Definition at line 81 of file vtkScalarsToColors.h.

virtual unsigned char* vtkScalarsToColors::MapValue ( double  v)
virtual

Map one value through the lookup table and return a color defined as a RGBA unsigned char tuple (4 bytes).

Reimplemented in vtkLookupTable, vtkDiscretizableColorTransferFunction, and vtkColorTransferFunction.

virtual void vtkScalarsToColors::GetColor ( double  v,
double  rgb[3] 
)
virtual

Map one value through the lookup table and store the color as an RGB array of doubles between 0 and 1 in the rgb argument.

Reimplemented in vtkLookupTable, vtkDiscretizableColorTransferFunction, and vtkColorTransferFunction.

double* vtkScalarsToColors::GetColor ( double  v)
inline

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

Definition at line 96 of file vtkScalarsToColors.h.

virtual double vtkScalarsToColors::GetOpacity ( double  v)
virtual

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

Reimplemented in vtkLookupTable, and vtkDiscretizableColorTransferFunction.

double vtkScalarsToColors::GetLuminance ( double  x)
inline

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. Returns the luminance value for the specified scalar value.

Definition at line 109 of file vtkScalarsToColors.h.

virtual void vtkScalarsToColors::SetAlpha ( double  alpha)
virtual

Specify an additional opacity (alpha) value to blend with. Values != 1 modify the resulting color consistent with the requested form of the output. This is typically used by an actor in order to blend its opacity. Value is clamped between 0 and 1.

Reimplemented in vtkDiscretizableColorTransferFunction.

virtual double vtkScalarsToColors::GetAlpha ( )
virtual

Specify an additional opacity (alpha) value to blend with. Values != 1 modify the resulting color consistent with the requested form of the output. This is typically used by an actor in order to blend its opacity. Value is clamped between 0 and 1.

virtual vtkUnsignedCharArray* vtkScalarsToColors::MapScalars ( vtkDataArray scalars,
int  colorMode,
int  component 
)
virtual

Internal methods that map a data array into a 4-component, unsigned char RGBA array. The color mode determines the behavior of mapping. If VTK_COLOR_MODE_DEFAULT is set, then unsigned char data arrays are treated as colors (and converted to RGBA if necessary); If VTK_COLOR_MODE_DIRECT_SCALARS is set, then all arrays are treated as colors (integer types are clamped in the range 0-255, floating point arrays are clamped in the range 0.0-1.0. Note 'char' does not have enough values to represent a color so mapping this type is considered an error); otherwise, the data is mapped through this instance of ScalarsToColors. The component argument is used for data arrays with more than one component; it indicates which component to use to do the blending. When the component argument is -1, then the this object uses its own selected technique to change a vector into a scalar to map.

Reimplemented in vtkDiscretizableColorTransferFunction.

virtual vtkUnsignedCharArray* vtkScalarsToColors::MapScalars ( vtkAbstractArray scalars,
int  colorMode,
int  component 
)
virtual

Internal methods that map a data array into a 4-component, unsigned char RGBA array. The color mode determines the behavior of mapping. If VTK_COLOR_MODE_DEFAULT is set, then unsigned char data arrays are treated as colors (and converted to RGBA if necessary); If VTK_COLOR_MODE_DIRECT_SCALARS is set, then all arrays are treated as colors (integer types are clamped in the range 0-255, floating point arrays are clamped in the range 0.0-1.0. Note 'char' does not have enough values to represent a color so mapping this type is considered an error); otherwise, the data is mapped through this instance of ScalarsToColors. The component argument is used for data arrays with more than one component; it indicates which component to use to do the blending. When the component argument is -1, then the this object uses its own selected technique to change a vector into a scalar to map.

Reimplemented in vtkDiscretizableColorTransferFunction.

virtual void vtkScalarsToColors::SetVectorMode ( int  )
virtual

Change mode that maps vectors by magnitude vs. component. If the mode is "RGBColors", then the vectors components are scaled to the range and passed directly as the colors.

virtual int vtkScalarsToColors::GetVectorMode ( )
virtual

Change mode that maps vectors by magnitude vs. component. If the mode is "RGBColors", then the vectors components are scaled to the range and passed directly as the colors.

void vtkScalarsToColors::SetVectorModeToMagnitude ( )

Change mode that maps vectors by magnitude vs. component. If the mode is "RGBColors", then the vectors components are scaled to the range and passed directly as the colors.

void vtkScalarsToColors::SetVectorModeToComponent ( )

Change mode that maps vectors by magnitude vs. component. If the mode is "RGBColors", then the vectors components are scaled to the range and passed directly as the colors.

void vtkScalarsToColors::SetVectorModeToRGBColors ( )

Change mode that maps vectors by magnitude vs. component. If the mode is "RGBColors", then the vectors components are scaled to the range and passed directly as the colors.

virtual void vtkScalarsToColors::SetVectorComponent ( int  )
virtual

If the mapper does not select which component of a vector to map to colors, you can specify it here.

virtual int vtkScalarsToColors::GetVectorComponent ( )
virtual

If the mapper does not select which component of a vector to map to colors, you can specify it here.

virtual void vtkScalarsToColors::SetVectorSize ( int  )
virtual

When mapping vectors, consider only the number of components selected by VectorSize to be part of the vector, and ignore any other components. Set to -1 to map all components. If this is not set to -1, then you can use SetVectorComponent to set which scalar component will be the first component in the vector to be mapped.

virtual int vtkScalarsToColors::GetVectorSize ( )
virtual

When mapping vectors, consider only the number of components selected by VectorSize to be part of the vector, and ignore any other components. Set to -1 to map all components. If this is not set to -1, then you can use SetVectorComponent to set which scalar component will be the first component in the vector to be mapped.

void vtkScalarsToColors::MapVectorsThroughTable ( void *  input,
unsigned char *  output,
int  inputDataType,
int  numberOfValues,
int  inputIncrement,
int  outputFormat,
int  vectorComponent,
int  vectorSize 
)

Map vectors through the lookup table. Unlike MapScalarsThroughTable, this method will use the VectorMode to decide how to map vectors. The output format can be set to VTK_RGBA (4 components), VTK_RGB (3 components), VTK_LUMINANCE (1 component, greyscale), or VTK_LUMINANCE_ALPHA (2 components)

void vtkScalarsToColors::MapVectorsThroughTable ( void *  input,
unsigned char *  output,
int  inputDataType,
int  numberOfValues,
int  inputIncrement,
int  outputFormat 
)
inline

Map vectors through the lookup table. Unlike MapScalarsThroughTable, this method will use the VectorMode to decide how to map vectors. The output format can be set to VTK_RGBA (4 components), VTK_RGB (3 components), VTK_LUMINANCE (1 component, greyscale), or VTK_LUMINANCE_ALPHA (2 components)

Definition at line 191 of file vtkScalarsToColors.h.

void vtkScalarsToColors::MapScalarsThroughTable ( vtkDataArray scalars,
unsigned char *  output,
int  outputFormat 
)

Map a set of scalars through the lookup table in a single operation. This method ignores the VectorMode and the VectorComponent. The output format can be set to VTK_RGBA (4 components), VTK_RGB (3 components), VTK_LUMINANCE (1 component, greyscale), or VTK_LUMINANCE_ALPHA (2 components) If not supplied, the output format defaults to RGBA.

void vtkScalarsToColors::MapScalarsThroughTable ( vtkDataArray scalars,
unsigned char *  output 
)
inline

Map a set of scalars through the lookup table in a single operation. This method ignores the VectorMode and the VectorComponent. The output format can be set to VTK_RGBA (4 components), VTK_RGB (3 components), VTK_LUMINANCE (1 component, greyscale), or VTK_LUMINANCE_ALPHA (2 components) If not supplied, the output format defaults to RGBA.

Definition at line 208 of file vtkScalarsToColors.h.

void vtkScalarsToColors::MapScalarsThroughTable ( void *  input,
unsigned char *  output,
int  inputDataType,
int  numberOfValues,
int  inputIncrement,
int  outputFormat 
)
inline

Map a set of scalars through the lookup table in a single operation. This method ignores the VectorMode and the VectorComponent. The output format can be set to VTK_RGBA (4 components), VTK_RGB (3 components), VTK_LUMINANCE (1 component, greyscale), or VTK_LUMINANCE_ALPHA (2 components) If not supplied, the output format defaults to RGBA.

Definition at line 211 of file vtkScalarsToColors.h.

virtual void vtkScalarsToColors::MapScalarsThroughTable2 ( void *  input,
unsigned char *  output,
int  inputDataType,
int  numberOfValues,
int  inputIncrement,
int  outputFormat 
)
virtual

An internal method typically not used in applications. This should be a protected function, but it must be kept public for backwards compatibility. Never call this method directly.

Reimplemented in vtkLookupTable, vtkColorTransferFunction, and vtkLookupTableWithEnabling.

virtual void vtkScalarsToColors::DeepCopy ( vtkScalarsToColors o)
virtual

Copy the contents from another object.

Reimplemented in vtkLookupTable, and vtkColorTransferFunction.

virtual int vtkScalarsToColors::UsingLogScale ( )
inlinevirtual

This should return 1 is the subclass is using log scale for mapping scalars to colors. Default implementation always returns 0.

Reimplemented in vtkLookupTable, and vtkDiscretizableColorTransferFunction.

Definition at line 235 of file vtkScalarsToColors.h.

virtual vtkIdType vtkScalarsToColors::GetNumberOfAvailableColors ( )
virtual

Get the number of available colors for mapping to.

Reimplemented in vtkLookupTable, vtkColorTransferFunction, and vtkDiscretizableColorTransferFunction.

virtual void vtkScalarsToColors::SetAnnotations ( vtkAbstractArray values,
vtkStringArray annotations 
)
virtual

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). The two arrays must both either be NULL or of the same length or the call will be ignored. Note that these arrays are deep copied rather than being used directly in order to support the use case where edits are made. If the values and annotations arrays were held by this class then each call to map scalar values to colors would require us to check the MTime of the arrays.

virtual vtkAbstractArray* vtkScalarsToColors::GetAnnotatedValues ( )
virtual

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). The two arrays must both either be NULL or of the same length or the call will be ignored. Note that these arrays are deep copied rather than being used directly in order to support the use case where edits are made. If the values and annotations arrays were held by this class then each call to map scalar values to colors would require us to check the MTime of the arrays.

virtual vtkStringArray* vtkScalarsToColors::GetAnnotations ( )
virtual

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). The two arrays must both either be NULL or of the same length or the call will be ignored. Note that these arrays are deep copied rather than being used directly in order to support the use case where edits are made. If the values and annotations arrays were held by this class then each call to map scalar values to colors would require us to check the MTime of the arrays.

virtual vtkIdType vtkScalarsToColors::SetAnnotation ( vtkVariant  value,
vtkStdString  annotation 
)
virtual

Add a new entry (or change an existing entry) to the list of annotated values. Returns the index of value in the list of annotations.

virtual vtkIdType vtkScalarsToColors::SetAnnotation ( vtkStdString  value,
vtkStdString  annotation 
)
virtual

This variant of SetAnnotation accepts the value as a string so ParaView can treat annotations as string vector arrays.

vtkIdType vtkScalarsToColors::GetNumberOfAnnotatedValues ( )

Return the annotated value at a particular index in the list of annotations.

vtkVariant vtkScalarsToColors::GetAnnotatedValue ( vtkIdType  idx)

Return the annotated value at a particular index in the list of annotations.

vtkStdString vtkScalarsToColors::GetAnnotation ( vtkIdType  idx)

Return the annotation at a particular index in the list of annotations.

virtual void vtkScalarsToColors::GetAnnotationColor ( const vtkVariant val,
double  rgba[4] 
)
virtual

Obtain the color associated with a particular annotated value (or NanColor if unmatched).

vtkIdType vtkScalarsToColors::GetAnnotatedValueIndex ( vtkVariant  val)

Return the index of the given value in the list of annotated values (or -1 if not present).

vtkIdType vtkScalarsToColors::GetAnnotatedValueIndexInternal ( vtkVariant val)

Look up an index into the array of annotations given a value. Does no pointer checks. Returns -1 when val not present.

virtual void vtkScalarsToColors::GetIndexedColor ( vtkIdType  i,
double  rgba[4] 
)
virtual

Get the "indexed color" assigned to an index. The index is used in IndexedLookup mode to assign colors to annotations (in the order the annotations were set). Subclasses must implement this and interpret how to treat the index. vtkLookupTable simply returns GetTableValue(index % this->GetNumberOfTableValues()). vtkColorTransferFunction returns the color assocated with node index % this->GetSize(). Note that implementations must set the opacity (alpha) component of the color, even if they do not provide opacity values in their colormaps. In that case, alpha = 1 should be used.

Reimplemented in vtkLookupTable, vtkColorTransferFunction, and vtkDiscretizableColorTransferFunction.

virtual bool vtkScalarsToColors::RemoveAnnotation ( vtkVariant  value)
virtual

Remove an existing entry from the list of annotated values. Returns true when the entry was actually removed (i.e., it existed before the call). Otherwise, returns false.

virtual void vtkScalarsToColors::ResetAnnotations ( )
virtual

Remove all existing values and their annotations.

virtual void vtkScalarsToColors::SetIndexedLookup ( int  )
virtual

Set/get whether the lookup table is for categorical or ordinal data. The default is ordinal data; values not present in the lookup table will be assigned an interpolated color. When categorical data is present, only values in the lookup table will be considered valid; all other values will be assigned NanColor.

virtual int vtkScalarsToColors::GetIndexedLookup ( )
virtual

Set/get whether the lookup table is for categorical or ordinal data. The default is ordinal data; values not present in the lookup table will be assigned an interpolated color. When categorical data is present, only values in the lookup table will be considered valid; all other values will be assigned NanColor.

virtual void vtkScalarsToColors::IndexedLookupOn ( )
virtual

Set/get whether the lookup table is for categorical or ordinal data. The default is ordinal data; values not present in the lookup table will be assigned an interpolated color. When categorical data is present, only values in the lookup table will be considered valid; all other values will be assigned NanColor.

virtual void vtkScalarsToColors::IndexedLookupOff ( )
virtual

Set/get whether the lookup table is for categorical or ordinal data. The default is ordinal data; values not present in the lookup table will be assigned an interpolated color. When categorical data is present, only values in the lookup table will be considered valid; all other values will be assigned NanColor.

template<typename T >
static unsigned char vtkScalarsToColors::ColorToUChar ( t)
inlinestatic

Converts a color from numeric type T to uchar. We assume the integral type is already in the range 0-255. If it is not, it is going to be truncated. Floating point types are assumed to be in interval 0.0-1.0

Definition at line 327 of file vtkScalarsToColors.h.

template<typename T >
static void vtkScalarsToColors::ColorToUChar ( t,
unsigned char *  dest 
)
inlinestatic

Converts a color from numeric type T to uchar. We assume the integral type is already in the range 0-255. If it is not, it is going to be truncated. Floating point types are assumed to be in interval 0.0-1.0

Definition at line 332 of file vtkScalarsToColors.h.

void vtkScalarsToColors::MapColorsToColors ( void *  input,
unsigned char *  output,
int  inputDataType,
int  numberOfValues,
int  numberOfComponents,
int  vectorSize,
int  outputFormat 
)
protected

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. If the input has 1 or 2 components, the first component will be duplicated if the output format is RGB or RGBA. If the input has 2 or 4 components, the last component will be used for the alpha if the output format is RGBA or LuminanceAlpha. If the input has 3 or 4 components but the output is Luminance or LuminanceAlpha, then the components will be combined to compute the luminance. Any components past the fourth component will be ignored.

vtkUnsignedCharArray* vtkScalarsToColors::ConvertToRGBA ( vtkDataArray colors,
int  numComp,
int  numTuples 
)
protected

An internal method used to convert a color array to RGBA. The method instantiates a vtkUnsignedCharArray and returns it. The user is responsible for managing the memory.

void vtkScalarsToColors::MapVectorsToMagnitude ( void *  input,
double output,
int  inputDataType,
int  numberOfValues,
int  numberOfComponents,
int  vectorSize 
)
protected

An internal method for converting vectors to magnitudes, used as a preliminary step before doing magnitude mapping.

virtual vtkIdType vtkScalarsToColors::CheckForAnnotatedValue ( vtkVariant  value)
protectedvirtual

Allocate annotation arrays if needed, then return the index of the given value or -1 if not present.

virtual void vtkScalarsToColors::UpdateAnnotatedValueMap ( )
protectedvirtual

Update the map from annotated values to indices in the array of annotations.

template<>
unsigned char vtkScalarsToColors::ColorToUChar ( double  t)
inline

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.

Definition at line 419 of file vtkScalarsToColors.h.

template<>
unsigned char vtkScalarsToColors::ColorToUChar ( float  t)
inline

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.

Definition at line 424 of file vtkScalarsToColors.h.

Member Data Documentation

vtkAbstractArray* vtkScalarsToColors::AnnotatedValues
protected

Definition at line 386 of file vtkScalarsToColors.h.

vtkStringArray* vtkScalarsToColors::Annotations
protected

Definition at line 387 of file vtkScalarsToColors.h.

vtkInternalAnnotatedValueMap* vtkScalarsToColors::AnnotatedValueMap
protected

Definition at line 389 of file vtkScalarsToColors.h.

int vtkScalarsToColors::IndexedLookup
protected

Definition at line 392 of file vtkScalarsToColors.h.

double vtkScalarsToColors::Alpha
protected

Definition at line 394 of file vtkScalarsToColors.h.

int vtkScalarsToColors::VectorMode
protected

Definition at line 397 of file vtkScalarsToColors.h.

int vtkScalarsToColors::VectorComponent
protected

Definition at line 398 of file vtkScalarsToColors.h.

int vtkScalarsToColors::VectorSize
protected

Definition at line 399 of file vtkScalarsToColors.h.

int vtkScalarsToColors::UseMagnitude
protected

Definition at line 402 of file vtkScalarsToColors.h.

unsigned char vtkScalarsToColors::RGBABytes[4]
protected

Definition at line 404 of file vtkScalarsToColors.h.


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