---

vtkImageMapToColors Class Reference

map the input image through a lookup table. More...

#include <vtkImageMapToColors.h>

Inheritance diagram for vtkImageMapToColors:

[legend]Collaboration diagram for vtkImageMapToColors:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
unsigned long	GetMTime ()
virtual void	SetLookupTable (vtkScalarsToColors *)
virtual vtkScalarsToColors *	GetLookupTable ()
virtual void	SetOutputFormat (int)
virtual int	GetOutputFormat ()
void	SetOutputFormatToRGBA ()
void	SetOutputFormatToRGB ()
void	SetOutputFormatToLuminanceAlpha ()
void	SetOutputFormatToLuminance ()
virtual void	SetActiveComponent (int)
virtual int	GetActiveComponent ()
virtual void	SetPassAlphaToOutput (int)
virtual void	PassAlphaToOutputOn ()
virtual void	PassAlphaToOutputOff ()
virtual int	GetPassAlphaToOutput ()
Static Public Methods
vtkImageMapToColors *	New ()
int	IsTypeOf (const char *type)
vtkImageMapToColors *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkImageMapToColors ()
	~vtkImageMapToColors ()
void	ExecuteInformation (vtkImageData *inData, vtkImageData *outData)
void	ExecuteInformation ()
void	ThreadedExecute (vtkImageData *inData, vtkImageData *outData, int extent[6], int id)
void	ExecuteData (vtkDataObject *output)
Protected Attributes
vtkScalarsToColors *	LookupTable
int	OutputFormat
int	ActiveComponent
int	PassAlphaToOutput
int	DataWasPassed

---

Detailed Description

map the input image through a lookup table.

Date:

2001/11/13 14:32:38

Revision:

1.16

Thanks:

Thanks to David G. Gobbi who developed this class.

The vtkImageMapToColors filter will take an input image of any valid scalar type, and map the first component of the image through a lookup table. The result is an image of type VTK_UNSIGNED_CHAR. If the lookup table is not set, or is set to NULL, then the input data will be passed through if it is already of type UNSIGNED_CHAR.

See also:

vtkLookupTable vtkScalarsToColors

Tests:

vtkImageMapToColors (Tests)

Definition at line 67 of file vtkImageMapToColors.h.

---

Constructor & Destructor Documentation

vtkImageMapToColors::vtkImageMapToColors (    )  [protected]

vtkImageMapToColors::~vtkImageMapToColors (    )  [protected]

---

Member Function Documentation

vtkImageMapToColors* vtkImageMapToColors::New (    )  [static]

Instantiate object with no start, end, or progress methods. Reimplemented from vtkImageToImageFilter. Reimplemented in vtkImageMapToRGBA, and vtkImageMapToWindowLevelColors.

virtual const char* vtkImageMapToColors::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 vtkImageToImageFilter. Reimplemented in vtkImageMapToRGBA, and vtkImageMapToWindowLevelColors.

int vtkImageMapToColors::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 vtkImageToImageFilter. Reimplemented in vtkImageMapToRGBA, and vtkImageMapToWindowLevelColors.

virtual int vtkImageMapToColors::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 vtkImageToImageFilter. Reimplemented in vtkImageMapToRGBA, and vtkImageMapToWindowLevelColors.

vtkImageMapToColors* vtkImageMapToColors::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 vtkImageToImageFilter. Reimplemented in vtkImageMapToRGBA, and vtkImageMapToWindowLevelColors.

void vtkImageMapToColors::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 vtkImageToImageFilter. Reimplemented in vtkImageMapToWindowLevelColors.

virtual void vtkImageMapToColors::SetLookupTable (  vtkScalarsToColors *    )  [virtual]

Set the lookup table.

virtual vtkScalarsToColors* vtkImageMapToColors::GetLookupTable (    )  [virtual]

Set the lookup table.

virtual void vtkImageMapToColors::SetOutputFormat (  int    )  [virtual]

Set the output format, the default is RGBA.

