A general filter for gradient estimation. More...

#include <vtkGradientFilter.h>

Inheritance diagram for vtkGradientFilter:

Collaboration diagram for vtkGradientFilter:

Public Types
enum	ContributingCellEnum { All = 0 , Patch = 1 , DataSetMax = 2 }
	Options to choose what cells contribute to the gradient calculation. More...

enum	ReplacementValueEnum { Zero = 0 , NaN = 1 , DataTypeMin = 2 , DataTypeMax = 3 }
	The replacement value or entities that don't have any gradient computed over them based on the ContributingCellOption. More...

Public Types inherited from vtkDataSetAlgorithm
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 void	SetInputScalars (int fieldAssociation, const char *name)
	These are basically a convenience method that calls SetInputArrayToProcess to set the array used as the input scalars.

virtual void	SetInputScalars (int fieldAssociation, int fieldAttributeType)
	These are basically a convenience method that calls SetInputArrayToProcess to set the array used as the input scalars.


virtual char *	GetResultArrayName ()
	Get/Set the name of the gradient array to create.

virtual void	SetResultArrayName (const char *)
	Get/Set the name of the gradient array to create.


virtual char *	GetDivergenceArrayName ()
	Get/Set the name of the divergence array to create.

virtual void	SetDivergenceArrayName (const char *)
	Get/Set the name of the divergence array to create.


virtual char *	GetVorticityArrayName ()
	Get/Set the name of the vorticity array to create.

virtual void	SetVorticityArrayName (const char *)
	Get/Set the name of the vorticity array to create.


virtual char *	GetQCriterionArrayName ()
	Get/Set the name of the Q criterion array to create.

virtual void	SetQCriterionArrayName (const char *)
	Get/Set the name of the Q criterion array to create.


virtual vtkTypeBool	GetFasterApproximation ()
	When this flag is on (default is off), the gradient filter will provide a less accurate (but close) algorithm that performs fewer derivative calculations (and is therefore faster).

virtual void	SetFasterApproximation (vtkTypeBool)
	When this flag is on (default is off), the gradient filter will provide a less accurate (but close) algorithm that performs fewer derivative calculations (and is therefore faster).

virtual void	FasterApproximationOn ()
	When this flag is on (default is off), the gradient filter will provide a less accurate (but close) algorithm that performs fewer derivative calculations (and is therefore faster).

virtual void	FasterApproximationOff ()
	When this flag is on (default is off), the gradient filter will provide a less accurate (but close) algorithm that performs fewer derivative calculations (and is therefore faster).


virtual void	SetComputeGradient (vtkTypeBool)
	Add the gradient to the output field data.

virtual vtkTypeBool	GetComputeGradient ()
	Add the gradient to the output field data.

virtual void	ComputeGradientOn ()
	Add the gradient to the output field data.

virtual void	ComputeGradientOff ()
	Add the gradient to the output field data.


virtual void	SetComputeDivergence (vtkTypeBool)
	Add divergence to the output field data.

virtual vtkTypeBool	GetComputeDivergence ()
	Add divergence to the output field data.

virtual void	ComputeDivergenceOn ()
	Add divergence to the output field data.

virtual void	ComputeDivergenceOff ()
	Add divergence to the output field data.


virtual void	SetComputeVorticity (vtkTypeBool)
	Add voriticity/curl to the output field data.

virtual vtkTypeBool	GetComputeVorticity ()
	Add voriticity/curl to the output field data.

virtual void	ComputeVorticityOn ()
	Add voriticity/curl to the output field data.

virtual void	ComputeVorticityOff ()
	Add voriticity/curl to the output field data.


virtual void	SetComputeQCriterion (vtkTypeBool)
	Add Q-criterion to the output field data.

virtual vtkTypeBool	GetComputeQCriterion ()
	Add Q-criterion to the output field data.

virtual void	ComputeQCriterionOn ()
	Add Q-criterion to the output field data.

virtual void	ComputeQCriterionOff ()
	Add Q-criterion to the output field data.


virtual void	SetContributingCellOption (int)
	Option to specify what cells to include in the gradient computation.

virtual int	GetContributingCellOption ()
	Option to specify what cells to include in the gradient computation.


virtual void	SetReplacementValueOption (int)
	Option to specify what replacement value or entities that don't have any gradient computed over them based on the ContributingCellOption.

