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

perform mathematical operations on data in field data arrays More...

#include <vtkArrayCalculator.h>

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

Public Types

enum  FunctionParserTypes { FunctionParser , ExprTkFunctionParser , NumberOfFunctionParserTypes }
 Enum that includes the types of parsers that can be used. More...
 
typedef vtkPassInputTypeAlgorithm Superclass
 
- Public Types inherited from vtkPassInputTypeAlgorithm
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. More...
 
vtkArrayCalculatorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
const char * GetAttributeTypeAsString ()
 Returns a string representation of the calculator's AttributeType. More...
 
void RemoveAllVariables ()
 Remove all the variable names and their associated array names. More...
 
virtual void RemoveScalarVariables ()
 Remove all the scalar variable names and their associated array names. More...
 
virtual void RemoveVectorVariables ()
 Remove all the scalar variable names and their associated array names. More...
 
virtual void RemoveCoordinateScalarVariables ()
 Remove all the coordinate variables. More...
 
virtual void RemoveCoordinateVectorVariables ()
 Remove all the coordinate variables. More...
 
vtkDataSetGetDataSetOutput ()
 Returns the output of the filter downcast to a vtkDataSet or nullptr if the cast fails. More...
 
virtual void SetFunction (const char *)
 Set/Get the function to be evaluated. More...
 
virtual char * GetFunction ()
 Set/Get the function to be evaluated. More...
 
void AddScalarArrayName (const char *arrayName, int component=0)
 Add an array name to the list of arrays used in the function and specify which components of the array to use in evaluating the function. More...
 
void AddVectorArrayName (const char *arrayName, int component0=0, int component1=1, int component2=2)
 Add an array name to the list of arrays used in the function and specify which components of the array to use in evaluating the function. More...
 
void AddScalarVariable (const char *variableName, const char *arrayName, int component=0)
 Add a variable name, a corresponding array name, and which components of the array to use. More...
 
void AddVectorVariable (const char *variableName, const char *arrayName, int component0=0, int component1=1, int component2=2)
 Add a variable name, a corresponding array name, and which components of the array to use. More...
 
void AddCoordinateScalarVariable (const char *variableName, int component=0)
 Add a variable name, a corresponding array name, and which components of the array to use. More...
 
void AddCoordinateVectorVariable (const char *variableName, int component0=0, int component1=1, int component2=2)
 Add a variable name, a corresponding array name, and which components of the array to use. More...
 
virtual void SetResultArrayName (const char *)
 Set the name of the array in which to store the result of evaluating this function. More...
 
virtual char * GetResultArrayName ()
 Set the name of the array in which to store the result of evaluating this function. More...
 
virtual int GetResultArrayType ()
 Type of the result array. More...
 
virtual void SetResultArrayType (int)
 Type of the result array. More...
 
virtual vtkTypeBool GetCoordinateResults ()
 Set whether to output results as coordinates. More...
 
virtual void SetCoordinateResults (vtkTypeBool)
 Set whether to output results as coordinates. More...
 
virtual void CoordinateResultsOn ()
 Set whether to output results as coordinates. More...
 
virtual void CoordinateResultsOff ()
 Set whether to output results as coordinates. More...
 
virtual bool GetResultNormals ()
 Set whether to output results as point/cell normals. More...
 
virtual void SetResultNormals (bool)
 Set whether to output results as point/cell normals. More...
 
virtual void ResultNormalsOn ()
 Set whether to output results as point/cell normals. More...
 
virtual void ResultNormalsOff ()
 Set whether to output results as point/cell normals. More...
 
virtual bool GetResultTCoords ()
 Set whether to output results as point/cell texture coordinates. More...
 
virtual void SetResultTCoords (bool)
 Set whether to output results as point/cell texture coordinates. More...
 
virtual void ResultTCoordsOn ()
 Set whether to output results as point/cell texture coordinates. More...
 
virtual void ResultTCoordsOff ()
 Set whether to output results as point/cell texture coordinates. More...
 
virtual void SetAttributeType (int)
 Control which AttributeType the filter operates on (point data or cell data for vtkDataSets). More...
 
virtual int GetAttributeType ()
 Control which AttributeType the filter operates on (point data or cell data for vtkDataSets). More...
 
void SetAttributeTypeToDefault ()
 Control which AttributeType the filter operates on (point data or cell data for vtkDataSets). More...
 
void SetAttributeTypeToPointData ()
 Control which AttributeType the filter operates on (point data or cell data for vtkDataSets). More...
 
void SetAttributeTypeToCellData ()
 Control which AttributeType the filter operates on (point data or cell data for vtkDataSets). More...
 
void SetAttributeTypeToEdgeData ()
 Control which AttributeType the filter operates on (point data or cell data for vtkDataSets). More...
 
void SetAttributeTypeToVertexData ()
 Control which AttributeType the filter operates on (point data or cell data for vtkDataSets). More...
 
