VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkColorTransferFunction Class Reference

Defines a transfer function for mapping a property to an RGB color value. More...

#include <vtkColorTransferFunction.h>

Inheritance diagram for vtkColorTransferFunction:
[legend]
Collaboration diagram for vtkColorTransferFunction:
[legend]

Public Types

typedef vtkScalarsToColors Superclass
 
- Public Types inherited from vtkScalarsToColors
enum  VectorModes { MAGNITUDE = 0, COMPONENT = 1, RGBCOLORS = 2 }
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkColorTransferFunctionNewInstance () const
 
void DeepCopy (vtkScalarsToColors *f) override
 Copy the contents from another object. More...
 
void ShallowCopy (vtkColorTransferFunction *f)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Print method for vtkColorTransferFunction. More...
 
int GetSize ()
 How many nodes define this function? More...
 
int AddRGBPoint (double x, double r, double g, double b)
 Add/Remove a point to/from the function defined in RGB or HSV Return the index of the point (0 based), or -1 on error. More...
 
int AddRGBPoint (double x, double r, double g, double b, double midpoint, double sharpness)
 
int AddHSVPoint (double x, double h, double s, double v)
 
int AddHSVPoint (double x, double h, double s, double v, double midpoint, double sharpness)
 
int RemovePoint (double x)
 
void AddRGBSegment (double x1, double r1, double g1, double b1, double x2, double r2, double g2, double b2)
 Add two points to the function and remove all the points between them. More...
 
void AddHSVSegment (double x1, double h1, double s1, double v1, double x2, double h2, double s2, double v2)
 
void RemoveAllPoints ()
 Remove all points. More...
 
double * GetColor (double x)
 Returns an RGB color for the specified scalar value. More...
 
void GetColor (double x, double rgb[3]) override
 Map one value through the lookup table and store the color as an RGB array of doubles between 0 and 1 in the rgb argument. More...
 
double GetRedValue (double x)
 Get the color components individually. More...
 
double GetGreenValue (double x)
 
double GetBlueValue (double x)
 
int GetNodeValue (int index, double val[6])
 For the node specified by index, set/get the location (X), R, G, and B values, midpoint, and sharpness values at the node. More...
 
int SetNodeValue (int index, double val[6])
 
const unsigned char * MapValue (double v) override
 Map one value through the lookup table. More...
 
double * GetRange () override
 Returns min and max position of all function points. More...
 
virtual void GetRange (double &arg1, double &arg2)
 
virtual void GetRange (double _arg[2])
 
int AdjustRange (double range[2])
 Remove all points out of the new range, and make sure there is a point at each end of that range. More...
 
void GetTable (double x1, double x2, int n, double *table)
 Fills in a table of n colors mapped from values mapped with even spacing between x1 and x2, inclusive. More...
 
void GetTable (double x1, double x2, int n, float *table)
 
const unsigned char * GetTable (double x1, double x2, int n)
 
void BuildFunctionFromTable (double x1, double x2, int size, double *table)
 Construct a color transfer function from a table. More...
 
virtual void SetClamping (vtkTypeBool)
 Sets/gets whether clamping is used. More...
 
virtual vtkTypeBool GetClamping ()
 
virtual void ClampingOn ()
 
virtual void ClampingOff ()
 
virtual void SetColorSpace (int)
 Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step. More...
 
void SetColorSpaceToRGB ()
 
void SetColorSpaceToHSV ()
 
void SetColorSpaceToLab ()
 
void SetColorSpaceToLabCIEDE2000 ()
 
void SetColorSpaceToDiverging ()
 
void SetColorSpaceToStep ()
 
virtual int GetColorSpace ()
 
virtual void SetHSVWrap (vtkTypeBool)
 
virtual vtkTypeBool GetHSVWrap ()
 
virtual void HSVWrapOn ()
 
virtual void HSVWrapOff ()
 
virtual void SetScale (int)
 Set the type of scale to use, linear or logarithmic. More...
 
void SetScaleToLinear ()
 
void SetScaleToLog10 ()
 
virtual int GetScale ()
 
virtual void SetNanColor (double, double, double)
 Set the RGB color to use when a NaN (not a number) is encountered. More...
 
virtual void SetNanColor (double[3])
 
virtual double * GetNanColor ()
 
virtual void GetNanColor (double &, double &, double &)
 
virtual void GetNanColor (double[3])
 
virtual void SetNanOpacity (double)
 Get/Set the opacity to use when a NaN (not a number) is encountered. More...
 
virtual double GetNanOpacity ()
 
virtual void SetNanColorRGBA (double r, double g, double b, double a)
 Set the RGBA color to use when a NaN (not a number) is encountered. More...
 
void SetNanColorRGBA (double rgba[4])
 
virtual void SetBelowRangeColor (double, double, double)
 Set the color to use when a value below the range is encountered. More...
 
virtual void SetBelowRangeColor (double[3])
 
