VTK  9.3.0
vtkFieldDataToAttributeDataFilter.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
55 #ifndef vtkFieldDataToAttributeDataFilter_h
56 #define vtkFieldDataToAttributeDataFilter_h
57 
58 #include "vtkDataSetAlgorithm.h"
59 #include "vtkFiltersCoreModule.h" // For export macro
60 
61 #define VTK_DATA_OBJECT_FIELD 0
62 #define VTK_POINT_DATA_FIELD 1
63 #define VTK_CELL_DATA_FIELD 2
64 
65 #define VTK_CELL_DATA 0
66 #define VTK_POINT_DATA 1
67 
68 VTK_ABI_NAMESPACE_BEGIN
69 class vtkDataArray;
71 class vtkFieldData;
72 
73 class VTKFILTERSCORE_EXPORT vtkFieldDataToAttributeDataFilter : public vtkDataSetAlgorithm
74 {
75 public:
76  void PrintSelf(ostream& os, vtkIndent indent) override;
78 
84 
86 
92  vtkSetMacro(InputField, int);
93  vtkGetMacro(InputField, int);
94  void SetInputFieldToDataObjectField() { this->SetInputField(VTK_DATA_OBJECT_FIELD); }
95  void SetInputFieldToPointDataField() { this->SetInputField(VTK_POINT_DATA_FIELD); }
96  void SetInputFieldToCellDataField() { this->SetInputField(VTK_CELL_DATA_FIELD); }
98 
100 
103  vtkSetMacro(OutputAttributeData, int);
104  vtkGetMacro(OutputAttributeData, int);
105  void SetOutputAttributeDataToCellData() { this->SetOutputAttributeData(VTK_CELL_DATA); }
106  void SetOutputAttributeDataToPointData() { this->SetOutputAttributeData(VTK_POINT_DATA); }
108 
110 
118  int comp, const char* arrayName, int arrayComp, int min, int max, int normalize);
119  void SetScalarComponent(int comp, const char* arrayName, int arrayComp)
120  {
121  this->SetScalarComponent(comp, arrayName, arrayComp, -1, -1, this->DefaultNormalize);
122  }
123  const char* GetScalarComponentArrayName(int comp);
129 
131 
139  int comp, const char* arrayName, int arrayComp, int min, int max, int normalize);
140  void SetVectorComponent(int comp, const char* arrayName, int arrayComp)
141  {
142  this->SetVectorComponent(comp, arrayName, arrayComp, -1, -1, this->DefaultNormalize);
143  }
144  const char* GetVectorComponentArrayName(int comp);
150 
152 
160  int comp, const char* arrayName, int arrayComp, int min, int max, int normalize);
161  void SetNormalComponent(int comp, const char* arrayName, int arrayComp)
162  {
163  this->SetNormalComponent(comp, arrayName, arrayComp, -1, -1, this->DefaultNormalize);
164  }
165  const char* GetNormalComponentArrayName(int comp);
171 
173 
181  int comp, const char* arrayName, int arrayComp, int min, int max, int normalize);
182  void SetTensorComponent(int comp, const char* arrayName, int arrayComp)
183  {
184  this->SetTensorComponent(comp, arrayName, arrayComp, -1, -1, this->DefaultNormalize);
185  }
186  const char* GetTensorComponentArrayName(int comp);
192 
194 
202  int comp, const char* arrayName, int arrayComp, int min, int max, int normalize);
203  void SetTCoordComponent(int comp, const char* arrayName, int arrayComp)
204  {
205  this->SetTCoordComponent(comp, arrayName, arrayComp, -1, -1, this->DefaultNormalize);
206  }
207  const char* GetTCoordComponentArrayName(int comp);
213 
215 
219  vtkSetMacro(DefaultNormalize, vtkTypeBool);
220  vtkGetMacro(DefaultNormalize, vtkTypeBool);
221  vtkBooleanMacro(DefaultNormalize, vtkTypeBool);
223 
224  // Helper functions, made public to support other classes
225 
231  static int GetComponentsType(int numComp, vtkDataArray** arrays);
232 
239  static int ConstructArray(vtkDataArray* da, int comp, vtkDataArray* fieldArray, int fieldComp,
240  vtkIdType min, vtkIdType max, int normalize);
241 
245  static vtkDataArray* GetFieldArray(vtkFieldData* fd, const char* name, int comp);
246 
250  static void SetArrayName(vtkObject* self, char*& name, const char* newName);
251 
256  static int UpdateComponentRange(vtkDataArray* da, vtkIdType compRange[2]);
257 
262 
263 protected:
266 
268  vtkInformationVector*) override; // generate output data
269 
272 
273  int NumberOfScalarComponents; // the number of components to fill-in
274  char* ScalarArrays[4]; // the name of the arrays used to construct the scalar
275  int ScalarArrayComponents[4]; // the components of the arrays used to construct
276  vtkIdType ScalarComponentRange[4][2]; // the range of the components to use
277  int ScalarNormalize[4]; // flags control normalization
278 
279  char* VectorArrays[3]; // the name of the arrays used to construct the vectors
280  int VectorArrayComponents[3]; // the components of the arrays used to construct
281  vtkIdType VectorComponentRange[3][2]; // the range of the components to use
282  int VectorNormalize[3]; // flags control normalization
283 
284  char* GhostLevelArray; // the name of the array used to construct the ghost levels
285  int GhostLevelArrayComponent; // the component of the array used to construct
286  vtkIdType GhostLevelComponentRange[2]; // the range of the components to use
287  int GhostLevelNormalize; // flags control normalization
288 
289  char* NormalArrays[3]; // the name of the arrays used to construct the normals
290  int NormalArrayComponents[3]; // the components of the arrays used to construct
291  vtkIdType NormalComponentRange[3][2]; // the range of the components to use
292  int NormalNormalize[3]; // flags control normalization
293 
294  char* TensorArrays[9]; // the name of the arrays used to construct the tensors
295  int TensorArrayComponents[9]; // the components of the arrays used to construct
296  vtkIdType TensorComponentRange[9][2]; // the range of the components to use
297  int TensorNormalize[9]; // flags control normalization
298 
299  int NumberOfTCoordComponents; // the number of components to fill-in
300  char* TCoordArrays[3]; // the name of the arrays used to construct the tcoords
301  int TCoordArrayComponents[3]; // the components of the arrays used to construct
302  vtkIdType TCoordComponentRange[3][2]; // the range of the components to use
303  int TCoordNormalize[3]; // flags control normalization
304 
306 
308  vtkIdType componentRange[4][2], char* arrays[4], int arrayComponents[4], int normalize[4],
309  int numComp);
311  vtkIdType componentRange[3][2], char* arrays[3], int arrayComponents[3], int normalize[3]);
313  vtkIdType componentRange[2], char* array, int arrayComponent, int normalize);
315  vtkIdType componentRange[3][2], char* arrays[3], int arrayComponents[3], int normalize[3]);
317  vtkIdType componentRange[3][2], char* arrays[3], int arrayComponents[3], int normalize[3],
318  int numComp);
320  vtkIdType componentRange[9][2], char* arrays[9], int arrayComponents[9], int normalize[9]);
322 
323 private:
325  void operator=(const vtkFieldDataToAttributeDataFilter&) = delete;
326 };
327 
328 VTK_ABI_NAMESPACE_END
329 #endif
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:54
Superclass for algorithms that produce output of the same type as input.
represent and manipulate attribute data in a dataset
map field data to dataset attribute data
void SetOutputAttributeDataToPointData()
Specify which attribute data to output: point or cell data attributes.
static int GetComponentsType(int numComp, vtkDataArray **arrays)
Given an array of names of arrays in field data, return the common type for these arrays.
int GetNormalComponentMinRange(int comp)
Define the component(s) of the field to be used for the normal components.
void SetOutputAttributeDataToCellData()
Specify which attribute data to output: point or cell data attributes.
void SetInputFieldToCellDataField()
Specify which field data to use to generate the output attribute data.
int GetTensorComponentMaxRange(int comp)
Define the components of the field to be used for the tensor components.
int GetNormalComponentMaxRange(int comp)
Define the component(s) of the field to be used for the normal components.
void SetTensorComponent(int comp, const char *arrayName, int arrayComp)
Define the components of the field to be used for the tensor components.
void ConstructNormals(int num, vtkFieldData *fd, vtkDataSetAttributes *attr, vtkIdType componentRange[3][2], char *arrays[3], int arrayComponents[3], int normalize[3])
static int UpdateComponentRange(vtkDataArray *da, vtkIdType compRange[2])
Update the maximum and minimum component range values.
void ConstructVectors(int num, vtkFieldData *fd, vtkDataSetAttributes *attr, vtkIdType componentRange[3][2], char *arrays[3], int arrayComponents[3], int normalize[3])
const char * GetTensorComponentArrayName(int comp)
Define the components of the field to be used for the tensor components.
static void SetArrayName(vtkObject *self, char *&name, const char *newName)
Specify an array name for one of the components.
static vtkDataArray * GetFieldArray(vtkFieldData *fd, const char *name, int comp)
Return an array of a particular name from field data and do error checking.
const char * GetNormalComponentArrayName(int comp)
Define the component(s) of the field to be used for the normal components.
void SetInputFieldToDataObjectField()
Specify which field data to use to generate the output attribute data.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int GetTCoordComponentArrayComponent(int comp)
Define the components of the field to be used for the cell texture coord components.
void ConstructFieldData(int num, vtkDataSetAttributes *attr)
void ConstructTCoords(int num, vtkFieldData *fd, vtkDataSetAttributes *attr, vtkIdType componentRange[3][2], char *arrays[3], int arrayComponents[3], int normalize[3], int numComp)
void SetNormalComponent(int comp, const char *arrayName, int arrayComp)
Define the component(s) of the field to be used for the normal components.
int GetTCoordComponentMaxRange(int comp)
Define the components of the field to be used for the cell texture coord components.
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when a request asks the algorithm to do its work.
int GetTensorComponentMinRange(int comp)
Define the components of the field to be used for the tensor components.
static int ConstructArray(vtkDataArray *da, int comp, vtkDataArray *fieldArray, int fieldComp, vtkIdType min, vtkIdType max, int normalize)
Construct a portion of a data array (the comp portion) from another data array and its component.
int GetVectorComponentArrayComponent(int comp)
Define the component(s) of the field to be used for the vector components.
const char * GetScalarComponentArrayName(int comp)
Define the component(s) of the field to be used for the scalar components.
const char * GetTCoordComponentArrayName(int comp)
Define the components of the field to be used for the cell texture coord components.
int GetTensorComponentNormalizeFlag(int comp)
Define the components of the field to be used for the tensor components.
int GetScalarComponentMinRange(int comp)
Define the component(s) of the field to be used for the scalar components.
void SetVectorComponent(int comp, const char *arrayName, int arrayComp, int min, int max, int normalize)
Define the component(s) of the field to be used for the vector components.
int RequestUpdateExtent(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
If output does not need exact extent, the I do not either.
int GetVectorComponentMaxRange(int comp)
Define the component(s) of the field to be used for the vector components.
int GetTensorComponentArrayComponent(int comp)
Define the components of the field to be used for the tensor components.
static vtkFieldDataToAttributeDataFilter * New()
Construct object with input field set to the data object field, and the output attribute data set to ...
const char * GetVectorComponentArrayName(int comp)
Define the component(s) of the field to be used for the vector components.
void SetTCoordComponent(int comp, const char *arrayName, int arrayComp)
Define the components of the field to be used for the cell texture coord components.
void SetScalarComponent(int comp, const char *arrayName, int arrayComp, int min, int max, int normalize)
Define the component(s) of the field to be used for the scalar components.
void ConstructGhostLevels(int num, vtkFieldData *fd, vtkDataSetAttributes *attr, vtkIdType componentRange[2], char *array, int arrayComponent, int normalize)
int GetTCoordComponentMinRange(int comp)
Define the components of the field to be used for the cell texture coord components.
void SetTCoordComponent(int comp, const char *arrayName, int arrayComp, int min, int max, int normalize)
Define the components of the field to be used for the cell texture coord components.
void ConstructTensors(int num, vtkFieldData *fd, vtkDataSetAttributes *attr, vtkIdType componentRange[9][2], char *arrays[9], int arrayComponents[9], int normalize[9])
void SetVectorComponent(int comp, const char *arrayName, int arrayComp)
Define the component(s) of the field to be used for the vector components.
int GetScalarComponentMaxRange(int comp)
Define the component(s) of the field to be used for the scalar components.
void SetScalarComponent(int comp, const char *arrayName, int arrayComp)
Define the component(s) of the field to be used for the scalar components.
void SetTensorComponent(int comp, const char *arrayName, int arrayComp, int min, int max, int normalize)
Define the components of the field to be used for the tensor components.
void ConstructScalars(int num, vtkFieldData *fd, vtkDataSetAttributes *attr, vtkIdType componentRange[4][2], char *arrays[4], int arrayComponents[4], int normalize[4], int numComp)
int GetNormalComponentArrayComponent(int comp)
Define the component(s) of the field to be used for the normal components.
int GetScalarComponentArrayComponent(int comp)
Define the component(s) of the field to be used for the scalar components.
int GetTCoordComponentNormalizeFlag(int comp)
Define the components of the field to be used for the cell texture coord components.
int GetVectorComponentMinRange(int comp)
Define the component(s) of the field to be used for the vector components.
int GetNormalComponentNormalizeFlag(int comp)
Define the component(s) of the field to be used for the normal components.
void SetInputFieldToPointDataField()
Specify which field data to use to generate the output attribute data.
void SetNormalComponent(int comp, const char *arrayName, int arrayComp, int min, int max, int normalize)
Define the component(s) of the field to be used for the normal components.
int GetScalarComponentNormalizeFlag(int comp)
Define the component(s) of the field to be used for the scalar components.
int GetVectorComponentNormalizeFlag(int comp)
Define the component(s) of the field to be used for the vector components.
represent and manipulate fields of data
Definition: vtkFieldData.h:61
a simple class to control print indentation
Definition: vtkIndent.h:38
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
abstract base class for most VTK objects
Definition: vtkObject.h:61
@ name
Definition: vtkX3D.h:219
int vtkTypeBool
Definition: vtkABI.h:64
#define VTK_POINT_DATA_FIELD
#define VTK_CELL_DATA_FIELD
#define VTK_DATA_OBJECT_FIELD
int vtkIdType
Definition: vtkType.h:315
#define max(a, b)