virtual int	GetReplacementValueOption ()
	Option to specify what replacement value or entities that don't have any gradient computed over them based on the ContributingCellOption.

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

vtkDataSetAlgorithm *	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.

vtkPolyData *	GetPolyDataOutput ()
	Get the output as vtkPolyData.

vtkStructuredPoints *	GetStructuredPointsOutput ()
	Get the output as vtkStructuredPoints.

vtkImageData *	GetImageDataOutput ()
	Get the output as vtkStructuredPoints.

vtkStructuredGrid *	GetStructuredGridOutput ()
	Get the output as vtkStructuredGrid.

vtkUnstructuredGrid *	GetUnstructuredGridOutput ()
	Get the output as vtkUnstructuredGrid.

vtkRectilinearGrid *	GetRectilinearGridOutput ()
	Get the output as vtkRectilinearGrid.

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

vtkDataSet *	GetOutput ()
	Get the output data object for a port on this algorithm.

vtkDataSet *	GetOutput (int)
	Get the output data object for a port on this algorithm.

void	SetInputData (vtkDataObject *)
	Assign a data object as input.

void	SetInputData (int, vtkDataObject *)
	Assign a data object as input.

void	SetInputData (vtkDataSet *)
	Assign a data object as input.

void	SetInputData (int, vtkDataSet *)
	Assign a data object as input.

void	AddInputData (vtkDataObject *)
	Assign a data object as input.

void	AddInputData (vtkDataSet *)
	Assign a data object as input.

void	AddInputData (int, vtkDataSet *)
	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.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	String based versions of SetInputArrayToProcess().

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.

void	RemoveAllInputs ()
	Remove all the input data.

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.

vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.

virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.

virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.

virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.

vtkAlgorithmOutput *	GetOutputPort ()

int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.

int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)

vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.

virtual vtkTypeBool	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).

virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.

virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.

virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.

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

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	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 void	Update (int port)
	Bring this algorithm's outputs up-to-date.

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

Protected Member Functions
	vtkGradientFilter ()

	~vtkGradientFilter () override

int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	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.

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

virtual int	ComputeUnstructuredGridGradient (vtkDataArray Array, int fieldAssociation, vtkDataSet input, bool computeVorticity, bool computeQCriterion, bool computeDivergence, vtkDataSet *output)
	Compute the gradients for grids that are not a vtkImageData, vtkRectilinearGrid, or vtkStructuredGrid.

virtual int	ComputeRegularGridGradient (vtkDataArray Array, int dims, int fieldAssociation, bool computeVorticity, bool computeQCriterion, bool computeDivergence, vtkDataSet output, vtkUnsignedCharArray ghosts, unsigned char hiddenGhost)
	Compute the gradients for either a vtkImageData, vtkRectilinearGrid or a vtkStructuredGrid.

int	GetOutputArrayType (vtkDataArray *inputArray)
	Get the proper array type to compute requested derivative quantities for.

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

	vtkDataSetAlgorithm ()

	~vtkDataSetAlgorithm () 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	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	RequestUpdateTime (vtkInformation , vtkInformationVector , vtkInformationVector )

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

Protected Attributes
char *	ResultArrayName
	If non-null then it contains the name of the outputted gradient array.

char *	DivergenceArrayName
	If non-null then it contains the name of the outputted divergence array.

char *	VorticityArrayName
	If non-null then it contains the name of the outputted vorticity array.

char *	QCriterionArrayName
	If non-null then it contains the name of the outputted Q criterion array.

vtkTypeBool	FasterApproximation
	When this flag is on (default is off), the gradient filter will provide a less accurate (but close) algorithm that performs fewer derivative calculations (and is therefore faster).

vtkTypeBool	ComputeGradient
	Flag to indicate that the gradient of the input vector is to be computed.

vtkTypeBool	ComputeDivergence
	Flag to indicate that the divergence of the input vector is to be computed.

vtkTypeBool	ComputeQCriterion
	Flag to indicate that the Q-criterion of the input vector is to be computed.

vtkTypeBool	ComputeVorticity
	Flag to indicate that vorticity/curl of the input vector is to be computed.

int	ContributingCellOption
	Option to specify what cells to include in the gradient computation.

int	ReplacementValueOption
	Option to specify what replacement value or entities that don't have any gradient computed over them based on the ContributingCellOption.

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