virtual double * GetBelowRangeColor ()
 
virtual void GetBelowRangeColor (double &, double &, double &)
 
virtual void GetBelowRangeColor (double[3])
 
virtual void SetUseBelowRangeColor (vtkTypeBool)
 Set whether the below range color should be used. More...
 
virtual vtkTypeBool GetUseBelowRangeColor ()
 
virtual void UseBelowRangeColorOn ()
 
virtual void UseBelowRangeColorOff ()
 
virtual void SetAboveRangeColor (double, double, double)
 Set the color to use when a value above the range is encountered. More...
 
virtual void SetAboveRangeColor (double[3])
 
virtual double * GetAboveRangeColor ()
 
virtual void GetAboveRangeColor (double &, double &, double &)
 
virtual void GetAboveRangeColor (double[3])
 
virtual void SetUseAboveRangeColor (vtkTypeBool)
 Set whether the below range color should be used. More...
 
virtual vtkTypeBool GetUseAboveRangeColor ()
 
virtual void UseAboveRangeColorOn ()
 
virtual void UseAboveRangeColorOff ()
 
double * GetDataPointer ()
 Returns a pointer to an array of all node values in an interleaved array with the layout [X1, R1, G1, B1, X2, R2, G2, B2, ..., Xn, Rn, Gn, Bn] where n is the number of nodes defining the transfer function. More...
 
void FillFromDataPointer (int n, double *ptr)
 Defines the nodes from an array ptr with the layout [X1, R1, G1, B1, X2, R2, G2, B2, ..., Xn, Rn, Gn, Bn] where n is the number of nodes. More...
 
void MapScalarsThroughTable2 (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputIncrement) override
 Map a set of scalars through the lookup table. More...
 
virtual void SetAllowDuplicateScalars (vtkTypeBool)
 Toggle whether to allow duplicate scalar values in the color transfer function (off by default). More...
 
virtual vtkTypeBool GetAllowDuplicateScalars ()
 
virtual void AllowDuplicateScalarsOn ()
 
virtual void AllowDuplicateScalarsOff ()
 
vtkIdType GetNumberOfAvailableColors () override
 Get the number of available colors for mapping to. More...
 
void GetIndexedColor (vtkIdType idx, double rgba[4]) override
 Return a color given an integer index. More...
 
int EstimateMinNumberOfSamples (double const &x1, double const &x2)
 Estimates the minimum size of a table such that it would correctly sample this function. More...
 
- Public Member Functions inherited from vtkScalarsToColors
vtkScalarsToColorsNewInstance () const
 
virtual int IsOpaque ()
 Return true if all of the values defining the mapping have an opacity equal to 1. More...
 
virtual int IsOpaque (vtkAbstractArray *scalars, int colorMode, int component)
 
virtual void Build ()
 Perform any processing required (if any) before processing scalars. More...
 
double * GetColor (double v)
 Map one value through the lookup table and return the color as an RGB array of doubles between 0 and 1. More...
 
virtual double GetOpacity (double v)
 Map one value through the lookup table and return the alpha value (the opacity) as a double between 0 and 1. More...
 
double GetLuminance (double x)
 Map one value through the lookup table and return the luminance 0.3*red + 0.59*green + 0.11*blue as a double between 0 and 1. More...
 
virtual void SetAlpha (double alpha)
 Specify an additional opacity (alpha) value to blend with. More...
 
virtual double GetAlpha ()
 
virtual vtkUnsignedCharArrayMapScalars (vtkDataArray *scalars, int colorMode, int component, int outputFormat=VTK_RGBA)
 Internal methods that map a data array into an unsigned char array. More...
 
virtual vtkUnsignedCharArrayMapScalars (vtkAbstractArray *scalars, int colorMode, int component, int outputFormat=VTK_RGBA)
 
virtual void SetVectorMode (int)
 Change mode that maps vectors by magnitude vs. More...
 
virtual int GetVectorMode ()
 
void SetVectorModeToMagnitude ()
 
void SetVectorModeToComponent ()
 
void SetVectorModeToRGBColors ()
 
virtual void SetVectorComponent (int)
 If the mapper does not select which component of a vector to map to colors, you can specify it here. More...
 
virtual int GetVectorComponent ()
 
virtual void SetVectorSize (int)
 When mapping vectors, consider only the number of components selected by VectorSize to be part of the vector, and ignore any other components. More...
 
virtual int GetVectorSize ()
 
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. More...
 
void MapVectorsThroughTable (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat)
 
void MapScalarsThroughTable (vtkDataArray *scalars, unsigned char *output, int outputFormat)
 Map a set of scalars through the lookup table in a single operation. More...
 
void MapScalarsThroughTable (vtkDataArray *scalars, unsigned char *output)
 
void MapScalarsThroughTable (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat)
 
virtual int UsingLogScale ()
 This should return 1 is the subclass is using log scale for mapping scalars to colors. More...
 
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 as a set of annotations to add to a scalar array (when IndexedLookup is false). More...
 
