VTK: Filters/Core/vtkResampleWithDataSet.h Source File

| VTK 9.3.1

vtkResampleWithDataSet.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
21 #ifndef vtkResampleWithDataSet_h
22 #define vtkResampleWithDataSet_h
23
24 #include "vtkFiltersCoreModule.h" // For export macro
25 #include "vtkNew.h" // For vtkCompositeDataProbeFilter member variable
26 #include "vtkPassInputTypeAlgorithm.h"
27
28 VTK_ABI_NAMESPACE_BEGIN
29 class vtkAbstractCellLocator;
30 class vtkCompositeDataProbeFilter;
31 class vtkDataSet;
32
33 class VTKFILTERSCORE_EXPORT vtkResampleWithDataSet : public vtkPassInputTypeAlgorithm
34 {
35 public:
36 vtkTypeMacro(vtkResampleWithDataSet, vtkPassInputTypeAlgorithm);
37 void PrintSelf(ostream& os, vtkIndent indent) override;
38
39 static vtkResampleWithDataSet* New();
40
47 void SetSourceData(vtkDataObject* source);
48
55 void SetSourceConnection(vtkAlgorithmOutput* algOutput);
56
58
63 void SetCategoricalData(bool arg);
64 bool GetCategoricalData();
66
68
72 void SetPassCellArrays(bool arg);
73 bool GetPassCellArrays();
74 vtkBooleanMacro(PassCellArrays, bool);
76
78
82 void SetPassPointArrays(bool arg);
83 bool GetPassPointArrays();
84 vtkBooleanMacro(PassPointArrays, bool);
86
88
92 void SetPassFieldArrays(bool arg);
93 bool GetPassFieldArrays();
94 vtkBooleanMacro(PassFieldArrays, bool);
96
98
110 void SetPassPartialArrays(bool arg);
111 bool GetPassPartialArrays();
112 vtkBooleanMacro(PassPartialArrays, bool);
114
116
121 void SetTolerance(double arg);
122 double GetTolerance();
124
126
131 void SetComputeTolerance(bool arg);
132 bool GetComputeTolerance();
133 vtkBooleanMacro(ComputeTolerance, bool);
135
137
141 vtkSetMacro(MarkBlankPointsAndCells, bool);
142 vtkGetMacro(MarkBlankPointsAndCells, bool);
143 vtkBooleanMacro(MarkBlankPointsAndCells, bool);
145
147
155 void SetSnapToCellWithClosestPoint(bool arg);
156 bool GetSnapToCellWithClosestPoint();
157 vtkBooleanMacro(SnapToCellWithClosestPoint, bool);
159
161 /*
162 * Set/Get the prototype cell locator to use for probing the source dataset.
163 * The value is forwarded to the underlying probe filter.
164 */
165 virtual void SetCellLocatorPrototype(vtkAbstractCellLocator*);
166 virtual vtkAbstractCellLocator* GetCellLocatorPrototype() const;
168
169 vtkMTimeType GetMTime() override;
170
171 protected:
172 vtkResampleWithDataSet();
173 ~vtkResampleWithDataSet() override;
174
175 // Usual data generation method
176 int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
177 int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
178 int RequestUpdateExtent(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
179 int FillInputPortInformation(int, vtkInformation*) override;
180 int FillOutputPortInformation(int, vtkInformation*) override;
181
185 const char* GetMaskArrayName() const;
186
190 void SetBlankPointsAndCells(vtkDataSet* data);
191
192 vtkNew<vtkCompositeDataProbeFilter> Prober;
193 bool MarkBlankPointsAndCells;
194
195 private:
196 vtkResampleWithDataSet(const vtkResampleWithDataSet&) = delete;
197 void operator=(const vtkResampleWithDataSet&) = delete;
198 };
199
200 VTK_ABI_NAMESPACE_END
201 #endif // vtkResampleWithDataSet_h
vtkAbstractCellLocator
an abstract base class for locators which find cells
Definition: vtkAbstractCellLocator.h:46
vtkAlgorithmOutput
Proxy object to connect input/output ports.
Definition: vtkAlgorithmOutput.h:41
vtkCompositeDataProbeFilter
subclass of vtkProbeFilter which supports composite datasets in the input.
Definition: vtkCompositeDataProbeFilter.h:47
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:64
vtkDataSet
abstract class to specify dataset behavior
Definition: vtkDataSet.h:62
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:38
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:40
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:72
vtkNew< vtkCompositeDataProbeFilter >
vtkPassInputTypeAlgorithm
Superclass for algorithms that produce output of the same type as input.
Definition: vtkPassInputTypeAlgorithm.h:45
vtkResampleWithDataSet
sample point and cell data of a dataset on points from another dataset.
Definition: vtkResampleWithDataSet.h:34
vtkResampleWithDataSet::SetBlankPointsAndCells
void SetBlankPointsAndCells(vtkDataSet *data)
Mark invalid points and cells of output DataSet as hidden.
vtkResampleWithDataSet::SetPassFieldArrays
void SetPassFieldArrays(bool arg)
Set whether to pass the field-data arrays from the Input i.e.
vtkResampleWithDataSet::GetPassPointArrays
bool GetPassPointArrays()
Shallow copy the input point data arrays to the output Off by default.
vtkResampleWithDataSet::SetSnapToCellWithClosestPoint
void SetSnapToCellWithClosestPoint(bool arg)
Set/Get whether to snap to the cell with the closest point, if no cell has been found while FindCell ...
vtkResampleWithDataSet::GetCellLocatorPrototype
virtual vtkAbstractCellLocator * GetCellLocatorPrototype() const
vtkResampleWithDataSet::SetPassPartialArrays
void SetPassPartialArrays(bool arg)
When sampling from composite datasets, partial arrays are common i.e.
vtkResampleWithDataSet::RequestData
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when a request asks the algorithm to do its work.
vtkResampleWithDataSet::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkResampleWithDataSet::GetMaskArrayName
const char * GetMaskArrayName() const
Get the name of the valid-points mask array.
vtkResampleWithDataSet::GetCategoricalData
bool GetCategoricalData()
Control whether the source point data is to be treated as categorical.
vtkResampleWithDataSet::GetTolerance
double GetTolerance()
Set the tolerance used to compute whether a point in the source is in a cell of the input.
vtkResampleWithDataSet::GetPassFieldArrays
bool GetPassFieldArrays()
Set whether to pass the field-data arrays from the Input i.e.
vtkResampleWithDataSet::GetSnapToCellWithClosestPoint
bool GetSnapToCellWithClosestPoint()
Set/Get whether to snap to the cell with the closest point, if no cell has been found while FindCell ...
vtkResampleWithDataSet::FillOutputPortInformation
int FillOutputPortInformation(int, vtkInformation *) override
Fill the output port information objects for this algorithm.
vtkResampleWithDataSet::SetCategoricalData
void SetCategoricalData(bool arg)
Control whether the source point data is to be treated as categorical.
vtkResampleWithDataSet::~vtkResampleWithDataSet
~vtkResampleWithDataSet() override
vtkResampleWithDataSet::SetTolerance
void SetTolerance(double arg)
Set the tolerance used to compute whether a point in the source is in a cell of the input.
vtkResampleWithDataSet::GetComputeTolerance
bool GetComputeTolerance()
Set whether to use the Tolerance field or precompute the tolerance.
vtkResampleWithDataSet::SetSourceConnection
void SetSourceConnection(vtkAlgorithmOutput *algOutput)
Specify the data set that will be probed at the input points.
vtkResampleWithDataSet::SetPassCellArrays
void SetPassCellArrays(bool arg)
Shallow copy the input cell data arrays to the output.
vtkResampleWithDataSet::GetPassPartialArrays
bool GetPassPartialArrays()
When sampling from composite datasets, partial arrays are common i.e.
vtkResampleWithDataSet::FillInputPortInformation
int FillInputPortInformation(int, vtkInformation *) override
Fill the input port information objects for this algorithm.
vtkResampleWithDataSet::New
static vtkResampleWithDataSet * New()
vtkResampleWithDataSet::SetSourceData
void SetSourceData(vtkDataObject *source)
Specify the data set that will be probed at the input points.
vtkResampleWithDataSet::MarkBlankPointsAndCells
bool MarkBlankPointsAndCells
Definition: vtkResampleWithDataSet.h:193
vtkResampleWithDataSet::Prober
vtkNew< vtkCompositeDataProbeFilter > Prober
Definition: vtkResampleWithDataSet.h:192
vtkResampleWithDataSet::RequestUpdateExtent
int RequestUpdateExtent(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when each filter in the pipeline decides what portion of its inp...
vtkResampleWithDataSet::RequestInformation
int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when a request asks for Information.
vtkResampleWithDataSet::SetCellLocatorPrototype
virtual void SetCellLocatorPrototype(vtkAbstractCellLocator *)
vtkResampleWithDataSet::SetComputeTolerance
void SetComputeTolerance(bool arg)
Set whether to use the Tolerance field or precompute the tolerance.
vtkResampleWithDataSet::GetMTime
vtkMTimeType GetMTime() override
Return this object's modified time.
vtkResampleWithDataSet::vtkResampleWithDataSet
vtkResampleWithDataSet()
vtkResampleWithDataSet::GetPassCellArrays
bool GetPassCellArrays()
Shallow copy the input cell data arrays to the output.
vtkResampleWithDataSet::SetPassPointArrays
void SetPassPointArrays(bool arg)
Shallow copy the input point data arrays to the output Off by default.
vtkX3D::data
@ data
Definition: vtkX3D.h:315
source
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
Definition: vtkBoostGraphAdapter.h:964
vtkNew.h
vtkPassInputTypeAlgorithm.h
vtkMTimeType
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:270