VTK  9.7.20261119
vtkMultiVariateToRGBA Class Reference

#include <vtkMultiVariateToRGBA.h>

Detailed Description

Maps multivariate data to color and opacity.

Maps multivariate data (multi-component point or cell scalars in a vtkDataSet or one component numeric columns, of any types, in a table) to color and opacity (RGBA). The filter can also generate two additional set of point coordinates. First, point coordinates for vertices associated with the components on the outline of a circle centered at (0, 0) with radius 1 (these points form a polygon). Second, points associated with the data (generalized barycentric coordinates (GBC) inside the vertices polygon, scaled to cover the circle) (see StoreRGBA, StoreVertices, StoreGBC). The color and opacity can be used to volume render the dataset.

The first vertex is at the top and the following vertices are placed clockwise, in the same order as the colors of the color wheel, so the first component is red (see VerticesClockwiseOrdering). Vertices can be rotated (VerticesRotation), which will change the GBC positions and colors.

Points' opacity can be further modified using a lens (LensCenter, LensRadius) which modifies the opacity of the points outside the lens (see OutsideLensAlpha). When only the lens changes, the filter reuses the results of its last execution and only recomputes the opacity, so that the lens can be dragged interactively.

You can specify a partition of the set of components in groups (subsets) (see SetPartitionIndices) so that components in each group (subset) are normalized together. By default, all components are in one group. This can be used when value ranges of different components are very different.

The implementation is based on the papers: RadVolViz: An Information Display-Inspired Transfer Function Editor for Multivariate Volume Visualization Ayush Kumar, Xinyu Zhang, Huolin L. Xin, Hanfei Yan, Xiaojing Huang, Wei Xu, and Klaus Mueller and RadViz Deluxe: An Attribute-Aware Display for Multivariate Data Shenghui Cheng, Wei Xu and Klaus Mueller

Tests:
vtkMultiVariateToRGBA (Tests)

Definition at line 70 of file vtkMultiVariateToRGBA.h.

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

Public Types

typedef vtkDataObjectAlgorithm Superclass
Public Types inherited from vtkDataObjectAlgorithm
typedef vtkAlgorithm Superclass
Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
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.
vtkMultiVariateToRGBA * NewInstance () const
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
virtual void SetVerticesRotation (double rotation)
 Angle in degrees to rotate the vertices encoding the multivariate attributes.
virtual double GetVerticesRotation ()
std::vector< double > GetRange () VTK_FUTURE_CONST
 The global [min, max] range actually used to normalize each partition group during the last RequestData, in the same flat, interleaved layout as CustomRange: CustomRange[i] when it was set for that group, otherwise the range computed from the data (and reduced across processes if the Controller is not null).
void Modified () override
 Overridden to tell lens-only changes apart from all other changes.
virtual void SetStoreGBC (bool)
 This filter computes colors (RGBA) that can be used to volume render the data.
virtual bool GetStoreGBC ()
 This filter computes colors (RGBA) that can be used to volume render the data.
virtual void SetStoreVertices (bool)
 This filter computes colors (RGBA) that can be used to volume render the data.
virtual bool GetStoreVertices ()
 This filter computes colors (RGBA) that can be used to volume render the data.
virtual void SetStoreRGBA (bool)
 This filter computes colors (RGBA) that can be used to volume render the data.
virtual bool GetStoreRGBA ()
 This filter computes colors (RGBA) that can be used to volume render the data.
virtual void SetStoreA (bool)
 This filter computes colors (RGBA) that can be used to volume render the data.
virtual bool GetStoreA ()
 This filter computes colors (RGBA) that can be used to volume render the data.
virtual void SetVerticesClockwiseOrdering (bool)
 If true, the vertices are placed clockwise, otherwise counter-clockwise.
virtual bool GetVerticesClockwiseOrdering ()
 If true, the vertices are placed clockwise, otherwise counter-clockwise.
virtual void VerticesClockwiseOrderingOn ()
 If true, the vertices are placed clockwise, otherwise counter-clockwise.
virtual void VerticesClockwiseOrderingOff ()
 If true, the vertices are placed clockwise, otherwise counter-clockwise.
virtual void SetController (vtkMultiProcessController *)
 Set and get the controller.
virtual vtkMultiProcessController * GetController ()
 Set and get the controller.
void SetCustomRange (const std::vector< double > &customRange)
 Custom ranges used as the global min/max when normalizing scalars, instead of the range computed from the data (see NormalizeWorker), one [min, max] range per partition group (see SetPartitionIndices).
std::vector< double > GetCustomRange () VTK_FUTURE_CONST
 Custom ranges used as the global min/max when normalizing scalars, instead of the range computed from the data (see NormalizeWorker), one [min, max] range per partition group (see SetPartitionIndices).
void ClearCustomRange ()
 Element-wise, ClientServer-wrappable equivalents of SetCustomRange().
void AddCustomRange (double min, double max)
 Element-wise, ClientServer-wrappable equivalents of SetCustomRange().
void SetPartitionIndices (const std::vector< int > &partitionIndices)
 Variables can be partitioned into several groups.
std::vector< int > GetPartitionIndices () VTK_FUTURE_CONST
 Variables can be partitioned into several groups.
void SetPartitionOffsets (const std::vector< int > &partitionOffsets)
 Variables can be partitioned into several groups.
std::vector< int > GetPartitionOffsets () VTK_FUTURE_CONST
 Variables can be partitioned into several groups.
void ClearPartitionIndices ()
 Element-wise, ClientServer-wrappable equivalents of SetPartitionIndices() and SetPartitionOffsets().
void AddPartitionIndex (int index)
 Element-wise, ClientServer-wrappable equivalents of SetPartitionIndices() and SetPartitionOffsets().
void ClearPartitionOffsets ()
 Element-wise, ClientServer-wrappable equivalents of SetPartitionIndices() and SetPartitionOffsets().
void AddPartitionOffset (int offset)
 Element-wise, ClientServer-wrappable equivalents of SetPartitionIndices() and SetPartitionOffsets().
void SetVariableVisibility (const std::string &name, bool visible)
 Variable visibility.
void SetVariableVisibility (int index, bool visible)
 Variable visibility.
void SetVariableVisibilityAll (bool visible)
 Set the visibility of all variables, including the ones of inputs set later.
bool GetVariableVisibility (const std::string &name)
 Get the visibility of a variable of the current input, by name or index.
bool GetVariableVisibility (int index)
 Variable visibility.
virtual vtkStringArray * GetVisibleVariables ()
 Get the names of the visible variables of the current input, in their natural order.
virtual void SetVisibleVariables (vtkStringArray *names)
 Set the list of visible variables by name: every variable not in this list is hidden.
void SetVisibleVariableIndices (const std::vector< int > &indices)
 Set the list of visible variables by index: every variable not in this list is hidden.
std::vector< int > GetVisibleVariableIndices ()
 Get the indices of the visible variables of the current input, in increasing order.
void ResetVisibleVariableIndices ()
 Build the list of visible variables by index, for the ParaView server manager XML, which calls a method without arguments (clean_command) and then a method once per index (command), like AddPartitionIndex().
void AddVisibleVariableIndex (int index)
 Variable visibility.
vtkSmartPointer< vtkStringArray > GetAllVariableNames ()
 Returns the names of every variable of the current input, visible or not, in their natural order.
virtual bool GetVariablesVisibleByDefault ()
 The visibility as stored (see VariablesVisibleByDefault), which does not depend on the input, so vtkPlotRadViz can save and restore it.
virtual void SetVariablesVisibleByDefault (bool)
 Variable visibility.
std::vector< std::string > GetNameVisibilityExceptions () VTK_FUTURE_CONST
 Variable visibility.
void SetNameVisibilityExceptions (const std::vector< std::string > &names)
 Variable visibility.
std::vector< int > GetIndexVisibilityExceptions () VTK_FUTURE_CONST
 Variable visibility.
void SetIndexVisibilityExceptions (const std::vector< int > &indices)
 Variable visibility.
virtual void SetOutputScalarType (int)
 Data type of the 'rgba' array: VTK_DOUBLE (the default) or VTK_FLOAT.
virtual int GetOutputScalarType ()
 Data type of the 'rgba' array: VTK_DOUBLE (the default) or VTK_FLOAT.
