|
virtual vtkTypeBool | IsA (const char *type) |
| Return 1 if this class is the same type of (or a subclass of) the named class. More...
|
|
vtkDiscretizableColorTransferFunction * | NewInstance () const |
|
void | PrintSelf (ostream &os, vtkIndent indent) override |
| Print method for vtkColorTransferFunction. More...
|
|
int | IsOpaque () override |
| Returns the negation of EnableOpacityMapping. More...
|
|
void | SetIndexedColorRGB (unsigned int index, const double rgb[3]) |
| Add colors to use when IndexedLookup is true. More...
|
|
void | SetIndexedColorRGBA (unsigned int index, const double rgba[4]) |
|
void | SetIndexedColor (unsigned int index, double r, double g, double b, double a=1.0) |
|
void | GetIndexedColor (vtkIdType i, double rgba[4]) override |
| Get the "indexed color" assigned to an index. More...
|
|
void | SetNumberOfIndexedColors (unsigned int count) |
| Set the number of indexed colors. More...
|
|
unsigned int | GetNumberOfIndexedColors () |
|
void | Build () override |
| Generate discretized lookup table, if applicable. More...
|
|
virtual void | SetDiscretize (vtkTypeBool) |
| Set if the values are to be mapped after discretization. More...
|
|
virtual vtkTypeBool | GetDiscretize () |
|
virtual void | DiscretizeOn () |
|
virtual void | DiscretizeOff () |
|
virtual void | SetUseLogScale (int useLogScale) |
| Get/Set if log scale must be used while mapping scalars to colors. More...
|
|
virtual int | GetUseLogScale () |
|
virtual void | SetNumberOfValues (vtkIdType) |
| Set the number of values i.e. More...
|
|
virtual vtkIdType | GetNumberOfValues () |
|
const unsigned char * | MapValue (double v) override |
| Map one value through the lookup table and return a color defined as a RGBA unsigned char tuple (4 bytes). More...
|
|
void | GetColor (double v, double rgb[3]) override |
| Map one value through the lookup table and return the color as an RGB array of doubles between 0 and 1. More...
|
|
double | GetOpacity (double v) override |
| Return the opacity of a given scalar. More...
|
|
void | MapScalarsThroughTable2 (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputFormat) override |
| Map a set of scalars through the lookup table. More...
|
|
void | SetAlpha (double alpha) override |
| Specify an additional opacity (alpha) value to blend with. More...
|
|
void | SetNanColor (double r, double g, double b) override |
| Set the color to use when a NaN (not a number) is encountered. More...
|
|
void | SetNanColor (double rgb[3]) override |
|
void | SetNanOpacity (double a) override |
| Set the opacity to use when a NaN (not a number) is encountered. More...
|
|
int | UsingLogScale () override |
| This should return 1 if the subclass is using log scale for mapping scalars to colors. More...
|
|
vtkIdType | GetNumberOfAvailableColors () override |
| Get the number of available colors for mapping to. More...
|
|
virtual void | SetScalarOpacityFunction (vtkPiecewiseFunction *function) |
| Set/get the opacity function to use. More...
|
|
virtual vtkPiecewiseFunction * | GetScalarOpacityFunction () const |
|
virtual void | SetEnableOpacityMapping (bool) |
| Enable/disable the usage of the scalar opacity function. More...
|
|
virtual bool | GetEnableOpacityMapping () |
|
virtual void | EnableOpacityMappingOn () |
|
virtual void | EnableOpacityMappingOff () |
|
vtkMTimeType | GetMTime () override |
| Overridden to include the ScalarOpacityFunction's MTime. More...
|
|
vtkColorTransferFunction * | NewInstance () const |
|
void | DeepCopy (vtkScalarsToColors *f) override |
| Copy the contents from another object. More...
|
|
void | ShallowCopy (vtkColorTransferFunction *f) |
|
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...
|
|
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]) |
|
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 double * | GetNanColor () |
|
virtual void | GetNanColor (double &, double &, double &) |
|
virtual void | GetNanColor (double[3]) |
|
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...
|
|
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 () |
|
int | EstimateMinNumberOfSamples (double const &x1, double const &x2) |
| Estimates the minimum size of a table such that it would correctly sample this function. More...
|
|
vtkScalarsToColors * | NewInstance () const |
|
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...
|
|
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 double | GetAlpha () |
|
virtual vtkUnsignedCharArray * | MapScalars (vtkDataArray *scalars, int colorMode, int component) |
| Internal methods that map a data array into a 4-component, unsigned char RGBA array. More...
|
|
virtual vtkUnsignedCharArray * | MapScalars (vtkAbstractArray *scalars, int colorMode, int component) |
|
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 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 vtkAbstractArray * | GetAnnotatedValues () |
|
virtual vtkStringArray * | GetAnnotations () |
|
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 () |
|
| 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...
|
|
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) |
|
vtkCommand * | GetCommand (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) |
|
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...
|
|
a combination of vtkColorTransferFunction and vtkLookupTable.
This is a cross between a vtkColorTransferFunction and a vtkLookupTable selectively combining the functionality of both. This class is a vtkColorTransferFunction allowing users to specify the RGB control points that control the color transfer function. At the same time, by setting Discretize to 1 (true), one can force the transfer function to only have NumberOfValues discrete colors.
When IndexedLookup is true, this class behaves differently. The annotated values are considered to the be only valid values for which entries in the color table should be returned. The colors for annotated values are those specified using AddIndexedColors. Typically, there must be at least as many indexed colors specified as the annotations. For backwards compatibility, if no indexed-colors are specified, the colors in the lookup Table are assigned to annotated values by taking the modulus of their index in the list of annotations. If a scalar value is not present in AnnotatedValues, then NanColor will be used.
One can set a scalar opacity function to map scalars to color types handling transparency (VTK_RGBA, VTK_LUMINANCE_ALPHA). Opacity mapping is off by default. Call EnableOpacityMappingOn() to handle mapping of alpha values.
NOTE: One must call Build() after making any changes to the points in the ColorTransferFunction to ensure that the discrete and non-discrete versions match up.
- Tests:
- vtkDiscretizableColorTransferFunction (Tests)
Definition at line 60 of file vtkDiscretizableColorTransferFunction.h.