VTK  9.3.0
vtkPointInterpolator.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 vtkPointInterpolator_h
57#define vtkPointInterpolator_h
58
59#include "vtkDataSetAlgorithm.h"
60#include "vtkFiltersPointsModule.h" // For export macro
61#include "vtkStdString.h" // For vtkStdString ivars
62#include <vector> //For STL vector
63
64VTK_ABI_NAMESPACE_BEGIN
66class vtkIdList;
67class vtkDoubleArray;
69class vtkCharArray;
70
71class VTKFILTERSPOINTS_EXPORT vtkPointInterpolator : public vtkDataSetAlgorithm
72{
73public:
75
81 void PrintSelf(ostream& os, vtkIndent indent) override;
83
85
95
103
105
111 vtkGetObjectMacro(Locator, vtkAbstractPointLocator);
113
115
121 vtkGetObjectMacro(Kernel, vtkInterpolationKernel);
123
125 {
126 MASK_POINTS = 0,
127 NULL_VALUE = 1,
128 CLOSEST_POINT = 2
129 };
130
132
143 vtkSetMacro(NullPointsStrategy, int);
144 vtkGetMacro(NullPointsStrategy, int);
145 void SetNullPointsStrategyToMaskPoints() { this->SetNullPointsStrategy(MASK_POINTS); }
146 void SetNullPointsStrategyToNullValue() { this->SetNullPointsStrategy(NULL_VALUE); }
147 void SetNullPointsStrategyToClosestPoint() { this->SetNullPointsStrategy(CLOSEST_POINT); }
149
151
157 vtkSetMacro(ValidPointsMaskArrayName, vtkStdString);
158 vtkGetMacro(ValidPointsMaskArrayName, vtkStdString);
160
162
167 vtkSetMacro(NullValue, double);
168 vtkGetMacro(NullValue, double);
170
172
176 void AddExcludedArray(const vtkStdString& excludedArray)
177 {
178 this->ExcludedArrays.push_back(excludedArray);
179 this->Modified();
180 }
182
184
188 {
189 this->ExcludedArrays.clear();
190 this->Modified();
191 }
193
197 int GetNumberOfExcludedArrays() { return static_cast<int>(this->ExcludedArrays.size()); }
198
200
203 const char* GetExcludedArray(int i)
204 {
205 if (i < 0 || i >= static_cast<int>(this->ExcludedArrays.size()))
206 {
207 return nullptr;
208 }
209 return this->ExcludedArrays[i].c_str();
210 }
212
214
220 vtkSetMacro(PromoteOutputArrays, bool);
221 vtkBooleanMacro(PromoteOutputArrays, bool);
222 vtkGetMacro(PromoteOutputArrays, bool);
224
226
230 vtkSetMacro(PassPointArrays, bool);
231 vtkBooleanMacro(PassPointArrays, bool);
232 vtkGetMacro(PassPointArrays, bool);
234
236
240 vtkSetMacro(PassCellArrays, bool);
241 vtkBooleanMacro(PassCellArrays, bool);
242 vtkGetMacro(PassCellArrays, bool);
244
246
250 vtkSetMacro(PassFieldArrays, bool);
251 vtkBooleanMacro(PassFieldArrays, bool);
252 vtkGetMacro(PassFieldArrays, bool);
254
259
260protected:
263
266
268 double NullValue;
271
272 std::vector<vtkStdString> ExcludedArrays;
273
275
279
283
287 virtual void Probe(vtkDataSet* input, vtkDataSet* source, vtkDataSet* output);
288
294
299 vtkImageData* input, int dims[3], double origin[3], double spacing[3]);
300
301private:
303 void operator=(const vtkPointInterpolator&) = delete;
304};
305
306VTK_ABI_NAMESPACE_END
307#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
Superclass for algorithms that produce output of the same type as input.
abstract class to specify dataset behavior
Definition vtkDataSet.h:53
dynamic, self-adjusting array of double
list of point or cell ids
Definition vtkIdList.h:23
topologically and geometrically regular array of data
a simple class to control print indentation
Definition vtkIndent.h:29
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
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.
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:270