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

#include <vtkArrayCalculator.h>

Inheritance diagram for vtkArrayCalculator:

Collaboration diagram for vtkArrayCalculator:

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.

vtkArrayCalculator *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

const char *	GetAttributeTypeAsString ()
	Returns a string representation of the calculator's AttributeType.

void	RemoveAllVariables ()
	Remove all the variable names and their associated array names.

virtual void	RemoveScalarVariables ()
	Remove all the scalar variable names and their associated array names.

virtual void	RemoveVectorVariables ()
	Remove all the scalar variable names and their associated array names.

virtual void	RemoveCoordinateScalarVariables ()
	Remove all the coordinate variables.

virtual void	RemoveCoordinateVectorVariables ()
	Remove all the coordinate variables.

vtkDataSet *	GetDataSetOutput ()
	Returns the output of the filter downcast to a vtkDataSet or nullptr if the cast fails.


virtual void	SetFunction (const char *)
	Set/Get the function to be evaluated.

virtual char *	GetFunction ()
	Set/Get the function to be evaluated.


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.

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.


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.

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.


void	AddCoordinateScalarVariable (const char *variableName, int component=0)
	Add a variable name, a corresponding array name, and which components of the array to use.

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.


virtual void	SetResultArrayName (const char *)
	Set the name of the array in which to store the result of evaluating this function.

virtual char *	GetResultArrayName ()
	Set the name of the array in which to store the result of evaluating this function.


virtual int	GetResultArrayType ()
	Type of the result array.

virtual void	SetResultArrayType (int)
	Type of the result array.


virtual vtkTypeBool	GetCoordinateResults ()
	Set whether to output results as coordinates.

virtual void	SetCoordinateResults (vtkTypeBool)
	Set whether to output results as coordinates.

virtual void	CoordinateResultsOn ()
	Set whether to output results as coordinates.

virtual void	CoordinateResultsOff ()
	Set whether to output results as coordinates.


virtual bool	GetResultNormals ()
	Set whether to output results as point/cell normals.

virtual void	SetResultNormals (bool)
	Set whether to output results as point/cell normals.

virtual void	ResultNormalsOn ()
	Set whether to output results as point/cell normals.

virtual void	ResultNormalsOff ()
	Set whether to output results as point/cell normals.


virtual bool	GetResultTCoords ()
	Set whether to output results as point/cell texture coordinates.

virtual void	SetResultTCoords (bool)
	Set whether to output results as point/cell texture coordinates.

virtual void	ResultTCoordsOn ()
	Set whether to output results as point/cell texture coordinates.

virtual void	ResultTCoordsOff ()
	Set whether to output results as point/cell texture coordinates.


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

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

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

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

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

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

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

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


const std::vector< std::string > &	GetScalarArrayNames ()
	Methods to get information about the current variables.

std::string	GetScalarArrayName (int i)
	Methods to get information about the current variables.

const std::vector< std::string > &	GetVectorArrayNames ()
	Methods to get information about the current variables.

std::string	GetVectorArrayName (int i)
	Methods to get information about the current variables.

const std::vector< std::string > &	GetScalarVariableNames ()
	Methods to get information about the current variables.

std::string	GetScalarVariableName (int i)
	Methods to get information about the current variables.

const std::vector< std::string > &	GetVectorVariableNames ()
	Methods to get information about the current variables.

std::string	GetVectorVariableName (int i)
	Methods to get information about the current variables.

const std::vector< int > &	GetSelectedScalarComponents ()
	Methods to get information about the current variables.

int	GetSelectedScalarComponent (int i)
	Methods to get information about the current variables.

const std::vector< vtkTuple< int, 3 > > &	GetSelectedVectorComponents ()
	Methods to get information about the current variables.

vtkTuple< int, 3 >	GetSelectedVectorComponents (int i)
	Methods to get information about the current variables.

int	GetNumberOfScalarArrays ()
	Methods to get information about the current variables.

int	GetNumberOfVectorArrays ()
	Methods to get information about the current variables.


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.

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.

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.

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.

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.

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.


virtual void	SetIgnoreMissingArrays (bool)
	When this option is set, silently ignore datasets where the requested field data array is not present.

virtual bool	GetIgnoreMissingArrays ()
	When this option is set, silently ignore datasets where the requested field data array is not present.

virtual void	IgnoreMissingArraysOn ()
	When this option is set, silently ignore datasets where the requested field data array is not present.

virtual void	IgnoreMissingArraysOff ()
	When this option is set, silently ignore datasets where the requested field data array is not present.


	vtkSetEnumMacro (FunctionParserType, FunctionParserTypes)
	Set/Get the FunctionParser type that will be used.

void	SetFunctionParserTypeToFunctionParser ()
	Set/Get the FunctionParser type that will be used.