virtual vtkAbstractArrayGetAnnotatedValues ()
 
virtual vtkStringArrayGetAnnotations ()
 
virtual vtkIdType SetAnnotation (vtkVariant value, vtkStdString annotation)
 Add a new entry (or change an existing entry) to the list of annotated values. More...
 
virtual vtkIdType SetAnnotation (vtkStdString value, vtkStdString annotation)
 This variant of SetAnnotation accepts the value as a string so ParaView can treat annotations as string vector arrays. More...
 
vtkIdType GetNumberOfAnnotatedValues ()
 Return the annotated value at a particular index in the list of annotations. More...
 
vtkVariant GetAnnotatedValue (vtkIdType idx)
 Return the annotated value at a particular index in the list of annotations. More...
 
vtkStdString GetAnnotation (vtkIdType idx)
 Return the annotation at a particular index in the list of annotations. More...
 
virtual void GetAnnotationColor (const vtkVariant &val, double rgba[4])
 Obtain the color associated with a particular annotated value (or NanColor if unmatched). More...
 
vtkIdType GetAnnotatedValueIndex (vtkVariant val)
 Return the index of the given value in the list of annotated values (or -1 if not present). More...
 
vtkIdType GetAnnotatedValueIndexInternal (const vtkVariant &val)
 Look up an index into the array of annotations given a value. More...
 
virtual bool RemoveAnnotation (vtkVariant value)
 Remove an existing entry from the list of annotated values. More...
 
virtual void ResetAnnotations ()
 Remove all existing values and their annotations. More...
 
virtual void SetIndexedLookup (vtkTypeBool)
 Set/get whether the lookup table is for categorical or ordinal data. More...
 
virtual vtkTypeBool GetIndexedLookup ()
 
virtual void IndexedLookupOn ()
 
virtual void IndexedLookupOff ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkColorTransferFunctionNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkColorTransferFunctionSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkScalarsToColors
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkScalarsToColorsSafeDownCast (vtkObjectBase *o)
 
static vtkScalarsToColorsNew ()
 
template<typename T >
static unsigned char ColorToUChar (T t)
 Converts a color from numeric type T to uchar. More...
 
template<typename T >
static void ColorToUChar (T t, unsigned char *dest)
 
template<>
unsigned char ColorToUChar (double t)
 Specializations of vtkScalarsToColors::ColorToUChar Converts from a color in a floating point type in range 0.0-1.0 to a uchar in range 0-255. More...
 
template<>
unsigned char ColorToUChar (float t)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkColorTransferFunction ()
 
 ~vtkColorTransferFunction () override
 
void SetRange (double, double) override
 Set the range of scalars being mapped. More...
 
void SetRange (const double rng[2]) override
 
void SortAndUpdateRange ()
 Internal method to sort the vector and update the Range whenever a node is added, edited or removed It always calls Modified(). More...
 
bool UpdateRange ()
 Returns true if the range has been changed. More...
 
void MovePoint (double oldX, double newX)
 Moves point from oldX to newX. More...
 
double FindMinimumXDistance ()
 Traverses the nodes to find the minimum distance. More...
 
- Protected Member Functions inherited from vtkScalarsToColors
 vtkScalarsToColors ()
 
 ~vtkScalarsToColors () override
 
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 range to [0,255] and pads to the desired output format. More...
 
vtkUnsignedCharArrayConvertToRGBA (vtkDataArray *colors, int numComp, int numTuples)
 An internal method used to convert a color array to RGBA. More...
 
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 magnitude mapping. More...
 
virtual vtkIdType CheckForAnnotatedValue (vtkVariant value)
 Allocate annotation arrays if needed, then return the index of the given value or -1 if not present. More...
 
virtual void UpdateAnnotatedValueMap ()
 Update the map from annotated values to indices in the array of annotations. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkColorTransferFunctionInternals * Internal
 
vtkTypeBool Clamping
 Determines the function value outside of defined points Zero = always return 0.0 outside of defined points One = clamp to the lowest value below defined points and highest value above defined points. More...
 
int ColorSpace
 The color space in which interpolation is performed. More...
 
vtkTypeBool HSVWrap
 Specify if HSV is wrap or not. More...
 
int Scale
 The color interpolation scale (linear or logarithmic). More...
 
double NanColor [3]
 The color to use for not-a-number. More...
 
double NanOpacity
 The opacity to use for not-a-number. More...
 
double BelowRangeColor [3]
 The below-range color. More...
 
vtkTypeBool UseBelowRangeColor
 Flag indicating whether below-range color should be used. More...
 
double AboveRangeColor [3]
 The above-range color. More...
 
vtkTypeBool UseAboveRangeColor
 Flag indicating whether below-range color should be used. More...
 
double * Function
 Temporary array to store data from the nodes. More...
 
double Range [2]
 The min and max node locations. More...
 
