VTK
vtkImageMapToColors.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkImageMapToColors.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
29 #ifndef vtkImageMapToColors_h
30 #define vtkImageMapToColors_h
31 
32 
33 #include "vtkImagingCoreModule.h" // For export macro
35 
36 class vtkScalarsToColors;
37 
38 class VTKIMAGINGCORE_EXPORT vtkImageMapToColors : public vtkThreadedImageAlgorithm
39 {
40 public:
41  static vtkImageMapToColors *New();
43  void PrintSelf(ostream& os, vtkIndent indent) override;
44 
46 
49  virtual void SetLookupTable(vtkScalarsToColors*);
50  vtkGetObjectMacro(LookupTable,vtkScalarsToColors);
52 
54 
57  vtkSetMacro(OutputFormat,int);
58  vtkGetMacro(OutputFormat,int);
59  void SetOutputFormatToRGBA() { this->OutputFormat = VTK_RGBA; };
60  void SetOutputFormatToRGB() { this->OutputFormat = VTK_RGB; };
61  void SetOutputFormatToLuminanceAlpha() { this->OutputFormat = VTK_LUMINANCE_ALPHA; };
62  void SetOutputFormatToLuminance() { this->OutputFormat = VTK_LUMINANCE; };
64 
66 
69  vtkSetMacro(ActiveComponent,int);
70  vtkGetMacro(ActiveComponent,int);
72 
74 
78  vtkSetMacro(PassAlphaToOutput,vtkTypeBool);
79  vtkBooleanMacro(PassAlphaToOutput,vtkTypeBool);
80  vtkGetMacro(PassAlphaToOutput,vtkTypeBool);
82 
86  vtkMTimeType GetMTime() override;
87 
89 
93  vtkSetVector4Macro(NaNColor, unsigned char);
94  vtkGetVector4Macro(NaNColor, unsigned char);
96 
97 protected:
99  ~vtkImageMapToColors() override;
100 
103  vtkInformationVector *) override;
104 
105  void ThreadedRequestData(vtkInformation *request,
106  vtkInformationVector **inputVector,
107  vtkInformationVector *outputVector,
108  vtkImageData ***inData, vtkImageData **outData,
109  int extent[6], int id) override;
110 
111  int RequestData(vtkInformation *request,
112  vtkInformationVector **inputVector,
113  vtkInformationVector *outputVector) override;
114 
117 
120 
122 
123  unsigned char NaNColor[4];
124 private:
125  vtkImageMapToColors(const vtkImageMapToColors&) = delete;
126  void operator=(const vtkImageMapToColors&) = delete;
127 };
128 
129 #endif
130 
131 
132 
133 
134 
135 
136 
vtkThreadedImageAlgorithm::ThreadedRequestData
virtual void ThreadedRequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int extent[6], int threadId)
If the subclass does not define an Execute method, then the task will be broken up,...
vtkImageMapToColors::SetOutputFormatToLuminance
void SetOutputFormatToLuminance()
Definition: vtkImageMapToColors.h:62
vtkImageMapToColors::PassAlphaToOutput
vtkTypeBool PassAlphaToOutput
Definition: vtkImageMapToColors.h:119
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:35
vtkThreadedImageAlgorithm
Generic filter that has one input.
Definition: vtkThreadedImageAlgorithm.h:37
vtkImageMapToColors
map the input image through a lookup table
Definition: vtkImageMapToColors.h:38
vtkThreadedImageAlgorithm.h
vtkImageMapToColors::LookupTable
vtkScalarsToColors * LookupTable
Definition: vtkImageMapToColors.h:115
VTK_LUMINANCE
#define VTK_LUMINANCE
Definition: vtkSystemIncludes.h:97
vtkImageMapToColors::DataWasPassed
int DataWasPassed
Definition: vtkImageMapToColors.h:121
vtkImageMapToColors::ActiveComponent
int ActiveComponent
Definition: vtkImageMapToColors.h:118
vtkImageAlgorithm::RequestInformation
virtual int RequestInformation(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
Subclasses can reimplement this method to collect information from their inputs and set information f...
vtkObject::GetMTime
virtual vtkMTimeType GetMTime()
Return this object's modified time.
vtkThreadedImageAlgorithm::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkImageMapToColors::OutputFormat
int OutputFormat
Definition: vtkImageMapToColors.h:116
vtkImageMapToColors::SetOutputFormatToRGB
void SetOutputFormatToRGB()
Definition: vtkImageMapToColors.h:60
VTK_RGB
#define VTK_RGB
Definition: vtkSystemIncludes.h:99
vtkImageData
topologically and geometrically regular array of data
Definition: vtkImageData.h:39
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkScalarsToColors
Superclass for mapping scalar values to colors.
Definition: vtkScalarsToColors.h:60
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:80
vtkAlgorithm::New
static vtkAlgorithm * New()
VTK_LUMINANCE_ALPHA
#define VTK_LUMINANCE_ALPHA
Definition: vtkSystemIncludes.h:98
vtkImageMapToColors::SetOutputFormatToLuminanceAlpha
void SetOutputFormatToLuminanceAlpha()
Definition: vtkImageMapToColors.h:61
VTK_RGBA
#define VTK_RGBA
Definition: vtkSystemIncludes.h:100
vtkX3D::extent
Definition: vtkX3D.h:345
vtkThreadedImageAlgorithm::RequestData
int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
This is called by the superclass.
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:302
vtkImageMapToColors::SetOutputFormatToRGBA
void SetOutputFormatToRGBA()
Definition: vtkImageMapToColors.h:59