Public Member Functions inherited from vtkDataObjectAlgorithm
vtkDataObjectAlgorithm * NewInstance () const
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details
vtkDataObject * GetInput ()
vtkDataObject * GetInput (int port)
vtkDataObject * GetOutput ()
 Get the output data object for a port on this algorithm.
vtkDataObject * GetOutput (int)
 Get the output data object for a port on this algorithm.
virtual void SetOutput (vtkDataObject *d)
 Get the output data object for a port on this algorithm.
void SetInputData (vtkDataObject *)
 Assign a data object as input.
void SetInputData (int, vtkDataObject *)
 Assign a data object as input.
void AddInputData (vtkDataObject *)
 Assign a data object as input.
void AddInputData (int, vtkDataObject *)
 Assign a data object as input.
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm * NewInstance () const
vtkTypeBool HasExecutive ()
 Check whether this algorithm has an assigned executive.
vtkExecutive * GetExecutive ()
 Get this algorithm's executive.
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive.
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped.
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request.
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.
vtkInformation * GetInputPortInformation (int port)
 Get the information object associated with an input port.
vtkInformation * GetOutputPortInformation (int port)
 Get the information object associated with an output port.
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm.
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm.
void SetAbortExecuteAndUpdateTime ()
 Set AbortExecute Flag and update LastAbortTime.
void UpdateProgress (double amount)
 Update the progress of the process object.
bool CheckAbort ()
 Check to see if an input's ABORTED flag is set or if an upstream algorithm's AbortExecute is set.
bool CheckAbortAndInvoke ()
 Invoke AbortCheck event then return CheckAbort result.
void InvokeCleanupAbortCheck ()
 Invoke CleanupAbortCheck event, usually used by application to cleanup multi process communications triggered by CheckAbortAndInvoke.
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process.
int GetNumberOfInputArraySpecifications ()
 Get the number of input array indices that have already been set.
bool ResetInputArraySpecifications ()
 Clear all existing input array specifications (as if SetInputArrayToProcess had never been called).
vtkInformation * GetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm.
void RemoveAllInputs ()
 Remove all the input data.
vtkDataObject * GetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port.
vtkDataObject * GetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection.
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index.
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx.
virtual void RemoveAllInputConnections (int port)
 Removes all input connections.
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index.
virtual void SetInputDataObject (vtkDataObject *data)
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port.
virtual void AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput * GetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm.
vtkAlgorithmOutput * GetOutputPort ()
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port.
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm.
vtkAlgorithmOutput * GetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port.
vtkAlgorithm * GetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
vtkAlgorithm * GetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair.
vtkAlgorithm * GetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0).
vtkExecutive * GetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection.
vtkExecutive * GetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0).
vtkInformation * GetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection.
vtkInformation * GetInputInformation ()
 Equivalent to GetInputInformation(0, 0).
vtkInformation * GetOutputInformation (int port)
 Return the information object that is associated with a particular output port.
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port.
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port.
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port.
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port.
virtual bool UpdateInformation ()
 Bring the algorithm's information up-to-date.
virtual bool UpdateDataObject ()
 Create output object(s).
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream.
virtual bool UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date.
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
void RemoveNoPriorTemporalAccessInformationKey ()
 Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm.
virtual vtkInformation * GetInformation ()
 Set/Get the information object associated with this algorithm.
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm.
bool UsesGarbageCollector () const override
 Participate in garbage collection.
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object.
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object.
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object.
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object.
virtual double GetProgress ()
 Get the execution progress of a process object.
void SetContainerAlgorithm (vtkAlgorithm *containerAlg)
 Set/get a Container algorithm for this algorithm.
vtkAlgorithm * GetContainerAlgorithm ()
 Set/get a Container algorithm for this algorithm.
virtual void SetAbortOutput (bool)
 Set/Get an internal variable used to communicate between the algorithm and executive.
virtual bool GetAbortOutput ()
 Set/Get an internal variable used to communicate between the algorithm and executive.
virtual void AbortOutputOn ()
 Set/Get an internal variable used to communicate between the algorithm and executive.
virtual void AbortOutputOff ()
 Set/Get an internal variable used to communicate between the algorithm and executive.
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state.
virtual char * GetProgressText ()
 Set the current text message associated with the progress state.
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file.
void SetInputArrayToProcess (const char *name, int fieldAssociation, int component=vtkArrayComponents::AllComponents)
 Set the input data arrays that this algorithm will process.
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process.
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name, int component)
 This method variant also accepts a component to consider rather than the entire tuple.
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process.
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType, int component)
 This method variant also accepts a component to consider rather than the entire tuple.
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 Set the input data arrays that this algorithm will process.
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName, const char *component)
 Set the input data arrays that this algorithm will process.
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index.
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index.
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index.
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index.
virtual bool Update (int port)
 Bring this algorithm's outputs up-to-date.
virtual bool Update ()
 Bring this algorithm's outputs up-to-date.
virtual void SetReleaseDataFlag (vtkTypeBool)
 Turn release data flag on or off for all output ports.
virtual vtkTypeBool GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports.
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports.
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports.
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents.
int * GetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents.
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents.
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents.
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents.
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents.
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents.
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents.
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents.
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents.
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents.
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents.
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
virtual vtkProgressObserver * GetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
void SetNoPriorTemporalAccessInformationKey (int key)
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
void SetNoPriorTemporalAccessInformationKey ()
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void DebugOn ()
 Turn debugging output on.
virtual void DebugOff ()
 Turn debugging output off.
bool GetDebug ()
 Get the value of the debug flag.
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
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)
vtkTypeBool InvokeEvent (unsigned long event)
vtkTypeBool InvokeEvent (const char *event)
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand * GetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
template<class U, class T>
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
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.
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void Delete ()
 Delete a VTK object.
virtual void FastDelete ()
 Delete a reference to this object.
void InitializeObjectBase ()
void Print (ostream &os)
 Print an object to an ostream.
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
int GetReferenceCount ()
 Return the current reference count of this object.
void SetReferenceCount (int)
 Sets the reference count.
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions

static vtkMultiVariateToRGBA * New ()
static vtkTypeBool IsTypeOf (const char *type)
static vtkMultiVariateToRGBA * SafeDownCast (vtkObjectBase *o)
static constexpr int GetColorWheelStartAngle ()
 Describe the color wheel that matches the computed colors.
static constexpr bool GetColorWheelClockwiseOrdering ()
 Describe the color wheel that matches the computed colors.
Static Public Member Functions inherited from vtkDataObjectAlgorithm
static vtkDataObjectAlgorithm * New ()
static vtkTypeBool IsTypeOf (const char *type)
static vtkDataObjectAlgorithm * SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm * New ()
static vtkTypeBool IsTypeOf (const char *type)
static vtkAlgorithm * SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey * INPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements.
static vtkInformationIntegerKey * INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey * INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey * INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey * INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey * INPUT_PORT ()
static vtkInformationIntegerKey * INPUT_CONNECTION ()
static vtkInformationIntegerKey * CAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.
static vtkInformationIntegerKey * CAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
static vtkInformationIntegerKey * ABORTED ()
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
Static Public Member Functions inherited from vtkObject
static vtkObject * New ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase * New ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 vtkMultiVariateToRGBA ()
 ~vtkMultiVariateToRGBA () override
int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 This is called by the superclass.
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
Protected Member Functions inherited from vtkDataObjectAlgorithm
 vtkDataObjectAlgorithm ()
 ~vtkDataObjectAlgorithm () override
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass.
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm.
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm.
Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm () override
bool CheckUpstreamAbort ()
 Checks to see if an upstream filter has been aborted.
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm.
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm.
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
int GetInputArrayComponent (int idx)
 Get the component to process of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkInformation * GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
virtual vtkExecutive * CreateDefaultExecutive ()
 Create a default executive.
void ReportReferences (vtkGarbageCollector *) override
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port.
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port.
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input.
void AddInputDataInternal (int port, vtkDataObject *input)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
vtkSmartPointer< vtkAbstractArray > GetInputArray (int idx, int connection, vtkInformationVector **inputVector, int &association, int requestedComponent=vtkArrayComponents::Requested)
 Get an array from the input at index idx.
vtkSmartPointer< vtkAbstractArray > GetInputArray (int idx, vtkDataObject *input, int &association, int requestedComponent=vtkArrayComponents::Requested)
 Get an array from the input at index idx.