unsigned char UnsignedCharRGBAValue [4]
 Temporary storage for an evaluated color (0 to 255 RGBA A=255) More...
 
vtkTypeBool AllowDuplicateScalars
 If on, the same scalar value may have more than one node assigned to it. More...
 
vtkTimeStamp BuildTime
 
unsigned char * Table
 
int TableSize
 Temporary storage for the size of the table. More...
 
- Protected Attributes inherited from vtkScalarsToColors
vtkAbstractArrayAnnotatedValues
 
vtkStringArrayAnnotations
 
vtkInternalAnnotatedValueMap * AnnotatedValueMap
 
vtkTypeBool IndexedLookup
 
double Alpha
 
int VectorMode
 
int VectorComponent
 
int VectorSize
 
int UseMagnitude
 
unsigned char RGBABytes [4]
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Defines a transfer function for mapping a property to an RGB color value.

vtkColorTransferFunction is a color mapping in RGB or HSV space that uses piecewise hermite functions to allow interpolation that can be piecewise constant, piecewise linear, or somewhere in-between (a modified piecewise hermite function that squishes the function according to a sharpness parameter). The function also allows for the specification of the midpoint (the place where the function reaches the average of the two bounding nodes) as a normalize distance between nodes. See the description of class vtkPiecewiseFunction for an explanation of midpoint and sharpness.

See also
vtkPiecewiseFunction

Definition at line 54 of file vtkColorTransferFunction.h.

Member Typedef Documentation

◆ Superclass

Definition at line 58 of file vtkColorTransferFunction.h.

Constructor & Destructor Documentation

◆ vtkColorTransferFunction()

vtkColorTransferFunction::vtkColorTransferFunction ( )
protected

◆ ~vtkColorTransferFunction()

vtkColorTransferFunction::~vtkColorTransferFunction ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkColorTransferFunction* vtkColorTransferFunction::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkColorTransferFunction::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkColorTransferFunction::IsA ( const char *  name)
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 vtkScalarsToColors.

Reimplemented in vtkDiscretizableColorTransferFunction.

◆ SafeDownCast()

static vtkColorTransferFunction* vtkColorTransferFunction::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkColorTransferFunction::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkScalarsToColors.

Reimplemented in vtkDiscretizableColorTransferFunction.

◆ NewInstance()

vtkColorTransferFunction* vtkColorTransferFunction::NewInstance ( ) const

◆ DeepCopy()

void vtkColorTransferFunction::DeepCopy ( vtkScalarsToColors o)
overridevirtual

Copy the contents from another object.

Reimplemented from vtkScalarsToColors.

◆ ShallowCopy()

void vtkColorTransferFunction::ShallowCopy ( vtkColorTransferFunction f)

◆ PrintSelf()

void vtkColorTransferFunction::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Print method for vtkColorTransferFunction.

Reimplemented from vtkScalarsToColors.

Reimplemented in vtkDiscretizableColorTransferFunction.

◆ GetSize()

int vtkColorTransferFunction::GetSize ( )

How many nodes define this function?

◆ AddRGBPoint() [1/2]

int vtkColorTransferFunction::AddRGBPoint ( double  x,
double  r,
double  g,
double  b 
)

Add/Remove a point to/from the function defined in RGB or HSV Return the index of the point (0 based), or -1 on error.

See the description of class vtkPiecewiseFunction for an explanation of midpoint and sharpness.

◆ AddRGBPoint() [2/2]

int vtkColorTransferFunction::AddRGBPoint ( double  x,
double  r,
double  g,
double  b,
double  midpoint,
double  sharpness 
)

◆ AddHSVPoint() [1/2]

int vtkColorTransferFunction::AddHSVPoint ( double  x,
double  h,
double  s,
double  v 
)

◆ AddHSVPoint() [2/2]

int vtkColorTransferFunction::AddHSVPoint ( double  x,
double  h,
double  s,
double  v,
double  midpoint,
double  sharpness 
)

◆ RemovePoint()

int vtkColorTransferFunction::RemovePoint ( double  x)

◆ AddRGBSegment()

void vtkColorTransferFunction::AddRGBSegment ( double  x1,
double  r1,
double  g1,
double  b1,
double  x2,
double  r2,
double  g2,
double  b2 
)

Add two points to the function and remove all the points between them.

◆ AddHSVSegment()

void vtkColorTransferFunction::AddHSVSegment ( double  x1,
double  h1,
double  s1,
double  v1,
double  x2,
double  h2,
double  s2,
double  v2 
)

◆ RemoveAllPoints()

void vtkColorTransferFunction::RemoveAllPoints ( )

Remove all points.

◆ GetColor() [1/2]

double* vtkColorTransferFunction::GetColor ( double  x)
inline

Returns an RGB color for the specified scalar value.

Definition at line 105 of file vtkColorTransferFunction.h.

◆ GetColor() [2/2]

void vtkColorTransferFunction::GetColor ( double  v,
double  rgb[3] 
)
overridevirtual

