VTK
vtkPointDensityFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPointDensityFilter.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 =========================================================================*/
77 #ifndef vtkPointDensityFilter_h
78 #define vtkPointDensityFilter_h
79 
80 #include "vtkFiltersPointsModule.h" // For export macro
81 #include "vtkImageAlgorithm.h"
82 
83 #define VTK_DENSITY_ESTIMATE_FIXED_RADIUS 0
84 #define VTK_DENSITY_ESTIMATE_RELATIVE_RADIUS 1
85 
86 #define VTK_DENSITY_FORM_VOLUME_NORM 0
87 #define VTK_DENSITY_FORM_NPTS 1
88 
90 
91 class VTKFILTERSPOINTS_EXPORT vtkPointDensityFilter : public vtkImageAlgorithm
92 {
93 public:
95 
99  static vtkPointDensityFilter *New();
101  void PrintSelf(ostream& os, vtkIndent indent) override;
103 
105 
111  void SetSampleDimensions(int i, int j, int k);
112  void SetSampleDimensions(int dim[3]);
113  vtkGetVectorMacro(SampleDimensions,int,3);
115 
117 
123  vtkSetVector6Macro(ModelBounds,double);
124  vtkGetVectorMacro(ModelBounds,double,6);
126 
128 
134  vtkSetClampMacro(AdjustDistance,double,-1.0,1.0);
135  vtkGetMacro(AdjustDistance,double);
137 
139 
144  vtkSetClampMacro(DensityEstimate,int, VTK_DENSITY_ESTIMATE_FIXED_RADIUS,
146  vtkGetMacro(DensityEstimate,int);
148  {this->SetDensityEstimate(VTK_DENSITY_ESTIMATE_FIXED_RADIUS);}
150  {this->SetDensityEstimate(VTK_DENSITY_ESTIMATE_RELATIVE_RADIUS);}
151  const char *GetDensityEstimateAsString();
153 
155 
160  vtkSetClampMacro(DensityForm,int, VTK_DENSITY_FORM_VOLUME_NORM,
162  vtkGetMacro(DensityForm,int);
164  {this->SetDensityForm(VTK_DENSITY_FORM_VOLUME_NORM);}
166  {this->SetDensityForm(VTK_DENSITY_FORM_NPTS);}
167  const char *GetDensityFormAsString();
169 
171 
176  vtkSetClampMacro(Radius,double,0.0,VTK_DOUBLE_MAX);
177  vtkGetMacro(Radius,double);
179 
181 
188  vtkSetClampMacro(RelativeRadius,double,0.0,VTK_DOUBLE_MAX);
189  vtkGetMacro(RelativeRadius,double);
191 
193 
197  vtkSetMacro(ScalarWeighting,bool);
198  vtkGetMacro(ScalarWeighting,bool);
199  vtkBooleanMacro(ScalarWeighting,bool);
201 
203 
210  vtkSetMacro(ComputeGradient,bool);
211  vtkGetMacro(ComputeGradient,bool);
212  vtkBooleanMacro(ComputeGradient,bool);
214 
216 
221  void SetLocator(vtkAbstractPointLocator *locator);
222  vtkGetObjectMacro(Locator,vtkAbstractPointLocator);
224 
232  {
233  ZERO=0,
234  NON_ZERO=1
235  };
236 
237 protected:
239  ~vtkPointDensityFilter() override;
240 
241  int SampleDimensions[3]; // dimensions of volume over which to estimate density
242  double ModelBounds[6]; // bounding box of splatting dimensions
243  double AdjustDistance; // how much to pad the model bounds if automatically computed
244  double Origin[3], Spacing[3]; // output geometry
245  int DensityEstimate; // how to compute the density
246  int DensityForm; // how to represent density value
247  double RelativeRadius; // Radius factor for estimating density
248  double Radius; // Actually radius used
249  bool ScalarWeighting; // Are point densities weighted or not?
250  bool ComputeGradient; // Compute the gradient vector and magnitude
251  vtkAbstractPointLocator *Locator; //accelerate point searches
252 
253  int FillInputPortInformation(int port, vtkInformation* info) override;
256  vtkInformationVector *) override;
259  vtkInformationVector *) override;
260 
261  void ComputeModelBounds(vtkDataSet *input, vtkImageData *output,
262  vtkInformation *outInfo);
263 
264 private:
266  void operator=(const vtkPointDensityFilter&) = delete;
267 };
268 
269 #endif
#define VTK_DOUBLE_MAX
Definition: vtkType.h:169
Store vtkAlgorithm input/output information.
FunctionClass
This enum is used to classify the behavior of the function gradient.
abstract class to specify dataset behavior
Definition: vtkDataSet.h:56
#define VTK_DENSITY_FORM_NPTS
#define VTK_DENSITY_ESTIMATE_RELATIVE_RADIUS
void SetDensityEstimateToRelativeRadius()
Specify the method to estimate point density.
a simple class to control print indentation
Definition: vtkIndent.h:33
abstract class to quickly locate points in 3-space
topologically and geometrically regular array of data
Definition: vtkImageData.h:39
virtual int RequestInformation(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
Subclasses can reimplement this method to collect information from their inputs and set information f...
void SetDensityFormToVolumeNormalized()
Specify the form by which the density is expressed.
#define VTK_DENSITY_FORM_VOLUME_NORM
void SetDensityEstimateToFixedRadius()
Specify the method to estimate point density.
void SetDensityFormToNumberOfPoints()
Specify the form by which the density is expressed.
int FillInputPortInformation(int port, vtkInformation *info) override
These method should be reimplemented by subclasses that have more than a single input or single outpu...
Generic algorithm superclass for image algs.
#define VTK_DENSITY_ESTIMATE_FIXED_RADIUS
Store zero or more vtkInformation instances.
static vtkAlgorithm * New()
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
This is called in response to a REQUEST_DATA request from the executive.
produce density field from input point cloud
vtkAbstractPointLocator * Locator