template<typename ArrayType, typename... Params>
vtkSmartPointer< ArrayType > GetInputArrayAs (Params &&... params)
 Get an array from the input at index idx.
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file.
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.
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkMultiProcessController * Controller = nullptr
double VerticesRotation = 0
bool VerticesClockwiseOrdering = true
bool StoreGBC = false
bool StoreVertices = false
bool StoreRGBA = true
bool StoreA = false
std::vector< int > PartitionIndices
std::vector< int > PartitionOffsets
double LensCenter [2] = { 0.0, 0.0 }
 Where the lens is drawn and its radius.
double LensRadius = 1.0
double OutsideLensAlpha = 0.0
 Alpha cap for points outside the lens.
bool InvertLens = false
int OutputScalarType = VTK_DOUBLE
std::vector< double > CustomRange
 Custom ranges used as the global min/max when normalizing scalars, interleaved as [min0, max0, min1, max1, ...], one pair per partition group.
std::vector< double > Range
 The global [min, max] range actually used to normalize each partition group during the last RequestData, in the same flat, interleaved layout as CustomRange.
bool VariablesVisibleByDefault = true
 Variable visibility: a variable is visible when VariablesVisibleByDefault is true, unless its name or index is in the exceptions, which flip it.
std::set< std::string > NameVisibilityExceptions
std::set< int > IndexVisibilityExceptions
bool StartVisibleIndexList = true
 True after ResetVisibleVariableIndices() or on a new filter, until the next visibility setter: the next AddVisibleVariableIndex() hides every other variable.
Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp LastAbortCheckTime
vtkInformation * Information
double Progress
char * ProgressText
vtkProgressObserver * ProgressObserver
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file.
Protected Attributes inherited from vtkObject
bool Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
std::string ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
vtkWeakPointerBase ** WeakPointers
static constexpr double ColorLightness = 0.55
 Convert hue, saturation and lightness (all in [0, 1]) to red, green and blue (in [0, 1]) using the same conversion as the computed colors.
static void HSLToRGB (double h, double s, double l, double rgb[3])
 Convert hue, saturation and lightness (all in [0, 1]) to red, green and blue (in [0, 1]) using the same conversion as the computed colors.
static double GetLensRadius (double lensRadius, double radius, const double *lensCenter, const double *center)
 Clamp the lens circle (lensCenter, lensRadius) so that it intersects the reference circle (center, radius).
static std::array< double, 2 > GetLensCenter (double lensRadius, double radius, const double *lensCenter, const double *center)
 Clamp the lens circle (lensCenter, lensRadius) so that it intersects the reference circle (center, radius).
void SetLensCenter (const double *center)
 Center of the lens in GBC space (unit circle centered at the origin).
virtual void SetLensCenter (double centerX, double centerY)
 Clamp the lens circle (lensCenter, lensRadius) so that it intersects the reference circle (center, radius).
virtual double * GetLensCenter ()
 Clamp the lens circle (lensCenter, lensRadius) so that it intersects the reference circle (center, radius).
virtual void GetLensCenter (double &, double &)
 Clamp the lens circle (lensCenter, lensRadius) so that it intersects the reference circle (center, radius).
virtual void GetLensCenter (double[2])
 Clamp the lens circle (lensCenter, lensRadius) so that it intersects the reference circle (center, radius).
virtual void SetLensRadius (double radius)
 Radius of the lens in GBC space (unit circle centered at the origin).
virtual double GetLensRadius ()
 Clamp the lens circle (lensCenter, lensRadius) so that it intersects the reference circle (center, radius).
virtual void SetOutsideLensAlpha (double alpha)
 Alpha (opacity) cap for points outside the lens.
virtual double GetOutsideLensAlpha ()
 Clamp the lens circle (lensCenter, lensRadius) so that it intersects the reference circle (center, radius).
virtual void SetInvertLens (bool invert)
 Swap inside and outside: cap the alpha of the points inside the lens instead.
virtual bool GetInvertLens ()
 Clamp the lens circle (lensCenter, lensRadius) so that it intersects the reference circle (center, radius).
virtual void InvertLensOn ()
 Clamp the lens circle (lensCenter, lensRadius) so that it intersects the reference circle (center, radius).
virtual void InvertLensOff ()
 Clamp the lens circle (lensCenter, lensRadius) so that it intersects the reference circle (center, radius).

Additional Inherited Members

Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBool > AbortExecute
Static Protected Member Functions inherited from vtkDataObjectAlgorithm
static bool SetOutputDataObject (int dataType, vtkInformation *outputInformation, bool exact=false)
 A helper method that can be used by subclasses in RequestDataObject to create an output data object of the given type if not already present.
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey * PORT_REQUIREMENTS_FILLED ()
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
static vtkReallocingFunction GetCurrentReallocFunction ()
static vtkFreeingFunction GetCurrentFreeFunction ()
static vtkFreeingFunction GetAlternateFreeFunction ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive * DefaultExecutivePrototype

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkMultiVariateToRGBA()

vtkMultiVariateToRGBA::vtkMultiVariateToRGBA ( )
protected

◆ ~vtkMultiVariateToRGBA()

vtkMultiVariateToRGBA::~vtkMultiVariateToRGBA ( )
overrideprotected

Member Function Documentation

◆ New()

vtkMultiVariateToRGBA * vtkMultiVariateToRGBA::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkMultiVariateToRGBA::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 vtkDataObjectAlgorithm.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkMultiVariateToRGBA::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

◆ NewInstance()

vtkMultiVariateToRGBA * vtkMultiVariateToRGBA::NewInstance ( ) const

◆ PrintSelf()

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

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkDataObjectAlgorithm.

◆ SetStoreGBC()

virtual void vtkMultiVariateToRGBA::SetStoreGBC ( bool )
virtual

This filter computes colors (RGBA) that can be used to volume render the data.

To do that, it computes several intermediate arrays which include vertex positions used to encode variables and generalized barycentric coordinates (GBC). All arrays are stored as vtkDoubleArray.

If StoreVertices (default is false) is set to true, we store the computed vertices as a field array named 'vertices'.

If StoreGBC (default is false) is set to true, we store the computed GBC as a point/cell array named 'gbc'.

If StoreRGBA (default is true, in which case we store the computed point/cell array named 'rgba') is set to false, we don't compute the color.

If StoreA (default is false) is set to true, we store a point/cell array named 'rgba' that only has its alpha (A) component computed; the RGB part is initialized to 0. This is a cheaper alternative to StoreRGBA when only opacity is needed. StoreRGBA and StoreA cannot both be true.

Setting StoreGBC, StoreRGBA and StoreA all to false is an error.

See also
vtkChartRadViz, vtkPlotRadViz

◆ GetStoreGBC()

virtual bool vtkMultiVariateToRGBA::GetStoreGBC ( )
virtual

This filter computes colors (RGBA) that can be used to volume render the data.

To do that, it computes several intermediate arrays which include vertex positions used to encode variables and generalized barycentric coordinates (GBC). All arrays are stored as vtkDoubleArray.

If StoreVertices (default is false) is set to true, we store the computed vertices as a field array named 'vertices'.

If StoreGBC (default is false) is set to true, we store the computed GBC as a point/cell array named 'gbc'.

If StoreRGBA (default is true, in which case we store the computed point/cell array named 'rgba') is set to false, we don't compute the color.

If StoreA (default is false) is set to true, we store a point/cell array named 'rgba' that only has its alpha (A) component computed; the RGB part is initialized to 0. This is a cheaper alternative to StoreRGBA when only opacity is needed. StoreRGBA and StoreA cannot both be true.

Setting StoreGBC, StoreRGBA and StoreA all to false is an error.

See also
vtkChartRadViz, vtkPlotRadViz

◆ SetStoreVertices()

virtual void vtkMultiVariateToRGBA::SetStoreVertices ( bool )
virtual

This filter computes colors (RGBA) that can be used to volume render the data.

To do that, it computes several intermediate arrays which include vertex positions used to encode variables and generalized barycentric coordinates (GBC). All arrays are stored as vtkDoubleArray.

If StoreVertices (default is false) is set to true, we store the computed vertices as a field array named 'vertices'.

If StoreGBC (default is false) is set to true, we store the computed GBC as a point/cell array named 'gbc'.

If StoreRGBA (default is true, in which case we store the computed point/cell array named 'rgba') is set to false, we don't compute the color.

If StoreA (default is false) is set to true, we store a point/cell array named 'rgba' that only has its alpha (A) component computed; the RGB part is initialized to 0. This is a cheaper alternative to StoreRGBA when only opacity is needed. StoreRGBA and StoreA cannot both be true.

Setting StoreGBC, StoreRGBA and StoreA all to false is an error.

See also
vtkChartRadViz, vtkPlotRadViz

◆ GetStoreVertices()

virtual bool vtkMultiVariateToRGBA::GetStoreVertices ( )
virtual

This filter computes colors (RGBA) that can be used to volume render the data.

To do that, it computes several intermediate arrays which include vertex positions used to encode variables and generalized barycentric coordinates (GBC). All arrays are stored as vtkDoubleArray.

If StoreVertices (default is false) is set to true, we store the computed vertices as a field array named 'vertices'.

If StoreGBC (default is false) is set to true, we store the computed GBC as a point/cell array named 'gbc'.

If StoreRGBA (default is true, in which case we store the computed point/cell array named 'rgba') is set to false, we don't compute the color.

If StoreA (default is false) is set to true, we store a point/cell array named 'rgba' that only has its alpha (A) component computed; the RGB part is initialized to 0. This is a cheaper alternative to StoreRGBA when only opacity is needed. StoreRGBA and StoreA cannot both be true.

Setting StoreGBC, StoreRGBA and StoreA all to false is an error.

See also
vtkChartRadViz, vtkPlotRadViz

◆ SetStoreRGBA()

virtual void vtkMultiVariateToRGBA::SetStoreRGBA ( bool )
virtual

This filter computes colors (RGBA) that can be used to volume render the data.

To do that, it computes several intermediate arrays which include vertex positions used to encode variables and generalized barycentric coordinates (GBC). All arrays are stored as vtkDoubleArray.

If StoreVertices (default is false) is set to true, we store the computed vertices as a field array named 'vertices'.

If StoreGBC (default is false) is set to true, we store the computed GBC as a point/cell array named 'gbc'.

If StoreRGBA (default is true, in which case we store the computed point/cell array named 'rgba') is set to false, we don't compute the color.

If StoreA (default is false) is set to true, we store a point/cell array named 'rgba' that only has its alpha (A) component computed; the RGB part is initialized to 0. This is a cheaper alternative to StoreRGBA when only opacity is needed. StoreRGBA and StoreA cannot both be true.

Setting StoreGBC, StoreRGBA and StoreA all to false is an error.

See also
vtkChartRadViz, vtkPlotRadViz

◆ GetStoreRGBA()

virtual bool vtkMultiVariateToRGBA::GetStoreRGBA ( )
virtual

This filter computes colors (RGBA) that can be used to volume render the data.

To do that, it computes several intermediate arrays which include vertex positions used to encode variables and generalized barycentric coordinates (GBC). All arrays are stored as vtkDoubleArray.

If StoreVertices (default is false) is set to true, we store the computed vertices as a field array named 'vertices'.

If StoreGBC (default is false) is set to true, we store the computed GBC as a point/cell array named 'gbc'.

If StoreRGBA (default is true, in which case we store the computed point/cell array named 'rgba') is set to false, we don't compute the color.

If StoreA (default is false) is set to true, we store a point/cell array named 'rgba' that only has its alpha (A) component computed; the RGB part is initialized to 0. This is a cheaper alternative to StoreRGBA when only opacity is needed. StoreRGBA and StoreA cannot both be true.

Setting StoreGBC, StoreRGBA and StoreA all to false is an error.

See also
vtkChartRadViz, vtkPlotRadViz

◆ SetStoreA()

virtual void vtkMultiVariateToRGBA::SetStoreA ( bool )
virtual

This filter computes colors (RGBA) that can be used to volume render the data.

To do that, it computes several intermediate arrays which include vertex positions used to encode variables and generalized barycentric coordinates (GBC). All arrays are stored as vtkDoubleArray.

If StoreVertices (default is false) is set to true, we store the computed vertices as a field array named 'vertices'.

If StoreGBC (default is false) is set to true, we store the computed GBC as a point/cell array named 'gbc'.

If StoreRGBA (default is true, in which case we store the computed point/cell array named 'rgba') is set to false, we don't compute the color.

If StoreA (default is false) is set to true, we store a point/cell array named 'rgba' that only has its alpha (A) component computed; the RGB part is initialized to 0. This is a cheaper alternative to StoreRGBA when only opacity is needed. StoreRGBA and StoreA cannot both be true.

Setting StoreGBC, StoreRGBA and StoreA all to false is an error.

See also
vtkChartRadViz, vtkPlotRadViz

◆ GetStoreA()

virtual bool vtkMultiVariateToRGBA::GetStoreA ( )
virtual

This filter computes colors (RGBA) that can be used to volume render the data.

To do that, it computes several intermediate arrays which include vertex positions used to encode variables and generalized barycentric coordinates (GBC). All arrays are stored as vtkDoubleArray.

If StoreVertices (default is false) is set to true, we store the computed vertices as a field array named 'vertices'.

If StoreGBC (default is false) is set to true, we store the computed GBC as a point/cell array named 'gbc'.

If StoreRGBA (default is true, in which case we store the computed point/cell array named 'rgba') is set to false, we don't compute the color.

If StoreA (default is false) is set to true, we store a point/cell array named 'rgba' that only has its alpha (A) component computed; the RGB part is initialized to 0. This is a cheaper alternative to StoreRGBA when only opacity is needed. StoreRGBA and StoreA cannot both be true.

Setting StoreGBC, StoreRGBA and StoreA all to false is an error.

See also
vtkChartRadViz, vtkPlotRadViz

◆ SetVerticesRotation()

virtual void vtkMultiVariateToRGBA::SetVerticesRotation ( double rotation)
virtual

Angle in degrees to rotate the vertices encoding the multivariate attributes.

Default is 0 degrees. This angle affects the GBC positions and the computed colors. The rotation will be clamped to [0, 360).

◆ GetVerticesRotation()

virtual double vtkMultiVariateToRGBA::GetVerticesRotation ( )
virtual

◆ SetVerticesClockwiseOrdering()

virtual void vtkMultiVariateToRGBA::SetVerticesClockwiseOrdering ( bool )
virtual

If true, the vertices are placed clockwise, otherwise counter-clockwise.

The first vertex is at the top in both cases, before VerticesRotation is applied. Default is true: the vertices follow the colors of the color wheel, so component i of n has the hue i / n and the first component is red.

◆ GetVerticesClockwiseOrdering()

virtual bool vtkMultiVariateToRGBA::GetVerticesClockwiseOrdering ( )
virtual

If true, the vertices are placed clockwise, otherwise counter-clockwise.

The first vertex is at the top in both cases, before VerticesRotation is applied. Default is true: the vertices follow the colors of the color wheel, so component i of n has the hue i / n and the first component is red.

◆ VerticesClockwiseOrderingOn()

virtual void vtkMultiVariateToRGBA::VerticesClockwiseOrderingOn ( )
virtual

If true, the vertices are placed clockwise, otherwise counter-clockwise.

The first vertex is at the top in both cases, before VerticesRotation is applied. Default is true: the vertices follow the colors of the color wheel, so component i of n has the hue i / n and the first component is red.

◆ VerticesClockwiseOrderingOff()

virtual void vtkMultiVariateToRGBA::VerticesClockwiseOrderingOff ( )
virtual

If true, the vertices are placed clockwise, otherwise counter-clockwise.

The first vertex is at the top in both cases, before VerticesRotation is applied. Default is true: the vertices follow the colors of the color wheel, so component i of n has the hue i / n and the first component is red.

◆ SetLensCenter() [1/2]

void vtkMultiVariateToRGBA::SetLensCenter ( const double * center)

Center of the lens in GBC space (unit circle centered at the origin).

If the lens does not intersect the GBC circle, its center is moved toward the circle when the filter executes, so LensCenter and LensRadius can be set in any order.

◆ SetLensCenter() [2/2]

virtual void vtkMultiVariateToRGBA::SetLensCenter ( double centerX,
double centerY )
virtual

Clamp the lens circle (lensCenter, lensRadius) so that it intersects the reference circle (center, radius).

GetLensRadius returns the adjusted radius; GetLensCenter returns the adjusted center.

◆ GetLensCenter() [1/4]

virtual double * vtkMultiVariateToRGBA::GetLensCenter ( )
virtual

Clamp the lens circle (lensCenter, lensRadius) so that it intersects the reference circle (center, radius).

GetLensRadius returns the adjusted radius; GetLensCenter returns the adjusted center.

◆ GetLensCenter() [2/4]

virtual void vtkMultiVariateToRGBA::GetLensCenter ( double & ,
double &  )
virtual

Clamp the lens circle (lensCenter, lensRadius) so that it intersects the reference circle (center, radius).

GetLensRadius returns the adjusted radius; GetLensCenter returns the adjusted center.

◆ GetLensCenter() [3/4]

virtual void vtkMultiVariateToRGBA::GetLensCenter ( double [2])
virtual

Clamp the lens circle (lensCenter, lensRadius) so that it intersects the reference circle (center, radius).

GetLensRadius returns the adjusted radius; GetLensCenter returns the adjusted center.

◆ SetLensRadius()

virtual void vtkMultiVariateToRGBA::SetLensRadius ( double radius)
virtual

Radius of the lens in GBC space (unit circle centered at the origin).

A negative radius is an error and leaves the radius unchanged.

◆ GetLensRadius() [1/2]

virtual double vtkMultiVariateToRGBA::GetLensRadius ( )
virtual

Clamp the lens circle (lensCenter, lensRadius) so that it intersects the reference circle (center, radius).

GetLensRadius returns the adjusted radius; GetLensCenter returns the adjusted center.

◆ SetOutsideLensAlpha()

virtual void vtkMultiVariateToRGBA::SetOutsideLensAlpha ( double alpha)
virtual

Alpha (opacity) cap for points outside the lens.

Each point's alpha is clamped to min(its alpha, OutsideLensAlpha). Default is 0 (points outside the lens fully transparent).

◆ GetOutsideLensAlpha()

virtual double vtkMultiVariateToRGBA::GetOutsideLensAlpha ( )
virtual

Clamp the lens circle (lensCenter, lensRadius) so that it intersects the reference circle (center, radius).

GetLensRadius returns the adjusted radius; GetLensCenter returns the adjusted center.

◆ SetInvertLens()

virtual void vtkMultiVariateToRGBA::SetInvertLens ( bool invert)
virtual

Swap inside and outside: cap the alpha of the points inside the lens instead.

Default is false.

◆ GetInvertLens()

virtual bool vtkMultiVariateToRGBA::GetInvertLens ( )
virtual

Clamp the lens circle (lensCenter, lensRadius) so that it intersects the reference circle (center, radius).

GetLensRadius returns the adjusted radius; GetLensCenter returns the adjusted center.

◆ InvertLensOn()

virtual void vtkMultiVariateToRGBA::InvertLensOn ( )
virtual

Clamp the lens circle (lensCenter, lensRadius) so that it intersects the reference circle (center, radius).

GetLensRadius returns the adjusted radius; GetLensCenter returns the adjusted center.

◆ InvertLensOff()

virtual void vtkMultiVariateToRGBA::InvertLensOff ( )
virtual

Clamp the lens circle (lensCenter, lensRadius) so that it intersects the reference circle (center, radius).

GetLensRadius returns the adjusted radius; GetLensCenter returns the adjusted center.

◆ GetLensRadius() [2/2]

double vtkMultiVariateToRGBA::GetLensRadius ( double lensRadius,
double radius,
const double * lensCenter,
const double * center )
static

Clamp the lens circle (lensCenter, lensRadius) so that it intersects the reference circle (center, radius).

GetLensRadius returns the adjusted radius; GetLensCenter returns the adjusted center.

◆ GetLensCenter() [4/4]

std::array< double, 2 > vtkMultiVariateToRGBA::GetLensCenter ( double lensRadius,
double radius,
const double * lensCenter,
const double * center )
static

Clamp the lens circle (lensCenter, lensRadius) so that it intersects the reference circle (center, radius).

GetLensRadius returns the adjusted radius; GetLensCenter returns the adjusted center.

◆ HSLToRGB()

void vtkMultiVariateToRGBA::HSLToRGB ( double h,
double s,
double l,
double rgb[3] )
static

Convert hue, saturation and lightness (all in [0, 1]) to red, green and blue (in [0, 1]) using the same conversion as the computed colors.

ColorLightness is the lightness used for the computed colors.

See also
vtkPlotRadViz

◆ GetColorWheelStartAngle()

constexpr int vtkMultiVariateToRGBA::GetColorWheelStartAngle ( )
inlinestaticconstexpr

Describe the color wheel that matches the computed colors.

GetColorWheelStartAngle returns the angle at which red, the first color, is placed: 90 degrees, measured counter-clockwise from the X axis. GetColorWheelClockwiseOrdering returns true, as the colors follow each other clockwise around the wheel.

See also
vtkPlotRadViz

Definition at line 194 of file vtkMultiVariateToRGBA.h.

◆ GetColorWheelClockwiseOrdering()

constexpr bool vtkMultiVariateToRGBA::GetColorWheelClockwiseOrdering ( )
inlinestaticconstexpr

Describe the color wheel that matches the computed colors.

GetColorWheelStartAngle returns the angle at which red, the first color, is placed: 90 degrees, measured counter-clockwise from the X axis. GetColorWheelClockwiseOrdering returns true, as the colors follow each other clockwise around the wheel.

See also
vtkPlotRadViz

Definition at line 195 of file vtkMultiVariateToRGBA.h.

◆ SetController()

virtual void vtkMultiVariateToRGBA::SetController ( vtkMultiProcessController * )
virtual

Set and get the controller.

◆ GetController()

virtual vtkMultiProcessController * vtkMultiVariateToRGBA::GetController ( )
virtual

Set and get the controller.

◆ SetCustomRange()

void vtkMultiVariateToRGBA::SetCustomRange ( const std::vector< double > & customRange)

Custom ranges used as the global min/max when normalizing scalars, instead of the range computed from the data (see NormalizeWorker), one [min, max] range per partition group (see SetPartitionIndices).

Since these ranges are meant to be the global ranges, when they are set no AllReduce is performed, even if the Controller is not null. Values outside a custom range are clamped to it.

CustomRange is a flat array, interleaved as [min0, max0, min1, max1, ...]. An empty CustomRange (the default) means no custom range is set, in which case the global min/max is computed from the data (and reduced across processes if the Controller is not null). Otherwise, CustomRange must hold exactly two values (one [min, max] pair) per partition group, with min <= max. A pair with min == max, which GetRange reports for a group with a constant value, maps every value of that group to 0, the same as a constant group without a custom range.

◆ GetCustomRange()

std::vector< double > vtkMultiVariateToRGBA::GetCustomRange ( )

Custom ranges used as the global min/max when normalizing scalars, instead of the range computed from the data (see NormalizeWorker), one [min, max] range per partition group (see SetPartitionIndices).

Since these ranges are meant to be the global ranges, when they are set no AllReduce is performed, even if the Controller is not null. Values outside a custom range are clamped to it.

CustomRange is a flat array, interleaved as [min0, max0, min1, max1, ...]. An empty CustomRange (the default) means no custom range is set, in which case the global min/max is computed from the data (and reduced across processes if the Controller is not null). Otherwise, CustomRange must hold exactly two values (one [min, max] pair) per partition group, with min <= max. A pair with min == max, which GetRange reports for a group with a constant value, maps every value of that group to 0, the same as a constant group without a custom range.

◆ ClearCustomRange()

void vtkMultiVariateToRGBA::ClearCustomRange ( )

Element-wise, ClientServer-wrappable equivalents of SetCustomRange().

ClearCustomRange() empties CustomRange and AddCustomRange() appends one [min, max] pair, for the next partition group.

◆ AddCustomRange()

void vtkMultiVariateToRGBA::AddCustomRange ( double min,
double max )

Element-wise, ClientServer-wrappable equivalents of SetCustomRange().

ClearCustomRange() empties CustomRange and AddCustomRange() appends one [min, max] pair, for the next partition group.

◆ GetRange()

std::vector< double > vtkMultiVariateToRGBA::GetRange ( )

The global [min, max] range actually used to normalize each partition group during the last RequestData, in the same flat, interleaved layout as CustomRange: CustomRange[i] when it was set for that group, otherwise the range computed from the data (and reduced across processes if the Controller is not null).

