vtkStatisticalOutlierRemoval.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkStatisticalOutlierRemoval.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.

=========================================================================*/
#ifndef vtkStatisticalOutlierRemoval_h
#define vtkStatisticalOutlierRemoval_h

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

class vtkAbstractPointLocator;
class vtkPointSet;


class VTKFILTERSPOINTS_EXPORT vtkStatisticalOutlierRemoval : public vtkPointCloudFilter
{
public:

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


  vtkSetClampMacro(SampleSize,int,1,VTK_INT_MAX);
  vtkGetMacro(SampleSize,int);


  vtkSetClampMacro(StandardDeviationFactor,double,0.0,VTK_FLOAT_MAX);
  vtkGetMacro(StandardDeviationFactor,double);


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


  vtkSetClampMacro(ComputedMean,double,0.0,VTK_FLOAT_MAX);
  vtkGetMacro(ComputedMean,double);


  vtkSetClampMacro(ComputedStandardDeviation,double,0.0,VTK_FLOAT_MAX);
  vtkGetMacro(ComputedStandardDeviation,double);

protected:
  vtkStatisticalOutlierRemoval();
  ~vtkStatisticalOutlierRemoval() override;

  int SampleSize;
  double StandardDeviationFactor;
  vtkAbstractPointLocator *Locator;

  // Derived quantities
  double ComputedMean;
  double ComputedStandardDeviation;

  // 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.
  int FilterPoints(vtkPointSet *input) override;

private:
  vtkStatisticalOutlierRemoval(const vtkStatisticalOutlierRemoval&) = delete;
  void operator=(const vtkStatisticalOutlierRemoval&) = delete;

};

#endif