Map one value through the lookup table and store the color as an RGB array of doubles between 0 and 1 in the rgb argument.

Reimplemented from vtkScalarsToColors.

Reimplemented in vtkDiscretizableColorTransferFunction.

◆ GetRedValue()

double vtkColorTransferFunction::GetRedValue ( double  x)

Get the color components individually.

◆ GetGreenValue()

double vtkColorTransferFunction::GetGreenValue ( double  x)

◆ GetBlueValue()

double vtkColorTransferFunction::GetBlueValue ( double  x)

◆ GetNodeValue()

int vtkColorTransferFunction::GetNodeValue ( int  index,
double  val[6] 
)

For the node specified by index, set/get the location (X), R, G, and B values, midpoint, and sharpness values at the node.

◆ SetNodeValue()

int vtkColorTransferFunction::SetNodeValue ( int  index,
double  val[6] 
)

◆ MapValue()

const unsigned char* vtkColorTransferFunction::MapValue ( double  v)
overridevirtual

Map one value through the lookup table.

Reimplemented from vtkScalarsToColors.

Reimplemented in vtkDiscretizableColorTransferFunction.

◆ GetRange() [1/3]

double* vtkColorTransferFunction::GetRange ( )
inlineoverridevirtual

Returns min and max position of all function points.

Reimplemented from vtkScalarsToColors.

Definition at line 136 of file vtkColorTransferFunction.h.

◆ GetRange() [2/3]

virtual void vtkColorTransferFunction::GetRange ( double &  arg1,
double &  arg2 
)
inlinevirtual

Definition at line 137 of file vtkColorTransferFunction.h.

◆ GetRange() [3/3]

virtual void vtkColorTransferFunction::GetRange ( double  _arg[2])
inlinevirtual

Definition at line 142 of file vtkColorTransferFunction.h.

◆ AdjustRange()

int vtkColorTransferFunction::AdjustRange ( double  range[2])

Remove all points out of the new range, and make sure there is a point at each end of that range.

Returns 1 on success, 0 otherwise.

◆ GetTable() [1/3]

void vtkColorTransferFunction::GetTable ( double  x1,
double  x2,
int  n,
double *  table 
)

Fills in a table of n colors mapped from values mapped with even spacing between x1 and x2, inclusive.

Note that GetTable ignores IndexedLookup

◆ GetTable() [2/3]

void vtkColorTransferFunction::GetTable ( double  x1,
double  x2,
int  n,
float *  table 
)

◆ GetTable() [3/3]

const unsigned char* vtkColorTransferFunction::GetTable ( double  x1,
double  x2,
int  n 
)

◆ BuildFunctionFromTable()

void vtkColorTransferFunction::BuildFunctionFromTable ( double  x1,
double  x2,
int  size,
double *  table 
)

Construct a color transfer function from a table.

Unlike FillFromDataPointer(), the table parameter's layout is assumed to be [R1, G1, B1, R2, G2, B2, ..., Rn, Gn, Bn], and it is assumed to be a block of memory of size [3*size]. After calling this method, the function range will be [x1, x2], the function will have size nodes, and function values will be regularly spaced between x1 and x2.

◆ SetClamping()

virtual void vtkColorTransferFunction::SetClamping ( vtkTypeBool  )
virtual

Sets/gets whether clamping is used.

If on, scalar values below the lower range value set for the transfer function will be mapped to the first node color, and scalar values above the upper range value set for the transfer function will be mapped to the last node color. If off, values outside the range are mapped to black.

◆ GetClamping()

virtual vtkTypeBool vtkColorTransferFunction::GetClamping ( )
virtual

◆ ClampingOn()

virtual void vtkColorTransferFunction::ClampingOn ( )
virtual

◆ ClampingOff()

virtual void vtkColorTransferFunction::ClampingOff ( )
virtual

◆ SetColorSpace()

virtual void vtkColorTransferFunction::SetColorSpace ( int  )
virtual

Set/Get the color space used for interpolation: RGB, HSV, CIELAB, Diverging or Step.

In HSV mode, if HSVWrap is on, it will take the shortest path in Hue (going back through 0 if that is the shortest way around the hue circle) whereas if HSVWrap is off it will not go through 0 (in order the match the current functionality of vtkLookupTable). In Lab/CIEDE2000 mode, it will take the shortest path in the Lab color space with respect to the CIE Delta E 2000 color distance measure. Diverging is a special mode where colors will pass through white when interpolating between two saturated colors. Step is a mode where the color of an interval is the color of the second color of the interval.

◆ SetColorSpaceToRGB()

void vtkColorTransferFunction::SetColorSpaceToRGB ( )
inline

Definition at line 203 of file vtkColorTransferFunction.h.

◆ SetColorSpaceToHSV()

void vtkColorTransferFunction::SetColorSpaceToHSV ( )
inline

Definition at line 204 of file vtkColorTransferFunction.h.