typedef vtkDataSetAlgorithm	Superclass
	Standard methods for instantiation, obtaining type information, and printing.

static vtkGradientFilter *	New ()
	Standard methods for instantiation, obtaining type information, and printing.

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for instantiation, obtaining type information, and printing.

static vtkGradientFilter *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instantiation, obtaining type information, and printing.

virtual vtkTypeBool	IsA (const char *type)
	Standard methods for instantiation, obtaining type information, and printing.

vtkGradientFilter *	NewInstance () const
	Standard methods for instantiation, obtaining type information, and printing.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for instantiation, obtaining type information, and printing.

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for instantiation, obtaining type information, and printing.

Additional Inherited Members
Static Public Member Functions inherited from vtkDataSetAlgorithm
static vtkDataSetAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

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

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

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp	LastAbortTime

static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

A general filter for gradient estimation.

This filter estimates the gradient of a field in a data set. The gradient calculation is dependent on the input dataset type. The created gradient array is of the same type as the array it is calculated from (e.g. point data or cell data) but the data type will be either float or double. At the boundary the gradient does not use central differencing. The output gradient array has 3*number of components of the input data array. The ordering for the output gradient tuple will be {du/dx, du/dy, du/dz, dv/dx, dv/dy, dv/dz, dw/dx, dw/dy, dw/dz} for an input array {u, v, w}. There are also the options to additionally compute the vorticity and Q criterion of a vector field. Unstructured grids and polydata can have cells of different dimensions. To handle different use cases in this situation, the user can specify which cells contribute to the computation. The options for this are All (default), Patch and DataSetMax. Patch uses only the highest dimension cells attached to a point. DataSetMax uses the highest cell dimension in the entire data set. For Patch or DataSetMax it is possible that some values will not be computed. The ReplacementValueOption specifies what to use for these values.

Online Examples:

GradientFilter

Tests:: vtkGradientFilter (Tests)

Definition at line 62 of file vtkGradientFilter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataSetAlgorithm vtkGradientFilter::Superclass

Standard methods for instantiation, obtaining type information, and printing.

Definition at line 70 of file vtkGradientFilter.h.

Member Enumeration Documentation

◆ ContributingCellEnum

enum vtkGradientFilter::ContributingCellEnum

Options to choose what cells contribute to the gradient calculation.

Enumerator
All	All cells.
Patch	Highest dimension cells in the patch of cells contributing to the calculation.
DataSetMax	Highest dimension cells in the data set.

Definition at line 75 of file vtkGradientFilter.h.

◆ ReplacementValueEnum

enum vtkGradientFilter::ReplacementValueEnum

The replacement value or entities that don't have any gradient computed over them based on the ContributingCellOption.

Enumerator
Zero	0
NaN	NaN.
DataTypeMin	The minimum possible value of the input array data type.
DataTypeMax	The maximum possible value of the input array data type.

Definition at line 84 of file vtkGradientFilter.h.

Constructor & Destructor Documentation

◆ vtkGradientFilter()

vtkGradientFilter::vtkGradientFilter ( )

protected

◆ ~vtkGradientFilter()

vtkGradientFilter::~vtkGradientFilter ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkGradientFilter * vtkGradientFilter::New ( )

static

Standard methods for instantiation, obtaining type information, and printing.

◆ IsTypeOf()

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

static

Standard methods for instantiation, obtaining type information, and printing.

◆ IsA()

virtual vtkTypeBool vtkGradientFilter::IsA ( const char * type )

virtual

Standard methods for instantiation, obtaining type information, and printing.

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkmGradient.

◆ SafeDownCast()

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

static

Standard methods for instantiation, obtaining type information, and printing.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkGradientFilter::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for instantiation, obtaining type information, and printing.

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkmGradient.

◆ NewInstance()

vtkGradientFilter * vtkGradientFilter::NewInstance ( ) const

Standard methods for instantiation, obtaining type information, and printing.

◆ PrintSelf()

void vtkGradientFilter::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Standard methods for instantiation, obtaining type information, and printing.

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkmGradient.

◆ SetInputScalars() [1/2]

virtual void vtkGradientFilter::SetInputScalars	(	int	fieldAssociation,
		const char *	name
	)

virtual

These are basically a convenience method that calls SetInputArrayToProcess to set the array used as the input scalars.

The fieldAssociation comes from the vtkDataObject::FieldAssociations enum. The fieldAttributeType comes from the vtkDataSetAttributes::AttributeTypes enum.

