A general filter for gradient estimation. More...

#include <vtkGradientFilter.h>

Inheritance diagram for vtkGradientFilter:

Collaboration diagram for vtkGradientFilter:

Public Types
typedef vtkDataSetAlgorithm	Superclass

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

vtkGradientFilter *	NewInstance () const

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


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

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


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

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


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

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


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

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


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

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


virtual int	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). More...

virtual void	SetFasterApproximation (int)
	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). More...

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). More...

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). More...


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

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

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

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


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

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

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

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


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

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

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

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


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

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

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

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

Public Member Functions inherited from vtkDataSetAlgorithm
vtkDataSetAlgorithm *	NewInstance () const

vtkDataObject *	GetInput ()
	Get the input data object. More...

vtkPolyData *	GetPolyDataOutput ()
	Get the output as vtkPolyData. More...

vtkStructuredPoints *	GetStructuredPointsOutput ()
	Get the output as vtkStructuredPoints. More...

vtkImageData *	GetImageDataOutput ()
	Get the output as vtkStructuredPoints. More...

vtkStructuredGrid *	GetStructuredGridOutput ()
	Get the output as vtkStructuredGrid. More...

vtkUnstructuredGrid *	GetUnstructuredGridOutput ()
	Get the output as vtkUnstructuredGrid. More...

vtkRectilinearGrid *	GetRectilinearGridOutput ()
	Get the output as vtkRectilinearGrid. More...

int	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override
	see vtkAlgorithm for details More...

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

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

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

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

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

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

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

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

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

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

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()
	Check whether this algorithm has an assigned executive. More...

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive. More...

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive. More...

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped. More...

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request. More...

virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port. More...

vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port. More...

int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm. More...

int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm. More...

void	UpdateProgress (double amount)
	Update the progress of the process object. More...

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

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

void	RemoveAllInputs ()
	Remove all the input data. More...

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

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

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

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

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

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

virtual void	SetInputDataObject (vtkDataObject *data)

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

virtual void	AddInputDataObject (vtkDataObject *data)

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

vtkAlgorithmOutput *	GetOutputPort ()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	UpdateInformation ()
	Bring the algorithm's information up-to-date. More...

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

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream. More...

virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date. More...

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...

int	SetUpdateExtentToWholeExtent (int port)
	If the whole output extent is required, this method can be called to set the output update extent to the whole extent. More...

int	SetUpdateExtentToWholeExtent ()
	Convenience function equivalent to SetUpdateExtentToWholeExtent(0) This method assumes that the whole extent is known (that UpdateInformation has been called). More...

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
	Set the output update extent in terms of piece and ghost levels. More...

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
	Convenience function equivalent to SetUpdateExtent(0, piece, numPieces, ghostLevel) More...

void	SetUpdateExtent (int port, int extent[6])
	Set the output update extent for data objects that use 3D extents. More...

void	SetUpdateExtent (int extent[6])
	Convenience function equivalent to SetUpdateExtent(0, extent) More...

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm. More...

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm. More...

void	Register (vtkObjectBase *o) override
	Participate in garbage collection. More...

void	UnRegister (vtkObjectBase *o) override
	Participate in garbage collection. More...

virtual void	SetAbortExecute (int)
	Set/Get the AbortExecute flag for the process object. More...

virtual int	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	SetProgress (double)
	Set/Get the execution progress of a process object. More...

virtual double	GetProgress ()
	Set/Get the execution progress of a process object. More...

void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state. More...

virtual char *	GetProgressText ()
	Set the current text message associated with the progress state. More...

virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index. More...

virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index. More...

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...

virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...

virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date. More...

virtual void	Update ()
	Bring this algorithm's outputs up-to-date. More...

virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports. More...

virtual int	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports. More...

void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports. More...

void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports. More...

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...

int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents. More...

int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents. More...

int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents. More...

void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...

virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

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

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

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkGradientFilter *	SafeDownCast (vtkObjectBase *o)

static vtkGradientFilter *	New ()

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

static int	IsTypeOf (const char *type)