◆ SetColorSpaceToLab()

void vtkColorTransferFunction::SetColorSpaceToLab ( )
inline

Definition at line 205 of file vtkColorTransferFunction.h.

◆ SetColorSpaceToLabCIEDE2000()

void vtkColorTransferFunction::SetColorSpaceToLabCIEDE2000 ( )
inline

Definition at line 206 of file vtkColorTransferFunction.h.

◆ SetColorSpaceToDiverging()

void vtkColorTransferFunction::SetColorSpaceToDiverging ( )
inline

Definition at line 207 of file vtkColorTransferFunction.h.

◆ SetColorSpaceToStep()

void vtkColorTransferFunction::SetColorSpaceToStep ( )
inline

Definition at line 208 of file vtkColorTransferFunction.h.

◆ GetColorSpace()

virtual int vtkColorTransferFunction::GetColorSpace ( )
virtual

◆ SetHSVWrap()

virtual void vtkColorTransferFunction::SetHSVWrap ( vtkTypeBool  )
virtual

◆ GetHSVWrap()

virtual vtkTypeBool vtkColorTransferFunction::GetHSVWrap ( )
virtual

◆ HSVWrapOn()

virtual void vtkColorTransferFunction::HSVWrapOn ( )
virtual

◆ HSVWrapOff()

virtual void vtkColorTransferFunction::HSVWrapOff ( )
virtual

◆ SetScale()

virtual void vtkColorTransferFunction::SetScale ( int  )
virtual

Set the type of scale to use, linear or logarithmic.

The default is linear. If the scale is logarithmic, and the range contains zero, the color mapping will be linear.

◆ SetScaleToLinear()

void vtkColorTransferFunction::SetScaleToLinear ( )
inline

Definition at line 222 of file vtkColorTransferFunction.h.

◆ SetScaleToLog10()

void vtkColorTransferFunction::SetScaleToLog10 ( )
inline

Definition at line 223 of file vtkColorTransferFunction.h.

◆ GetScale()

virtual int vtkColorTransferFunction::GetScale ( )
virtual

◆ SetNanColor() [1/2]

virtual void vtkColorTransferFunction::SetNanColor ( double  ,
double  ,
double   
)
virtual

Set the RGB color to use when a NaN (not a number) is encountered.

This is an RGB 3-tuple color of doubles in the range [0,1].

Reimplemented in vtkDiscretizableColorTransferFunction.

◆ SetNanColor() [2/2]

virtual void vtkColorTransferFunction::SetNanColor ( double  [3])
virtual

◆ GetNanColor() [1/3]

virtual double* vtkColorTransferFunction::GetNanColor ( )
virtual

◆ GetNanColor() [2/3]

virtual void vtkColorTransferFunction::GetNanColor ( double &  ,
double &  ,
double &   
)
virtual

◆ GetNanColor() [3/3]

virtual void vtkColorTransferFunction::GetNanColor ( double  [3])
virtual

◆ SetNanOpacity()

virtual void vtkColorTransferFunction::SetNanOpacity ( double  )
virtual

Get/Set the opacity to use when a NaN (not a number) is encountered.

This a double in the range [0,1].

Reimplemented in vtkDiscretizableColorTransferFunction.

◆ GetNanOpacity()

virtual double vtkColorTransferFunction::GetNanOpacity ( )
virtual

◆ SetNanColorRGBA() [1/2]

virtual void vtkColorTransferFunction::SetNanColorRGBA ( double  r,
double  g,
double  b,
double  a 
)
inlinevirtual

Set the RGBA color to use when a NaN (not a number) is encountered.

This is an RGBA 4-tuple color of doubles in the range [0,1].

Definition at line 252 of file vtkColorTransferFunction.h.

◆ SetNanColorRGBA() [2/2]

void vtkColorTransferFunction::SetNanColorRGBA ( double  rgba[4])
inline

Definition at line 258 of file vtkColorTransferFunction.h.

◆ SetBelowRangeColor() [1/2]

virtual void vtkColorTransferFunction::SetBelowRangeColor ( double  ,
double  ,
double   
)
virtual

Set the color to use when a value below the range is encountered.

This is an RGB 3-tuple of doubles in the range [0, 1].

◆ SetBelowRangeColor() [2/2]

virtual void vtkColorTransferFunction::SetBelowRangeColor ( double  [3])
virtual

◆ GetBelowRangeColor() [1/3]

virtual double* vtkColorTransferFunction::GetBelowRangeColor ( )
virtual

◆ GetBelowRangeColor() [2/3]

virtual void vtkColorTransferFunction::GetBelowRangeColor ( double &  ,
double &  ,
double &   
)
virtual

◆ GetBelowRangeColor() [3/3]

virtual void vtkColorTransferFunction::GetBelowRangeColor ( double  [3])
virtual

◆ SetUseBelowRangeColor()