◆ SetInputScalars() [2/2]

virtual void vtkGradientFilter::SetInputScalars	(	int	fieldAssociation,
		int	fieldAttributeType
	)

virtual

These are basically a convenience method that calls SetInputArrayToProcess to set the array used as the input scalars.

The fieldAssociation comes from the vtkDataObject::FieldAssociations enum. The fieldAttributeType comes from the vtkDataSetAttributes::AttributeTypes enum.

◆ GetResultArrayName()

virtual char * vtkGradientFilter::GetResultArrayName ( )

virtual

Get/Set the name of the gradient array to create.

This is only used if ComputeGradient is non-zero. If nullptr (the default) then the output array will be named "Gradients".

◆ SetResultArrayName()

virtual void vtkGradientFilter::SetResultArrayName ( const char * )

virtual

Get/Set the name of the gradient array to create.

This is only used if ComputeGradient is non-zero. If nullptr (the default) then the output array will be named "Gradients".

◆ GetDivergenceArrayName()

virtual char * vtkGradientFilter::GetDivergenceArrayName ( )

virtual

Get/Set the name of the divergence array to create.

This is only used if ComputeDivergence is non-zero. If nullptr (the default) then the output array will be named "Divergence".

◆ SetDivergenceArrayName()

virtual void vtkGradientFilter::SetDivergenceArrayName ( const char * )

virtual

Get/Set the name of the divergence array to create.

This is only used if ComputeDivergence is non-zero. If nullptr (the default) then the output array will be named "Divergence".

◆ GetVorticityArrayName()

virtual char * vtkGradientFilter::GetVorticityArrayName ( )

virtual

Get/Set the name of the vorticity array to create.

This is only used if ComputeVorticity is non-zero. If nullptr (the default) then the output array will be named "Vorticity".

◆ SetVorticityArrayName()

virtual void vtkGradientFilter::SetVorticityArrayName ( const char * )

virtual

Get/Set the name of the vorticity array to create.

This is only used if ComputeVorticity is non-zero. If nullptr (the default) then the output array will be named "Vorticity".

◆ GetQCriterionArrayName()

virtual char * vtkGradientFilter::GetQCriterionArrayName ( )

virtual

Get/Set the name of the Q criterion array to create.

This is only used if ComputeQCriterion is non-zero. If nullptr (the default) then the output array will be named "Q-criterion".

◆ SetQCriterionArrayName()

virtual void vtkGradientFilter::SetQCriterionArrayName ( const char * )

virtual

Get/Set the name of the Q criterion array to create.

This is only used if ComputeQCriterion is non-zero. If nullptr (the default) then the output array will be named "Q-criterion".

◆ GetFasterApproximation()

virtual vtkTypeBool vtkGradientFilter::GetFasterApproximation ( )

virtual

When this flag is on (default is off), the gradient filter will provide a less accurate (but close) algorithm that performs fewer derivative calculations (and is therefore faster).

The error contains some smoothing of the output data and some possible errors on the boundary. This parameter has no effect when performing the gradient of cell data. This only applies if the input grid is a vtkUnstructuredGrid or a vtkPolyData, and when point gradients are computed.

◆ SetFasterApproximation()

virtual void vtkGradientFilter::SetFasterApproximation ( vtkTypeBool )

virtual

When this flag is on (default is off), the gradient filter will provide a less accurate (but close) algorithm that performs fewer derivative calculations (and is therefore faster).

The error contains some smoothing of the output data and some possible errors on the boundary. This parameter has no effect when performing the gradient of cell data. This only applies if the input grid is a vtkUnstructuredGrid or a vtkPolyData, and when point gradients are computed.

◆ FasterApproximationOn()

virtual void vtkGradientFilter::FasterApproximationOn ( )

virtual

When this flag is on (default is off), the gradient filter will provide a less accurate (but close) algorithm that performs fewer derivative calculations (and is therefore faster).

The error contains some smoothing of the output data and some possible errors on the boundary. This parameter has no effect when performing the gradient of cell data. This only applies if the input grid is a vtkUnstructuredGrid or a vtkPolyData, and when point gradients are computed.

◆ FasterApproximationOff()

virtual void vtkGradientFilter::FasterApproximationOff ( )

virtual

When this flag is on (default is off), the gradient filter will provide a less accurate (but close) algorithm that performs fewer derivative calculations (and is therefore faster).

