VTK  9.1.0
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=========================================================================*/
84#ifndef vtkFieldDataToAttributeDataFilter_h
85#define vtkFieldDataToAttributeDataFilter_h
86
87#include "vtkDataSetAlgorithm.h"
88#include "vtkFiltersCoreModule.h" // For export macro
89
90#define VTK_DATA_OBJECT_FIELD 0
91#define VTK_POINT_DATA_FIELD 1
92#define VTK_CELL_DATA_FIELD 2
93
94#define VTK_CELL_DATA 0
95#define VTK_POINT_DATA 1
96
97class vtkDataArray;
99class vtkFieldData;
100
101class VTKFILTERSCORE_EXPORT vtkFieldDataToAttributeDataFilter : public vtkDataSetAlgorithm
102{
103public:
104 void PrintSelf(ostream& os, vtkIndent indent) override;
106
112
114
120 vtkSetMacro(InputField, int);
121 vtkGetMacro(InputField, int);
124 void SetInputFieldToCellDataField() { this->SetInputField(VTK_CELL_DATA_FIELD); }
126
128
131 vtkSetMacro(OutputAttributeData, int);
132 vtkGetMacro(OutputAttributeData, int);
133 void SetOutputAttributeDataToCellData() { this->SetOutputAttributeData(VTK_CELL_DATA); }
134 void SetOutputAttributeDataToPointData() { this->SetOutputAttributeData(VTK_POINT_DATA); }
136
138
146 int comp, const char* arrayName, int arrayComp, int min, int max, int normalize);
147 void SetScalarComponent(int comp, const char* arrayName, int arrayComp)
148 {
149 this->SetScalarComponent(comp, arrayName, arrayComp, -1, -1, this->DefaultNormalize);
150 }
151 const char* GetScalarComponentArrayName(int comp);
157
159
167 int comp, const char* arrayName, int arrayComp, int min, int max, int normalize);
168 void SetVectorComponent(int comp, const char* arrayName, int arrayComp)
169 {
170 this->SetVectorComponent(comp, arrayName, arrayComp, -1, -1, this->DefaultNormalize);
171 }
172 const char* GetVectorComponentArrayName(int comp);
178
180
188 int comp, const char* arrayName, int arrayComp, int min, int max, int normalize);
189 void SetNormalComponent(int comp, const char* arrayName, int arrayComp)
190 {
191 this->SetNormalComponent(comp, arrayName, arrayComp, -1, -1, this->DefaultNormalize);
192 }
193 const char* GetNormalComponentArrayName(int comp);
199
201
209 int comp, const char* arrayName, int arrayComp, int min, int max, int normalize);
210 void SetTensorComponent(int comp, const char* arrayName, int arrayComp)
211 {
212 this->SetTensorComponent(comp, arrayName, arrayComp, -1, -1, this->DefaultNormalize);
213 }
214 const char* GetTensorComponentArrayName(int comp);
220
222
230 int comp, const char* arrayName, int arrayComp, int min, int max, int normalize);
231 void SetTCoordComponent(int comp, const char* arrayName, int arrayComp)
232 {
233 this->SetTCoordComponent(comp, arrayName, arrayComp, -1, -1, this->DefaultNormalize);
234 }
235 const char* GetTCoordComponentArrayName(int comp);
241
243
247 vtkSetMacro(DefaultNormalize, vtkTypeBool);
248 vtkGetMacro(DefaultNormalize, vtkTypeBool);
249 vtkBooleanMacro(DefaultNormalize, vtkTypeBool);
251
252 // Helper functions, made public to support other classes
253
259 static int GetComponentsType(int numComp, vtkDataArray** arrays);
260
267 static int ConstructArray(vtkDataArray* da, int comp, vtkDataArray* fieldArray, int fieldComp,
268 vtkIdType min, vtkIdType max, int normalize);
269
273 static vtkDataArray* GetFieldArray(vtkFieldData* fd, const char* name, int comp);
274
278 static void SetArrayName(vtkObject* self, char*& name, const char* newName);
279
284 static int UpdateComponentRange(vtkDataArray* da, vtkIdType compRange[2]);
285
290
291protected:
294
296 vtkInformationVector*) override; // generate output data
297
300
301 int NumberOfScalarComponents; // the number of components to fill-in
302 char* ScalarArrays[4]; // the name of the arrays used to construct the scalar
303 int ScalarArrayComponents[4]; // the components of the arrays used to construct
304 vtkIdType ScalarComponentRange[4][2]; // the range of the components to use
305 int ScalarNormalize[4]; // flags control normalization
306
307 char* VectorArrays[3]; // the name of the arrays used to construct the vectors
308 int VectorArrayComponents[3]; // the components of the arrays used to construct
309 vtkIdType VectorComponentRange[3][2]; // the range of the components to use
310 int VectorNormalize[3]; // flags control normalization
311
312 char* GhostLevelArray; // the name of the array used to construct the ghost levels
313 int GhostLevelArrayComponent; // the component of the array used to construct
314 vtkIdType GhostLevelComponentRange[2]; // the range of the components to use
315 int GhostLevelNormalize; // flags control normalization
316
317 char* NormalArrays[3]; // the name of the arrays used to construct the normals
318 int NormalArrayComponents[3]; // the components of the arrays used to construct
319 vtkIdType NormalComponentRange[3][2]; // the range of the components to use
320 int NormalNormalize[3]; // flags control normalization
321
322 char* TensorArrays[9]; // the name of the arrays used to construct the tensors
323 int TensorArrayComponents[9]; // the components of the arrays used to construct
324 vtkIdType TensorComponentRange[9][2]; // the range of the components to use
325 int TensorNormalize[9]; // flags control normalization
326
327 int NumberOfTCoordComponents; // the number of components to fill-in
328 char* TCoordArrays[3]; // the name of the arrays used to construct the tcoords
329 int TCoordArrayComponents[3]; // the components of the arrays used to construct
330 vtkIdType TCoordComponentRange[3][2]; // the range of the components to use
331 int TCoordNormalize[3]; // flags control normalization
332
334
336 vtkIdType componentRange[4][2], char* arrays[4], int arrayComponents[4], int normalize[4],
337 int numComp);
339 vtkIdType componentRange[3][2], char* arrays[3], int arrayComponents[3], int normalize[3]);
341 vtkIdType componentRange[2], char* array, int arrayComponent, int normalize);
343 vtkIdType componentRange[3][2], char* arrays[3], int arrayComponents[3], int normalize[3]);
345 vtkIdType componentRange[3][2], char* arrays[3], int arrayComponents[3], int normalize[3],
346 int numComp);
348 vtkIdType componentRange[9][2], char* arrays[9], int arrayComponents[9], int normalize[9]);
350
351private:
353 void operator=(const vtkFieldDataToAttributeDataFilter&) = delete;
354};
355
356#endif
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:159
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:164
a simple class to control print indentation
Definition: vtkIndent.h:113
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
abstract base class for most VTK objects
Definition: vtkObject.h:82
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)