virtual void vtkColorTransferFunction::SetUseBelowRangeColor ( vtkTypeBool  )
virtual

Set whether the below range color should be used.

◆ GetUseBelowRangeColor()

virtual vtkTypeBool vtkColorTransferFunction::GetUseBelowRangeColor ( )
virtual

◆ UseBelowRangeColorOn()

virtual void vtkColorTransferFunction::UseBelowRangeColorOn ( )
virtual

◆ UseBelowRangeColorOff()

virtual void vtkColorTransferFunction::UseBelowRangeColorOff ( )
virtual

◆ SetAboveRangeColor() [1/2]

virtual void vtkColorTransferFunction::SetAboveRangeColor ( double  ,
double  ,
double   
)
virtual

Set the color to use when a value above the range is encountered.

This is an RGB 3-tuple of doubles in the range [0, 1].

◆ SetAboveRangeColor() [2/2]

virtual void vtkColorTransferFunction::SetAboveRangeColor ( double  [3])
virtual

◆ GetAboveRangeColor() [1/3]

virtual double* vtkColorTransferFunction::GetAboveRangeColor ( )
virtual

◆ GetAboveRangeColor() [2/3]

virtual void vtkColorTransferFunction::GetAboveRangeColor ( double &  ,
double &  ,
double &   
)
virtual

◆ GetAboveRangeColor() [3/3]

virtual void vtkColorTransferFunction::GetAboveRangeColor ( double  [3])
virtual

◆ SetUseAboveRangeColor()

virtual void vtkColorTransferFunction::SetUseAboveRangeColor ( vtkTypeBool  )
virtual

Set whether the below range color should be used.

◆ GetUseAboveRangeColor()

virtual vtkTypeBool vtkColorTransferFunction::GetUseAboveRangeColor ( )
virtual

◆ UseAboveRangeColorOn()

virtual void vtkColorTransferFunction::UseAboveRangeColorOn ( )
virtual

◆ UseAboveRangeColorOff()

virtual void vtkColorTransferFunction::UseAboveRangeColorOff ( )
virtual

◆ GetDataPointer()

double* vtkColorTransferFunction::GetDataPointer ( )

Returns a pointer to an array of all node values in an interleaved array with the layout [X1, R1, G1, B1, X2, R2, G2, B2, ..., Xn, Rn, Gn, Bn] where n is the number of nodes defining the transfer function.

The returned pointer points to an array that is managed by this class, so callers should not free it.

◆ FillFromDataPointer()

void vtkColorTransferFunction::FillFromDataPointer ( int  n,
double *  ptr 
)

Defines the nodes from an array ptr with the layout [X1, R1, G1, B1, X2, R2, G2, B2, ..., Xn, Rn, Gn, Bn] where n is the number of nodes.

◆ MapScalarsThroughTable2()

void vtkColorTransferFunction::MapScalarsThroughTable2 ( void *  input,
unsigned char *  output,
int  inputDataType,
int  numberOfValues,
int  inputIncrement,
int  outputIncrement 
)
overridevirtual

Map a set of scalars through the lookup table.

Reimplemented from vtkScalarsToColors.

Reimplemented in vtkDiscretizableColorTransferFunction.

◆ SetAllowDuplicateScalars()

virtual void vtkColorTransferFunction::SetAllowDuplicateScalars ( vtkTypeBool  )
virtual

Toggle whether to allow duplicate scalar values in the color transfer function (off by default).

◆ GetAllowDuplicateScalars()

virtual vtkTypeBool vtkColorTransferFunction::GetAllowDuplicateScalars ( )
virtual

◆ AllowDuplicateScalarsOn()

virtual void vtkColorTransferFunction::AllowDuplicateScalarsOn ( )
virtual

◆ AllowDuplicateScalarsOff()

virtual void vtkColorTransferFunction::AllowDuplicateScalarsOff ( )
virtual

◆ GetNumberOfAvailableColors()

vtkIdType vtkColorTransferFunction::GetNumberOfAvailableColors ( )
overridevirtual

Get the number of available colors for mapping to.

Reimplemented from vtkScalarsToColors.

Reimplemented in vtkDiscretizableColorTransferFunction.

◆ GetIndexedColor()

void vtkColorTransferFunction::GetIndexedColor ( vtkIdType  idx,
double  rgba[4] 
)
overridevirtual

Return a color given an integer index.

This is used to assign colors to annotations (given an offset into the list of annotations). If there are no control points or idx < 0, then NanColor is returned.

Reimplemented from vtkScalarsToColors.

Reimplemented in vtkDiscretizableColorTransferFunction.

◆ EstimateMinNumberOfSamples()

int vtkColorTransferFunction::EstimateMinNumberOfSamples ( double const &  x1,
double const &  x2 
)

Estimates the minimum size of a table such that it would correctly sample this function.

The returned value should be passed as parameter 'n' when calling GetTable().

◆ SetRange() [1/2]

