VTK  9.2.6
vtkPointInterpolator.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkPointInterpolator.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=========================================================================*/
64
65#ifndef vtkPointInterpolator_h
66#define vtkPointInterpolator_h
67
68#include "vtkDataSetAlgorithm.h"
69#include "vtkFiltersPointsModule.h" // For export macro
70#include "vtkStdString.h" // For vtkStdString ivars
71#include <vector> //For STL vector
72
74class vtkIdList;
75class vtkDoubleArray;
77class vtkCharArray;
78
79class VTKFILTERSPOINTS_EXPORT vtkPointInterpolator : public vtkDataSetAlgorithm
80{
81public:
83
89 void PrintSelf(ostream& os, vtkIndent indent) override;
91
93
103
111
113
119 vtkGetObjectMacro(Locator, vtkAbstractPointLocator);
121
123
129 vtkGetObjectMacro(Kernel, vtkInterpolationKernel);
131
138
140
151 vtkSetMacro(NullPointsStrategy, int);
152 vtkGetMacro(NullPointsStrategy, int);
157
159
168
170
175 vtkSetMacro(NullValue, double);
176 vtkGetMacro(NullValue, double);
178
180
184 void AddExcludedArray(const vtkStdString& excludedArray)
185 {
186 this->ExcludedArrays.push_back(excludedArray);
187 this->Modified();
188 }
189
190
192
196 {
197 this->ExcludedArrays.clear();
198 this->Modified();
199 }
200
201
205 int GetNumberOfExcludedArrays() { return static_cast<int>(this->ExcludedArrays.size()); }
206
208
211 const char* GetExcludedArray(int i)
212 {
213 if (i < 0 || i >= static_cast<int>(this->ExcludedArrays.size()))
214 {
215 return nullptr;
216 }
217 return this->ExcludedArrays[i].c_str();
218 }
219
220
222
228 vtkSetMacro(PromoteOutputArrays, bool);
229 vtkBooleanMacro(PromoteOutputArrays, bool);
230 vtkGetMacro(PromoteOutputArrays, bool);
232
234
238 vtkSetMacro(PassPointArrays, bool);
239 vtkBooleanMacro(PassPointArrays, bool);
240 vtkGetMacro(PassPointArrays, bool);
242
244
248 vtkSetMacro(PassCellArrays, bool);
249 vtkBooleanMacro(PassCellArrays, bool);
250 vtkGetMacro(PassCellArrays, bool);
252
254
258 vtkSetMacro(PassFieldArrays, bool);
259 vtkBooleanMacro(PassFieldArrays, bool);
260 vtkGetMacro(PassFieldArrays, bool);
262
267
268protected:
271
274
276 double NullValue;
279
280 std::vector<vtkStdString> ExcludedArrays;
281
283
287
291
295 virtual void Probe(vtkDataSet* input, vtkDataSet* source, vtkDataSet* output);
296
302
307 vtkImageData* input, int dims[3], double origin[3], double spacing[3]);
308
309private:
311 void operator=(const vtkPointInterpolator&) = delete;
312};
313
314#endif
abstract class to quickly locate points in 3-space
Proxy object to connect input/output ports.
dynamic, self-adjusting array of char
general representation of visualization data
abstract class to specify dataset behavior
Definition vtkDataSet.h:57
dynamic, self-adjusting array of double
list of point or cell ids
Definition vtkIdList.h:31
topologically and geometrically regular array of data
a simple class to control print indentation
Definition vtkIndent.h:34
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
base class for interpolation kernels
virtual void Modified()
Update the modification time for this object.
vtkInterpolationKernel * Kernel
int GetNumberOfExcludedArrays()
Return the number of excluded arrays.
std::vector< vtkStdString > ExcludedArrays
void SetNullPointsStrategyToNullValue()
Specify a strategy to use when encountering a "null" point during the interpolation process.
virtual void SetNullPointsStrategy(int)
Specify a strategy to use when encountering a "null" point during the interpolation process.
void AddExcludedArray(const vtkStdString &excludedArray)
Adds an array to the list of arrays which are to be excluded from the interpolation process.
vtkStdString ValidPointsMaskArrayName
void SetSourceData(vtkDataObject *source)
Specify the dataset Pc that will be probed by the input points P.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for instantiating, obtaining type information, and printing.
vtkDataObject * GetSource()
Specify the dataset Pc that will be probed by the input points P.
virtual void PassAttributeData(vtkDataSet *input, vtkDataObject *source, vtkDataSet *output)
Call at end of RequestData() to pass attribute data respecting the PassCellArrays,...
void SetSourceConnection(vtkAlgorithmOutput *algOutput)
Specify the dataset Pc that will be probed by the input points P.
static vtkPointInterpolator * New()
Standard methods for instantiating, obtaining type information, and printing.
int RequestUpdateExtent(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when each filter in the pipeline decides what portion of its inp...
virtual void Probe(vtkDataSet *input, vtkDataSet *source, vtkDataSet *output)
Virtual for specialized subclass(es)
void SetNullPointsStrategyToClosestPoint()
Specify a strategy to use when encountering a "null" point during the interpolation process.
vtkAbstractPointLocator * Locator
void SetKernel(vtkInterpolationKernel *kernel)
Specify an interpolation kernel.
void ExtractImageDescription(vtkImageData *input, int dims[3], double origin[3], double spacing[3])
Internal method to extract image metadata.
~vtkPointInterpolator() override
void ClearExcludedArrays()
Clears the contents of excluded array list.
void SetNullPointsStrategyToMaskPoints()
Specify a strategy to use when encountering a "null" point during the interpolation process.
const char * GetExcludedArray(int i)
Return the name of the ith excluded array.
vtkMTimeType GetMTime() override
Get the MTime of this object also considering the locator and kernel.
int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when a request asks for Information.
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when a request asks the algorithm to do its work.
void SetLocator(vtkAbstractPointLocator *locator)
Specify a point locator.
Wrapper around std::string to keep symbols short.
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:287