VTK
vtkArrayCalculator.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkArrayCalculator.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 =========================================================================*/
61 #ifndef vtkArrayCalculator_h
62 #define vtkArrayCalculator_h
63 
64 #include "vtkDataObject.h" // For attribute types
65 #include "vtkFiltersCoreModule.h" // For export macro
67 
68 class vtkDataSet;
69 class vtkFunctionParser;
70 
71 #ifndef VTK_LEGACY_REMOVE
72 #define VTK_ATTRIBUTE_MODE_DEFAULT 0
73 #define VTK_ATTRIBUTE_MODE_USE_POINT_DATA 1
74 #define VTK_ATTRIBUTE_MODE_USE_CELL_DATA 2
75 #define VTK_ATTRIBUTE_MODE_USE_VERTEX_DATA 3
76 #define VTK_ATTRIBUTE_MODE_USE_EDGE_DATA 4
77 #endif
78 
79 class VTKFILTERSCORE_EXPORT vtkArrayCalculator : public vtkPassInputTypeAlgorithm
80 {
81 public:
83  void PrintSelf(ostream& os, vtkIndent indent) override;
84 
85  static vtkArrayCalculator *New();
86 
88 
91  virtual void SetFunction(const char* function);
92  vtkGetStringMacro(Function);
94 
96 
102  void AddScalarArrayName(const char* arrayName, int component = 0);
103  void AddVectorArrayName(const char* arrayName, int component0 = 0,
104  int component1 = 1, int component2 = 2);
106 
108 
112  void AddScalarVariable(const char* variableName, const char* arrayName,
113  int component = 0);
114  void AddVectorVariable(const char* variableName, const char* arrayName,
115  int component0 = 0, int component1 = 1,
116  int component2 = 2);
118 
120 
124  void AddCoordinateScalarVariable(const char* variableName,
125  int component = 0);
126  void AddCoordinateVectorVariable(const char* variableName,
127  int component0 = 0, int component1 = 1,
128  int component2 = 2);
130 
132 
138  void SetResultArrayName(const char* name);
139  vtkGetStringMacro(ResultArrayName);
141 
143 
147  vtkGetMacro(ResultArrayType,int);
148  vtkSetMacro(ResultArrayType,int);
150 
152 
158  vtkGetMacro(CoordinateResults, vtkTypeBool);
159  vtkSetMacro(CoordinateResults, vtkTypeBool);
160  vtkBooleanMacro(CoordinateResults, vtkTypeBool);
162 
164 
169  vtkGetMacro(ResultNormals, bool);
170  vtkSetMacro(ResultNormals, bool);
171  vtkBooleanMacro(ResultNormals, bool);
173 
175 
180  vtkGetMacro(ResultTCoords, bool);
181  vtkSetMacro(ResultTCoords, bool);
182  vtkBooleanMacro(ResultTCoords, bool);
184 
186 
196 #ifndef VTK_LEGACY_REMOVE
197  VTK_LEGACY(void SetAttributeMode(int newMode);)
198  VTK_LEGACY(int GetAttributeMode();)
199  VTK_LEGACY(void SetAttributeModeToDefault())
200  {this->SetAttributeType(DEFAULT_ATTRIBUTE_TYPE);};
202  {this->SetAttributeType(vtkDataObject::POINT);};
203  VTK_LEGACY(void SetAttributeModeToUseCellData())
204  {this->SetAttributeType(vtkDataObject::CELL);};
206  {this->SetAttributeType(vtkDataObject::VERTEX);};
207  VTK_LEGACY(void SetAttributeModeToUseEdgeData())
208  {this->SetAttributeType(vtkDataObject::EDGE);};
209  VTK_LEGACY(const char *GetAttributeModeAsString());
210 #endif
211 
212 
216  const char *GetAttributeTypeAsString();
217 
218  static const int DEFAULT_ATTRIBUTE_TYPE = -1;
220 
226  vtkSetMacro(AttributeType, int);
227  vtkGetMacro(AttributeType, int);
229  {this->SetAttributeType(DEFAULT_ATTRIBUTE_TYPE);}
231  {this->SetAttributeType(vtkDataObject::POINT);}
233  {this->SetAttributeType(vtkDataObject::CELL);}
235  {this->SetAttributeType(vtkDataObject::EDGE);}
237  {this->SetAttributeType(vtkDataObject::VERTEX);}
239  {this->SetAttributeType(vtkDataObject::ROW);}
241 
245  void RemoveAllVariables();
246 
250  virtual void RemoveScalarVariables();
251 
255  virtual void RemoveVectorVariables();
256 
260  virtual void RemoveCoordinateScalarVariables();
261 
265  virtual void RemoveCoordinateVectorVariables();
266 
268 
271  char** GetScalarArrayNames() { return this->ScalarArrayNames; }
272  char* GetScalarArrayName(int i);
273  char** GetVectorArrayNames() { return this->VectorArrayNames; }
274  char* GetVectorArrayName(int i);
275  char** GetScalarVariableNames() { return this->ScalarVariableNames; }
276  char* GetScalarVariableName(int i);
277  char** GetVectorVariableNames() { return this->VectorVariableNames; }
278  char* GetVectorVariableName(int i);
279  int* GetSelectedScalarComponents() { return this->SelectedScalarComponents; }
280  int GetSelectedScalarComponent(int i);
281  int** GetSelectedVectorComponents() { return this->SelectedVectorComponents;}
282  int* GetSelectedVectorComponents(int i);
283  vtkGetMacro(NumberOfScalarArrays, int);
284  vtkGetMacro(NumberOfVectorArrays, int);
286 
288 
294  vtkSetMacro(ReplaceInvalidValues,vtkTypeBool);
295  vtkGetMacro(ReplaceInvalidValues,vtkTypeBool);
296  vtkBooleanMacro(ReplaceInvalidValues,vtkTypeBool);
297  vtkSetMacro(ReplacementValue,double);
298  vtkGetMacro(ReplacementValue,double);
300 
305  vtkDataSet* GetDataSetOutput();
306 
307 protected:
309  ~vtkArrayCalculator() override;
310 
311  int FillInputPortInformation(int, vtkInformation*) override;
312 
314 
315  char * Function;
327 
330 
340 
342 private:
343  vtkArrayCalculator(const vtkArrayCalculator&) = delete;
344  void operator=(const vtkArrayCalculator&) = delete;
345 };
346 
347 #endif
vtkArrayCalculator::SetAttributeTypeToDefault
void SetAttributeTypeToDefault()
Definition: vtkArrayCalculator.h:228
vtkArrayCalculator::ResultTCoords
bool ResultTCoords
Definition: vtkArrayCalculator.h:333
vtkDataObject::POINT
Definition: vtkDataObject.h:269
vtkArrayCalculator::NumberOfVectorArrays
int NumberOfVectorArrays
Definition: vtkArrayCalculator.h:322
vtkArrayCalculator::ResultArrayType
int ResultArrayType
Definition: vtkArrayCalculator.h:341
vtkDataObject::CELL
Definition: vtkDataObject.h:270
vtkArrayCalculator
perform mathematical operations on data in field data arrays
Definition: vtkArrayCalculator.h:79
vtkPassInputTypeAlgorithm.h
vtkX3D::component
Definition: vtkX3D.h:175
vtkArrayCalculator::ReplaceInvalidValues
vtkTypeBool ReplaceInvalidValues
Definition: vtkArrayCalculator.h:328
vtkArrayCalculator::SetAttributeModeToDefault
void SetAttributeModeToDefault()
Definition: vtkArrayCalculator.h:199
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:35
vtkArrayCalculator::SetAttributeModeToUseEdgeData
void SetAttributeModeToUseEdgeData()
Definition: vtkArrayCalculator.h:207
vtkArrayCalculator::ResultNormals
bool ResultNormals
Definition: vtkArrayCalculator.h:332
vtkArrayCalculator::SetAttributeTypeToEdgeData
void SetAttributeTypeToEdgeData()
Definition: vtkArrayCalculator.h:234
vtkArrayCalculator::CoordinateResults
vtkTypeBool CoordinateResults
Definition: vtkArrayCalculator.h:331
vtkArrayCalculator::NumberOfCoordinateVectorArrays
int NumberOfCoordinateVectorArrays
Definition: vtkArrayCalculator.h:339
vtkArrayCalculator::GetVectorVariableNames
char ** GetVectorVariableNames()
Definition: vtkArrayCalculator.h:277
vtkArrayCalculator::SelectedCoordinateScalarComponents
int * SelectedCoordinateScalarComponents
Definition: vtkArrayCalculator.h:336
vtkPassInputTypeAlgorithm::FillInputPortInformation
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
vtkArrayCalculator::NumberOfScalarArrays
int NumberOfScalarArrays
Definition: vtkArrayCalculator.h:321
vtkArrayCalculator::GetScalarArrayNames
char ** GetScalarArrayNames()
Methods to get information about the current variables.
Definition: vtkArrayCalculator.h:271
vtkArrayCalculator::ScalarVariableNames
char ** ScalarVariableNames
Definition: vtkArrayCalculator.h:319
vtkArrayCalculator::SetAttributeModeToUseCellData
void SetAttributeModeToUseCellData()
Definition: vtkArrayCalculator.h:203
vtkArrayCalculator::GetScalarVariableNames
char ** GetScalarVariableNames()
Definition: vtkArrayCalculator.h:275
vtkArrayCalculator::SetAttributeModeToUseVertexData
void SetAttributeModeToUseVertexData()
Definition: vtkArrayCalculator.h:205
vtkArrayCalculator::NumberOfCoordinateScalarArrays
int NumberOfCoordinateScalarArrays
Definition: vtkArrayCalculator.h:338
vtkArrayCalculator::VectorVariableNames
char ** VectorVariableNames
Definition: vtkArrayCalculator.h:320
vtkArrayCalculator::GetSelectedScalarComponents
int * GetSelectedScalarComponents()
Definition: vtkArrayCalculator.h:279
vtkArrayCalculator::AttributeType
int AttributeType
Definition: vtkArrayCalculator.h:323
vtkPassInputTypeAlgorithm::RequestData
virtual int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called within ProcessRequest when a request asks the algorithm to do its work.
Definition: vtkPassInputTypeAlgorithm.h:175
vtkDataObject::VERTEX
Definition: vtkDataObject.h:273
vtkArrayCalculator::SetAttributeTypeToRowData
void SetAttributeTypeToRowData()
Definition: vtkArrayCalculator.h:238
vtkArrayCalculator::CoordinateVectorVariableNames
char ** CoordinateVectorVariableNames
Definition: vtkArrayCalculator.h:335
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkArrayCalculator::VectorArrayNames
char ** VectorArrayNames
Definition: vtkArrayCalculator.h:318
vtkArrayCalculator::SetAttributeTypeToCellData
void SetAttributeTypeToCellData()
Definition: vtkArrayCalculator.h:232
vtkArrayCalculator::GetVectorArrayNames
char ** GetVectorArrayNames()
Definition: vtkArrayCalculator.h:273
vtkDataObject::ROW
Definition: vtkDataObject.h:275
vtkX3D::name
Definition: vtkX3D.h:219
vtkArrayCalculator::ResultArrayName
char * ResultArrayName
Definition: vtkArrayCalculator.h:316
vtkArrayCalculator::ScalarArrayNames
char ** ScalarArrayNames
Definition: vtkArrayCalculator.h:317
vtkDataSet
abstract class to specify dataset behavior
Definition: vtkDataSet.h:56
vtkArrayCalculator::SetAttributeTypeToVertexData
void SetAttributeTypeToVertexData()
Definition: vtkArrayCalculator.h:236
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:80
vtkArrayCalculator::SelectedVectorComponents
int ** SelectedVectorComponents
Definition: vtkArrayCalculator.h:325
vtkDataObject::EDGE
Definition: vtkDataObject.h:274
vtkArrayCalculator::GetSelectedVectorComponents
int ** GetSelectedVectorComponents()
Definition: vtkArrayCalculator.h:281
vtkDataObject.h
vtkArrayCalculator::SetAttributeModeToUsePointData
void SetAttributeModeToUsePointData()
Definition: vtkArrayCalculator.h:201
vtkArrayCalculator::CoordinateScalarVariableNames
char ** CoordinateScalarVariableNames
Definition: vtkArrayCalculator.h:334
vtkFunctionParser
Parse and evaluate a mathematical expression.
Definition: vtkFunctionParser.h:133
vtkPassInputTypeAlgorithm::New
static vtkPassInputTypeAlgorithm * New()
vtkPassInputTypeAlgorithm::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkArrayCalculator::SelectedCoordinateVectorComponents
int ** SelectedCoordinateVectorComponents
Definition: vtkArrayCalculator.h:337
vtkArrayCalculator::SetAttributeTypeToPointData
void SetAttributeTypeToPointData()
Definition: vtkArrayCalculator.h:230
vtkArrayCalculator::Function
char * Function
Definition: vtkArrayCalculator.h:315
vtkArrayCalculator::ReplacementValue
double ReplacementValue
Definition: vtkArrayCalculator.h:329
vtkArrayCalculator::FunctionParser
vtkFunctionParser * FunctionParser
Definition: vtkArrayCalculator.h:326
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkPassInputTypeAlgorithm
Superclass for algorithms that produce output of the same type as input.
Definition: vtkPassInputTypeAlgorithm.h:51
vtkArrayCalculator::SelectedScalarComponents
int * SelectedScalarComponents
Definition: vtkArrayCalculator.h:324