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

  Program:   Visualization Toolkit
  Module:    vtkRadiusOutlierRemoval.h

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See LICENSE file 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.

=========================================================================*/
// .NAME vtkRadiusOutlierRemoval - remove isolated points

// .SECTION Description
// vtkRadiusOutlierRemoval removes isolated points; i.e., those points that
// have few neighbors within a specified radius. The user must specify the
// radius defining the local region, as well as the isolation threshold
// (i.e., number of neighboring points required for the point to be
// considered isolated). Optionally, users can specify a point locator to
// accelerate local neighborhood search operations. (By default a
// vtkStaticPointLocator will be created.)
//
// Note that while any vtkPointSet type can be provided as input, the output
// is represented by an explicit representation of points via a
// vtkPolyData. This output polydata will populate its instance of vtkPoints,
// but no cells will be defined (i.e., no vtkVertex or vtkPolyVertex are
// contained in the output). Also, after filter execution, the user can
// request a vtkIdType* map which indicates how the input points were mapped
// to the output. A value of map[i] (where i is the ith input point) less
// than 0 means that the ith input point was removed. (See also the
// superclass documentation for accessing the removed points through the
// filter's second output.)

// .SECTION Caveats
// This class has been threaded with vtkSMPTools. Using TBB or other
// non-sequential type (set in the CMake variable
// VTK_SMP_IMPLEMENTATION_TYPE) may improve performance significantly.

// .SECTION See Also
// vtkPointCloudFilter vtkStatisticalOutlierRemoval vtkExtractPoints
// vtkThresholdPoints vtkImplicitFunction

#ifndef vtkRadiusOutlierRemoval_h
#define vtkRadiusOutlierRemoval_h

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

class vtkAbstractPointLocator;
class vtkPointSet;


class VTKFILTERSPOINTS_EXPORT vtkRadiusOutlierRemoval : public vtkPointCloudFilter
{
public:
  // Description:
  // Standard methods for instantiating, obtaining type information, and
  // printing information.
  static vtkRadiusOutlierRemoval *New();
  vtkTypeMacro(vtkRadiusOutlierRemoval,vtkPointCloudFilter);
  void PrintSelf(ostream& os, vtkIndent indent);

  // Description:
  // Specify the local search radius.
  vtkSetClampMacro(Radius,double,0.0,VTK_FLOAT_MAX);
  vtkGetMacro(Radius,double);

  // Description:
  // Specify the number of neighbors that a point must have, within
  // the specified radius, for the point to not be considered isolated.
  vtkSetClampMacro(NumberOfNeighbors,int,1,VTK_INT_MAX);
  vtkGetMacro(NumberOfNeighbors,int);

  // Description:
  // Specify a point locator. By default a vtkStaticPointLocator is
  // used. The locator performs efficient searches to locate near a
  // specified interpolation position.
  void SetLocator(vtkAbstractPointLocator *locator);
  vtkGetObjectMacro(Locator,vtkAbstractPointLocator);

protected:
  vtkRadiusOutlierRemoval();
  ~vtkRadiusOutlierRemoval();

  double Radius;
  int NumberOfNeighbors;
  vtkAbstractPointLocator *Locator;

  // All derived classes must implement this method. Note that a side effect of
  // the class is to populate the PointMap. Zero is returned if there is a failure.
  virtual int FilterPoints(vtkPointSet *input);

private:
  vtkRadiusOutlierRemoval(const vtkRadiusOutlierRemoval&) VTK_DELETE_FUNCTION;
  void operator=(const vtkRadiusOutlierRemoval&) VTK_DELETE_FUNCTION;

};

#endif
