---

vtkScalarsToColors Class Reference

map scalar values into colors. More...

#include <vtkScalarsToColors.h>

Inheritance diagram for vtkScalarsToColors:

[legend]Collaboration diagram for vtkScalarsToColors:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Build ()
virtual unsigned char *	MapValue (float v)=0
virtual void	GetColor (float v, float rgb[3])=0
virtual float *	GetRange ()=0
virtual void	SetRange (float min, float max)=0
void	SetRange (float rng[2])
float *	GetColor (float v)
virtual float	GetOpacity (float vtkNotUsed(v))
float	GetLuminance (float x)
void	SetAlpha (float alpha)
virtual float	GetAlpha ()
vtkUnsignedCharArray *	MapScalars (vtkDataArray *scalars, int colorMode, int component)
void	MapScalarsThroughTable (vtkDataArray *scalars, unsigned char *output, int outputFormat)
void	MapScalarsThroughTable (vtkDataArray *scalars, unsigned char *output)
virtual void	MapScalarsThroughTable2 (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat)=0
virtual vtkUnsignedCharArray *	ConvertUnsignedCharToRGBA (vtkUnsignedCharArray *colors, int numComp, int numTuples)
Static Public Methods
int	IsTypeOf (const char *type)
vtkScalarsToColors *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkScalarsToColors ()
	~vtkScalarsToColors ()
Protected Attributes
float	Alpha

---

Detailed Description

map scalar values into colors.

Date:

2001/12/05 14:04:35

Revision:

1.21

vtkScalarsToColors is a general purpose superclass for objects that convert scalars to colors. This include vtkLookupTable classes and color transfer functions.

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.

See also:

vtkLookupTable vtkColorTransferFunction

Definition at line 74 of file vtkScalarsToColors.h.

---

Constructor & Destructor Documentation

vtkScalarsToColors::vtkScalarsToColors (    )  [inline, protected]

Definition at line 175 of file vtkScalarsToColors.h.

vtkScalarsToColors::~vtkScalarsToColors (    )  [inline, protected]

Definition at line 176 of file vtkScalarsToColors.h.

---

Member Function Documentation

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

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkObject. Reimplemented in vtkLogLookupTable, vtkLookupTable, vtkWindowLevelLookupTable, and vtkColorTransferFunction.

int vtkScalarsToColors::IsTypeOf (  const char *    type )  [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 vtkLogLookupTable, vtkLookupTable, vtkWindowLevelLookupTable, and vtkColorTransferFunction.

virtual int vtkScalarsToColors::IsA (  const char *    type )  [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 vtkLogLookupTable, vtkLookupTable, vtkWindowLevelLookupTable, and vtkColorTransferFunction.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkObject. Reimplemented in vtkLogLookupTable, vtkLookupTable, vtkWindowLevelLookupTable, and vtkColorTransferFunction.

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

virtual void vtkScalarsToColors::Build (    )  [inline, virtual]

Perform any processing required (if any) before processing scalars. Reimplemented in vtkLookupTable, and vtkWindowLevelLookupTable. Definition at line 81 of file vtkScalarsToColors.h.

virtual float* vtkScalarsToColors::GetRange (    )  [pure virtual]

Sets/Gets the range of scalars which will be mapped. Reimplemented in vtkLookupTable, and vtkColorTransferFunction.

virtual void vtkScalarsToColors::SetRange (  float    min, float    max )  [pure virtual]

Sets/Gets the range of scalars which will be mapped. Reimplemented in vtkLookupTable, and vtkColorTransferFunction. Referenced by vtkColorTransferFunction::SetRange(), and vtkLookupTable::SetRange().

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

Sets/Gets the range of scalars which will be mapped. Reimplemented in vtkLookupTable, and vtkColorTransferFunction. Definition at line 87 of file vtkScalarsToColors.h.

virtual unsigned char* vtkScalarsToColors::MapValue (  float    v )  [pure virtual]

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

virtual void vtkScalarsToColors::GetColor (  float    x, float    rgb[3] )  [pure virtual]

Map one value through the lookup table and return the color as an RGB array of floats between 0 and 1. Reimplemented in vtkLookupTable, and vtkColorTransferFunction. Referenced by vtkColorTransferFunction::GetColor(), and vtkLookupTable::GetColor().

float* vtkScalarsToColors::GetColor (  float    x )  [inline]

Map one value through the lookup table and return the color as an RGB array of floats between 0 and 1. Reimplemented in vtkLookupTable, and vtkColorTransferFunction. Definition at line 102 of file vtkScalarsToColors.h.

virtual float vtkScalarsToColors::GetOpacity (  float vtkNotUsed(v)    )  [inline, virtual]

Map one value through the lookup table and return the alpha value (the opacity) as a float between 0 and 1. Definition at line 109 of file vtkScalarsToColors.h.

float vtkScalarsToColors::GetLuminance (  float    x )  [inline]

Map one value through the lookup table and return the luminance 0.3*red + 0.59*green + 0.11*blue as a float between 0 and 1. Returns the luminance value for the specified scalar value. Definition at line 117 of file vtkScalarsToColors.h.

void vtkScalarsToColors::SetAlpha (  float    alpha )

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

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

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.

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

Map a set of scalars through the lookup table in a single operation. 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. 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 152 of file vtkScalarsToColors.h.

virtual void vtkScalarsToColors::MapScalarsThroughTable2 (  void *    input, unsigned char *    output, int    inputDataType, int    numberOfValues, int    inputIncrement, int    outputIncrement )  [pure virtual]

An internal method typically not used in applications. Reimplemented in vtkLookupTable, and vtkColorTransferFunction.

virtual vtkUnsignedCharArray* vtkScalarsToColors::ConvertUnsignedCharToRGBA (  vtkUnsignedCharArray *    colors, int    numComp, int    numTuples )  [virtual]

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.

---

Member Data Documentation

float vtkScalarsToColors::Alpha [protected]

Definition at line 178 of file vtkScalarsToColors.h.

---

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

• Common/vtkScalarsToColors.h

---