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
46 #ifndef vtkFieldDataToAttributeDataFilter_h
47 #define vtkFieldDataToAttributeDataFilter_h
48 
49 #include "vtkDataSetAlgorithm.h"
50 #include "vtkFiltersCoreModule.h" // For export macro
51 
52 #define VTK_DATA_OBJECT_FIELD 0
53 #define VTK_POINT_DATA_FIELD 1
54 #define VTK_CELL_DATA_FIELD 2
55 
56 #define VTK_CELL_DATA 0
57 #define VTK_POINT_DATA 1
58 
59 VTK_ABI_NAMESPACE_BEGIN
60 class vtkDataArray;
62 class vtkFieldData;
63 
64 class VTKFILTERSCORE_EXPORT vtkFieldDataToAttributeDataFilter : public vtkDataSetAlgorithm
65 {
66 public:
67  void PrintSelf(ostream& os, vtkIndent indent) override;
69 
75 
77 
83  vtkSetMacro(InputField, int);
84  vtkGetMacro(InputField, int);
85  void SetInputFieldToDataObjectField() { this->SetInputField(VTK_DATA_OBJECT_FIELD); }
86  void SetInputFieldToPointDataField() { this->SetInputField(VTK_POINT_DATA_FIELD); }
87  void SetInputFieldToCellDataField() { this->SetInputField(VTK_CELL_DATA_FIELD); }
89 
91 
94  vtkSetMacro(OutputAttributeData, int);
95  vtkGetMacro(OutputAttributeData, int);
96  void SetOutputAttributeDataToCellData() { this->SetOutputAttributeData(VTK_CELL_DATA); }
97  void SetOutputAttributeDataToPointData() { this->SetOutputAttributeData(VTK_POINT_DATA); }
99 
101 
109  int comp, const char* arrayName, int arrayComp, int min, int max, int normalize);
110  void SetScalarComponent(int comp, const char* arrayName, int arrayComp)
111  {
112  this->SetScalarComponent(comp, arrayName, arrayComp, -1, -1, this->DefaultNormalize);
113  }
114  const char* GetScalarComponentArrayName(int comp);
120 
122 
130  int comp, const char* arrayName, int arrayComp, int min, int max, int normalize);
131  void SetVectorComponent(int comp, const char* arrayName, int arrayComp)
132  {
133  this->SetVectorComponent(comp, arrayName, arrayComp, -1, -1, this->DefaultNormalize);
134  }
135  const char* GetVectorComponentArrayName(int comp);
141 
143 
151  int comp, const char* arrayName, int arrayComp, int min, int max, int normalize);
152  void SetNormalComponent(int comp, const char* arrayName, int arrayComp)
153  {
154  this->SetNormalComponent(comp, arrayName, arrayComp, -1, -1, this->DefaultNormalize);
155  }
156  const char* GetNormalComponentArrayName(int comp);
162 
164 
172  int comp, const char* arrayName, int arrayComp, int min, int max, int normalize);
173  void SetTensorComponent(int comp, const char* arrayName, int arrayComp)
174  {
175  this->SetTensorComponent(comp, arrayName, arrayComp, -1, -1, this->DefaultNormalize);
176  }
177  const char* GetTensorComponentArrayName(int comp);
183 
185 
193  int comp, const char* arrayName, int arrayComp, int min, int max, int normalize);
194  void SetTCoordComponent(int comp, const char* arrayName, int arrayComp)
195  {
196  this->SetTCoordComponent(comp, arrayName, arrayComp, -1, -1, this->DefaultNormalize);
197  }
198  const char* GetTCoordComponentArrayName(int comp);
204 
206 
210  vtkSetMacro(DefaultNormalize, vtkTypeBool);
211  vtkGetMacro(DefaultNormalize, vtkTypeBool);
212  vtkBooleanMacro(DefaultNormalize, vtkTypeBool);
214 
215  // Helper functions, made public to support other classes
216 
222  static int GetComponentsType(int numComp, vtkDataArray** arrays);
223 
230  static int ConstructArray(vtkDataArray* da, int comp, vtkDataArray* fieldArray, int fieldComp,
231  vtkIdType min, vtkIdType max, int normalize);
232 
236  static vtkDataArray* GetFieldArray(vtkFieldData* fd, const char* name, int comp);
237 
241  static void SetArrayName(vtkObject* self, char*& name, const char* newName);
242 
247  static int UpdateComponentRange(vtkDataArray* da, vtkIdType compRange[2]);
248 
253 
254 protected:
257 
259  vtkInformationVector*) override; // generate output data
260 
263 
264  int NumberOfScalarComponents; // the number of components to fill-in
265  char* ScalarArrays[4]; // the name of the arrays used to construct the scalar
266  int ScalarArrayComponents[4]; // the components of the arrays used to construct
267  vtkIdType ScalarComponentRange[4][2]; // the range of the components to use
268  int ScalarNormalize[4]; // flags control normalization
269 
270  char* VectorArrays[3]; // the name of the arrays used to construct the vectors
271  int VectorArrayComponents[3]; // the components of the arrays used to construct
272  vtkIdType VectorComponentRange[3][2]; // the range of the components to use
273  int VectorNormalize[3]; // flags control normalization
274 
275  char* GhostLevelArray; // the name of the array used to construct the ghost levels
276  int GhostLevelArrayComponent; // the component of the array used to construct
277  vtkIdType GhostLevelComponentRange[2]; // the range of the components to use
278  int GhostLevelNormalize; // flags control normalization
279 
280  char* NormalArrays[3]; // the name of the arrays used to construct the normals
281  int NormalArrayComponents[3]; // the components of the arrays used to construct
282  vtkIdType NormalComponentRange[3][2]; // the range of the components to use
283  int NormalNormalize[3]; // flags control normalization
284 
285  char* TensorArrays[9]; // the name of the arrays used to construct the tensors
286  int TensorArrayComponents[9]; // the components of the arrays used to construct
287  vtkIdType TensorComponentRange[9][2]; // the range of the components to use
288  int TensorNormalize[9]; // flags control normalization
289 
290  int NumberOfTCoordComponents; // the number of components to fill-in
291  char* TCoordArrays[3]; // the name of the arrays used to construct the tcoords
292  int TCoordArrayComponents[3]; // the components of the arrays used to construct
293  vtkIdType TCoordComponentRange[3][2]; // the range of the components to use
294  int TCoordNormalize[3]; // flags control normalization
295 
297 
299  vtkIdType componentRange[4][2], char* arrays[4], int arrayComponents[4], int normalize[4],
300  int numComp);
302  vtkIdType componentRange[3][2], char* arrays[3], int arrayComponents[3], int normalize[3]);
304  vtkIdType componentRange[2], char* array, int arrayComponent, int normalize);
306  vtkIdType componentRange[3][2], char* arrays[3], int arrayComponents[3], int normalize[3]);
308  vtkIdType componentRange[3][2], char* arrays[3], int arrayComponents[3], int normalize[3],
309  int numComp);
311  vtkIdType componentRange[9][2], char* arrays[9], int arrayComponents[9], int normalize[9]);
313 
314 private:
316  void operator=(const vtkFieldDataToAttributeDataFilter&) = delete;
317 };
318 
319 VTK_ABI_NAMESPACE_END
320 #endif
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:45
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:52
a simple class to control print indentation
Definition: vtkIndent.h:29
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
abstract base class for most VTK objects
Definition: vtkObject.h:52
@ 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)