void SetAttributeTypeToRowData ()
 Control which AttributeType the filter operates on (point data or cell data for vtkDataSets). More...
 
const std::vector< std::string > & GetScalarArrayNames ()
 Methods to get information about the current variables. More...
 
std::string GetScalarArrayName (int i)
 Methods to get information about the current variables. More...
 
const std::vector< std::string > & GetVectorArrayNames ()
 Methods to get information about the current variables. More...
 
std::string GetVectorArrayName (int i)
 Methods to get information about the current variables. More...
 
const std::vector< std::string > & GetScalarVariableNames ()
 Methods to get information about the current variables. More...
 
std::string GetScalarVariableName (int i)
 Methods to get information about the current variables. More...
 
const std::vector< std::string > & GetVectorVariableNames ()
 Methods to get information about the current variables. More...
 
std::string GetVectorVariableName (int i)
 Methods to get information about the current variables. More...
 
const std::vector< int > & GetSelectedScalarComponents ()
 Methods to get information about the current variables. More...
 
int GetSelectedScalarComponent (int i)
 Methods to get information about the current variables. More...
 
const std::vector< vtkTuple< int, 3 > > & GetSelectedVectorComponents ()
 Methods to get information about the current variables. More...
 
vtkTuple< int, 3 > GetSelectedVectorComponents (int i)
 Methods to get information about the current variables. More...
 
int GetNumberOfScalarArrays ()
 Methods to get information about the current variables. More...
 
int GetNumberOfVectorArrays ()
 Methods to get information about the current variables. More...
 
virtual void SetReplaceInvalidValues (vtkTypeBool)
 When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. More...
 
virtual vtkTypeBool GetReplaceInvalidValues ()
 When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. More...
 
virtual void ReplaceInvalidValuesOn ()
 When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. More...
 
virtual void ReplaceInvalidValuesOff ()
 When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. More...
 
virtual void SetReplacementValue (double)
 When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. More...
 
virtual double GetReplacementValue ()
 When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue. More...
 
virtual void SetIgnoreMissingArrays (bool)
 When this option is set, silently ignore datasets where the requested field data array is not present. More...
 
virtual bool GetIgnoreMissingArrays ()
 When this option is set, silently ignore datasets where the requested field data array is not present. More...
 
virtual void IgnoreMissingArraysOn ()
 When this option is set, silently ignore datasets where the requested field data array is not present. More...
 
virtual void IgnoreMissingArraysOff ()
 When this option is set, silently ignore datasets where the requested field data array is not present. More...
 
 vtkSetEnumMacro (FunctionParserType, FunctionParserTypes)
 Set/Get the FunctionParser type that will be used. More...
 
void SetFunctionParserTypeToFunctionParser ()
 Set/Get the FunctionParser type that will be used. More...
 
void SetFunctionParserTypeToExprTkFunctionParser ()
 Set/Get the FunctionParser type that will be used. More...
 
 vtkGetEnumMacro (FunctionParserType, FunctionParserTypes)
 Set/Get the FunctionParser type that will be used. More...
 
- Public Member Functions inherited from vtkPassInputTypeAlgorithm
vtkPassInputTypeAlgorithmNewInstance () const
 
vtkDataObjectGetInput ()
 Get the input data object. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 see vtkAlgorithm for details More...
 
vtkDataObjectGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkDataObjectGetOutput (int)
 Get the output data object for a port on this algorithm. More...
 
vtkPolyDataGetPolyDataOutput ()
 Get the output as a concrete type. More...
 
vtkStructuredPointsGetStructuredPointsOutput ()
 Get the output as a concrete type. More...
 
vtkImageDataGetImageDataOutput ()
 Get the output as a concrete type. More...
 
vtkStructuredGridGetStructuredGridOutput ()
 Get the output as a concrete type. More...
 
vtkUnstructuredGridGetUnstructuredGridOutput ()
 Get the output as a concrete type. More...
 
vtkRectilinearGridGetRectilinearGridOutput ()
 Get the output as a concrete type. More...
 
vtkGraphGetGraphOutput ()
 Get the output as a concrete type. More...
 
vtkMoleculeGetMoleculeOutput ()
 Get the output as a concrete type. More...
 
vtkTableGetTableOutput ()
 Get the output as a concrete type. More...
 
vtkHyperTreeGridGetHyperTreeGridOutput ()
 Get the output as a concrete type. More...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
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. More...
 
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. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void SetAbortExecuteAndUpdateTime ()
 Set AbortExecute Flag and update LastAbortTime. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
bool CheckAbort ()
 Checks to see if this filter should abort. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
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). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
bool UsesGarbageCollector () const override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetContainerAlgorithm (vtkAlgorithm *containerAlg)
 Set/get a Container algorithm for this algorithm. More...
 
