VTK  9.2.20230320
vtkResampleWithDataSet.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkResampleWithDataSet.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 =========================================================================*/
33 #ifndef vtkResampleWithDataSet_h
34 #define vtkResampleWithDataSet_h
35 
36 #include "vtkFiltersCoreModule.h" // For export macro
37 #include "vtkNew.h" // For vtkCompositeDataProbeFilter member variable
39 
40 VTK_ABI_NAMESPACE_BEGIN
43 class vtkDataSet;
44 
45 class VTKFILTERSCORE_EXPORT vtkResampleWithDataSet : public vtkPassInputTypeAlgorithm
46 {
47 public:
49  void PrintSelf(ostream& os, vtkIndent indent) override;
50 
52 
60 
68 
70 
75  void SetCategoricalData(bool arg);
78 
80 
84  void SetPassCellArrays(bool arg);
86  vtkBooleanMacro(PassCellArrays, bool);
88 
90 
94  void SetPassPointArrays(bool arg);
96  vtkBooleanMacro(PassPointArrays, bool);
98 
100 
104  void SetPassFieldArrays(bool arg);
106  vtkBooleanMacro(PassFieldArrays, bool);
108 
110 
122  void SetPassPartialArrays(bool arg);
124  vtkBooleanMacro(PassPartialArrays, bool);
126 
128 
133  void SetTolerance(double arg);
134  double GetTolerance();
136 
138 
143  void SetComputeTolerance(bool arg);
145  vtkBooleanMacro(ComputeTolerance, bool);
147 
149 
153  vtkSetMacro(MarkBlankPointsAndCells, bool);
154  vtkGetMacro(MarkBlankPointsAndCells, bool);
155  vtkBooleanMacro(MarkBlankPointsAndCells, bool);
157 
159 
169  vtkBooleanMacro(SnapToCellWithClosestPoint, bool);
171 
173  /*
174  * Set/Get the prototype cell locator to use for probing the source dataset.
175  * The value is forwarded to the underlying probe filter.
176  */
180 
181  vtkMTimeType GetMTime() override;
182 
183 protected:
186 
187  // Usual data generation method
193 
197  const char* GetMaskArrayName() const;
198 
203 
206 
207 private:
209  void operator=(const vtkResampleWithDataSet&) = delete;
210 };
211 
212 VTK_ABI_NAMESPACE_END
213 #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:174
a simple class to control print indentation
Definition: vtkIndent.h:120
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.
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
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:327
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:282