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 
36 #ifndef vtkGradientFilter_h
37 #define vtkGradientFilter_h
38 
39 #include "vtkFiltersGeneralModule.h" // For export macro
40 #include "vtkDataSetAlgorithm.h"
41 
42 class VTKFILTERSGENERAL_EXPORT vtkGradientFilter : public vtkDataSetAlgorithm
43 {
44 public:
46  void PrintSelf(ostream &os, vtkIndent indent) VTK_OVERRIDE;
47 
48  static vtkGradientFilter *New();
49 
51 
57  virtual void SetInputScalars(int fieldAssociation, const char *name);
58  virtual void SetInputScalars(int fieldAssociation, int fieldAttributeType);
60 
62 
67  vtkGetStringMacro(ResultArrayName);
68  vtkSetStringMacro(ResultArrayName);
70 
72 
77  vtkGetStringMacro(DivergenceArrayName);
78  vtkSetStringMacro(DivergenceArrayName);
80 
82 
87  vtkGetStringMacro(VorticityArrayName);
88  vtkSetStringMacro(VorticityArrayName);
90 
92 
97  vtkGetStringMacro(QCriterionArrayName);
98  vtkSetStringMacro(QCriterionArrayName);
100 
102 
111  vtkGetMacro(FasterApproximation, int);
112  vtkSetMacro(FasterApproximation, int);
113  vtkBooleanMacro(FasterApproximation, int);
115 
117 
122  vtkSetMacro(ComputeGradient, int);
123  vtkGetMacro(ComputeGradient, int);
124  vtkBooleanMacro(ComputeGradient, int);
126 
128 
134  vtkSetMacro(ComputeDivergence, int);
135  vtkGetMacro(ComputeDivergence, int);
136  vtkBooleanMacro(ComputeDivergence, int);
138 
140 
146  vtkSetMacro(ComputeVorticity, int);
147  vtkGetMacro(ComputeVorticity, int);
148  vtkBooleanMacro(ComputeVorticity, int);
150 
152 
159  vtkSetMacro(ComputeQCriterion, int);
160  vtkGetMacro(ComputeQCriterion, int);
161  vtkBooleanMacro(ComputeQCriterion, int);
163 
164 protected:
166  ~vtkGradientFilter() VTK_OVERRIDE;
167 
168  int RequestUpdateExtent(vtkInformation *,
170  vtkInformationVector *) VTK_OVERRIDE;
171  int RequestData(vtkInformation *, vtkInformationVector **,
172  vtkInformationVector *) VTK_OVERRIDE;
173 
179  virtual int ComputeUnstructuredGridGradient(
180  vtkDataArray* Array, int fieldAssociation, vtkDataSet* input,
181  bool computeVorticity, bool computeQCriterion, bool computeDivergence,
182  vtkDataSet* output);
183 
189  virtual int ComputeRegularGridGradient(
190  vtkDataArray* Array, int fieldAssociation, bool computeVorticity,
191  bool computeQCriterion, bool computeDivergence, vtkDataSet* output);
192 
197  char *ResultArrayName;
198 
203  char *DivergenceArrayName;
204 
209  char *VorticityArrayName;
210 
215  char *QCriterionArrayName;
216 
226  int FasterApproximation;
227 
232  int ComputeGradient;
233 
239  int ComputeDivergence;
240 
246  int ComputeQCriterion;
247 
253  int ComputeVorticity;
254 
255 private:
256  vtkGradientFilter(const vtkGradientFilter &) VTK_DELETE_FUNCTION;
257  void operator=(const vtkGradientFilter &) VTK_DELETE_FUNCTION;
258 };
259 
260 #endif //_vtkGradientFilter_h
Store vtkAlgorithm input/output information.
abstract class to specify dataset behavior
Definition: vtkDataSet.h:56
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
a simple class to control print indentation
Definition: vtkIndent.h:33
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:48
vtkGetStringMacro(ExtensionsString)
Returns a string listing all available extensions.
A general filter for gradient estimation.
vtkSetMacro(IgnoreDriverBugs, bool)
When set known driver bugs are ignored during driver feature detection.
Store zero or more vtkInformation instances.
Superclass for algorithms that produce output of the same type as input.
vtkBooleanMacro(IgnoreDriverBugs, bool)
When set known driver bugs are ignored during driver feature detection.
static vtkDataSetAlgorithm * New()