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

#include <vtkScalarsToColors.h>

Inheritance diagram for vtkScalarsToColors:

Collaboration diagram for vtkScalarsToColors:

Public Types
enum	VectorModes { MAGNITUDE = 0, COMPONENT = 1, RGBCOLORS = 2 }
typedef vtkObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkScalarsToColors *	NewInstance () 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)
	Add a new entry (or change an existing entry) to the list of annotated values.
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.
vtkIdType	GetNumberOfAnnotatedValues ()
	Return the annotated value at a particular index in the list of annotations.
vtkVariant	GetAnnotatedValue (vtkIdType idx)
	Return the annotated value at a particular index in the list of annotations.
vtkStdString	GetAnnotation (vtkIdType idx)
	Return the annotation at a particular index in the list of annotations.
virtual void	GetAnnotationColor (const vtkVariant &val, double rgba[4])
	Obtain the color associated with a particular annotated value (or NanColor if unmatched).
vtkIdType	GetAnnotatedValueIndex (vtkVariant val)
	Return the index of the given value in the list of annotated values (or -1 if not present).
vtkIdType	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	GetIndexedColor (vtkIdType i, double rgba[4])
	Get the "indexed color" assigned to an index.
virtual bool	RemoveAnnotation (vtkVariant value)
	Remove an existing entry from the list of annotated values.
virtual void	ResetAnnotations ()
	Remove all existing values and their annotations.

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

double *	GetColor (double v)

double	GetLuminance (double x)

virtual void	SetAlpha (double alpha)
virtual double	GetAlpha ()

virtual vtkUnsignedCharArray *	MapScalars (vtkDataArray *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 vtkUnsignedCharArray *	ConvertUnsignedCharToRGBA (vtkUnsignedCharArray *colors, int numComp, int numTuples)

virtual int	UsingLogScale ()

virtual void	SetAnnotations (vtkAbstractArray values, vtkStringArray annotations)
virtual vtkAbstractArray *	GetAnnotatedValues ()
virtual vtkStringArray *	GetAnnotations ()

virtual void	SetIndexedLookup (int)
virtual int	GetIndexedLookup ()
virtual void	IndexedLookupOn ()
virtual void	IndexedLookupOff ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkScalarsToColors *	SafeDownCast (vtkObjectBase *o)
static vtkScalarsToColors *	New ()
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkScalarsToColors ()
	~vtkScalarsToColors ()
virtual vtkIdType	CheckForAnnotatedValue (vtkVariant value)
	Allocate annotation arrays if needed, then return the index of the given value or -1 if not present.
virtual void	UpdateAnnotatedValueMap ()
	Update the map from annotated values to indices in the array of annotations.

void	MapColorsToColors (void input, unsigned char output, int inputDataType, int numberOfValues, int numberOfComponents, int vectorSize, int outputFormat)

void	MapVectorsToMagnitude (void input, double output, int inputDataType, int numberOfValues, int numberOfComponents, int vectorSize)
Protected Attributes
vtkAbstractArray *	AnnotatedValues
vtkStringArray *	Annotations
vtkInternalAnnotatedValueMap *	AnnotatedValueMap
int	IndexedLookup
double	Alpha
int	VectorMode
int	VectorComponent
int	VectorSize
int	UseMagnitude

Detailed Description

Superclass for mapping scalar values to colors.

vtkScalarsToColors is a general purpose superclass 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 scalars 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 61 of file vtkScalarsToColors.h.

Member Typedef Documentation

typedef vtkObject vtkScalarsToColors::Superclass

Reimplemented from vtkObject.

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

Definition at line 64 of file vtkScalarsToColors.h.

Member Enumeration Documentation

enum vtkScalarsToColors::VectorModes

Enumerator:

MAGNITUDE
COMPONENT
RGBCOLORS

Definition at line 146 of file vtkScalarsToColors.h.

Constructor & Destructor Documentation

vtkScalarsToColors::vtkScalarsToColors ( ) [protected]

vtkScalarsToColors::~vtkScalarsToColors ( ) [protected]

Member Function Documentation

static int vtkScalarsToColors::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 vtkObject.

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

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]

Reimplemented from vtkObject.

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

virtual vtkObjectBase* vtkScalarsToColors::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkObject.

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

vtkScalarsToColors* vtkScalarsToColors::NewInstance ( ) const

Reimplemented from vtkObject.

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

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 vtkLookupTable, vtkColorTransferFunction, vtkDiscretizableColorTransferFunction, vtkLookupTableWithEnabling, vtkWindowLevelLookupTable, and vtkLogLookupTable.

static vtkScalarsToColors* vtkScalarsToColors::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

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

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 ( ) [inline, virtual]

Perform any processing required (if any) before processing scalars.

Reimplemented in vtkDiscretizableColorTransferFunction, vtkLookupTable, and vtkWindowLevelLookupTable.

Definition at line 73 of file vtkScalarsToColors.h.

virtual double* vtkScalarsToColors::GetRange ( ) [virtual]

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

Reimplemented in vtkLookupTable, and vtkColorTransferFunction.

virtual void vtkScalarsToColors::SetRange	(	double	min,
		double	max
	)		`[virtual]`

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

Reimplemented in vtkColorTransferFunction, and vtkLookupTable.

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

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

Reimplemented in vtkColorTransferFunction, and vtkLookupTable.

Definition at line 79 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 return the color as an RGB array of doubles between 0 and 1.

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.

Reimplemented in vtkColorTransferFunction.

Definition at line 94 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.

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

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.

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

An internal method maps 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); otherwise, the data is mapped through this instance of ScalarsToColors. The offset 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]