VTK  9.1.0
vtkScalarsToColors.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkScalarsToColors.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=========================================================================*/
46#ifndef vtkScalarsToColors_h
47#define vtkScalarsToColors_h
48
49#include "vtkCommonCoreModule.h" // For export macro
50#include "vtkObject.h"
51#include "vtkVariant.h" // Set/get annotation methods require variants.
52
54class vtkDataArray;
57class vtkStringArray;
58
59class VTKCOMMONCORE_EXPORT vtkScalarsToColors : public vtkObject
60{
61public:
63 void PrintSelf(ostream& os, vtkIndent indent) override;
65
67
72 virtual int IsOpaque();
73 virtual int IsOpaque(vtkAbstractArray* scalars, int colorMode, int component);
75
80 virtual void Build() {}
81
83
86 virtual double* GetRange() VTK_SIZEHINT(2);
87 virtual void SetRange(double min, double max);
88 virtual void SetRange(const double rng[2]) { this->SetRange(rng[0], rng[1]); }
90
95 virtual const unsigned char* MapValue(double v);
96
101 virtual void GetColor(double v, double rgb[3]);
102
107 double* GetColor(double v) VTK_SIZEHINT(3)
108 {
109 this->GetColor(v, this->RGB);
110 return this->RGB;
111 }
112
118 virtual double GetOpacity(double v);
119
125 double GetLuminance(double x)
126 {
127 double rgb[3];
128 this->GetColor(x, rgb);
129 return static_cast<double>(rgb[0] * 0.30 + rgb[1] * 0.59 + rgb[2] * 0.11);
130 }
131
133
139 virtual void SetAlpha(double alpha);
140 vtkGetMacro(Alpha, double);
142
144
164 vtkDataArray* scalars, int colorMode, int component, int outputFormat = VTK_RGBA);
166 vtkAbstractArray* scalars, int colorMode, int component, int outputFormat = VTK_RGBA);
168
170
175 vtkSetMacro(VectorMode, int);
176 vtkGetMacro(VectorMode, int);
181
183 {
184 MAGNITUDE = 0,
185 COMPONENT = 1,
186 RGBCOLORS = 2
187 };
188
190
194 vtkSetMacro(VectorComponent, int);
195 vtkGetMacro(VectorComponent, int);
197
199
206 vtkSetMacro(VectorSize, int);
207 vtkGetMacro(VectorSize, int);
209
217 void MapVectorsThroughTable(void* input, unsigned char* output, int inputDataType,
218 int numberOfValues, int inputIncrement, int outputFormat, int vectorComponent, int vectorSize);
219 void MapVectorsThroughTable(void* input, unsigned char* output, int inputDataType,
220 int numberOfValues, int inputIncrement, int outputFormat)
221 {
222 this->MapVectorsThroughTable(
223 input, output, inputDataType, numberOfValues, inputIncrement, outputFormat, -1, -1);
224 }
225
234 void MapScalarsThroughTable(vtkDataArray* scalars, unsigned char* output, int outputFormat);
235 void MapScalarsThroughTable(vtkDataArray* scalars, unsigned char* output)
236 {
237 this->MapScalarsThroughTable(scalars, output, VTK_RGBA);
238 }
239 void MapScalarsThroughTable(void* input, unsigned char* output, int inputDataType,
240 int numberOfValues, int inputIncrement, int outputFormat)
241 {
242 this->MapScalarsThroughTable2(
243 input, output, inputDataType, numberOfValues, inputIncrement, outputFormat);
244 }
245
251 virtual void MapScalarsThroughTable2(void* input, unsigned char* output, int inputDataType,
252 int numberOfValues, int inputIncrement, int outputFormat);
253
257 virtual void DeepCopy(vtkScalarsToColors* o);
258
263 virtual int UsingLogScale() { return 0; }
264
269
271
284 virtual void SetAnnotations(vtkAbstractArray* values, vtkStringArray* annotations);
285 vtkGetObjectMacro(AnnotatedValues, vtkAbstractArray);
286 vtkGetObjectMacro(Annotations, vtkStringArray);
288
293 virtual vtkIdType SetAnnotation(vtkVariant value, vtkStdString annotation);
294
300
305
310
315
319 virtual void GetAnnotationColor(const vtkVariant& val, double rgba[4]);
320
325
332
345 virtual void GetIndexedColor(vtkIdType i, double rgba[4]);
346
353 virtual bool RemoveAnnotation(vtkVariant value);
354
358 virtual void ResetAnnotations();
359
361
369 vtkSetMacro(IndexedLookup, vtkTypeBool);
370 vtkGetMacro(IndexedLookup, vtkTypeBool);
371 vtkBooleanMacro(IndexedLookup, vtkTypeBool);
373
375
380 template <typename T>
381 static unsigned char ColorToUChar(T t)
382 {
383 return static_cast<unsigned char>(t);
384 }
385 template <typename T>
386 static void ColorToUChar(T t, unsigned char* dest)
387 {
388 *dest = ColorToUChar(t);
389 }
391
392protected:
395
407 void MapColorsToColors(void* input, unsigned char* output, int inputDataType, int numberOfValues,
408 int numberOfComponents, int vectorSize, int outputFormat);
409
415 vtkUnsignedCharArray* ConvertToRGBA(vtkDataArray* colors, int numComp, int numTuples);
416
421 void MapVectorsToMagnitude(void* input, double* output, int inputDataType, int numberOfValues,
422 int numberOfComponents, int vectorSize);
423
429
435
436 // Annotations of specific values.
439
440 class vtkInternalAnnotatedValueList;
441 vtkInternalAnnotatedValueList* AnnotatedValueList;
442
444
445 double Alpha;
446
447 // How to map arrays with multiple components.
451
452 // Obsolete, kept so subclasses will still compile
454
455 unsigned char RGBABytes[4];
456
457private:
458 double RGB[3];
459 double InputRange[2];
460
461 vtkScalarsToColors(const vtkScalarsToColors&) = delete;
462 void operator=(const vtkScalarsToColors&) = delete;
463};
464
466
471template <>
472inline unsigned char vtkScalarsToColors::ColorToUChar(double t)
473{
474 return static_cast<unsigned char>(t * 255 + 0.5);
475}
476template <>
477inline unsigned char vtkScalarsToColors::ColorToUChar(float t)
478{
479 return static_cast<unsigned char>(t * 255 + 0.5);
480}
482
483#endif
Abstract superclass for all arrays.
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:50
a simple class to control print indentation
Definition: vtkIndent.h:34
abstract base class for most VTK objects
Definition: vtkObject.h:63
Superclass for mapping scalar values to colors.
double * GetColor(double v)
Map one value through the lookup table and return the color as an RGB array of doubles between 0 and ...
void MapScalarsThroughTable(vtkDataArray *scalars, unsigned char *output)
void MapColorsToColors(void *input, unsigned char *output, int inputDataType, int numberOfValues, int numberOfComponents, int vectorSize, int outputFormat)
An internal method that assumes that the input already has the right colors, and only remaps the rang...
virtual void DeepCopy(vtkScalarsToColors *o)
Copy the contents from another object.
virtual int IsOpaque()
Return true if all of the values defining the mapping have an opacity equal to 1.
vtkVariant GetAnnotatedValue(vtkIdType idx)
Return the annotated value at a particular index in the list of annotations.
void MapScalarsThroughTable(vtkDataArray *scalars, unsigned char *output, int outputFormat)
Map a set of scalars through the lookup table in a single operation.
virtual void UpdateAnnotatedValueMap()
Update the map from annotated values to indices in the array of annotations.
vtkUnsignedCharArray * ConvertToRGBA(vtkDataArray *colors, int numComp, int numTuples)
An internal method used to convert a color array to RGBA.
virtual void SetAlpha(double alpha)
Specify an additional opacity (alpha) value to blend with.
double GetLuminance(double x)
Map one value through the lookup table and return the luminance 0.3*red + 0.59*green + 0....
virtual void SetRange(const double rng[2])
Sets/Gets the range of scalars that will be mapped.
static vtkScalarsToColors * New()
virtual void GetIndexedColor(vtkIdType i, double rgba[4])
Get the "indexed color" assigned to an index.
virtual vtkIdType SetAnnotation(vtkStdString value, vtkStdString annotation)
This variant of SetAnnotation accepts the value as a string so ParaView can treat annotations as stri...
virtual vtkIdType GetNumberOfAvailableColors()
Get the number of available colors for mapping to.
static void ColorToUChar(T t, unsigned char *dest)
Converts a color from numeric type T to uchar.
void MapScalarsThroughTable(void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat)
void MapVectorsThroughTable(void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat, int vectorComponent, int vectorSize)
Map vectors through the lookup table.
virtual bool RemoveAnnotation(vtkVariant value)
Remove an existing entry from the list of annotated values.
virtual int IsOpaque(vtkAbstractArray *scalars, int colorMode, int component)
Return true if all of the values defining the mapping have an opacity equal to 1.
virtual int UsingLogScale()
This should return 1 is the subclass is using log scale for mapping scalars to colors.
virtual double GetOpacity(double v)
Map one value through the lookup table and return the alpha value (the opacity) as a double between 0...
void MapVectorsThroughTable(void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat)
~vtkScalarsToColors() override
virtual void ResetAnnotations()
Remove all existing values and their annotations.
virtual const unsigned char * MapValue(double v)
Map one value through the lookup table and return a color defined as an RGBA unsigned char tuple (4 b...
virtual vtkUnsignedCharArray * MapScalars(vtkDataArray *scalars, int colorMode, int component, int outputFormat=VTK_RGBA)
Internal methods that map a data array into an unsigned char array.
void SetVectorModeToComponent()
Change mode that maps vectors by magnitude vs.
void SetVectorModeToMagnitude()
Change mode that maps vectors by magnitude vs.
vtkIdType GetAnnotatedValueIndexInternal(const vtkVariant &val)
Look up an index into the array of annotations given a value.
virtual void SetAnnotations(vtkAbstractArray *values, vtkStringArray *annotations)
Set a list of discrete values, either as a categorical set of values (when IndexedLookup is true) or ...
static unsigned char ColorToUChar(T t)
Converts a color from numeric type T to uchar.
virtual void GetColor(double v, double rgb[3])
Map one value through the lookup table and store the color as an RGB array of doubles between 0 and 1...
vtkIdType GetNumberOfAnnotatedValues()
Return the annotated value at a particular index in the list of annotations.
virtual void MapScalarsThroughTable2(void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat)
An internal method typically not used in applications.
virtual void Build()
Perform any processing required (if any) before processing scalars.
virtual vtkIdType SetAnnotation(vtkVariant value, vtkStdString annotation)
Add a new entry (or change an existing entry) to the list of annotated values.
virtual void GetAnnotationColor(const vtkVariant &val, double rgba[4])
Obtain the color associated with a particular annotated value (or NanColor if unmatched).
vtkInternalAnnotatedValueList * AnnotatedValueList
vtkAbstractArray * AnnotatedValues
virtual vtkIdType CheckForAnnotatedValue(vtkVariant value)
Allocate annotation arrays if needed, then return the index of the given value or -1 if not present.
virtual double * GetRange()
Sets/Gets the range of scalars that will be mapped.
void MapVectorsToMagnitude(void *input, double *output, int inputDataType, int numberOfValues, int numberOfComponents, int vectorSize)
An internal method for converting vectors to magnitudes, used as a preliminary step before doing magn...
virtual vtkUnsignedCharArray * MapScalars(vtkAbstractArray *scalars, int colorMode, int component, int outputFormat=VTK_RGBA)
Internal methods that map a data array into an unsigned char array.
vtkIdType GetAnnotatedValueIndex(vtkVariant val)
Return the index of the given value in the list of annotated values (or -1 if not present).
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkStringArray * Annotations
void SetVectorModeToRGBColors()
Change mode that maps vectors by magnitude vs.
vtkStdString GetAnnotation(vtkIdType idx)
Return the annotation at a particular index in the list of annotations.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:36
a vtkAbstractArray subclass for strings
dynamic, self-adjusting array of unsigned char
A atomic type representing the union of many types.
Definition: vtkVariant.h:66
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_RGBA
int vtkIdType
Definition: vtkType.h:332
#define VTK_SIZEHINT(...)
#define max(a, b)