void vtkColorTransferFunction::SetRange ( double  ,
double   
)
inlineoverrideprotectedvirtual

Set the range of scalars being mapped.

This method has no functionality in this subclass of vtkScalarsToColors.

Reimplemented from vtkScalarsToColors.

Definition at line 443 of file vtkColorTransferFunction.h.

◆ SetRange() [2/2]

void vtkColorTransferFunction::SetRange ( const double  rng[2])
inlineoverrideprotectedvirtual

Reimplemented from vtkScalarsToColors.

Definition at line 444 of file vtkColorTransferFunction.h.

◆ SortAndUpdateRange()

void vtkColorTransferFunction::SortAndUpdateRange ( )
protected

Internal method to sort the vector and update the Range whenever a node is added, edited or removed It always calls Modified().

◆ UpdateRange()

bool vtkColorTransferFunction::UpdateRange ( )
protected

Returns true if the range has been changed.

If the ranged has been modified, calls Modified().

◆ MovePoint()

void vtkColorTransferFunction::MovePoint ( double  oldX,
double  newX 
)
protected

Moves point from oldX to newX.

It removed the point from oldX. If any point existed at newX, it will also be removed.

◆ FindMinimumXDistance()

double vtkColorTransferFunction::FindMinimumXDistance ( )
protected

Traverses the nodes to find the minimum distance.

Assumes nodes are sorted.

Member Data Documentation

◆ Internal

vtkColorTransferFunctionInternals* vtkColorTransferFunction::Internal
protected

Definition at line 355 of file vtkColorTransferFunction.h.

◆ Clamping

vtkTypeBool vtkColorTransferFunction::Clamping
protected

Determines the function value outside of defined points Zero = always return 0.0 outside of defined points One = clamp to the lowest value below defined points and highest value above defined points.

Definition at line 363 of file vtkColorTransferFunction.h.

◆ ColorSpace

int vtkColorTransferFunction::ColorSpace
protected

The color space in which interpolation is performed.

Definition at line 368 of file vtkColorTransferFunction.h.

◆ HSVWrap

vtkTypeBool vtkColorTransferFunction::HSVWrap
protected

Specify if HSV is wrap or not.

Definition at line 373 of file vtkColorTransferFunction.h.

◆ Scale

int vtkColorTransferFunction::Scale
protected

The color interpolation scale (linear or logarithmic).

Definition at line 378 of file vtkColorTransferFunction.h.

◆ NanColor

double vtkColorTransferFunction::NanColor[3]
protected

The color to use for not-a-number.

Definition at line 383 of file vtkColorTransferFunction.h.

◆ NanOpacity

double vtkColorTransferFunction::NanOpacity
protected

The opacity to use for not-a-number.

Definition at line 388 of file vtkColorTransferFunction.h.

◆ BelowRangeColor

double vtkColorTransferFunction::BelowRangeColor[3]
protected

The below-range color.

Definition at line 393 of file vtkColorTransferFunction.h.

◆ UseBelowRangeColor

vtkTypeBool vtkColorTransferFunction::UseBelowRangeColor
protected

Flag indicating whether below-range color should be used.

Definition at line 398 of file vtkColorTransferFunction.h.

◆ AboveRangeColor

double vtkColorTransferFunction::AboveRangeColor[3]
protected

The above-range color.

Definition at line 403 of file vtkColorTransferFunction.h.

◆ UseAboveRangeColor

vtkTypeBool vtkColorTransferFunction::UseAboveRangeColor
protected

Flag indicating whether below-range color should be used.

Definition at line 408 of file vtkColorTransferFunction.h.

◆ Function

double* vtkColorTransferFunction::Function
protected

Temporary array to store data from the nodes.

Definition at line 413 of file vtkColorTransferFunction.h.

◆ Range

double vtkColorTransferFunction::Range[2]
protected

The min and max node locations.

Definition at line 418 of file vtkColorTransferFunction.h.

◆ UnsignedCharRGBAValue

unsigned char vtkColorTransferFunction::UnsignedCharRGBAValue[4]
protected

Temporary storage for an evaluated color (0 to 255 RGBA A=255)

Definition at line 423 of file vtkColorTransferFunction.h.

◆ AllowDuplicateScalars

vtkTypeBool vtkColorTransferFunction::AllowDuplicateScalars
protected

If on, the same scalar value may have more than one node assigned to it.

Definition at line 428 of file vtkColorTransferFunction.h.

◆ BuildTime

vtkTimeStamp vtkColorTransferFunction::BuildTime
protected

Definition at line 430 of file vtkColorTransferFunction.h.

◆ Table

unsigned char* vtkColorTransferFunction::Table
protected

Definition at line 431 of file vtkColorTransferFunction.h.

◆ TableSize

int vtkColorTransferFunction::TableSize
protected

Temporary storage for the size of the table.

Set in the method GetTable() and queried in GetNumberOfAvailableColors().

Definition at line 437 of file vtkColorTransferFunction.h.


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