VTK  9.3.0
vtkScalarsToColors.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
40 #ifndef vtkScalarsToColors_h
41 #define vtkScalarsToColors_h
42 
43 #include "vtkCommonCoreModule.h" // For export macro
44 #include "vtkObject.h"
45 #include "vtkVariant.h" // Set/get annotation methods require variants.
46 
47 VTK_ABI_NAMESPACE_BEGIN
48 class vtkAbstractArray;
49 class vtkDataArray;
51 class vtkAbstractArray;
52 class vtkStringArray;
54 
55 class VTKCOMMONCORE_EXPORT vtkScalarsToColors : public vtkObject
56 {
57 public:
58  vtkTypeMacro(vtkScalarsToColors, vtkObject);
59  void PrintSelf(ostream& os, vtkIndent indent) override;
61 
63 
68  virtual vtkTypeBool IsOpaque();
69  virtual vtkTypeBool IsOpaque(vtkAbstractArray* scalars, int colorMode, int component);
70  virtual vtkTypeBool IsOpaque(vtkAbstractArray* scalars, int colorMode, int component,
71  vtkUnsignedCharArray* ghosts, unsigned char ghostsToSkip = 0xff);
73 
78  virtual void Build() {}
79 
81 
84  virtual double* GetRange() VTK_SIZEHINT(2);
85  virtual void SetRange(double min, double max);
86  virtual void SetRange(const double rng[2]) { this->SetRange(rng[0], rng[1]); }
88 
93  virtual const unsigned char* MapValue(double v);
94 
99  virtual void GetColor(double v, double rgb[3]);
100 
105  double* GetColor(double v) VTK_SIZEHINT(3)
106  {
107  this->GetColor(v, this->RGB);
108  return this->RGB;
109  }
110 
116  virtual double GetOpacity(double v);
117 
123  double GetLuminance(double x)
124  {
125  double rgb[3];
126  this->GetColor(x, rgb);
127  return static_cast<double>(rgb[0] * 0.30 + rgb[1] * 0.59 + rgb[2] * 0.11);
128  }
129 
131 
137  virtual void SetAlpha(double alpha);
138  vtkGetMacro(Alpha, double);
140 
142 
162  vtkDataArray* scalars, int colorMode, int component, int outputFormat = VTK_RGBA);
164  vtkAbstractArray* scalars, int colorMode, int component, int outputFormat = VTK_RGBA);
166 
168 
173  vtkSetMacro(VectorMode, int);
174  vtkGetMacro(VectorMode, int);
179 
181  {
182  MAGNITUDE = 0,
183  COMPONENT = 1,
184  RGBCOLORS = 2
185  };
186 
188 
192  vtkSetMacro(VectorComponent, int);
193  vtkGetMacro(VectorComponent, int);
195 
197 
204  vtkSetMacro(VectorSize, int);
205  vtkGetMacro(VectorSize, int);
207 
215  void MapVectorsThroughTable(void* input, unsigned char* output, int inputDataType,
216  int numberOfValues, int inputIncrement, int outputFormat, int vectorComponent, int vectorSize);
217  void MapVectorsThroughTable(void* input, unsigned char* output, int inputDataType,
218  int numberOfValues, int inputIncrement, int outputFormat)
219  {
220  this->MapVectorsThroughTable(
221  input, output, inputDataType, numberOfValues, inputIncrement, outputFormat, -1, -1);
222  }
223 
232  void MapScalarsThroughTable(vtkDataArray* scalars, unsigned char* output, int outputFormat);
233  void MapScalarsThroughTable(vtkDataArray* scalars, unsigned char* output)
234  {
235  this->MapScalarsThroughTable(scalars, output, VTK_RGBA);
236  }
237  void MapScalarsThroughTable(void* input, unsigned char* output, int inputDataType,
238  int numberOfValues, int inputIncrement, int outputFormat)
239  {
240  this->MapScalarsThroughTable2(
241  input, output, inputDataType, numberOfValues, inputIncrement, outputFormat);
242  }
243 
249  virtual void MapScalarsThroughTable2(void* input, unsigned char* output, int inputDataType,
250  int numberOfValues, int inputIncrement, int outputFormat);
251 
255  virtual void DeepCopy(vtkScalarsToColors* o);
256 
261  virtual vtkTypeBool UsingLogScale() { return 0; }
262 
267 
269 
282  virtual void SetAnnotations(vtkAbstractArray* values, vtkStringArray* annotations);
283  vtkGetObjectMacro(AnnotatedValues, vtkAbstractArray);
284  vtkGetObjectMacro(Annotations, vtkStringArray);
286 
292 
298 
303 
309 
315 
319  virtual void GetAnnotationColor(const vtkVariant& val, double rgba[4]);
320 
325 
332 
345  virtual void GetIndexedColor(vtkIdType i, double rgba[4]);
346 
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 
392 protected:
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 
434  virtual void UpdateAnnotatedValueMap();
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 #if !defined(VTK_LEGACY_REMOVE)
453  // Obsolete, kept so subclasses will still compile
455 #endif
456 
457  unsigned char RGBABytes[4];
458 
459 private:
460  double RGB[3];
461  double InputRange[2];
462 
463  vtkScalarsToColors(const vtkScalarsToColors&) = delete;
464  void operator=(const vtkScalarsToColors&) = delete;
465 };
466 
468 
473 template <>
474 inline unsigned char vtkScalarsToColors::ColorToUChar(double t)
475 {
476  double temp = (t * 255.0) + 0.5;
477  return static_cast<unsigned char>(temp);
478 }
479 template <>
480 inline unsigned char vtkScalarsToColors::ColorToUChar(float t)
481 {
482  double temp = (t * 255.0) + 0.5;
483  return static_cast<unsigned char>(temp);
484 }
486 
487 VTK_ABI_NAMESPACE_END
488 #endif
Abstract superclass for all arrays.
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:45
a simple class to control print indentation
Definition: vtkIndent.h:29
abstract base class for most VTK objects
Definition: vtkObject.h:52
Superclass for mapping scalar values to colors.
virtual vtkTypeBool UsingLogScale()
This should return 1 if the subclass is using log scale for mapping scalars to colors.
static vtkScalarsToColors * New()
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.
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.
virtual vtkTypeBool IsOpaque(vtkAbstractArray *scalars, int colorMode, int component)
Return true if all of the values defining the mapping have an opacity equal to 1.
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 vtkUnsignedCharArray * MapScalars(vtkAbstractArray *scalars, int colorMode, int component, int outputFormat=VTK_RGBA)
Internal methods that map a data array into an unsigned char array.
virtual void SetRange(const double rng[2])
Sets/Gets the range of scalars that will be mapped.
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 vtkTypeBool IsOpaque()
Return true if all of the values defining the mapping have an opacity equal to 1.
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.
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(void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat)
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 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 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 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 vtkTypeBool IsOpaque(vtkAbstractArray *scalars, int colorMode, int component, vtkUnsignedCharArray *ghosts, unsigned char ghostsToSkip=0xff)
Return true if all of the values defining the mapping have an opacity equal to 1.
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
virtual double * GetRange()
Sets/Gets the range of scalars that will be mapped.
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.
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...
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.
vtkUnsignedCharArray * ConvertToRGBA(vtkDataArray *colors, int numComp, int numTuples)
An internal method used to convert a color array to RGBA.
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:29
a vtkAbstractArray subclass for strings
dynamic, self-adjusting array of unsigned char
A type representing the union of many types.
Definition: vtkVariant.h:53
@ component
Definition: vtkX3D.h:175
@ value
Definition: vtkX3D.h:220
@ alpha
Definition: vtkX3D.h:250
int vtkTypeBool
Definition: vtkABI.h:64
#define VTK_RGBA
int vtkIdType
Definition: vtkType.h:315
#define VTK_SIZEHINT(...)
#define max(a, b)