VTK  9.3.20240304
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
27 
28 VTK_ABI_NAMESPACE_BEGIN
31 class vtkDataSet;
32 
33 class VTKFILTERSCORE_EXPORT vtkResampleWithDataSet : public vtkPassInputTypeAlgorithm
34 {
35 public:
37  void PrintSelf(ostream& os, vtkIndent indent) override;
38 
40 
48 
56 
58 
63  void SetCategoricalData(bool arg);
66 
68 
72  void SetPassCellArrays(bool arg);
74  vtkBooleanMacro(PassCellArrays, bool);
76 
78 
82  void SetPassPointArrays(bool arg);
84  vtkBooleanMacro(PassPointArrays, bool);
86 
88 
92  void SetPassFieldArrays(bool arg);
94  vtkBooleanMacro(PassFieldArrays, bool);
96 
98 
110  void SetPassPartialArrays(bool arg);
112  vtkBooleanMacro(PassPartialArrays, bool);
114 
116 
121  void SetTolerance(double arg);
122  double GetTolerance();
124 
126 
131  void SetComputeTolerance(bool arg);
133  vtkBooleanMacro(ComputeTolerance, bool);
135 
137 
141  vtkSetMacro(MarkBlankPointsAndCells, bool);
142  vtkGetMacro(MarkBlankPointsAndCells, bool);
143  vtkBooleanMacro(MarkBlankPointsAndCells, bool);
145 
147 
157  vtkBooleanMacro(SnapToCellWithClosestPoint, bool);
159 
161 
173  void SetUseImplicitArrays(bool arg);
175  vtkBooleanMacro(UseImplicitArrays, bool);
177 
179  /*
180  * Set/Get the prototype cell locator to use for probing the source dataset.
181  * The value is forwarded to the underlying probe filter.
182  */
186 
187  vtkMTimeType GetMTime() override;
188 
189 protected:
192 
193  // Usual data generation method
199 
203  const char* GetMaskArrayName() const;
204 
209 
212 
213 private:
215  void operator=(const vtkResampleWithDataSet&) = delete;
216 };
217 
218 VTK_ABI_NAMESPACE_END
219 #endif // vtkResampleWithDataSet_h
an abstract base class for locators which find cells
Proxy object to connect input/output ports.
subclass of vtkProbeFilter which supports composite datasets in the input.
general representation of visualization data
abstract class to specify dataset behavior
Definition: vtkDataSet.h:165
a simple class to control print indentation
Definition: vtkIndent.h:108
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Superclass for algorithms that produce output of the same type as input.
sample point and cell data of a dataset on points from another dataset.
void SetBlankPointsAndCells(vtkDataSet *data)
Mark invalid points and cells of output DataSet as hidden.
void SetPassFieldArrays(bool arg)
Set whether to pass the field-data arrays from the Input i.e.
bool GetPassPointArrays()
Shallow copy the input point data arrays to the output Off by default.
void SetSnapToCellWithClosestPoint(bool arg)
Set/Get whether to snap to the cell with the closest point, if no cell has been found while FindCell ...
virtual vtkAbstractCellLocator * GetCellLocatorPrototype() const
void SetPassPartialArrays(bool arg)
When sampling from composite datasets, partial arrays are common i.e.
void SetUseImplicitArrays(bool arg)
Get/Set wether or not the filter should use implicit arrays.
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when a request asks the algorithm to do its work.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
const char * GetMaskArrayName() const
Get the name of the valid-points mask array.
bool GetCategoricalData()
Control whether the source point data is to be treated as categorical.
double GetTolerance()
Set the tolerance used to compute whether a point in the source is in a cell of the input.
bool GetPassFieldArrays()
Set whether to pass the field-data arrays from the Input i.e.
bool GetSnapToCellWithClosestPoint()
Set/Get whether to snap to the cell with the closest point, if no cell has been found while FindCell ...
int FillOutputPortInformation(int, vtkInformation *) override
Fill the output port information objects for this algorithm.
void SetCategoricalData(bool arg)
Control whether the source point data is to be treated as categorical.
~vtkResampleWithDataSet() override
void SetTolerance(double arg)
Set the tolerance used to compute whether a point in the source is in a cell of the input.
bool GetComputeTolerance()
Set whether to use the Tolerance field or precompute the tolerance.
void SetSourceConnection(vtkAlgorithmOutput *algOutput)
Specify the data set that will be probed at the input points.
void SetPassCellArrays(bool arg)
Shallow copy the input cell data arrays to the output.
bool GetPassPartialArrays()
When sampling from composite datasets, partial arrays are common i.e.
int FillInputPortInformation(int, vtkInformation *) override
Fill the input port information objects for this algorithm.
static vtkResampleWithDataSet * New()
void SetSourceData(vtkDataObject *source)
Specify the data set that will be probed at the input points.
vtkNew< vtkCompositeDataProbeFilter > Prober
bool GetUseImplicitArrays()
Get/Set wether or not the filter should use implicit arrays.
int RequestUpdateExtent(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when each filter in the pipeline decides what portion of its inp...
int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called within ProcessRequest when a request asks for Information.
virtual void SetCellLocatorPrototype(vtkAbstractCellLocator *)
void SetComputeTolerance(bool arg)
Set whether to use the Tolerance field or precompute the tolerance.
vtkMTimeType GetMTime() override
Return this object's modified time.
bool GetPassCellArrays()
Shallow copy the input cell data arrays to the output.
void SetPassPointArrays(bool arg)
Shallow copy the input point data arrays to the output Off by default.
@ data
Definition: vtkX3D.h:315
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:270