The error contains some smoothing of the output data and some possible errors on the boundary. This parameter has no effect when performing the gradient of cell data. This only applies if the input grid is a vtkUnstructuredGrid or a vtkPolyData, and when point gradients are computed.

◆ SetComputeGradient()

virtual void vtkGradientFilter::SetComputeGradient ( vtkTypeBool )

virtual

Add the gradient to the output field data.

The name of the array will be ResultArrayName and will be the same type as the input array. The default is on.

◆ GetComputeGradient()

virtual vtkTypeBool vtkGradientFilter::GetComputeGradient ( )

virtual

Add the gradient to the output field data.

The name of the array will be ResultArrayName and will be the same type as the input array. The default is on.

◆ ComputeGradientOn()

virtual void vtkGradientFilter::ComputeGradientOn ( )

virtual

Add the gradient to the output field data.

The name of the array will be ResultArrayName and will be the same type as the input array. The default is on.

◆ ComputeGradientOff()

virtual void vtkGradientFilter::ComputeGradientOff ( )

virtual

Add the gradient to the output field data.

The name of the array will be ResultArrayName and will be the same type as the input array. The default is on.

◆ SetComputeDivergence()

virtual void vtkGradientFilter::SetComputeDivergence ( vtkTypeBool )

virtual

Add divergence to the output field data.

The name of the array will be DivergenceArrayName and will be the same type as the input array. The input array must have 3 components in order to compute this. The default is off.

◆ GetComputeDivergence()

virtual vtkTypeBool vtkGradientFilter::GetComputeDivergence ( )

virtual

Add divergence to the output field data.

The name of the array will be DivergenceArrayName and will be the same type as the input array. The input array must have 3 components in order to compute this. The default is off.

◆ ComputeDivergenceOn()

virtual void vtkGradientFilter::ComputeDivergenceOn ( )

virtual

Add divergence to the output field data.

The name of the array will be DivergenceArrayName and will be the same type as the input array. The input array must have 3 components in order to compute this. The default is off.

◆ ComputeDivergenceOff()

virtual void vtkGradientFilter::ComputeDivergenceOff ( )

virtual

Add divergence to the output field data.

The name of the array will be DivergenceArrayName and will be the same type as the input array. The input array must have 3 components in order to compute this. The default is off.

◆ SetComputeVorticity()

virtual void vtkGradientFilter::SetComputeVorticity ( vtkTypeBool )

virtual

Add voriticity/curl to the output field data.

The name of the array will be VorticityArrayName and will be the same type as the input array. The input array must have 3 components in order to compute this. The default is off.

◆ GetComputeVorticity()

virtual vtkTypeBool vtkGradientFilter::GetComputeVorticity ( )

virtual

Add voriticity/curl to the output field data.

The name of the array will be VorticityArrayName and will be the same type as the input array. The input array must have 3 components in order to compute this. The default is off.

◆ ComputeVorticityOn()

virtual void vtkGradientFilter::ComputeVorticityOn ( )

virtual

Add voriticity/curl to the output field data.

The name of the array will be VorticityArrayName and will be the same type as the input array. The input array must have 3 components in order to compute this. The default is off.

◆ ComputeVorticityOff()

virtual void vtkGradientFilter::ComputeVorticityOff ( )

virtual

Add voriticity/curl to the output field data.

The name of the array will be VorticityArrayName and will be the same type as the input array. The input array must have 3 components in order to compute this. The default is off.

◆ SetComputeQCriterion()

virtual void vtkGradientFilter::SetComputeQCriterion ( vtkTypeBool )

virtual

Add Q-criterion to the output field data.

The name of the array will be QCriterionArrayName and will be the same type as the input array. The input array must have 3 components in order to compute this. Note that Q-citerion is a balance of the rate of vorticity and the rate of strain. The default is off.

◆ GetComputeQCriterion()

virtual vtkTypeBool vtkGradientFilter::GetComputeQCriterion ( )

virtual

Add Q-criterion to the output field data.

The name of the array will be QCriterionArrayName and will be the same type as the input array. The input array must have 3 components in order to compute this. Note that Q-citerion is a balance of the rate of vorticity and the rate of strain. The default is off.

◆ ComputeQCriterionOn()

virtual void vtkGradientFilter::ComputeQCriterionOn ( )

virtual

Add Q-criterion to the output field data.

The name of the array will be QCriterionArrayName and will be the same type as the input array. The input array must have 3 components in order to compute this. Note that Q-citerion is a balance of the rate of vorticity and the rate of strain. The default is off.

◆ ComputeQCriterionOff()

virtual void vtkGradientFilter::ComputeQCriterionOff ( )

virtual

Add Q-criterion to the output field data.

The name of the array will be QCriterionArrayName and will be the same type as the input array. The input array must have 3 components in order to compute this. Note that Q-citerion is a balance of the rate of vorticity and the rate of strain. The default is off.

◆ SetContributingCellOption()

virtual void vtkGradientFilter::SetContributingCellOption ( int )

virtual

Option to specify what cells to include in the gradient computation.

Options are all cells (All, Patch and DataSetMax). The default is All.

◆ GetContributingCellOption()

virtual int vtkGradientFilter::GetContributingCellOption ( )

virtual

Option to specify what cells to include in the gradient computation.

Options are all cells (All, Patch and DataSetMax). The default is All.

◆ SetReplacementValueOption()

virtual void vtkGradientFilter::SetReplacementValueOption ( int )

virtual

Option to specify what replacement value or entities that don't have any gradient computed over them based on the ContributingCellOption.

Options are (Zero, NaN, DataTypeMin, DataTypeMax). The default is Zero.

◆ GetReplacementValueOption()

virtual int vtkGradientFilter::GetReplacementValueOption ( )

virtual

Option to specify what replacement value or entities that don't have any gradient computed over them based on the ContributingCellOption.

Options are (Zero, NaN, DataTypeMin, DataTypeMax). The default is Zero.

◆ RequestUpdateExtent()

int vtkGradientFilter::RequestUpdateExtent	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

overrideprotectedvirtual

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.

This happens after the RequestInformation pass of the pipeline execution process.

Reimplemented from vtkDataSetAlgorithm.

◆ RequestData()

int vtkGradientFilter::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 vtkDataSetAlgorithm.

Reimplemented in vtkmGradient.

◆ ComputeUnstructuredGridGradient()

virtual int vtkGradientFilter::ComputeUnstructuredGridGradient	(	vtkDataArray *	Array,
		int	fieldAssociation,
		vtkDataSet *	input,
		bool	computeVorticity,
		bool	computeQCriterion,
		bool	computeDivergence,
		vtkDataSet *	output
	)

protectedvirtual

Compute the gradients for grids that are not a vtkImageData, vtkRectilinearGrid, or vtkStructuredGrid.

Returns non-zero if the operation was successful.

◆ ComputeRegularGridGradient()

virtual int vtkGradientFilter::ComputeRegularGridGradient	(	vtkDataArray *	Array,
		int *	dims,
		int	fieldAssociation,
		bool	computeVorticity,
		bool	computeQCriterion,
		bool	computeDivergence,
		vtkDataSet *	output,
		vtkUnsignedCharArray *	ghosts,
		unsigned char	hiddenGhost
	)

protectedvirtual

Compute the gradients for either a vtkImageData, vtkRectilinearGrid or a vtkStructuredGrid.

Computes the gradient using finite differences. Returns non-zero if the operation was successful.

◆ GetOutputArrayType()

int vtkGradientFilter::GetOutputArrayType ( vtkDataArray * inputArray )

protected

Get the proper array type to compute requested derivative quantities for.

If the input array is an unsigned type then we switch to a float array for the output but otherwise the output array type is the same as the input array type.

Member Data Documentation

◆ ResultArrayName

char* vtkGradientFilter::ResultArrayName

protected

If non-null then it contains the name of the outputted gradient array.

By derault it is "Gradients".

Definition at line 262 of file vtkGradientFilter.h.

◆ DivergenceArrayName

char* vtkGradientFilter::DivergenceArrayName

protected

If non-null then it contains the name of the outputted divergence array.

By derault it is "Divergence".

Definition at line 268 of file vtkGradientFilter.h.

◆ VorticityArrayName

char* vtkGradientFilter::VorticityArrayName

protected

If non-null then it contains the name of the outputted vorticity array.

By derault it is "Vorticity".

Definition at line 274 of file vtkGradientFilter.h.

◆ QCriterionArrayName

char* vtkGradientFilter::QCriterionArrayName

protected

If non-null then it contains the name of the outputted Q criterion array.

