|
VTK
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
|
VTK
|
A general filter for gradient estimation. More...
#include <vtkGradientFilter.h>
Public Types | |
| typedef vtkDataSetAlgorithm | Superclass |
 Public Types inherited from vtkDataSetAlgorithm | |
| typedef vtkAlgorithm | Superclass |
| Public Types inherited from vtkAlgorithm | |
| typedef vtkObject | Superclass |
| enum | DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION } |
Public Member Functions | |
| virtual int | IsA (const char *type) |
| vtkGradientFilter * | NewInstance () const |
| 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 *) |
| virtual char * | GetVorticityArrayName () |
| virtual void | SetVorticityArrayName (const char *) |
| virtual char * | GetQCriterionArrayName () |
| virtual void | SetQCriterionArrayName (const char *) |
| virtual int | GetFasterApproximation () |
| virtual void | SetFasterApproximation (int) |
| virtual void | FasterApproximationOn () |
| virtual void | FasterApproximationOff () |
| virtual void | SetComputeVorticity (int) |
| virtual int | GetComputeVorticity () |
| virtual void | ComputeVorticityOn () |
| virtual void | ComputeVorticityOff () |
| virtual void | SetComputeQCriterion (int) |
| virtual int | GetComputeQCriterion () |
| virtual void | ComputeQCriterionOn () |
| virtual void | ComputeQCriterionOff () |
| Public Member Functions inherited from vtkDataSetAlgorithm | |
| vtkDataSetAlgorithm * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| vtkDataObject * | GetInput () |
| vtkPolyData * | GetPolyDataOutput () |
| vtkStructuredPoints * | GetStructuredPointsOutput () |
| vtkImageData * | GetImageDataOutput () |
| vtkStructuredGrid * | GetStructuredGridOutput () |
| vtkUnstructuredGrid * | GetUnstructuredGridOutput () |
| vtkRectilinearGrid * | GetRectilinearGridOutput () |
| vtkDataSet * | GetOutput () |
| vtkDataSet * | GetOutput (int) |
| void | SetInputData (vtkDataObject *) |
| void | SetInputData (int, vtkDataObject *) |
| void | SetInputData (vtkDataSet *) |
| void | SetInputData (int, vtkDataSet *) |
| void | AddInputData (vtkDataObject *) |
| void | AddInputData (vtkDataSet *) |
| void | AddInputData (int, vtkDataSet *) |
| void | AddInputData (int, vtkDataObject *) |
| virtual int | ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) |
| Public Member Functions inherited from vtkAlgorithm | |
| vtkAlgorithm * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| int | HasExecutive () |
| vtkExecutive * | GetExecutive () |
| virtual void | SetExecutive (vtkExecutive *executive) |
| virtual int | ModifyRequest (vtkInformation *request, int when) |
| vtkInformation * | GetInputPortInformation (int port) |
| vtkInformation * | GetOutputPortInformation (int port) |
| int | GetNumberOfInputPorts () |
| int | GetNumberOfOutputPorts () |
| void | UpdateProgress (double amount) |
| vtkInformation * | GetInputArrayInformation (int idx) |
| void | RemoveAllInputs () |
| vtkDataObject * | GetOutputDataObject (int port) |
| virtual void | RemoveInputConnection (int port, vtkAlgorithmOutput *input) |
| virtual void | RemoveInputConnection (int port, int idx) |
| virtual void | RemoveAllInputConnections (int port) |
| int | GetNumberOfInputConnections (int port) |
| int | GetTotalNumberOfInputConnections () |
| vtkAlgorithmOutput * | GetInputConnection (int port, int index) |
| vtkAlgorithm * | GetInputAlgorithm (int port, int index, int &algPort) |
| vtkAlgorithm * | GetInputAlgorithm (int port, int index) |
| vtkExecutive * | GetInputExecutive (int port, int index) |
| vtkInformation * | GetInputInformation (int port, int index) |
| vtkInformation * | GetOutputInformation (int port) |
| virtual void | UpdateInformation () |
| virtual void | PropagateUpdateExtent () |
| virtual void | UpdateWholeExtent () |
| void | ConvertTotalInputToPortConnection (int ind, int &port, int &conn) |
| virtual double | ComputePriority () |
| int | SetUpdateExtentToWholeExtent (int port) |
| int | SetUpdateExtentToWholeExtent () |
| void | SetUpdateExtent (int port, int extent[6]) |
| int | ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo) |
| virtual int | ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime) |
| virtual vtkInformation * | GetInformation () |
| virtual void | SetInformation (vtkInformation *) |
| virtual void | Register (vtkObjectBase *o) |
| virtual void | UnRegister (vtkObjectBase *o) |
| virtual void | SetAbortExecute (int) |
| virtual int | GetAbortExecute () |
| virtual void | AbortExecuteOn () |
| virtual void | AbortExecuteOff () |
| virtual void | SetProgress (double) |
| virtual double | GetProgress () |
| void | SetProgressText (const char *ptext) |
| virtual char * | GetProgressText () |
| virtual unsigned long | GetErrorCode () |
| virtual void | SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name) |
| virtual void | SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType) |
| virtual void | SetInputArrayToProcess (int idx, vtkInformation *info) |
| virtual void | SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName) |
| vtkDataObject * | GetInputDataObject (int port, int connection) |
| virtual void | SetInputConnection (int port, vtkAlgorithmOutput *input) |
| virtual void | SetInputConnection (vtkAlgorithmOutput *input) |
| virtual void | AddInputConnection (int port, vtkAlgorithmOutput *input) |
| virtual void | AddInputConnection (vtkAlgorithmOutput *input) |
| virtual void | SetInputDataObject (int port, vtkDataObject *data) |
| virtual void | SetInputDataObject (vtkDataObject *data) |
| virtual void | AddInputDataObject (int port, vtkDataObject *data) |
| virtual void | AddInputDataObject (vtkDataObject *data) |
| vtkAlgorithmOutput * | GetOutputPort (int index) |
| vtkAlgorithmOutput * | GetOutputPort () |
| vtkAlgorithm * | GetInputAlgorithm () |
| vtkExecutive * | GetInputExecutive () |
| vtkInformation * | GetInputInformation () |
| virtual void | Update (int port) |
| virtual void | Update () |
| virtual void | SetReleaseDataFlag (int) |
| virtual int | GetReleaseDataFlag () |
| void | ReleaseDataFlagOn () |
| void | ReleaseDataFlagOff () |
| int | UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output) |
| int | UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType) |
| void | SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel) |
| void | SetUpdateExtent (int piece, int numPieces, int ghostLevel) |
| void | SetUpdateExtent (int extent[6]) |
| int * | GetUpdateExtent () |
| int * | GetUpdateExtent (int port) |
| void | GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1) |
| void | GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1) |
| void | GetUpdateExtent (int extent[6]) |
| void | GetUpdateExtent (int port, int extent[6]) |
| int | GetUpdatePiece () |
| int | GetUpdatePiece (int port) |
| int | GetUpdateNumberOfPieces () |
| int | GetUpdateNumberOfPieces (int port) |
| int | GetUpdateGhostLevel () |
| int | GetUpdateGhostLevel (int port) |
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 void | SetDefaultExecutivePrototype (vtkExecutive *proto) |
| static vtkInformationIntegerKey * | INPUT_IS_OPTIONAL () |
| 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 * | PRESERVES_DATASET () |
| static vtkInformationIntegerKey * | PRESERVES_GEOMETRY () |
| static vtkInformationIntegerKey * | PRESERVES_BOUNDS () |
| static vtkInformationIntegerKey * | PRESERVES_TOPOLOGY () |
| static vtkInformationIntegerKey * | PRESERVES_ATTRIBUTES () |
| static vtkInformationIntegerKey * | PRESERVES_RANGES () |
| static vtkInformationIntegerKey * | MANAGES_METAINFORMATION () |
Protected Member Functions | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| vtkGradientFilter () | |
| ~vtkGradientFilter () | |
| virtual int | RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *) |
| virtual int | RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) |
| virtual int | ComputeUnstructuredGridGradient (vtkDataArray *Array, int fieldAssociation, vtkDataSet *input, bool computeVorticity, bool computeQCriterion, vtkDataSet *output) |
| virtual int | ComputeRegularGridGradient (vtkDataArray *Array, int fieldAssociation, bool computeVorticity, bool computeQCriterion, vtkDataSet *output) |
| Protected Member Functions inherited from vtkDataSetAlgorithm | |
| vtkDataSetAlgorithm () | |
| ~vtkDataSetAlgorithm () | |
| virtual int | FillOutputPortInformation (int port, vtkInformation *info) |
| virtual int | FillInputPortInformation (int port, vtkInformation *info) |
| vtkDataObject * | GetInput (int port) |
| virtual int | RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) |
| virtual int | RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) |
| Protected Member Functions inherited from vtkAlgorithm | |
| vtkAlgorithm () | |
| ~vtkAlgorithm () | |
| virtual void | SetNumberOfInputPorts (int n) |
| virtual void | SetNumberOfOutputPorts (int n) |
| int | InputPortIndexInRange (int index, const char *action) |
| int | OutputPortIndexInRange (int index, const char *action) |
| int | GetInputArrayAssociation (int idx, vtkInformationVector **inputVector) |
| virtual vtkExecutive * | CreateDefaultExecutive () |
| virtual void | ReportReferences (vtkGarbageCollector *) |
| virtual void | SetNumberOfInputConnections (int port, int n) |
| int | GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector) |
| int | GetInputArrayAssociation (int idx, vtkDataObject *input) |
| vtkDataArray * | GetInputArrayToProcess (int idx, vtkInformationVector **inputVector) |
| vtkDataArray * | GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association) |
| vtkDataArray * | GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector) |
| vtkDataArray * | GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association) |
| vtkDataArray * | GetInputArrayToProcess (int idx, vtkDataObject *input) |
| vtkDataArray * | GetInputArrayToProcess (int idx, vtkDataObject *input, int &association) |
| vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector) |
| vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association) |
| vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector) |
| vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association) |
| vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkDataObject *input) |
| vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association) |
| vtkInformation * | GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector) |
| virtual void | SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input) |
| void | SetInputDataInternal (int port, vtkDataObject *input) |
| void | AddInputDataInternal (int port, vtkDataObject *input) |
| virtual void | SetErrorCode (unsigned long) |
Protected Attributes | |
| char * | ResultArrayName |
| char * | VorticityArrayName |
| char * | QCriterionArrayName |
| int | FasterApproximation |
| int | ComputeQCriterion |
| int | ComputeVorticity |
| Protected Attributes inherited from vtkAlgorithm | |
| vtkInformation * | Information |
| double | Progress |
| char * | ProgressText |
| unsigned long | ErrorCode |
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 |
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.
Definition at line 44 of file vtkGradientFilter.h.
Definition at line 47 of file vtkGradientFilter.h.
|
protected |
|
protected |
|
static |
|
virtual |
Reimplemented from vtkDataSetAlgorithm.
|
static |
|
protectedvirtual |
Reimplemented from vtkDataSetAlgorithm.
| vtkGradientFilter* vtkGradientFilter::NewInstance | ( | ) | const |
|
virtual |
|
static |
|
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 |
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 |
Get/Set the name of the gradient array to create. If NULL (the default) then the output array will be named "Gradients".
|
virtual |
Get/Set the name of the gradient array to create. If NULL (the default) then the output array will be named "Gradients".
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Set the resultant array to be vorticity/curl of the input array. The input array must have 3 components.
|
virtual |
Set the resultant array to be vorticity/curl of the input array. The input array must have 3 components.
|
virtual |
Set the resultant array to be vorticity/curl of the input array. The input array must have 3 components.
|
virtual |
Set the resultant array to be vorticity/curl of the input array. The input array must have 3 components.
|
virtual |
Add Q-criterion to the output field data. The name of the array will be "Q-Criterion" 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.
|
virtual |
Add Q-criterion to the output field data. The name of the array will be "Q-Criterion" 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.
|
virtual |
Add Q-criterion to the output field data. The name of the array will be "Q-Criterion" 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.
|
virtual |
Add Q-criterion to the output field data. The name of the array will be "Q-Criterion" 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.
|
protectedvirtual |
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.
|
protectedvirtual |
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.
|
protectedvirtual |
Compute the gradients for grids that are not a vtkImageData, vtkRectilinearGrid, or vtkStructuredGrid. Returns non-zero if the operation was successful.
|
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.
|
protected |
If non-null then it contains the name of the outputted gradient array. By derault it is "Gradients".
Definition at line 147 of file vtkGradientFilter.h.
|
protected |
If non-null then it contains the name of the outputted vorticity array. By derault it is "Vorticity".
Definition at line 151 of file vtkGradientFilter.h.
|
protected |
If non-null then it contains the name of the outputted Q criterion array. By derault it is "Q-criterion".
Definition at line 155 of file vtkGradientFilter.h.
|
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 164 of file vtkGradientFilter.h.
|
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 169 of file vtkGradientFilter.h.
|
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 174 of file vtkGradientFilter.h.
1.8.6