---

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)
virtual void	Build ()
virtual float *	GetRange ()=0
virtual void	SetRange (float min, float max)=0
void	SetRange (float rng[2])
virtual unsigned char *	MapValue (float v)=0
virtual void	GetColor (float v, float rgb[3])=0
float *	GetColor (float v)
virtual float	GetOpacity (float vtkNotUsed(v))
float	GetLuminance (float x)
void	MapScalarsThroughTable (vtkScalars *scalars, unsigned char *output, int outputFormat)
void	MapScalarsThroughTable (vtkScalars *scalars, unsigned char *output)
virtual void	MapScalarsThroughTable2 (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat)=0
Static Public Methods
int	IsTypeOf (const char *type)
vtkScalarsToColors *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkScalarsToColors ()
	~vtkScalarsToColors ()
	vtkScalarsToColors (const vtkScalarsToColors &)
void	operator= (const vtkScalarsToColors &)

---

Detailed Description

map scalar values into colors.

Date:

2000/12/11 11:57:19

Revision:

1.15

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

See also:

vtkLookupTable vtkColorTransferFunction

Definition at line 66 of file vtkScalarsToColors.h.

---

Constructor & Destructor Documentation

vtkScalarsToColors::vtkScalarsToColors (    )  [inline, protected]

Definition at line 125 of file vtkScalarsToColors.h.

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

Definition at line 126 of file vtkScalarsToColors.h.

vtkScalarsToColors::vtkScalarsToColors (  const vtkScalarsToColors &    )  [inline, protected]

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

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

Perform any processing required (if any) before processing scalars. Reimplemented in vtkLookupTable, and vtkWindowLevelLookupTable. Definition at line 72 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]

Reimplemented in vtkLookupTable, and vtkColorTransferFunction. Referenced by vtkColorTransferFunction::SetRange(), and vtkLookupTable::SetRange().

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

Reimplemented in vtkLookupTable, and vtkColorTransferFunction. Definition at line 77 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 vtkLogLookupTable, 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(), vtkLookupTable::GetColor(), and vtkColorTransferFunction::GetValue().

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 90 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 95 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 101 of file vtkScalarsToColors.h.

void vtkScalarsToColors::MapScalarsThroughTable (  vtkScalars *    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 (  vtkScalars *    scalars, unsigned char *    output )  [inline]

Definition at line 113 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 vtkLogLookupTable, vtkLookupTable, and vtkColorTransferFunction.

void vtkScalarsToColors::operator= (  const vtkScalarsToColors &    )  [inline, protected]

Definition at line 128 of file vtkScalarsToColors.h.

---

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

• common/vtkScalarsToColors.h

---