vtkAlgorithmGetContainerAlgorithm ()
 Set/get a Container algorithm for this algorithm. More...
 
virtual void SetAbortOutput (bool)
 Set/Get an internal variable used to communicate between the algorithm and executive. More...
 
virtual bool GetAbortOutput ()
 Set/Get an internal variable used to communicate between the algorithm and executive. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
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. More...
 
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. More...
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
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. More...
 
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. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkArrayCalculatorSafeDownCast (vtkObjectBase *o)
 
static vtkArrayCalculatorNew ()
 
- Static Public Member Functions inherited from vtkPassInputTypeAlgorithm
static vtkPassInputTypeAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPassInputTypeAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static vtkInformationIntegerKeyABORTED ()
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Static Public Attributes

static const int DEFAULT_ATTRIBUTE_TYPE = -1
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkArrayCalculator ()
 
 ~vtkArrayCalculator () override
 
int FillInputPortInformation (int, vtkInformation *) override
 Fill the input port information objects for this algorithm. More...
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called within ProcessRequest when a request asks the algorithm to do its work. More...
 
int GetAttributeTypeFromInput (vtkDataObject *input)
 Get the attribute type for the input. More...
 
- Protected Member Functions inherited from vtkPassInputTypeAlgorithm
 vtkPassInputTypeAlgorithm ()
 
 ~vtkPassInputTypeAlgorithm () override=default
 
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 This is called within ProcessRequest when a request asks the algorithm to create empty output data objects. More...
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called within ProcessRequest when a request asks for Information. More...
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called within ProcessRequest when a request ask for temporal information to be updated. More...
 
virtual int RequestUpdateTimeDependentInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called within ProcessRequest when a request ask for meta information to be updated. More...
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called within ProcessRequest when each filter in the pipeline decides what portion of its input is needed to create the portion of its output that the downstream filter asks for. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
vtkDataObjectGetInput (int port)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
bool CheckUpstreamAbort ()
 Checks to see if an upstream filter has been aborted. More...
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
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. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
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. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (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. More...
 
vtkDataArrayGetInputArrayToProcess (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. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static std::string CheckValidVariableName (const char *variableName)
 A variable name is valid if it's sanitized or enclosed in quotes. More...
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Protected Attributes

FunctionParserTypes FunctionParserType
 
char * Function
 
char * ResultArrayName
 
std::vector< std::string > ScalarArrayNames
 
std::vector< std::string > VectorArrayNames
 
std::vector< std::string > ScalarVariableNames
 
std::vector< std::string > VectorVariableNames
 
int AttributeType
 
std::vector< int > SelectedScalarComponents
 
std::vector< vtkTuple< int, 3 > > SelectedVectorComponents
 
vtkTypeBool ReplaceInvalidValues
 
double ReplacementValue
 
bool IgnoreMissingArrays
 
vtkTypeBool CoordinateResults
 
bool ResultNormals
 
bool ResultTCoords
 
std::vector< std::string > CoordinateScalarVariableNames
 
std::vector< std::string > CoordinateVectorVariableNames
 
std::vector< int > SelectedCoordinateScalarComponents
 
std::vector< vtkTuple< int, 3 > > SelectedCoordinateVectorComponents
 
int ResultArrayType
 
- Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp LastAbortCheckTime
 
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- 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
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBoolAbortExecute
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp LastAbortTime
 
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

perform mathematical operations on data in field data arrays

vtkArrayCalculator performs operations on vectors or scalars in field data arrays. It uses vtkFunctionParser/vtkExprTkFunctionParser to do the parsing and to evaluate the function for each entry in the input arrays. The arrays used in a given function must be all in point data or all in cell data. The resulting array will be stored as a field data array. The result array can either be stored in a new array or it can overwrite an existing array. vtkArrayCalculator can run in parallel using vtkSMPTools.

The functions that this array calculator understands is:

standard operations:

Note that some of these operations work on scalars, some on vectors, and some on both (e.g., you can multiply a scalar times a vector). The operations are performed tuple-wise (i.e., tuple-by-tuple). The user must specify which arrays to use as vectors and/or scalars, and the name of the output data array.

See also
For more detailed documentation of the supported functionality see: 1) vtkFunctionParser 2) vtkExprTkFunctionParser (default)
Online Examples:

Tests:
vtkArrayCalculator (Tests)

Definition at line 116 of file vtkArrayCalculator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 119 of file vtkArrayCalculator.h.

Member Enumeration Documentation

◆ FunctionParserTypes

Enum that includes the types of parsers that can be used.

Enumerator
FunctionParser 
ExprTkFunctionParser 
NumberOfFunctionParserTypes 

Definition at line 325 of file vtkArrayCalculator.h.

Constructor & Destructor Documentation

◆ vtkArrayCalculator()

vtkArrayCalculator::vtkArrayCalculator ( )
protected

