VTK  9.2.6
vtkFieldDataToAttributeDataFilter.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkFieldDataToAttributeDataFilter.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=========================================================================*/
58#ifndef vtkFieldDataToAttributeDataFilter_h
59#define vtkFieldDataToAttributeDataFilter_h
60
61#include "vtkDataSetAlgorithm.h"
62#include "vtkFiltersCoreModule.h" // For export macro
63
64#define VTK_DATA_OBJECT_FIELD 0
65#define VTK_POINT_DATA_FIELD 1
66#define VTK_CELL_DATA_FIELD 2
67
68#define VTK_CELL_DATA 0
69#define VTK_POINT_DATA 1
70
71class vtkDataArray;
73class vtkFieldData;
74
75class VTKFILTERSCORE_EXPORT vtkFieldDataToAttributeDataFilter : public vtkDataSetAlgorithm
76{
77public:
78 void PrintSelf(ostream& os, vtkIndent indent) override;
80
86
88
94 vtkSetMacro(InputField, int);
95 vtkGetMacro(InputField, int);
97 void SetInputFieldToPointDataField() { this->SetInputField(VTK_POINT_DATA_FIELD); }
98 void SetInputFieldToCellDataField() { this->SetInputField(VTK_CELL_DATA_FIELD); }
100
102
105 vtkSetMacro(OutputAttributeData, int);
106 vtkGetMacro(OutputAttributeData, int);
107 void SetOutputAttributeDataToCellData() { this->SetOutputAttributeData(VTK_CELL_DATA); }
108 void SetOutputAttributeDataToPointData() { this->SetOutputAttributeData(VTK_POINT_DATA); }
110
112
120 int comp, const char* arrayName, int arrayComp, int min, int max, int normalize);
121 void SetScalarComponent(int comp, const char* arrayName, int arrayComp)
122 {
123 this->SetScalarComponent(comp, arrayName, arrayComp, -1, -1, this->DefaultNormalize);
124 }
125 const char* GetScalarComponentArrayName(int comp);
131
133
141 int comp, const char* arrayName, int arrayComp, int min, int max, int normalize);
142 void SetVectorComponent(int comp, const char* arrayName, int arrayComp)
143 {
144 this->SetVectorComponent(comp, arrayName, arrayComp, -1, -1, this->DefaultNormalize);
145 }
146 const char* GetVectorComponentArrayName(int comp);
152
154
162 int comp, const char* arrayName, int arrayComp, int min, int max, int normalize);
163 void SetNormalComponent(int comp, const char* arrayName, int arrayComp)
164 {
165 this->SetNormalComponent(comp, arrayName, arrayComp, -1, -1, this->DefaultNormalize);
166 }
167 const char* GetNormalComponentArrayName(int comp);
173
175
183 int comp, const char* arrayName, int arrayComp, int min, int max, int normalize);
184 void SetTensorComponent(int comp, const char* arrayName, int arrayComp)
185 {
186 this->SetTensorComponent(comp, arrayName, arrayComp, -1, -1, this->DefaultNormalize);
187 }
188 const char* GetTensorComponentArrayName(int comp);
194
196
204 int comp, const char* arrayName, int arrayComp, int min, int max, int normalize);
205 void SetTCoordComponent(int comp, const char* arrayName, int arrayComp)
206 {
207 this->SetTCoordComponent(comp, arrayName, arrayComp, -1, -1, this->DefaultNormalize);
208 }
209 const char* GetTCoordComponentArrayName(int comp);
215
217
221 vtkSetMacro(DefaultNormalize, vtkTypeBool);
222 vtkGetMacro(DefaultNormalize, vtkTypeBool);
223 vtkBooleanMacro(DefaultNormalize, vtkTypeBool);
225
226 // Helper functions, made public to support other classes
227
233 static int GetComponentsType(int numComp, vtkDataArray** arrays);
234
241 static int ConstructArray(vtkDataArray* da, int comp, vtkDataArray* fieldArray, int fieldComp,
242 vtkIdType min, vtkIdType max, int normalize);
243
247 static vtkDataArray* GetFieldArray(vtkFieldData* fd, const char* name, int comp);
248
252 static void SetArrayName(vtkObject* self, char*& name, const char* newName);
253
258 static int UpdateComponentRange(vtkDataArray* da, vtkIdType compRange[2]);
259
264
265protected:
268
270 vtkInformationVector*) override; // generate output data
271
274
275 int NumberOfScalarComponents; // the number of components to fill-in
276 char* ScalarArrays[4]; // the name of the arrays used to construct the scalar
277 int ScalarArrayComponents[4]; // the components of the arrays used to construct
278 vtkIdType ScalarComponentRange[4][2]; // the range of the components to use
279 int ScalarNormalize[4]; // flags control normalization
280
281 char* VectorArrays[3]; // the name of the arrays used to construct the vectors
282 int VectorArrayComponents[3]; // the components of the arrays used to construct
283 vtkIdType VectorComponentRange[3][2]; // the range of the components to use
284 int VectorNormalize[3]; // flags control normalization
285
286 char* GhostLevelArray; // the name of the array used to construct the ghost levels
287 int GhostLevelArrayComponent; // the component of the array used to construct
288 vtkIdType GhostLevelComponentRange[2]; // the range of the components to use
289 int GhostLevelNormalize; // flags control normalization
290
291 char* NormalArrays[3]; // the name of the arrays used to construct the normals
292 int NormalArrayComponents[3]; // the components of the arrays used to construct
293 vtkIdType NormalComponentRange[3][2]; // the range of the components to use
294 int NormalNormalize[3]; // flags control normalization
295
296 char* TensorArrays[9]; // the name of the arrays used to construct the tensors
297 int TensorArrayComponents[9]; // the components of the arrays used to construct
298 vtkIdType TensorComponentRange[9][2]; // the range of the components to use
299 int TensorNormalize[9]; // flags control normalization
300
301 int NumberOfTCoordComponents; // the number of components to fill-in
302 char* TCoordArrays[3]; // the name of the arrays used to construct the tcoords
303 int TCoordArrayComponents[3]; // the components of the arrays used to construct
304 vtkIdType TCoordComponentRange[3][2]; // the range of the components to use
305 int TCoordNormalize[3]; // flags control normalization
306
308
310 vtkIdType componentRange[4][2], char* arrays[4], int arrayComponents[4], int normalize[4],
311 int numComp);
313 vtkIdType componentRange[3][2], char* arrays[3], int arrayComponents[3], int normalize[3]);
315 vtkIdType componentRange[2], char* array, int arrayComponent, int normalize);
317 vtkIdType componentRange[3][2], char* arrays[3], int arrayComponents[3], int normalize[3]);
319 vtkIdType componentRange[3][2], char* arrays[3], int arrayComponents[3], int normalize[3],
320 int numComp);
322 vtkIdType componentRange[9][2], char* arrays[9], int arrayComponents[9], int normalize[9]);
324
325private:
327 void operator=(const vtkFieldDataToAttributeDataFilter&) = delete;
328};
329
330#endif
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:56
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.
static vtkFieldDataToAttributeDataFilter * New()
Construct object with input field set to the data object field, and the output attribute data set to ...
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])
const char * GetTCoordComponentArrayName(int comp)
Define the components of the field to be used for the cell texture coord components.
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])
static void SetArrayName(vtkObject *self, char *&name, const char *newName)
Specify an array name for one of the components.
const char * GetVectorComponentArrayName(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 * 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.
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.
const char * GetTensorComponentArrayName(int comp)
Define the components of the field to be used for the tensor components.
int GetTensorComponentArrayComponent(int comp)
Define the components of the field to be used for the tensor 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.
static vtkDataArray * GetFieldArray(vtkFieldData *fd, const char *name, int comp)
Return an array of a particular name from field data and do error checking.
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:63
a simple class to control print indentation
Definition: vtkIndent.h:40
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
abstract base class for most VTK objects
Definition: vtkObject.h:63
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_POINT_DATA_FIELD
#define VTK_CELL_DATA_FIELD
#define VTK_DATA_OBJECT_FIELD
int vtkIdType
Definition: vtkType.h:332
#define max(a, b)