vtkPointDensityFilter.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkPointDensityFilter.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkPointDensityFilter_h
#define vtkPointDensityFilter_h

#include "vtkFiltersPointsModule.h" // For export macro
#include "vtkImageAlgorithm.h"

#define VTK_DENSITY_ESTIMATE_FIXED_RADIUS 0
#define VTK_DENSITY_ESTIMATE_RELATIVE_RADIUS 1

#define VTK_DENSITY_FORM_VOLUME_NORM 0
#define VTK_DENSITY_FORM_NPTS 1

class vtkAbstractPointLocator;

class VTKFILTERSPOINTS_EXPORT vtkPointDensityFilter : public vtkImageAlgorithm
{
public:

  static vtkPointDensityFilter *New();
  vtkTypeMacro(vtkPointDensityFilter,vtkImageAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  void SetSampleDimensions(int i, int j, int k);
  void SetSampleDimensions(int dim[3]);
  vtkGetVectorMacro(SampleDimensions,int,3);


  vtkSetVector6Macro(ModelBounds,double);
  vtkGetVectorMacro(ModelBounds,double,6);


  vtkSetClampMacro(AdjustDistance,double,-1.0,1.0);
  vtkGetMacro(AdjustDistance,double);


  vtkSetClampMacro(DensityEstimate,int, VTK_DENSITY_ESTIMATE_FIXED_RADIUS,
                   VTK_DENSITY_ESTIMATE_RELATIVE_RADIUS);
  vtkGetMacro(DensityEstimate,int);
  void SetDensityEstimateToFixedRadius()
    {this->SetDensityEstimate(VTK_DENSITY_ESTIMATE_FIXED_RADIUS);}
  void SetDensityEstimateToRelativeRadius()
    {this->SetDensityEstimate(VTK_DENSITY_ESTIMATE_RELATIVE_RADIUS);}
  const char *GetDensityEstimateAsString();


  vtkSetClampMacro(DensityForm,int, VTK_DENSITY_FORM_VOLUME_NORM,
                   VTK_DENSITY_FORM_NPTS);
  vtkGetMacro(DensityForm,int);
  void SetDensityFormToVolumeNormalized()
    {this->SetDensityForm(VTK_DENSITY_FORM_VOLUME_NORM);}
  void SetDensityFormToNumberOfPoints()
    {this->SetDensityForm(VTK_DENSITY_FORM_NPTS);}
  const char *GetDensityFormAsString();


  vtkSetClampMacro(Radius,double,0.0,VTK_DOUBLE_MAX);
  vtkGetMacro(Radius,double);


  vtkSetClampMacro(RelativeRadius,double,0.0,VTK_DOUBLE_MAX);
  vtkGetMacro(RelativeRadius,double);


  vtkSetMacro(ScalarWeighting,bool);
  vtkGetMacro(ScalarWeighting,bool);
  vtkBooleanMacro(ScalarWeighting,bool);


  vtkSetMacro(ComputeGradient,bool);
  vtkGetMacro(ComputeGradient,bool);
  vtkBooleanMacro(ComputeGradient,bool);


  void SetLocator(vtkAbstractPointLocator *locator);
  vtkGetObjectMacro(Locator,vtkAbstractPointLocator);

  enum FunctionClass
  {
    ZERO=0,
    NON_ZERO=1
  };

protected:
  vtkPointDensityFilter();
  ~vtkPointDensityFilter() override;

  int SampleDimensions[3]; // dimensions of volume over which to estimate density
  double ModelBounds[6]; // bounding box of splatting dimensions
  double AdjustDistance; // how much to pad the model bounds if automatically computed
  double Origin[3], Spacing[3]; // output geometry
  int DensityEstimate; // how to compute the density
  int DensityForm; // how to represent density value
  double RelativeRadius; // Radius factor for estimating density
  double Radius; // Actually radius used
  bool ScalarWeighting; // Are point densities weighted or not?
  bool ComputeGradient; // Compute the gradient vector and magnitude
  vtkAbstractPointLocator *Locator; //accelerate point searches

  int FillInputPortInformation(int port, vtkInformation* info) override;
  int RequestInformation (vtkInformation *,
                                  vtkInformationVector **,
                                  vtkInformationVector *) override;
  int RequestData(vtkInformation *,
                          vtkInformationVector **,
                          vtkInformationVector *) override;

  void ComputeModelBounds(vtkDataSet *input, vtkImageData *output,
                          vtkInformation *outInfo);

private:
  vtkPointDensityFilter(const vtkPointDensityFilter&) = delete;
  void operator=(const vtkPointDensityFilter&) = delete;
};

#endif