vtkImageMapToColors Class Reference

#include <vtkImageMapToColors.h>

Inheritance diagram for vtkImageMapToColors:

[legend]Collaboration diagram for vtkImageMapToColors:

[legend]List of all members.

---

Detailed Description

map the input image through a lookup table

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

Examples:

vtkImageMapToColors (Examples)

Tests:

vtkImageMapToColors (Tests)

Definition at line 42 of file vtkImageMapToColors.h.

Public Types
typedef vtkThreadedImageAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
virtual unsigned long	GetMTime ()
void	PrintSelf (ostream &os, vtkIndent indent)
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 Member Functions
static vtkImageMapToColors *	New ()
static int	IsTypeOf (const char *type)
static vtkImageMapToColors *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkImageMapToColors ()
	~vtkImageMapToColors ()
virtual int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void	ThreadedRequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int extent[6], int id)
virtual int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
Protected Attributes
vtkScalarsToColors *	LookupTable
int	OutputFormat
int	ActiveComponent
int	PassAlphaToOutput
int	DataWasPassed

---

Member Typedef Documentation

typedef vtkThreadedImageAlgorithm vtkImageMapToColors::Superclass

Reimplemented from vtkThreadedImageAlgorithm. Reimplemented in vtkImageMapToRGBA, and vtkImageMapToWindowLevelColors. Definition at line 46 of file vtkImageMapToColors.h.

---

Constructor & Destructor Documentation

vtkImageMapToColors::vtkImageMapToColors (   )  [protected]

vtkImageMapToColors::~vtkImageMapToColors (   )  [protected]

---

Member Function Documentation

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

Create an object with Debug turned off, modified time initialized to zero, and reference counting on. Reimplemented from vtkAlgorithm. Reimplemented in vtkImageMapToRGBA, and vtkImageMapToWindowLevelColors.

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

Reimplemented from vtkThreadedImageAlgorithm. Reimplemented in vtkImageMapToRGBA, and vtkImageMapToWindowLevelColors.

static 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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkThreadedImageAlgorithm. 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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkThreadedImageAlgorithm. Reimplemented in vtkImageMapToRGBA, and vtkImageMapToWindowLevelColors.

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

Reimplemented from vtkThreadedImageAlgorithm. 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 vtkThreadedImageAlgorithm. Reimplemented in vtkImageMapToWindowLevelColors.

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

Set the lookup table.

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

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 59 of file vtkImageMapToColors.h. References VTK_RGBA.

void vtkImageMapToColors::SetOutputFormatToRGB (   )  [inline]

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

void vtkImageMapToColors::SetOutputFormatToLuminanceAlpha (   )  [inline]

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

void vtkImageMapToColors::SetOutputFormatToLuminance (   )  [inline]

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

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)

virtual unsigned long vtkImageMapToColors::GetMTime (   )  [virtual]

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

virtual int vtkImageMapToColors::RequestInformation (  vtkInformation *  , vtkInformationVector **  , vtkInformationVector *  )  [protected, virtual]

Reimplemented from vtkImageAlgorithm. Reimplemented in vtkImageMapToWindowLevelColors.

void vtkImageMapToColors::ThreadedRequestData (  vtkInformation *  request, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector, 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 vtkThreadedImageAlgorithm. Reimplemented in vtkImageMapToWindowLevelColors.

virtual int vtkImageMapToColors::RequestData (  vtkInformation *  request, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector )  [protected, virtual]

This is called by the superclass. This is the method you should override. Reimplemented from vtkThreadedImageAlgorithm. Reimplemented in vtkImageMapToWindowLevelColors.

---

Member Data Documentation

vtkScalarsToColors* vtkImageMapToColors::LookupTable [protected]

Definition at line 99 of file vtkImageMapToColors.h.

int vtkImageMapToColors::OutputFormat [protected]

Definition at line 100 of file vtkImageMapToColors.h.

int vtkImageMapToColors::ActiveComponent [protected]

Definition at line 102 of file vtkImageMapToColors.h.

int vtkImageMapToColors::PassAlphaToOutput [protected]

Definition at line 103 of file vtkImageMapToColors.h.

int vtkImageMapToColors::DataWasPassed [protected]

Definition at line 105 of file vtkImageMapToColors.h.

---

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

• dox/Imaging/vtkImageMapToColors.h

---