VTK
vtkGradientFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkGradientFilter.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 /*----------------------------------------------------------------------------
16  Copyright (c) Sandia Corporation
17  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
18 ----------------------------------------------------------------------------*/
19 
39 #ifndef vtkGradientFilter_h
40 #define vtkGradientFilter_h
41 
42 #include "vtkFiltersGeneralModule.h" // For export macro
43 #include "vtkDataSetAlgorithm.h"
44 
45 class VTKFILTERSGENERAL_EXPORT vtkGradientFilter : public vtkDataSetAlgorithm
46 {
47 public:
49  void PrintSelf(ostream &os, vtkIndent indent) VTK_OVERRIDE;
50 
52 
54 
60  virtual void SetInputScalars(int fieldAssociation, const char *name);
61  virtual void SetInputScalars(int fieldAssociation, int fieldAttributeType);
63 
65 
70  vtkGetStringMacro(ResultArrayName);
71  vtkSetStringMacro(ResultArrayName);
73 
75 
80  vtkGetStringMacro(DivergenceArrayName);
81  vtkSetStringMacro(DivergenceArrayName);
83 
85 
90  vtkGetStringMacro(VorticityArrayName);
91  vtkSetStringMacro(VorticityArrayName);
93 
95 
100  vtkGetStringMacro(QCriterionArrayName);
101  vtkSetStringMacro(QCriterionArrayName);
103 
105 
114  vtkGetMacro(FasterApproximation, int);
115  vtkSetMacro(FasterApproximation, int);
116  vtkBooleanMacro(FasterApproximation, int);
118 
120 
125  vtkSetMacro(ComputeGradient, int);
126  vtkGetMacro(ComputeGradient, int);
127  vtkBooleanMacro(ComputeGradient, int);
129 
131 
137  vtkSetMacro(ComputeDivergence, int);
138  vtkGetMacro(ComputeDivergence, int);
139  vtkBooleanMacro(ComputeDivergence, int);
141 
143 
149  vtkSetMacro(ComputeVorticity, int);
150  vtkGetMacro(ComputeVorticity, int);
151  vtkBooleanMacro(ComputeVorticity, int);
153 
155 
162  vtkSetMacro(ComputeQCriterion, int);
163  vtkGetMacro(ComputeQCriterion, int);
164  vtkBooleanMacro(ComputeQCriterion, int);
166 
167 protected:
169  ~vtkGradientFilter() VTK_OVERRIDE;
170 
171  int RequestUpdateExtent(vtkInformation *,
173  vtkInformationVector *) VTK_OVERRIDE;
174  int RequestData(vtkInformation *, vtkInformationVector **,
175  vtkInformationVector *) VTK_OVERRIDE;
176 
182  virtual int ComputeUnstructuredGridGradient(
183  vtkDataArray* Array, int fieldAssociation, vtkDataSet* input,
184  bool computeVorticity, bool computeQCriterion, bool computeDivergence,
185  vtkDataSet* output);
186 
192  virtual int ComputeRegularGridGradient(
193  vtkDataArray* Array, int fieldAssociation, bool computeVorticity,
194  bool computeQCriterion, bool computeDivergence, vtkDataSet* output);
195 
200  char *ResultArrayName;
201 
206  char *DivergenceArrayName;
207 
212  char *VorticityArrayName;
213 
218  char *QCriterionArrayName;
219 
229  int FasterApproximation;
230 
235  int ComputeGradient;
236 
242  int ComputeDivergence;
243 
249  int ComputeQCriterion;
250 
256  int ComputeVorticity;
257 
258 private:
259  vtkGradientFilter(const vtkGradientFilter &) VTK_DELETE_FUNCTION;
260  void operator=(const vtkGradientFilter &) VTK_DELETE_FUNCTION;
261 };
262 
263 #endif //_vtkGradientFilter_h
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
Superclass for algorithms that produce output of the same type as input.
abstract class to specify dataset behavior
Definition: vtkDataSet.h:63
A general filter for gradient estimation.
~vtkGradientFilter() override
virtual void SetInputScalars(int fieldAssociation, int fieldAttributeType)
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static vtkGradientFilter * New()
virtual void SetInputScalars(int fieldAssociation, const char *name)
These are basically a convenience method that calls SetInputArrayToProcess to set the array used as t...
a simple class to control print indentation
Definition: vtkIndent.h:40
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
@ name
Definition: vtkX3D.h:219
vtkSetMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkBooleanMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkGetStringMacro(ExtensionsString)
Returns a string listing all available extensions.