◆ ~vtkArrayCalculator()

vtkArrayCalculator::~vtkArrayCalculator ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkArrayCalculator::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 vtkPassInputTypeAlgorithm.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkArrayCalculator::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPassInputTypeAlgorithm.

◆ NewInstance()

vtkArrayCalculator* vtkArrayCalculator::NewInstance ( ) const

◆ PrintSelf()

void vtkArrayCalculator::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 vtkPassInputTypeAlgorithm.

◆ New()

static vtkArrayCalculator* vtkArrayCalculator::New ( )
static

◆ SetFunction()

virtual void vtkArrayCalculator::SetFunction ( const char *  )
virtual

Set/Get the function to be evaluated.

◆ GetFunction()

virtual char* vtkArrayCalculator::GetFunction ( )
virtual

Set/Get the function to be evaluated.

◆ AddScalarArrayName()

void vtkArrayCalculator::AddScalarArrayName ( const char *  arrayName,
int  component = 0 
)

Add an array name to the list of arrays used in the function and specify which components of the array to use in evaluating the function.

The array name must match the name in the function. If the array name is not sanitized, the variable name will be the array name enclosed in quotes. Use AddScalarVariable or AddVectorVariable to use a user defined variable name.

Note
A sanitized variable name is accepted by the following regex: ^[a-zA-Z][a-zA-Z_0-9]*.

◆ AddVectorArrayName()

void vtkArrayCalculator::AddVectorArrayName ( const char *  arrayName,
int  component0 = 0,
int  component1 = 1,
int  component2 = 2 
)

Add an array name to the list of arrays used in the function and specify which components of the array to use in evaluating the function.

The array name must match the name in the function. If the array name is not sanitized, the variable name will be the array name enclosed in quotes. Use AddScalarVariable or AddVectorVariable to use a user defined variable name.

Note
A sanitized variable name is accepted by the following regex: ^[a-zA-Z][a-zA-Z_0-9]*.

◆ AddScalarVariable()

void vtkArrayCalculator::AddScalarVariable ( const char *  variableName,
const char *  arrayName,
int  component = 0 
)

Add a variable name, a corresponding array name, and which components of the array to use.

The variable name should be sanitized or in quotes.

Note
A sanitized variable name is accepted by the following regex: ^[a-zA-Z][a-zA-Z_0-9]*.

◆ AddVectorVariable()

void vtkArrayCalculator::AddVectorVariable ( const char *  variableName,
const char *  arrayName,
int  component0 = 0,
int  component1 = 1,
int  component2 = 2 
)

Add a variable name, a corresponding array name, and which components of the array to use.

The variable name should be sanitized or in quotes.

Note
A sanitized variable name is accepted by the following regex: ^[a-zA-Z][a-zA-Z_0-9]*.

◆ AddCoordinateScalarVariable()

void vtkArrayCalculator::AddCoordinateScalarVariable ( const char *  variableName,
int  component = 0 
)

Add a variable name, a corresponding array name, and which components of the array to use.

The variable name should be sanitized or in quotes.

Note
A sanitized variable name is accepted by the following regex: ^[a-zA-Z][a-zA-Z_0-9]*.

◆ AddCoordinateVectorVariable()

void vtkArrayCalculator::AddCoordinateVectorVariable ( const char *  variableName,
int  component0 = 0,
int  component1 = 1,
int  component2 = 2 
)

Add a variable name, a corresponding array name, and which components of the array to use.

The variable name should be sanitized or in quotes.

Note
A sanitized variable name is accepted by the following regex: ^[a-zA-Z][a-zA-Z_0-9]*.

◆ SetResultArrayName()

virtual void vtkArrayCalculator::SetResultArrayName ( const char *  )
virtual

Set the name of the array in which to store the result of evaluating this function.

If this is the name of an existing array, that array will be overwritten. Otherwise a new array will be created with the specified name.

◆ GetResultArrayName()

virtual char* vtkArrayCalculator::GetResultArrayName ( )
virtual

Set the name of the array in which to store the result of evaluating this function.

If this is the name of an existing array, that array will be overwritten. Otherwise a new array will be created with the specified name.

◆ GetResultArrayType()

virtual int vtkArrayCalculator::GetResultArrayType ( )
virtual

Type of the result array.

It is ignored if CoordinateResults is true. Initial value is VTK_DOUBLE.

◆ SetResultArrayType()

virtual void vtkArrayCalculator::SetResultArrayType ( int  )
virtual

Type of the result array.

It is ignored if CoordinateResults is true. Initial value is VTK_DOUBLE.

◆ GetCoordinateResults()

virtual vtkTypeBool vtkArrayCalculator::GetCoordinateResults ( )
virtual

Set whether to output results as coordinates.

ResultArrayName will be ignored. Outputting as coordinates is only valid with vector results and if the AttributeMode is AttributeModeToUsePointData. If a valid output can't be made, an error will occur.

