vtkGradientFilter Class Reference
#include <vtkGradientFilter.h>
Detailed Description
A general filter for gradient estimation.Estimates the gradient of a scalar field in a data set. This class is basically designed for unstructured data sets (i.e. vtkUnstructuredGrid). More efficient filters exist for vtkImageData.
Definition at line 39 of file vtkGradientFilter.h.
Public Types | |
| typedef vtkDataSetAlgorithm | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| virtual void | PrintSelf (ostream &os, vtkIndent indent) |
| virtual void | SetInputScalars (int fieldAssociation, const char *name) |
| virtual void | SetInputScalars (int fieldAssociation, int fieldAttributeType) |
| virtual char * | GetResultArrayName () |
| virtual void | SetResultArrayName (const char *) |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkGradientFilter * | SafeDownCast (vtkObject *o) |
| static vtkGradientFilter * | New () |
Protected Member Functions | |
| vtkGradientFilter () | |
| ~vtkGradientFilter () | |
| virtual int | RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *) |
| virtual int | RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) |
Protected Attributes | |
| char * | ResultArrayName |
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkGradientFilter::vtkGradientFilter | ( | ) | [protected] |
| vtkGradientFilter::~vtkGradientFilter | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkGradientFilter::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkDataSetAlgorithm.
| static int vtkGradientFilter::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkDataSetAlgorithm.
| 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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkDataSetAlgorithm.
| static vtkGradientFilter* vtkGradientFilter::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkDataSetAlgorithm.
| virtual void vtkGradientFilter::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
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] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkDataSetAlgorithm.
| 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 resulting array to create. 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 resulting array to create. If NULL (the default) then the output array will be named "Gradients".
| virtual int vtkGradientFilter::RequestUpdateExtent | ( | vtkInformation * | , | |
| vtkInformationVector ** | , | |||
| vtkInformationVector * | ||||
| ) | [protected, virtual] |
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.
| virtual int vtkGradientFilter::RequestData | ( | vtkInformation * | , | |
| vtkInformationVector ** | , | |||
| vtkInformationVector * | ||||
| ) | [protected, virtual] |
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.
Member Data Documentation
char* vtkGradientFilter::ResultArrayName [protected] |
Definition at line 74 of file vtkGradientFilter.h.
The documentation for this class was generated from the following file:
- dox/Graphics/vtkGradientFilter.h