For a group without values in any process, the computed range is [VTK_DOUBLE_MAX, VTK_DOUBLE_MIN], the range of an empty vtkDataArray. Empty until RequestData has run at least once.

◆ SetPartitionIndices()

void vtkMultiVariateToRGBA::SetPartitionIndices ( const std::vector< int > & partitionIndices)

Variables can be partitioned into several groups.

After that, all multivariate scalars in a group are normalized together. By default (both PartitionIndices and PartitionOffsets empty), all variables (components) are in one group; setting only one of them is an error.

The component indices refer to the visible variables only (see SetVariableVisibility), in their input order: with variables a, b, c, d and b hidden, index 1 is c. Hiding or showing a variable changes the number of components, so a partition set before is then invalid.

PartitionIndices holds component indices for each group, with groups stored contiguously. PartitionOffsets holds, for each group, the offset of the (last_element + 1) of that group in PartitionIndices, in the order the groups appear in PartitionIndices.

For example, to normalize indices [0, 1, 2] together and [3, 4] together, set PartitionIndices to [0, 1, 2, 3, 4] and PartitionOffsets to [3, 5].

◆ GetPartitionIndices()

std::vector< int > vtkMultiVariateToRGBA::GetPartitionIndices ( )

Variables can be partitioned into several groups.

After that, all multivariate scalars in a group are normalized together. By default (both PartitionIndices and PartitionOffsets empty), all variables (components) are in one group; setting only one of them is an error.

The component indices refer to the visible variables only (see SetVariableVisibility), in their input order: with variables a, b, c, d and b hidden, index 1 is c. Hiding or showing a variable changes the number of components, so a partition set before is then invalid.

PartitionIndices holds component indices for each group, with groups stored contiguously. PartitionOffsets holds, for each group, the offset of the (last_element + 1) of that group in PartitionIndices, in the order the groups appear in PartitionIndices.

For example, to normalize indices [0, 1, 2] together and [3, 4] together, set PartitionIndices to [0, 1, 2, 3, 4] and PartitionOffsets to [3, 5].

◆ SetPartitionOffsets()

void vtkMultiVariateToRGBA::SetPartitionOffsets ( const std::vector< int > & partitionOffsets)

Variables can be partitioned into several groups.

After that, all multivariate scalars in a group are normalized together. By default (both PartitionIndices and PartitionOffsets empty), all variables (components) are in one group; setting only one of them is an error.

The component indices refer to the visible variables only (see SetVariableVisibility), in their input order: with variables a, b, c, d and b hidden, index 1 is c. Hiding or showing a variable changes the number of components, so a partition set before is then invalid.

PartitionIndices holds component indices for each group, with groups stored contiguously. PartitionOffsets holds, for each group, the offset of the (last_element + 1) of that group in PartitionIndices, in the order the groups appear in PartitionIndices.

For example, to normalize indices [0, 1, 2] together and [3, 4] together, set PartitionIndices to [0, 1, 2, 3, 4] and PartitionOffsets to [3, 5].

◆ GetPartitionOffsets()

std::vector< int > vtkMultiVariateToRGBA::GetPartitionOffsets ( )

Variables can be partitioned into several groups.

After that, all multivariate scalars in a group are normalized together. By default (both PartitionIndices and PartitionOffsets empty), all variables (components) are in one group; setting only one of them is an error.

The component indices refer to the visible variables only (see SetVariableVisibility), in their input order: with variables a, b, c, d and b hidden, index 1 is c. Hiding or showing a variable changes the number of components, so a partition set before is then invalid.

PartitionIndices holds component indices for each group, with groups stored contiguously. PartitionOffsets holds, for each group, the offset of the (last_element + 1) of that group in PartitionIndices, in the order the groups appear in PartitionIndices.

For example, to normalize indices [0, 1, 2] together and [3, 4] together, set PartitionIndices to [0, 1, 2, 3, 4] and PartitionOffsets to [3, 5].

◆ ClearPartitionIndices()

void vtkMultiVariateToRGBA::ClearPartitionIndices ( )

Element-wise, ClientServer-wrappable equivalents of SetPartitionIndices() and SetPartitionOffsets().

The ParaView server manager XML cannot invoke a method taking a std::vector argument, so it instead calls ClearPartitionIndices()/ClearPartitionOffsets() once to empty the list, followed by one AddPartitionIndex()/AddPartitionOffset() call per value.

◆ AddPartitionIndex()

void vtkMultiVariateToRGBA::AddPartitionIndex ( int index)

Element-wise, ClientServer-wrappable equivalents of SetPartitionIndices() and SetPartitionOffsets().

The ParaView server manager XML cannot invoke a method taking a std::vector argument, so it instead calls ClearPartitionIndices()/ClearPartitionOffsets() once to empty the list, followed by one AddPartitionIndex()/AddPartitionOffset() call per value.

◆ ClearPartitionOffsets()

void vtkMultiVariateToRGBA::ClearPartitionOffsets ( )

Element-wise, ClientServer-wrappable equivalents of SetPartitionIndices() and SetPartitionOffsets().

The ParaView server manager XML cannot invoke a method taking a std::vector argument, so it instead calls ClearPartitionIndices()/ClearPartitionOffsets() once to empty the list, followed by one AddPartitionIndex()/AddPartitionOffset() call per value.

◆ AddPartitionOffset()

void vtkMultiVariateToRGBA::AddPartitionOffset ( int offset)

Element-wise, ClientServer-wrappable equivalents of SetPartitionIndices() and SetPartitionOffsets().

The ParaView server manager XML cannot invoke a method taking a std::vector argument, so it instead calls ClearPartitionIndices()/ClearPartitionOffsets() once to empty the list, followed by one AddPartitionIndex()/AddPartitionOffset() call per value.

◆ SetVariableVisibility() [1/2]

void vtkMultiVariateToRGBA::SetVariableVisibility ( const std::string & name,
bool visible )

Variable visibility.

Variables are the columns of a table or the components of the dataset array processed, and only the visible ones are used to compute the GBC/RGBA values, letting a subset of a multivariate dataset be visualized. A variable is set visible or hidden by name or by index; unnamed variables are named after their index ("0", "1", ...). Names are unique: a name already used, by a named variable or an earlier variable, gets the first free " (2)", " (3)", ... suffix, so a column named "1" keeps its name and an unnamed column 1 is named "1 (2)". By default, every variable is visible. The non-numeric columns of a table, such as string columns, are never visible, whatever their visibility is set to, but keep their index.

The visibility is stored as a default visibility and the variables that differ from it, which do not depend on the input, so they can be set before the input is connected. Names and indices do not mix: while variables differ from the default by name, setting the visibility by index is an error, and the other way around. SetVariableVisibilityAll(), SetVisibleVariables(), SetVisibleVariableIndices() and ResetVisibleVariableIndices() start over. Indices outside the input are ignored, and negative indices are an error.

◆ SetVariableVisibility() [2/2]

void vtkMultiVariateToRGBA::SetVariableVisibility ( int index,
bool visible )

Variable visibility.

Variables are the columns of a table or the components of the dataset array processed, and only the visible ones are used to compute the GBC/RGBA values, letting a subset of a multivariate dataset be visualized. A variable is set visible or hidden by name or by index; unnamed variables are named after their index ("0", "1", ...). Names are unique: a name already used, by a named variable or an earlier variable, gets the first free " (2)", " (3)", ... suffix, so a column named "1" keeps its name and an unnamed column 1 is named "1 (2)". By default, every variable is visible. The non-numeric columns of a table, such as string columns, are never visible, whatever their visibility is set to, but keep their index.

The visibility is stored as a default visibility and the variables that differ from it, which do not depend on the input, so they can be set before the input is connected. Names and indices do not mix: while variables differ from the default by name, setting the visibility by index is an error, and the other way around. SetVariableVisibilityAll(), SetVisibleVariables(), SetVisibleVariableIndices() and ResetVisibleVariableIndices() start over. Indices outside the input are ignored, and negative indices are an error.

◆ SetVariableVisibilityAll()

void vtkMultiVariateToRGBA::SetVariableVisibilityAll ( bool visible)

Set the visibility of all variables, including the ones of inputs set later.

The non-numeric columns of a table stay hidden. Passing false leaves the filter with nothing to process until variables are made visible again.