virtual int vtkImageMapToColors::GetOutputFormat (    )  [virtual]

Set the output format, the default is RGBA.

void vtkImageMapToColors::SetOutputFormatToRGBA (    )  [inline]

Set the output format, the default is RGBA. Definition at line 84 of file vtkImageMapToColors.h.

void vtkImageMapToColors::SetOutputFormatToRGB (    )  [inline]

Set the output format, the default is RGBA. Definition at line 85 of file vtkImageMapToColors.h.

void vtkImageMapToColors::SetOutputFormatToLuminanceAlpha (    )  [inline]

Set the output format, the default is RGBA. Definition at line 86 of file vtkImageMapToColors.h.

void vtkImageMapToColors::SetOutputFormatToLuminance (    )  [inline]

Set the output format, the default is RGBA. Definition at line 87 of file vtkImageMapToColors.h.

virtual void vtkImageMapToColors::SetActiveComponent (  int    )  [virtual]

Set the component to map for multi-component images (default: 0)

virtual int vtkImageMapToColors::GetActiveComponent (    )  [virtual]

Set the component to map for multi-component images (default: 0)

virtual void vtkImageMapToColors::SetPassAlphaToOutput (  int    )  [virtual]

Use the alpha component of the input when computing the alpha component of the output (useful when converting monochrome+alpha data to RGBA)

virtual void vtkImageMapToColors::PassAlphaToOutputOn (    )  [virtual]

Use the alpha component of the input when computing the alpha component of the output (useful when converting monochrome+alpha data to RGBA)

virtual void vtkImageMapToColors::PassAlphaToOutputOff (    )  [virtual]

Use the alpha component of the input when computing the alpha component of the output (useful when converting monochrome+alpha data to RGBA)

virtual int vtkImageMapToColors::GetPassAlphaToOutput (    )  [virtual]

Use the alpha component of the input when computing the alpha component of the output (useful when converting monochrome+alpha data to RGBA)

unsigned long vtkImageMapToColors::GetMTime (    )  [virtual]

We need to check the modified time of the lookup table too. Reimplemented from vtkObject.

void vtkImageMapToColors::ExecuteInformation (  vtkImageData *    inData, vtkImageData *    outData )  [protected, virtual]

Reimplemented from vtkImageToImageFilter. Reimplemented in vtkImageMapToWindowLevelColors.

void vtkImageMapToColors::ExecuteInformation (    )  [inline, protected, virtual]

Reimplemented from vtkImageToImageFilter. Reimplemented in vtkImageMapToWindowLevelColors. Definition at line 113 of file vtkImageMapToColors.h. Referenced by vtkImageMapToWindowLevelColors::ExecuteInformation().

void vtkImageMapToColors::ThreadedExecute (  vtkImageData *    inData, vtkImageData *    outData, int    extent[6], int    id )  [protected, virtual]

If the subclass does not define an Execute method, then the task will be broken up, multiple threads will be spawned, and each thread will call this method. It is public so that the thread functions can call this method. Reimplemented from vtkImageToImageFilter. Reimplemented in vtkImageMapToWindowLevelColors.

void vtkImageMapToColors::ExecuteData (  vtkDataObject *    output )  [protected]

Reimplemented from vtkImageToImageFilter. Reimplemented in vtkImageMapToWindowLevelColors.

---

Member Data Documentation

vtkScalarsToColors* vtkImageMapToColors::LookupTable [protected]

Definition at line 120 of file vtkImageMapToColors.h.

int vtkImageMapToColors::OutputFormat [protected]

Definition at line 121 of file vtkImageMapToColors.h.

int vtkImageMapToColors::ActiveComponent [protected]

Definition at line 123 of file vtkImageMapToColors.h.

int vtkImageMapToColors::PassAlphaToOutput [protected]

Definition at line 124 of file vtkImageMapToColors.h.

int vtkImageMapToColors::DataWasPassed [protected]

Definition at line 126 of file vtkImageMapToColors.h.

---

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

• Imaging/vtkImageMapToColors.h

---