◆ SetCoordinateResults()

virtual void vtkArrayCalculator::SetCoordinateResults ( vtkTypeBool  )
virtual

Set whether to output results as coordinates.

ResultArrayName will be ignored. Outputting as coordinates is only valid with vector results and if the AttributeMode is AttributeModeToUsePointData. If a valid output can't be made, an error will occur.

◆ CoordinateResultsOn()

virtual void vtkArrayCalculator::CoordinateResultsOn ( )
virtual

Set whether to output results as coordinates.

ResultArrayName will be ignored. Outputting as coordinates is only valid with vector results and if the AttributeMode is AttributeModeToUsePointData. If a valid output can't be made, an error will occur.

◆ CoordinateResultsOff()

virtual void vtkArrayCalculator::CoordinateResultsOff ( )
virtual

Set whether to output results as coordinates.

ResultArrayName will be ignored. Outputting as coordinates is only valid with vector results and if the AttributeMode is AttributeModeToUsePointData. If a valid output can't be made, an error will occur.

◆ GetResultNormals()

virtual bool vtkArrayCalculator::GetResultNormals ( )
virtual

Set whether to output results as point/cell normals.

Outputting as normals is only valid with vector results. Point or cell normals are selected using AttributeMode.

◆ SetResultNormals()

virtual void vtkArrayCalculator::SetResultNormals ( bool  )
virtual

Set whether to output results as point/cell normals.

Outputting as normals is only valid with vector results. Point or cell normals are selected using AttributeMode.

◆ ResultNormalsOn()

virtual void vtkArrayCalculator::ResultNormalsOn ( )
virtual

Set whether to output results as point/cell normals.

Outputting as normals is only valid with vector results. Point or cell normals are selected using AttributeMode.

◆ ResultNormalsOff()

virtual void vtkArrayCalculator::ResultNormalsOff ( )
virtual

Set whether to output results as point/cell normals.

Outputting as normals is only valid with vector results. Point or cell normals are selected using AttributeMode.

◆ GetResultTCoords()

virtual bool vtkArrayCalculator::GetResultTCoords ( )
virtual

Set whether to output results as point/cell texture coordinates.

Point or cell texture coordinates are selected using AttributeMode. 2-component texture coordinates cannot be generated at this time.

◆ SetResultTCoords()

virtual void vtkArrayCalculator::SetResultTCoords ( bool  )
virtual

Set whether to output results as point/cell texture coordinates.

Point or cell texture coordinates are selected using AttributeMode. 2-component texture coordinates cannot be generated at this time.

◆ ResultTCoordsOn()

virtual void vtkArrayCalculator::ResultTCoordsOn ( )
virtual

Set whether to output results as point/cell texture coordinates.

Point or cell texture coordinates are selected using AttributeMode. 2-component texture coordinates cannot be generated at this time.

◆ ResultTCoordsOff()

virtual void vtkArrayCalculator::ResultTCoordsOff ( )
virtual

Set whether to output results as point/cell texture coordinates.

Point or cell texture coordinates are selected using AttributeMode. 2-component texture coordinates cannot be generated at this time.

◆ GetAttributeTypeAsString()

const char* vtkArrayCalculator::GetAttributeTypeAsString ( )

Returns a string representation of the calculator's AttributeType.

◆ SetAttributeType()

virtual void vtkArrayCalculator::SetAttributeType ( int  )
virtual

Control which AttributeType the filter operates on (point data or cell data for vtkDataSets).

By default the filter uses Point/Vertex/Row data depending on the input data type. The input value for this function should be one of the constants in vtkDataObject::AttributeTypes or DEFAULT_ATTRIBUTE_TYPE for 'default behavior'.

◆ GetAttributeType()

virtual int vtkArrayCalculator::GetAttributeType ( )
virtual

Control which AttributeType the filter operates on (point data or cell data for vtkDataSets).

By default the filter uses Point/Vertex/Row data depending on the input data type. The input value for this function should be one of the constants in vtkDataObject::AttributeTypes or DEFAULT_ATTRIBUTE_TYPE for 'default behavior'.

◆ SetAttributeTypeToDefault()

void vtkArrayCalculator::SetAttributeTypeToDefault ( )
inline

Control which AttributeType the filter operates on (point data or cell data for vtkDataSets).

By default the filter uses Point/Vertex/Row data depending on the input data type. The input value for this function should be one of the constants in vtkDataObject::AttributeTypes or DEFAULT_ATTRIBUTE_TYPE for 'default behavior'.

Definition at line 241 of file vtkArrayCalculator.h.

◆ SetAttributeTypeToPointData()

void vtkArrayCalculator::SetAttributeTypeToPointData ( )
inline

Control which AttributeType the filter operates on (point data or cell data for vtkDataSets).