◆ GetVariableVisibility() [1/2]

bool vtkMultiVariateToRGBA::GetVariableVisibility ( const std::string & name)

Get the visibility of a variable of the current input, by name or index.

A variable that is not in the current input, or any variable when there is no input, is not visible.

◆ GetVariableVisibility() [2/2]

bool vtkMultiVariateToRGBA::GetVariableVisibility ( int index)

Variable visibility.

Variables are the columns of a table or the components of the dataset array processed, and only the visible ones are used to compute the GBC/RGBA values, letting a subset of a multivariate dataset be visualized. A variable is set visible or hidden by name or by index; unnamed variables are named after their index ("0", "1", ...). Names are unique: a name already used, by a named variable or an earlier variable, gets the first free " (2)", " (3)", ... suffix, so a column named "1" keeps its name and an unnamed column 1 is named "1 (2)". By default, every variable is visible. The non-numeric columns of a table, such as string columns, are never visible, whatever their visibility is set to, but keep their index.

The visibility is stored as a default visibility and the variables that differ from it, which do not depend on the input, so they can be set before the input is connected. Names and indices do not mix: while variables differ from the default by name, setting the visibility by index is an error, and the other way around. SetVariableVisibilityAll(), SetVisibleVariables(), SetVisibleVariableIndices() and ResetVisibleVariableIndices() start over. Indices outside the input are ignored, and negative indices are an error.

◆ GetVisibleVariables()

virtual vtkStringArray * vtkMultiVariateToRGBA::GetVisibleVariables ( )
virtual

Get the names of the visible variables of the current input, in their natural order.

Empty when the current input has no visible variable. The filter owns the array returned, and every call refills it, so copy it to keep the names of an earlier call.

◆ SetVisibleVariables()

virtual void vtkMultiVariateToRGBA::SetVisibleVariables ( vtkStringArray * names)
virtual

Set the list of visible variables by name: every variable not in this list is hidden.

Passing a null or empty array hides every variable.

◆ SetVisibleVariableIndices()

void vtkMultiVariateToRGBA::SetVisibleVariableIndices ( const std::vector< int > & indices)

Set the list of visible variables by index: every variable not in this list is hidden.

Passing an empty list hides every variable.

◆ GetVisibleVariableIndices()

std::vector< int > vtkMultiVariateToRGBA::GetVisibleVariableIndices ( )

Get the indices of the visible variables of the current input, in increasing order.

◆ ResetVisibleVariableIndices()

void vtkMultiVariateToRGBA::ResetVisibleVariableIndices ( )

Build the list of visible variables by index, for the ParaView server manager XML, which calls a method without arguments (clean_command) and then a method once per index (command), like AddPartitionIndex().

From C++ or Python, use SetVisibleVariableIndices() or SetVariableVisibility(int, bool) instead.

ResetVisibleVariableIndices() makes every variable visible, the same as SetVariableVisibilityAll(true), so an empty list shows every variable. The first AddVisibleVariableIndex() after it, or on a new filter, hides every other variable, so only the added ones are visible. After any other visibility setter, AddVisibleVariableIndex(i) is the same as SetVariableVisibility(i, true).

◆ AddVisibleVariableIndex()

void vtkMultiVariateToRGBA::AddVisibleVariableIndex ( int index)

Variable visibility.

Variables are the columns of a table or the components of the dataset array processed, and only the visible ones are used to compute the GBC/RGBA values, letting a subset of a multivariate dataset be visualized. A variable is set visible or hidden by name or by index; unnamed variables are named after their index ("0", "1", ...). Names are unique: a name already used, by a named variable or an earlier variable, gets the first free " (2)", " (3)", ... suffix, so a column named "1" keeps its name and an unnamed column 1 is named "1 (2)". By default, every variable is visible. The non-numeric columns of a table, such as string columns, are never visible, whatever their visibility is set to, but keep their index.

The visibility is stored as a default visibility and the variables that differ from it, which do not depend on the input, so they can be set before the input is connected. Names and indices do not mix: while variables differ from the default by name, setting the visibility by index is an error, and the other way around. SetVariableVisibilityAll(), SetVisibleVariables(), SetVisibleVariableIndices() and ResetVisibleVariableIndices() start over. Indices outside the input are ignored, and negative indices are an error.

◆ GetAllVariableNames()

vtkSmartPointer< vtkStringArray > vtkMultiVariateToRGBA::GetAllVariableNames ( )

Returns the names of every variable of the current input, visible or not, in their natural order.

◆ GetVariablesVisibleByDefault()

virtual bool vtkMultiVariateToRGBA::GetVariablesVisibleByDefault ( )
virtual

The visibility as stored (see VariablesVisibleByDefault), which does not depend on the input, so vtkPlotRadViz can save and restore it.

Use the setters above to change the visibility.

◆ SetVariablesVisibleByDefault()

virtual void vtkMultiVariateToRGBA::SetVariablesVisibleByDefault ( bool )
virtual

Variable visibility.

Variables are the columns of a table or the components of the dataset array processed, and only the visible ones are used to compute the GBC/RGBA values, letting a subset of a multivariate dataset be visualized. A variable is set visible or hidden by name or by index; unnamed variables are named after their index ("0", "1", ...). Names are unique: a name already used, by a named variable or an earlier variable, gets the first free " (2)", " (3)", ... suffix, so a column named "1" keeps its name and an unnamed column 1 is named "1 (2)". By default, every variable is visible. The non-numeric columns of a table, such as string columns, are never visible, whatever their visibility is set to, but keep their index.

The visibility is stored as a default visibility and the variables that differ from it, which do not depend on the input, so they can be set before the input is connected. Names and indices do not mix: while variables differ from the default by name, setting the visibility by index is an error, and the other way around. SetVariableVisibilityAll(), SetVisibleVariables(), SetVisibleVariableIndices() and ResetVisibleVariableIndices() start over. Indices outside the input are ignored, and negative indices are an error.

◆ GetNameVisibilityExceptions()

std::vector< std::string > vtkMultiVariateToRGBA::GetNameVisibilityExceptions ( )

Variable visibility.

Variables are the columns of a table or the components of the dataset array processed, and only the visible ones are used to compute the GBC/RGBA values, letting a subset of a multivariate dataset be visualized. A variable is set visible or hidden by name or by index; unnamed variables are named after their index ("0", "1", ...). Names are unique: a name already used, by a named variable or an earlier variable, gets the first free " (2)", " (3)", ... suffix, so a column named "1" keeps its name and an unnamed column 1 is named "1 (2)". By default, every variable is visible. The non-numeric columns of a table, such as string columns, are never visible, whatever their visibility is set to, but keep their index.

The visibility is stored as a default visibility and the variables that differ from it, which do not depend on the input, so they can be set before the input is connected. Names and indices do not mix: while variables differ from the default by name, setting the visibility by index is an error, and the other way around. SetVariableVisibilityAll(), SetVisibleVariables(), SetVisibleVariableIndices() and ResetVisibleVariableIndices() start over. Indices outside the input are ignored, and negative indices are an error.

◆ SetNameVisibilityExceptions()

void vtkMultiVariateToRGBA::SetNameVisibilityExceptions ( const std::vector< std::string > & names)

Variable visibility.

Variables are the columns of a table or the components of the dataset array processed, and only the visible ones are used to compute the GBC/RGBA values, letting a subset of a multivariate dataset be visualized. A variable is set visible or hidden by name or by index; unnamed variables are named after their index ("0", "1", ...). Names are unique: a name already used, by a named variable or an earlier variable, gets the first free " (2)", " (3)", ... suffix, so a column named "1" keeps its name and an unnamed column 1 is named "1 (2)". By default, every variable is visible. The non-numeric columns of a table, such as string columns, are never visible, whatever their visibility is set to, but keep their index.

The visibility is stored as a default visibility and the variables that differ from it, which do not depend on the input, so they can be set before the input is connected. Names and indices do not mix: while variables differ from the default by name, setting the visibility by index is an error, and the other way around. SetVariableVisibilityAll(), SetVisibleVariables(), SetVisibleVariableIndices() and ResetVisibleVariableIndices() start over. Indices outside the input are ignored, and negative indices are an error.

◆ GetIndexVisibilityExceptions()

std::vector< int > vtkMultiVariateToRGBA::GetIndexVisibilityExceptions ( )