void	SetFunctionParserTypeToExprTkFunctionParser ()
	Set/Get the FunctionParser type that will be used.

	vtkGetEnumMacro (FunctionParserType, FunctionParserTypes)
	Set/Get the FunctionParser type that will be used.

Public Member Functions inherited from vtkPassInputTypeAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkPassInputTypeAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

vtkDataObject *	GetInput ()
	Get the input data object.

vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override
	see vtkAlgorithm for details

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.

vtkPolyData *	GetPolyDataOutput ()
	Get the output as a concrete type.

vtkStructuredPoints *	GetStructuredPointsOutput ()
	Get the output as a concrete type.

vtkImageData *	GetImageDataOutput ()
	Get the output as a concrete type.

vtkStructuredGrid *	GetStructuredGridOutput ()
	Get the output as a concrete type.

vtkUnstructuredGrid *	GetUnstructuredGridOutput ()
	Get the output as a concrete type.

vtkRectilinearGrid *	GetRectilinearGridOutput ()
	Get the output as a concrete type.

vtkGraph *	GetGraphOutput ()
	Get the output as a concrete type.

vtkMolecule *	GetMoleculeOutput ()
	Get the output as a concrete type.

vtkTable *	GetTableOutput ()
	Get the output as a concrete type.

vtkHyperTreeGrid *	GetHyperTreeGridOutput ()
	Get the output as a concrete type.

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
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAlgorithm *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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.

virtual vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.

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 ()
	Checks to see if this filter should abort.

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 VTK_UNBLOCKTHREADS int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.

virtual VTK_UNBLOCKTHREADS 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 VTK_UNBLOCKTHREADS void	UpdateInformation ()
	Bring the algorithm's information up-to-date.

virtual void	UpdateDataObject ()
	Create output object(s).

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.

virtual VTK_UNBLOCKTHREADS void	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.

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)
	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, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	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)
	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 VTK_UNBLOCKTHREADS void	Update (int port)
	Bring this algorithm's outputs up-to-date.

virtual VTK_UNBLOCKTHREADS void	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 void	Modified ()
	Update the modification time for this object.

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 std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

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 vtkTypeBool	IsTypeOf (const char *type)

static vtkArrayCalculator *	SafeDownCast (vtkObjectBase *o)

static vtkArrayCalculator *	New ()

Static Public Member Functions inherited from vtkPassInputTypeAlgorithm
static vtkPassInputTypeAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkPassInputTypeAlgorithm *	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.

Static Public Attributes
static const int	DEFAULT_ATTRIBUTE_TYPE = -1

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkArrayCalculator ()

	~vtkArrayCalculator () override

int	FillInputPortInformation (int, vtkInformation *) override
	Fill the input port information objects for this algorithm.

int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	This is called within ProcessRequest when a request asks the algorithm to do its work.

int	GetAttributeTypeFromInput (vtkDataObject *input)
	Get the attribute type for the input.

Protected Member Functions inherited from vtkPassInputTypeAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const

	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.

virtual int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called within ProcessRequest when a request asks for Information.

virtual int	RequestUpdateTime (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called within ProcessRequest when a request ask for temporal information to be updated.

virtual int	RequestUpdateTimeDependentInformation (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called within ProcessRequest when a request ask for meta information to be updated.

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.

virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called within ProcessRequest when a request asks the algorithm to do its work.

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.

vtkDataObject *	GetInput (int port)

Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAlgorithm ()

	~vtkAlgorithm () override

bool	CheckUpstreamAbort ()
	Checks to see if an upstream filter has been aborted.

virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm.

virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm.

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.

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.

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 ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	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.

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 ()

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

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

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBool >	AbortExecute

Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp	LastAbortTime

static vtkExecutive *	DefaultExecutivePrototype

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:

/ ^ . (only by vtkFunctionParser) build unit vectors: iHat, jHat, kHat (ie (1,0,0), (0,1,0), (0,0,1)) abs acos asin atan ceil cos cosh exp floor ln mag min max norm dot (only by vtkExprTkFunctionParser) cross sign sin sinh sqrt tan tanh

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:

ArrayCalculator

ExtractArrayComponent

Tests:: vtkArrayCalculator (Tests)

Definition at line 104 of file vtkArrayCalculator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPassInputTypeAlgorithm vtkArrayCalculator::Superclass

Definition at line 107 of file vtkArrayCalculator.h.

Member Enumeration Documentation

◆ FunctionParserTypes

enum vtkArrayCalculator::FunctionParserTypes

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

Enumerator
FunctionParser
ExprTkFunctionParser
NumberOfFunctionParserTypes

Definition at line 313 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 vtkAlgorithm.

◆ 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 229 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 230 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 231 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 232 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 233 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 234 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.