VTK  9.1.0
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=========================================================================*/
94#ifndef vtkPointInterpolator_h
95#define vtkPointInterpolator_h
96
97#include "vtkDataSetAlgorithm.h"
98#include "vtkFiltersPointsModule.h" // For export macro
99#include "vtkStdString.h" // For vtkStdString ivars
100#include <vector> //For STL vector
101
103class vtkIdList;
104class vtkDoubleArray;
106class vtkCharArray;
107
108class VTKFILTERSPOINTS_EXPORT vtkPointInterpolator : public vtkDataSetAlgorithm
109{
110public:
112
118 void PrintSelf(ostream& os, vtkIndent indent) override;
120
122
132
140
142
148 vtkGetObjectMacro(Locator, vtkAbstractPointLocator);
150
152
158 vtkGetObjectMacro(Kernel, vtkInterpolationKernel);
160
162 {
163 MASK_POINTS = 0,
164 NULL_VALUE = 1,
165 CLOSEST_POINT = 2
166 };
167
169
180 vtkSetMacro(NullPointsStrategy, int);
181 vtkGetMacro(NullPointsStrategy, int);
182 void SetNullPointsStrategyToMaskPoints() { this->SetNullPointsStrategy(MASK_POINTS); }
183 void SetNullPointsStrategyToNullValue() { this->SetNullPointsStrategy(NULL_VALUE); }
184 void SetNullPointsStrategyToClosestPoint() { this->SetNullPointsStrategy(CLOSEST_POINT); }
186
188
194 vtkSetMacro(ValidPointsMaskArrayName, vtkStdString);
195 vtkGetMacro(ValidPointsMaskArrayName, vtkStdString);
197
199
204 vtkSetMacro(NullValue, double);
205 vtkGetMacro(NullValue, double);
207
209
213 void AddExcludedArray(const vtkStdString& excludedArray)
214 {
215 this->ExcludedArrays.push_back(excludedArray);
216 this->Modified();
217 }
219
221
225 {
226 this->ExcludedArrays.clear();
227 this->Modified();
228 }
230
234 int GetNumberOfExcludedArrays() { return static_cast<int>(this->ExcludedArrays.size()); }
235
237
240 const char* GetExcludedArray(int i)
241 {
242 if (i < 0 || i >= static_cast<int>(this->ExcludedArrays.size()))
243 {
244 return nullptr;
245 }
246 return this->ExcludedArrays[i].c_str();
247 }
249
251
257 vtkSetMacro(PromoteOutputArrays, bool);
258 vtkBooleanMacro(PromoteOutputArrays, bool);
259 vtkGetMacro(PromoteOutputArrays, bool);
261
263
267 vtkSetMacro(PassPointArrays, bool);
268 vtkBooleanMacro(PassPointArrays, bool);
269 vtkGetMacro(PassPointArrays, bool);
271
273
277 vtkSetMacro(PassCellArrays, bool);
278 vtkBooleanMacro(PassCellArrays, bool);
279 vtkGetMacro(PassCellArrays, bool);
281
283
287 vtkSetMacro(PassFieldArrays, bool);
288 vtkBooleanMacro(PassFieldArrays, bool);
289 vtkGetMacro(PassFieldArrays, bool);
291
296
297protected:
300
303
305 double NullValue;
308
309 std::vector<vtkStdString> ExcludedArrays;
310
312
316
320
324 virtual void Probe(vtkDataSet* input, vtkDataSet* source, vtkDataSet* output);
325
331
336 vtkImageData* input, int dims[3], double origin[3], double spacing[3]);
337
338private:
340 void operator=(const vtkPointInterpolator&) = delete;
341};
342
343#endif
abstract class to quickly locate points in 3-space
Proxy object to connect input/output ports.
dynamic, self-adjusting array of char
Definition: vtkCharArray.h:68
general representation of visualization data
Superclass for algorithms that produce output of the same type as input.
abstract class to specify dataset behavior
Definition: vtkDataSet.h:166
dynamic, self-adjusting array of double
list of point or cell ids
Definition: vtkIdList.h:140
topologically and geometrically regular array of data
Definition: vtkImageData.h:157
a simple class to control print indentation
Definition: vtkIndent.h:113
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.
interpolate over point cloud using various kernels
vtkCharArray * ValidPointsMask
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.
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.
Definition: vtkStdString.h:105
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287