static vtkDataSetAlgorithm *	SafeDownCast (vtkObjectBase *o)

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

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements. More...

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

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

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

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

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

virtual int	ComputeRegularGridGradient (vtkDataArray Array, int fieldAssociation, bool computeVorticity, bool computeQCriterion, bool computeDivergence, vtkDataSet output)
	Compute the gradients for either a vtkImageData, vtkRectilinearGrid or a vtkStructuredGrid. More...

Protected Member Functions inherited from vtkDataSetAlgorithm
	vtkDataSetAlgorithm ()

	~vtkDataSetAlgorithm () override

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

virtual int	RequestDataObject (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
	This is called within ProcessRequest to when a request asks the algorithm to create empty output data objects. More...

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

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

vtkDataObject *	GetInput (int port)

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm () override

virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm. More...

virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm. More...

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive. More...

void	ReportReferences (vtkGarbageCollector *) override

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port. More...

virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port. More...

void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input. More...

void	AddInputDataInternal (int port, vtkDataObject *input)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

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

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

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

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

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

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file. More...

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

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

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

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

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

int	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). More...

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

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

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

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

Protected Attributes inherited from vtkAlgorithm
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. More...

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute

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

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

A general filter for gradient estimation.

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) as well as data type (e.g. float, double). At the boundary the gradient is not central differencing. The output array has 3*number of components of the input data array. The ordering for the output 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.

Tests:: vtkGradientFilter (Tests)

Definition at line 45 of file vtkGradientFilter.h.

Member Typedef Documentation

typedef vtkDataSetAlgorithm vtkGradientFilter::Superclass

Definition at line 48 of file vtkGradientFilter.h.

Constructor & Destructor Documentation

vtkGradientFilter::vtkGradientFilter ( )

protected

vtkGradientFilter::~vtkGradientFilter ( )

overrideprotected

Member Function Documentation

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

static

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

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

static

virtual vtkObjectBase* vtkGradientFilter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDataSetAlgorithm.

vtkGradientFilter* vtkGradientFilter::NewInstance ( ) const

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

static vtkGradientFilter* vtkGradientFilter::New ( )

static

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::FieldAssocations enum. The fieldAttributeType comes from the vtkDataSetAttributes::AttributeTypes enum.

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::FieldAssocations enum. The fieldAttributeType comes from the vtkDataSetAttributes::AttributeTypes enum.

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 NULL (the default) then the output array will be named "Gradients".

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 NULL (the default) then the output array will be named "Gradients".

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 NULL (the default) then the output array will be named "Divergence".

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 NULL (the default) then the output array will be named "Divergence".

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 NULL (the default) then the output array will be named "Vorticity".

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 NULL (the default) then the output array will be named "Vorticity".

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 NULL (the default) then the output array will be named "Q-criterion".

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 NULL (the default) then the output array will be named "Q-criterion".

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

virtual void vtkGradientFilter::SetFasterApproximation ( int )

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.

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.

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.

virtual void vtkGradientFilter::SetComputeGradient ( int )

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.

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

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.

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.

virtual void vtkGradientFilter::SetComputeDivergence ( int )

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.

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

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.

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.

virtual void vtkGradientFilter::SetComputeVorticity ( int )

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.

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

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.

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.

virtual void vtkGradientFilter::SetComputeQCriterion ( int )

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.

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

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.

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.

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 during the second pass in the pipeline execution process.

Reimplemented from vtkDataSetAlgorithm.

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 fourth pass in the pipeline execution process.

Reimplemented from vtkDataSetAlgorithm.

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.

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

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.

Member Data Documentation

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 200 of file vtkGradientFilter.h.

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 206 of file vtkGradientFilter.h.

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 212 of file vtkGradientFilter.h.

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 218 of file vtkGradientFilter.h.

int 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 229 of file vtkGradientFilter.h.

int 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 235 of file vtkGradientFilter.h.

int 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 242 of file vtkGradientFilter.h.

int 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 249 of file vtkGradientFilter.h.

int 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 256 of file vtkGradientFilter.h.

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Filters/General/vtkGradientFilter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation