VTK  9.3.0
vtkDataObjectToDataSetFilter.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
56 #ifndef vtkDataObjectToDataSetFilter_h
57 #define vtkDataObjectToDataSetFilter_h
58 
59 #include "vtkDataSetAlgorithm.h"
60 #include "vtkFiltersCoreModule.h" // For export macro
61 
62 VTK_ABI_NAMESPACE_BEGIN
63 class vtkCellArray;
64 class vtkDataArray;
65 class vtkDataSet;
66 class vtkPointSet;
67 class vtkPolyData;
68 class vtkRectilinearGrid;
69 class vtkStructuredGrid;
72 
73 class VTKFILTERSCORE_EXPORT vtkDataObjectToDataSetFilter : public vtkDataSetAlgorithm
74 {
75 public:
78  void PrintSelf(ostream& os, vtkIndent indent) override;
79 
84 
86 
89  void SetDataSetType(int);
90  vtkGetMacro(DataSetType, int);
91  void SetDataSetTypeToPolyData() { this->SetDataSetType(VTK_POLY_DATA); }
92  void SetDataSetTypeToStructuredPoints() { this->SetDataSetType(VTK_STRUCTURED_POINTS); }
93  void SetDataSetTypeToStructuredGrid() { this->SetDataSetType(VTK_STRUCTURED_GRID); }
94  void SetDataSetTypeToRectilinearGrid() { this->SetDataSetType(VTK_RECTILINEAR_GRID); }
95  void SetDataSetTypeToUnstructuredGrid() { this->SetDataSetType(VTK_UNSTRUCTURED_GRID); }
97 
99 
114 
116 
129  int comp, const char* arrayName, int arrayComp, int min, int max, int normalize);
130  void SetPointComponent(int comp, const char* arrayName, int arrayComp)
131  {
132  this->SetPointComponent(comp, arrayName, arrayComp, -1, -1, this->DefaultNormalize);
133  }
134  const char* GetPointComponentArrayName(int comp);
140 
142 
151  void SetVertsComponent(const char* arrayName, int arrayComp, int min, int max);
152  void SetVertsComponent(const char* arrayName, int arrayComp)
153  {
154  this->SetVertsComponent(arrayName, arrayComp, -1, -1);
155  }
160  void SetLinesComponent(const char* arrayName, int arrayComp, int min, int max);
161  void SetLinesComponent(const char* arrayName, int arrayComp)
162  {
163  this->SetLinesComponent(arrayName, arrayComp, -1, -1);
164  }
169  void SetPolysComponent(const char* arrayName, int arrayComp, int min, int max);
170  void SetPolysComponent(const char* arrayName, int arrayComp)
171  {
172  this->SetPolysComponent(arrayName, arrayComp, -1, -1);
173  }
178  void SetStripsComponent(const char* arrayName, int arrayComp, int min, int max);
179  void SetStripsComponent(const char* arrayName, int arrayComp)
180  {
181  this->SetStripsComponent(arrayName, arrayComp, -1, -1);
182  }
188 
190 
199  void SetCellTypeComponent(const char* arrayName, int arrayComp, int min, int max);
200  void SetCellTypeComponent(const char* arrayName, int arrayComp)
201  {
202  this->SetCellTypeComponent(arrayName, arrayComp, -1, -1);
203  }
208  void SetCellConnectivityComponent(const char* arrayName, int arrayComp, int min, int max);
209  void SetCellConnectivityComponent(const char* arrayName, int arrayComp)
210  {
211  this->SetCellConnectivityComponent(arrayName, arrayComp, -1, -1);
212  }
218 
220 
224  vtkSetMacro(DefaultNormalize, vtkTypeBool);
225  vtkGetMacro(DefaultNormalize, vtkTypeBool);
226  vtkBooleanMacro(DefaultNormalize, vtkTypeBool);
228 
230 
235  vtkSetVector3Macro(Dimensions, int);
236  vtkGetVectorMacro(Dimensions, int, 3);
238 
240 
244  vtkSetVector3Macro(Origin, double);
245  vtkGetVectorMacro(Origin, double, 3);
247 
249 
253  vtkSetVector3Macro(Spacing, double);
254  vtkGetVectorMacro(Spacing, double, 3);
256 
258 
264  void SetDimensionsComponent(const char* arrayName, int arrayComp, int min, int max);
265  void SetDimensionsComponent(const char* arrayName, int arrayComp)
266  {
267  this->SetDimensionsComponent(arrayName, arrayComp, -1, -1);
268  }
269  void SetSpacingComponent(const char* arrayName, int arrayComp, int min, int max);
270  void SetSpacingComponent(const char* arrayName, int arrayComp)
271  {
272  this->SetSpacingComponent(arrayName, arrayComp, -1, -1);
273  }
274  void SetOriginComponent(const char* arrayName, int arrayComp, int min, int max);
275  void SetOriginComponent(const char* arrayName, int arrayComp)
276  {
277  this->SetOriginComponent(arrayName, arrayComp, -1, -1);
278  }
280 
281 protected:
284 
286  vtkInformationVector*) override; // generate output data
291 
292  char Updating;
293 
294  // control flags used to generate the output dataset
295  int DataSetType; // the type of dataset to generate
296 
297  // Support definition of points
298  char* PointArrays[3]; // the name of the arrays
299  int PointArrayComponents[3]; // the array components used for x-y-z
300  vtkIdType PointComponentRange[3][2]; // the range of the components to use
301  int PointNormalize[3]; // flags control normalization
302 
303  // These define cells for vtkPolyData
304  char* VertsArray; // the name of the array
305  int VertsArrayComponent; // the array component
306  vtkIdType VertsComponentRange[2]; // the range of the components to use
307 
308  char* LinesArray; // the name of the array
309  int LinesArrayComponent; // the array component used for cell types
310  vtkIdType LinesComponentRange[2]; // the range of the components to use
311 
312  char* PolysArray; // the name of the array
313  int PolysArrayComponent; // the array component
314  vtkIdType PolysComponentRange[2]; // the range of the components to use
315 
316  char* StripsArray; // the name of the array
317  int StripsArrayComponent; // the array component
318  vtkIdType StripsComponentRange[2]; // the range of the components to use
319 
320  // Used to define vtkUnstructuredGrid datasets
321  char* CellTypeArray; // the name of the array
322  int CellTypeArrayComponent; // the array component used for cell types
323  vtkIdType CellTypeComponentRange[2]; // the range of the components to use
324 
325  char* CellConnectivityArray; // the name of the array
326  int CellConnectivityArrayComponent; // the array components used for cell connectivity
327  vtkIdType CellConnectivityComponentRange[2]; // the range of the components to use
328 
329  // helper methods (and attributes) to construct datasets
330  void SetArrayName(char*& name, char* newName);
335  vtkCellArray* ConstructCellArray(vtkDataArray* da, int comp, vtkIdType compRange[2]);
336 
337  // Default value for normalization
339 
340  // Couple of different ways to specify dimensions, spacing, and origin.
341  int Dimensions[3];
342  double Origin[3];
343  double Spacing[3];
344 
345  char* DimensionsArray; // the name of the array
346  int DimensionsArrayComponent; // the component of the array used for dimensions
347  vtkIdType DimensionsComponentRange[2]; // the ComponentRange of the array for the dimensions
348 
349  char* OriginArray; // the name of the array
350  int OriginArrayComponent; // the component of the array used for Origins
351  vtkIdType OriginComponentRange[2]; // the ComponentRange of the array for the Origins
352 
353  char* SpacingArray; // the name of the array
354  int SpacingArrayComponent; // the component of the array used for Spacings
355  vtkIdType SpacingComponentRange[2]; // the ComponentRange of the array for the Spacings
356 
360 
361 private:
363  void operator=(const vtkDataObjectToDataSetFilter&) = delete;
364 };
365 
366 VTK_ABI_NAMESPACE_END
367 #endif
object to represent cell connectivity
Definition: vtkCellArray.h:176
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:45
map field data to concrete dataset
void SetCellTypeComponent(const char *arrayName, int arrayComp, int min, int max)
Define cell types and cell connectivity when creating unstructured grid data.
int GetPointComponentMaxRange(int comp)
Define the component of the field to be used for the x, y, and z values of the points.
void SetLinesComponent(const char *arrayName, int arrayComp)
Define cell connectivity when creating vtkPolyData.
static vtkDataObjectToDataSetFilter * New()
void SetStripsComponent(const char *arrayName, int arrayComp)
Define cell connectivity when creating vtkPolyData.
void SetArrayName(char *&name, char *newName)
void SetCellConnectivityComponent(const char *arrayName, int arrayComp)
Define cell types and cell connectivity when creating unstructured grid data.
vtkRectilinearGrid * GetRectilinearGridOutput()
Get the output in different forms.
int GetCellConnectivityComponentMinRange()
Define cell types and cell connectivity when creating unstructured grid data.
const char * GetPointComponentArrayName(int comp)
Define the component of the field to be used for the x, y, and z values of the points.
void SetPointComponent(int comp, const char *arrayName, int arrayComp, int min, int max, int normalize)
Define the component of the field to be used for the x, y, and z values of the points.
int GetLinesComponentArrayComponent()
Define cell connectivity when creating vtkPolyData.
int GetPointComponentNormailzeFlag(int comp)
Define the component of the field to be used for the x, y, and z values of the points.
int GetCellConnectivityComponentMaxRange()
Define cell types and cell connectivity when creating unstructured grid data.
void SetOriginComponent(const char *arrayName, int arrayComp, int min, int max)
Alternative methods to specify the dimensions, spacing, and origin for those datasets requiring this ...
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when a request asks the algorithm to do its work.
void SetDataSetTypeToRectilinearGrid()
Control what type of data is generated for output.
int GetStripsComponentMinRange()
Define cell connectivity when creating vtkPolyData.
int GetStripsComponentArrayComponent()
Define cell connectivity when creating vtkPolyData.
const char * GetStripsComponentArrayName()
Define cell connectivity when creating vtkPolyData.
int GetPointComponentArrayComponent(int comp)
Define the component of the field to be used for the x, y, and z values of the points.
int ConstructCells(vtkDataObject *input, vtkPolyData *pd)
int RequestDataObject(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when a request asks the algorithm to create empty output data ob...
void SetSpacingComponent(const char *arrayName, int arrayComp)
Alternative methods to specify the dimensions, spacing, and origin for those datasets requiring this ...
void SetStripsComponent(const char *arrayName, int arrayComp, int min, int max)
Define cell connectivity when creating vtkPolyData.
int GetStripsComponentMaxRange()
Define cell connectivity when creating vtkPolyData.
int GetLinesComponentMinRange()
Define cell connectivity when creating vtkPolyData.
void SetDimensionsComponent(const char *arrayName, int arrayComp, int min, int max)
Alternative methods to specify the dimensions, spacing, and origin for those datasets requiring this ...
const char * GetCellTypeComponentArrayName()
Define cell types and cell connectivity when creating unstructured grid data.
void SetSpacingComponent(const char *arrayName, int arrayComp, int min, int max)
Alternative methods to specify the dimensions, spacing, and origin for those datasets requiring this ...
void SetDataSetTypeToUnstructuredGrid()
Control what type of data is generated for output.
void SetDataSetTypeToStructuredGrid()
Control what type of data is generated for output.
int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when a request asks for Information.
~vtkDataObjectToDataSetFilter() override
int RequestUpdateExtent(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when each filter in the pipeline decides what portion of its inp...
void SetDataSetTypeToStructuredPoints()
Control what type of data is generated for output.
void SetPointComponent(int comp, const char *arrayName, int arrayComp)
Define the component of the field to be used for the x, y, and z values of the points.
int GetPolysComponentArrayComponent()
Define cell connectivity when creating vtkPolyData.
vtkStructuredPoints * GetStructuredPointsOutput()
Get the output in different forms.
vtkDataSet * GetOutput(int idx)
Get the output in different forms.
vtkIdType ConstructPoints(vtkDataObject *input, vtkPointSet *ps)
vtkUnstructuredGrid * GetUnstructuredGridOutput()
Get the output in different forms.
vtkDataSet * GetOutput()
Get the output in different forms.
const char * GetVertsComponentArrayName()
Define cell connectivity when creating vtkPolyData.
void SetCellConnectivityComponent(const char *arrayName, int arrayComp, int min, int max)
Define cell types and cell connectivity when creating unstructured grid data.
void SetCellTypeComponent(const char *arrayName, int arrayComp)
Define cell types and cell connectivity when creating unstructured grid data.
int GetPointComponentMinRange(int comp)
Define the component of the field to be used for the x, y, and z values of the points.
const char * GetLinesComponentArrayName()
Define cell connectivity when creating vtkPolyData.
void ConstructOrigin(vtkDataObject *input)
void ConstructSpacing(vtkDataObject *input)
int GetCellTypeComponentArrayComponent()
Define cell types and cell connectivity when creating unstructured grid data.
int GetVertsComponentMinRange()
Define cell connectivity when creating vtkPolyData.
int GetCellTypeComponentMinRange()
Define cell types and cell connectivity when creating unstructured grid data.
vtkCellArray * ConstructCellArray(vtkDataArray *da, int comp, vtkIdType compRange[2])
void SetLinesComponent(const char *arrayName, int arrayComp, int min, int max)
Define cell connectivity when creating vtkPolyData.
int GetPolysComponentMaxRange()
Define cell connectivity when creating vtkPolyData.
int FillInputPortInformation(int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.
void SetDataSetTypeToPolyData()
Control what type of data is generated for output.
void SetVertsComponent(const char *arrayName, int arrayComp)
Define cell connectivity when creating vtkPolyData.
vtkDataObject * GetInput()
Get the input to the filter.
int ConstructCells(vtkDataObject *input, vtkUnstructuredGrid *ug)
const char * GetPolysComponentArrayName()
Define cell connectivity when creating vtkPolyData.
int GetLinesComponentMaxRange()
Define cell connectivity when creating vtkPolyData.
void SetPolysComponent(const char *arrayName, int arrayComp, int min, int max)
Define cell connectivity when creating vtkPolyData.
int GetPolysComponentMinRange()
Define cell connectivity when creating vtkPolyData.
void SetPolysComponent(const char *arrayName, int arrayComp)
Define cell connectivity when creating vtkPolyData.
vtkPolyData * GetPolyDataOutput()
Get the output in different forms.
void ConstructDimensions(vtkDataObject *input)
int GetCellTypeComponentMaxRange()
Define cell types and cell connectivity when creating unstructured grid data.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkIdType ConstructPoints(vtkDataObject *input, vtkRectilinearGrid *rg)
void SetOriginComponent(const char *arrayName, int arrayComp)
Alternative methods to specify the dimensions, spacing, and origin for those datasets requiring this ...
void SetVertsComponent(const char *arrayName, int arrayComp, int min, int max)
Define cell connectivity when creating vtkPolyData.
void SetDataSetType(int)
Control what type of data is generated for output.
int GetVertsComponentMaxRange()
Define cell connectivity when creating vtkPolyData.
int GetVertsComponentArrayComponent()
Define cell connectivity when creating vtkPolyData.
void SetDimensionsComponent(const char *arrayName, int arrayComp)
Alternative methods to specify the dimensions, spacing, and origin for those datasets requiring this ...
const char * GetCellConnectivityComponentArrayName()
Define cell types and cell connectivity when creating unstructured grid data.
int GetCellConnectivityComponentArrayComponent()
Define cell types and cell connectivity when creating unstructured grid data.
vtkStructuredGrid * GetStructuredGridOutput()
Get the output in different forms.
general representation of visualization data
Definition: vtkDataObject.h:55
Superclass for algorithms that produce output of the same type as input.
abstract class to specify dataset behavior
Definition: vtkDataSet.h:53
a simple class to control print indentation
Definition: vtkIndent.h:29
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
concrete class for storing a set of points
Definition: vtkPointSet.h:59
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:80
a dataset that is topologically regular with variable spacing in the three coordinate directions
topologically regular array of data
A subclass of ImageData.
dataset represents arbitrary combinations of all possible cell types
@ info
Definition: vtkX3D.h:376
@ port
Definition: vtkX3D.h:447
@ name
Definition: vtkX3D.h:219
int vtkTypeBool
Definition: vtkABI.h:64
int vtkIdType
Definition: vtkType.h:315
#define VTK_RECTILINEAR_GRID
Definition: vtkType.h:68
#define VTK_UNSTRUCTURED_GRID
Definition: vtkType.h:69
#define VTK_STRUCTURED_GRID
Definition: vtkType.h:67
#define VTK_POLY_DATA
Definition: vtkType.h:65
#define VTK_STRUCTURED_POINTS
Definition: vtkType.h:66
#define max(a, b)