By default the filter uses Point/Vertex/Row data depending on the input data type. The input value for this function should be one of the constants in vtkDataObject::AttributeTypes or DEFAULT_ATTRIBUTE_TYPE for 'default behavior'.

Definition at line 242 of file vtkArrayCalculator.h.

◆ SetAttributeTypeToCellData()

void vtkArrayCalculator::SetAttributeTypeToCellData ( )
inline

Control which AttributeType the filter operates on (point data or cell data for vtkDataSets).

By default the filter uses Point/Vertex/Row data depending on the input data type. The input value for this function should be one of the constants in vtkDataObject::AttributeTypes or DEFAULT_ATTRIBUTE_TYPE for 'default behavior'.

Definition at line 243 of file vtkArrayCalculator.h.

◆ SetAttributeTypeToEdgeData()

void vtkArrayCalculator::SetAttributeTypeToEdgeData ( )
inline

Control which AttributeType the filter operates on (point data or cell data for vtkDataSets).

By default the filter uses Point/Vertex/Row data depending on the input data type. The input value for this function should be one of the constants in vtkDataObject::AttributeTypes or DEFAULT_ATTRIBUTE_TYPE for 'default behavior'.

Definition at line 244 of file vtkArrayCalculator.h.

◆ SetAttributeTypeToVertexData()

void vtkArrayCalculator::SetAttributeTypeToVertexData ( )
inline

Control which AttributeType the filter operates on (point data or cell data for vtkDataSets).

By default the filter uses Point/Vertex/Row data depending on the input data type. The input value for this function should be one of the constants in vtkDataObject::AttributeTypes or DEFAULT_ATTRIBUTE_TYPE for 'default behavior'.

Definition at line 245 of file vtkArrayCalculator.h.

◆ SetAttributeTypeToRowData()

void vtkArrayCalculator::SetAttributeTypeToRowData ( )
inline

Control which AttributeType the filter operates on (point data or cell data for vtkDataSets).

By default the filter uses Point/Vertex/Row data depending on the input data type. The input value for this function should be one of the constants in vtkDataObject::AttributeTypes or DEFAULT_ATTRIBUTE_TYPE for 'default behavior'.

Definition at line 246 of file vtkArrayCalculator.h.

◆ RemoveAllVariables()

void vtkArrayCalculator::RemoveAllVariables ( )

Remove all the variable names and their associated array names.

◆ RemoveScalarVariables()

virtual void vtkArrayCalculator::RemoveScalarVariables ( )
virtual

Remove all the scalar variable names and their associated array names.

◆ RemoveVectorVariables()

virtual void vtkArrayCalculator::RemoveVectorVariables ( )
virtual

Remove all the scalar variable names and their associated array names.

◆ RemoveCoordinateScalarVariables()

virtual void vtkArrayCalculator::RemoveCoordinateScalarVariables ( )
virtual

Remove all the coordinate variables.

◆ RemoveCoordinateVectorVariables()

virtual void vtkArrayCalculator::RemoveCoordinateVectorVariables ( )
virtual

Remove all the coordinate variables.

◆ GetScalarArrayNames()

const std::vector<std::string>& vtkArrayCalculator::GetScalarArrayNames ( )
inline

Methods to get information about the current variables.

Definition at line 278 of file vtkArrayCalculator.h.

◆ GetScalarArrayName()

std::string vtkArrayCalculator::GetScalarArrayName ( int  i)

Methods to get information about the current variables.

◆ GetVectorArrayNames()

const std::vector<std::string>& vtkArrayCalculator::GetVectorArrayNames ( )
inline

Methods to get information about the current variables.

Definition at line 280 of file vtkArrayCalculator.h.

◆ GetVectorArrayName()

std::string vtkArrayCalculator::GetVectorArrayName ( int  i)

Methods to get information about the current variables.

◆ GetScalarVariableNames()

const std::vector<std::string>& vtkArrayCalculator::GetScalarVariableNames ( )
inline

Methods to get information about the current variables.

Definition at line 282 of file vtkArrayCalculator.h.

◆ GetScalarVariableName()

std::string vtkArrayCalculator::GetScalarVariableName ( int  i)

Methods to get information about the current variables.

◆ GetVectorVariableNames()

const std::vector<std::string>& vtkArrayCalculator::GetVectorVariableNames ( )
inline

Methods to get information about the current variables.

Definition at line 284 of file vtkArrayCalculator.h.

◆ GetVectorVariableName()

std::string vtkArrayCalculator::GetVectorVariableName ( int  i)

Methods to get information about the current variables.

◆ GetSelectedScalarComponents()

const std::vector<int>& vtkArrayCalculator::GetSelectedScalarComponents ( )
inline

Methods to get information about the current variables.

Definition at line 286 of file vtkArrayCalculator.h.

◆ GetSelectedScalarComponent()