Variable visibility.

Variables are the columns of a table or the components of the dataset array processed, and only the visible ones are used to compute the GBC/RGBA values, letting a subset of a multivariate dataset be visualized. A variable is set visible or hidden by name or by index; unnamed variables are named after their index ("0", "1", ...). Names are unique: a name already used, by a named variable or an earlier variable, gets the first free " (2)", " (3)", ... suffix, so a column named "1" keeps its name and an unnamed column 1 is named "1 (2)". By default, every variable is visible. The non-numeric columns of a table, such as string columns, are never visible, whatever their visibility is set to, but keep their index.

The visibility is stored as a default visibility and the variables that differ from it, which do not depend on the input, so they can be set before the input is connected. Names and indices do not mix: while variables differ from the default by name, setting the visibility by index is an error, and the other way around. SetVariableVisibilityAll(), SetVisibleVariables(), SetVisibleVariableIndices() and ResetVisibleVariableIndices() start over. Indices outside the input are ignored, and negative indices are an error.

◆ SetIndexVisibilityExceptions()

void vtkMultiVariateToRGBA::SetIndexVisibilityExceptions ( const std::vector< int > & indices)

Variable visibility.

Variables are the columns of a table or the components of the dataset array processed, and only the visible ones are used to compute the GBC/RGBA values, letting a subset of a multivariate dataset be visualized. A variable is set visible or hidden by name or by index; unnamed variables are named after their index ("0", "1", ...). Names are unique: a name already used, by a named variable or an earlier variable, gets the first free " (2)", " (3)", ... suffix, so a column named "1" keeps its name and an unnamed column 1 is named "1 (2)". By default, every variable is visible. The non-numeric columns of a table, such as string columns, are never visible, whatever their visibility is set to, but keep their index.

The visibility is stored as a default visibility and the variables that differ from it, which do not depend on the input, so they can be set before the input is connected. Names and indices do not mix: while variables differ from the default by name, setting the visibility by index is an error, and the other way around. SetVariableVisibilityAll(), SetVisibleVariables(), SetVisibleVariableIndices() and ResetVisibleVariableIndices() start over. Indices outside the input are ignored, and negative indices are an error.

◆ SetOutputScalarType()

virtual void vtkMultiVariateToRGBA::SetOutputScalarType ( int )
virtual

Data type of the 'rgba' array: VTK_DOUBLE (the default) or VTK_FLOAT.

VTK_FLOAT uses half the memory and is faster to upload as a volume texture, which matters when the lens is dragged.

◆ GetOutputScalarType()

virtual int vtkMultiVariateToRGBA::GetOutputScalarType ( )
virtual

Data type of the 'rgba' array: VTK_DOUBLE (the default) or VTK_FLOAT.

VTK_FLOAT uses half the memory and is faster to upload as a volume texture, which matters when the lens is dragged.

◆ Modified()

void vtkMultiVariateToRGBA::Modified ( )
overridevirtual

Overridden to tell lens-only changes apart from all other changes.

Reimplemented from vtkObject.

◆ RequestDataObject()

int vtkMultiVariateToRGBA::RequestDataObject ( vtkInformation * ,
vtkInformationVector ** ,
vtkInformationVector *  )
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkDataObjectAlgorithm.

◆ RequestData()

int vtkMultiVariateToRGBA::RequestData ( vtkInformation * ,
vtkInformationVector ** ,
vtkInformationVector *  )
overrideprotectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

Member Data Documentation

◆ ColorLightness

double vtkMultiVariateToRGBA::ColorLightness = 0.55
staticconstexpr

Convert hue, saturation and lightness (all in [0, 1]) to red, green and blue (in [0, 1]) using the same conversion as the computed colors.

ColorLightness is the lightness used for the computed colors.

See also
vtkPlotRadViz

Definition at line 182 of file vtkMultiVariateToRGBA.h.

◆ Controller

vtkMultiProcessController* vtkMultiVariateToRGBA::Controller = nullptr
protected

Definition at line 406 of file vtkMultiVariateToRGBA.h.

◆ VerticesRotation

double vtkMultiVariateToRGBA::VerticesRotation = 0
protected

Definition at line 407 of file vtkMultiVariateToRGBA.h.

◆ VerticesClockwiseOrdering

bool vtkMultiVariateToRGBA::VerticesClockwiseOrdering = true
protected

Definition at line 408 of file vtkMultiVariateToRGBA.h.

◆ StoreGBC

bool vtkMultiVariateToRGBA::StoreGBC = false
protected

Definition at line 409 of file vtkMultiVariateToRGBA.h.

◆ StoreVertices

bool vtkMultiVariateToRGBA::StoreVertices = false
protected

Definition at line 410 of file vtkMultiVariateToRGBA.h.

◆ StoreRGBA

bool vtkMultiVariateToRGBA::StoreRGBA = true
protected

Definition at line 411 of file vtkMultiVariateToRGBA.h.

◆ StoreA

bool vtkMultiVariateToRGBA::StoreA = false
protected

Definition at line 412 of file vtkMultiVariateToRGBA.h.

◆ PartitionIndices

std::vector<int> vtkMultiVariateToRGBA::PartitionIndices
protected

Definition at line 413 of file vtkMultiVariateToRGBA.h.

◆ PartitionOffsets

std::vector<int> vtkMultiVariateToRGBA::PartitionOffsets
protected

Definition at line 414 of file vtkMultiVariateToRGBA.h.

◆ LensCenter

double vtkMultiVariateToRGBA::LensCenter[2] = { 0.0, 0.0 }
protected

Where the lens is drawn and its radius.

Definition at line 418 of file vtkMultiVariateToRGBA.h.

◆ LensRadius

double vtkMultiVariateToRGBA::LensRadius = 1.0
protected

Definition at line 419 of file vtkMultiVariateToRGBA.h.

◆ OutsideLensAlpha

double vtkMultiVariateToRGBA::OutsideLensAlpha = 0.0
protected

Alpha cap for points outside the lens.

Definition at line 423 of file vtkMultiVariateToRGBA.h.

◆ InvertLens

bool vtkMultiVariateToRGBA::InvertLens = false
protected

Definition at line 424 of file vtkMultiVariateToRGBA.h.

◆ OutputScalarType

int vtkMultiVariateToRGBA::OutputScalarType = VTK_DOUBLE
protected

Definition at line 425 of file vtkMultiVariateToRGBA.h.

◆ CustomRange

std::vector<double> vtkMultiVariateToRGBA::CustomRange
protected

Custom ranges used as the global min/max when normalizing scalars, interleaved as [min0, max0, min1, max1, ...], one pair per partition group.

Empty means no custom range is set.

Definition at line 431 of file vtkMultiVariateToRGBA.h.

◆ Range

std::vector<double> vtkMultiVariateToRGBA::Range
protected

The global [min, max] range actually used to normalize each partition group during the last RequestData, in the same flat, interleaved layout as CustomRange.

Set at the end of RequestData.

Definition at line 437 of file vtkMultiVariateToRGBA.h.

◆ VariablesVisibleByDefault

bool vtkMultiVariateToRGBA::VariablesVisibleByDefault = true
protected

Variable visibility: a variable is visible when VariablesVisibleByDefault is true, unless its name or index is in the exceptions, which flip it.

At most one of the exceptions is not empty. For example, for variables a, b, c: SetVariableVisibility("b", false) gives {true, {b}}, so a and c are visible; SetVisibleVariables({a, c}) gives {false, {a, c}}, the same visible variables.

Definition at line 446 of file vtkMultiVariateToRGBA.h.

◆ NameVisibilityExceptions

std::set<std::string> vtkMultiVariateToRGBA::NameVisibilityExceptions
protected

Definition at line 447 of file vtkMultiVariateToRGBA.h.

◆ IndexVisibilityExceptions

std::set<int> vtkMultiVariateToRGBA::IndexVisibilityExceptions
protected

Definition at line 448 of file vtkMultiVariateToRGBA.h.

◆ StartVisibleIndexList

bool vtkMultiVariateToRGBA::StartVisibleIndexList = true
protected

True after ResetVisibleVariableIndices() or on a new filter, until the next visibility setter: the next AddVisibleVariableIndex() hides every other variable.

It does not change the visibility, so it is not part of the MTime.

Definition at line 455 of file vtkMultiVariateToRGBA.h.


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