By derault it is "Q-criterion".

Definition at line 280 of file vtkGradientFilter.h.

◆ FasterApproximation

vtkTypeBool vtkGradientFilter::FasterApproximation

protected

When this flag is on (default is off), the gradient filter will provide a less accurate (but close) algorithm that performs fewer derivative calculations (and is therefore faster).

The error contains some smoothing of the output data and some possible errors on the boundary. This parameter has no effect when performing the gradient of cell data. This only applies if the input grid is a vtkUnstructuredGrid or a vtkPolyData.

Definition at line 291 of file vtkGradientFilter.h.

◆ ComputeGradient

vtkTypeBool vtkGradientFilter::ComputeGradient

protected

Flag to indicate that the gradient of the input vector is to be computed.

By default ComputeDivergence is on.

Definition at line 297 of file vtkGradientFilter.h.

◆ ComputeDivergence

vtkTypeBool vtkGradientFilter::ComputeDivergence

protected

Flag to indicate that the divergence of the input vector is to be computed.

The input array to be processed must have 3 components. By default ComputeDivergence is off.

Definition at line 304 of file vtkGradientFilter.h.

◆ ComputeQCriterion

vtkTypeBool vtkGradientFilter::ComputeQCriterion

protected

Flag to indicate that the Q-criterion of the input vector is to be computed.

The input array to be processed must have 3 components. By default ComputeQCriterion is off.

Definition at line 311 of file vtkGradientFilter.h.

◆ ComputeVorticity

vtkTypeBool vtkGradientFilter::ComputeVorticity

protected

Flag to indicate that vorticity/curl of the input vector is to be computed.

The input array to be processed must have 3 components. By default ComputeVorticity is off.

Definition at line 318 of file vtkGradientFilter.h.

◆ ContributingCellOption

int vtkGradientFilter::ContributingCellOption

protected

Option to specify what cells to include in the gradient computation.

Options are all cells (All, Patch and DataSet). The default is all.

Definition at line 324 of file vtkGradientFilter.h.

◆ ReplacementValueOption

int vtkGradientFilter::ReplacementValueOption

protected

Option to specify what replacement value or entities that don't have any gradient computed over them based on the ContributingCellOption.

Options are (Zero, NaN, DataTypeMin, DataTypeMax). The default is Zero.

Definition at line 331 of file vtkGradientFilter.h.

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

Filters/General/vtkGradientFilter.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ ContributingCellEnum

◆ ReplacementValueEnum

Constructor & Destructor Documentation

◆ vtkGradientFilter()

◆ ~vtkGradientFilter()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetInputScalars() [1/2]

◆ SetInputScalars() [2/2]

◆ GetResultArrayName()

◆ SetResultArrayName()

◆ GetDivergenceArrayName()

◆ SetDivergenceArrayName()

◆ GetVorticityArrayName()

◆ SetVorticityArrayName()

◆ GetQCriterionArrayName()

◆ SetQCriterionArrayName()

◆ GetFasterApproximation()

◆ SetFasterApproximation()

◆ FasterApproximationOn()

◆ FasterApproximationOff()

◆ SetComputeGradient()

◆ GetComputeGradient()

◆ ComputeGradientOn()

◆ ComputeGradientOff()

◆ SetComputeDivergence()

◆ GetComputeDivergence()

◆ ComputeDivergenceOn()

◆ ComputeDivergenceOff()

◆ SetComputeVorticity()

◆ GetComputeVorticity()

◆ ComputeVorticityOn()

◆ ComputeVorticityOff()

◆ SetComputeQCriterion()

◆ GetComputeQCriterion()

◆ ComputeQCriterionOn()

◆ ComputeQCriterionOff()

◆ SetContributingCellOption()

◆ GetContributingCellOption()

◆ SetReplacementValueOption()

◆ GetReplacementValueOption()

◆ RequestUpdateExtent()

◆ RequestData()

◆ ComputeUnstructuredGridGradient()

◆ ComputeRegularGridGradient()

◆ GetOutputArrayType()

Member Data Documentation

◆ ResultArrayName

◆ DivergenceArrayName

◆ VorticityArrayName

◆ QCriterionArrayName

◆ FasterApproximation

◆ ComputeGradient

◆ ComputeDivergence

◆ ComputeQCriterion

◆ ComputeVorticity

◆ ContributingCellOption

◆ ReplacementValueOption