int vtkArrayCalculator::GetSelectedScalarComponent ( int  i)

Methods to get information about the current variables.

◆ GetSelectedVectorComponents() [1/2]

const std::vector<vtkTuple<int, 3> >& vtkArrayCalculator::GetSelectedVectorComponents ( )
inline

Methods to get information about the current variables.

Definition at line 288 of file vtkArrayCalculator.h.

◆ GetSelectedVectorComponents() [2/2]

vtkTuple<int, 3> vtkArrayCalculator::GetSelectedVectorComponents ( int  i)

Methods to get information about the current variables.

◆ GetNumberOfScalarArrays()

int vtkArrayCalculator::GetNumberOfScalarArrays ( )
inline

Methods to get information about the current variables.

Definition at line 293 of file vtkArrayCalculator.h.

◆ GetNumberOfVectorArrays()

int vtkArrayCalculator::GetNumberOfVectorArrays ( )
inline

Methods to get information about the current variables.

Definition at line 294 of file vtkArrayCalculator.h.

◆ SetReplaceInvalidValues()

virtual void vtkArrayCalculator::SetReplaceInvalidValues ( vtkTypeBool  )
virtual

When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue.

Otherwise an error will be reported.

◆ GetReplaceInvalidValues()

virtual vtkTypeBool vtkArrayCalculator::GetReplaceInvalidValues ( )
virtual

When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue.

Otherwise an error will be reported.

◆ ReplaceInvalidValuesOn()

virtual void vtkArrayCalculator::ReplaceInvalidValuesOn ( )
virtual

When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue.

Otherwise an error will be reported.

◆ ReplaceInvalidValuesOff()

virtual void vtkArrayCalculator::ReplaceInvalidValuesOff ( )
virtual

When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue.

Otherwise an error will be reported.

◆ SetReplacementValue()

virtual void vtkArrayCalculator::SetReplacementValue ( double  )
virtual

When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue.

Otherwise an error will be reported.

◆ GetReplacementValue()

virtual double vtkArrayCalculator::GetReplacementValue ( )
virtual

When ReplaceInvalidValues is on, all invalid values (such as sqrt(-2), note that function parser does not handle complex numbers) will be replaced by ReplacementValue.

Otherwise an error will be reported.

◆ SetIgnoreMissingArrays()

virtual void vtkArrayCalculator::SetIgnoreMissingArrays ( bool  )
virtual

When this option is set, silently ignore datasets where the requested field data array is not present.

When an input array is not present, the result array will not be generated nor added to the output.

◆ GetIgnoreMissingArrays()

virtual bool vtkArrayCalculator::GetIgnoreMissingArrays ( )
virtual

When this option is set, silently ignore datasets where the requested field data array is not present.

When an input array is not present, the result array will not be generated nor added to the output.

◆ IgnoreMissingArraysOn()

virtual void vtkArrayCalculator::IgnoreMissingArraysOn ( )
virtual

When this option is set, silently ignore datasets where the requested field data array is not present.

When an input array is not present, the result array will not be generated nor added to the output.

◆ IgnoreMissingArraysOff()

virtual void vtkArrayCalculator::IgnoreMissingArraysOff ( )
virtual

When this option is set, silently ignore datasets where the requested field data array is not present.

When an input array is not present, the result array will not be generated nor added to the output.

◆ vtkSetEnumMacro()

vtkArrayCalculator::vtkSetEnumMacro ( FunctionParserType  ,
FunctionParserTypes   
)

Set/Get the FunctionParser type that will be used.

vtkFunctionParser = 0, vtkExprTkFunctionParser = 1. Default is 1.

◆ SetFunctionParserTypeToFunctionParser()

void vtkArrayCalculator::SetFunctionParserTypeToFunctionParser ( )
inline

Set/Get the FunctionParser type that will be used.

vtkFunctionParser = 0, vtkExprTkFunctionParser = 1. Default is 1.

Definition at line 338 of file vtkArrayCalculator.h.

◆ SetFunctionParserTypeToExprTkFunctionParser()

void vtkArrayCalculator::SetFunctionParserTypeToExprTkFunctionParser ( )
inline

Set/Get the FunctionParser type that will be used.

vtkFunctionParser = 0, vtkExprTkFunctionParser = 1. Default is 1.

Definition at line 343 of file vtkArrayCalculator.h.

◆ vtkGetEnumMacro()

vtkArrayCalculator::vtkGetEnumMacro ( FunctionParserType  ,
FunctionParserTypes   
)

Set/Get the FunctionParser type that will be used.

vtkFunctionParser = 0, vtkExprTkFunctionParser = 1. Default is 1.

◆ GetDataSetOutput()

vtkDataSet* vtkArrayCalculator::GetDataSetOutput ( )

Returns the output of the filter downcast to a vtkDataSet or nullptr if the cast fails.

◆ FillInputPortInformation()

int vtkArrayCalculator::FillInputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

Fill the input port information objects for this algorithm.

This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkPassInputTypeAlgorithm.

◆ RequestData()

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

This is called within ProcessRequest when a request asks the algorithm to do its work.

This is the method you should override to do whatever the algorithm is designed to do. This happens during the final pass in the pipeline execution process.

Reimplemented from vtkPassInputTypeAlgorithm.

◆ GetAttributeTypeFromInput()

int vtkArrayCalculator::GetAttributeTypeFromInput ( vtkDataObject input)
protected

Get the attribute type for the input.

◆ CheckValidVariableName()

static std::string vtkArrayCalculator::CheckValidVariableName ( const char *  variableName)
staticprotected

A variable name is valid if it's sanitized or enclosed in quotes.

1) if it's valid, return itself. 2) if it's not valid, return itself enclosed in quotes,

Note
A sanitized variable name is accepted by the following regex: ^[a-zA-Z][a-zA-Z_0-9]*.

Member Data Documentation

◆ DEFAULT_ATTRIBUTE_TYPE

const int vtkArrayCalculator::DEFAULT_ATTRIBUTE_TYPE = -1
static

Definition at line 231 of file vtkArrayCalculator.h.

◆ FunctionParserType

FunctionParserTypes vtkArrayCalculator::FunctionParserType
protected

Definition at line 379 of file vtkArrayCalculator.h.

◆ Function

char* vtkArrayCalculator::Function
protected

Definition at line 381 of file vtkArrayCalculator.h.

◆ ResultArrayName

char* vtkArrayCalculator::ResultArrayName
protected

Definition at line 382 of file vtkArrayCalculator.h.

◆ ScalarArrayNames

std::vector<std::string> vtkArrayCalculator::ScalarArrayNames
protected

Definition at line 383 of file vtkArrayCalculator.h.

◆ VectorArrayNames

std::vector<std::string> vtkArrayCalculator::VectorArrayNames
protected

Definition at line 384 of file vtkArrayCalculator.h.

◆ ScalarVariableNames

std::vector<std::string> vtkArrayCalculator::ScalarVariableNames
protected

Definition at line 385 of file vtkArrayCalculator.h.

◆ VectorVariableNames

std::vector<std::string> vtkArrayCalculator::VectorVariableNames
protected

Definition at line 386 of file vtkArrayCalculator.h.

◆ AttributeType

int vtkArrayCalculator::AttributeType
protected

Definition at line 387 of file vtkArrayCalculator.h.

◆ SelectedScalarComponents

std::vector<int> vtkArrayCalculator::SelectedScalarComponents
protected

Definition at line 388 of file vtkArrayCalculator.h.

◆ SelectedVectorComponents

std::vector<vtkTuple<int, 3> > vtkArrayCalculator::SelectedVectorComponents
protected

Definition at line 389 of file vtkArrayCalculator.h.

◆ ReplaceInvalidValues

vtkTypeBool vtkArrayCalculator::ReplaceInvalidValues
protected

Definition at line 391 of file vtkArrayCalculator.h.

◆ ReplacementValue

double vtkArrayCalculator::ReplacementValue
protected

Definition at line 392 of file vtkArrayCalculator.h.

◆ IgnoreMissingArrays

bool vtkArrayCalculator::IgnoreMissingArrays
protected

Definition at line 393 of file vtkArrayCalculator.h.

◆ CoordinateResults

vtkTypeBool vtkArrayCalculator::CoordinateResults
protected

Definition at line 395 of file vtkArrayCalculator.h.

◆ ResultNormals

bool vtkArrayCalculator::ResultNormals
protected

Definition at line 396 of file vtkArrayCalculator.h.

◆ ResultTCoords

bool vtkArrayCalculator::ResultTCoords
protected

Definition at line 397 of file vtkArrayCalculator.h.

◆ CoordinateScalarVariableNames

std::vector<std::string> vtkArrayCalculator::CoordinateScalarVariableNames
protected

Definition at line 398 of file vtkArrayCalculator.h.

◆ CoordinateVectorVariableNames

std::vector<std::string> vtkArrayCalculator::CoordinateVectorVariableNames
protected

Definition at line 399 of file vtkArrayCalculator.h.

◆ SelectedCoordinateScalarComponents

std::vector<int> vtkArrayCalculator::SelectedCoordinateScalarComponents
protected

Definition at line 400 of file vtkArrayCalculator.h.

◆ SelectedCoordinateVectorComponents

std::vector<vtkTuple<int, 3> > vtkArrayCalculator::SelectedCoordinateVectorComponents
protected

Definition at line 401 of file vtkArrayCalculator.h.

◆ ResultArrayType

int vtkArrayCalculator::ResultArrayType
protected

Definition at line 403 of file vtkArrayCalculator.h.


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