vtkPCANormalEstimation.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkPCANormalEstimation_h
#define vtkPCANormalEstimation_h

#include "vtkConvertToPointCloud.h" // For adding cells to output polydata
#include "vtkFiltersPointsModule.h" // For export macro
#include "vtkPolyDataAlgorithm.h"
#include "vtkSmartPointer.h"       // For vtkSmartPointer
#include "vtkStaticPointLocator.h" // For default locator

VTK_ABI_NAMESPACE_BEGIN
class vtkAbstractPointLocator;
class vtkIdList;
struct vtkOrientNormalsWorker;

class VTKFILTERSPOINTS_EXPORT vtkPCANormalEstimation : public vtkPolyDataAlgorithm
{
public:

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

  typedef enum
  {
    KNN = 0,
    RADIUS = 1
  } NeighborSearchMode;


  vtkSetMacro(SearchMode, int);
  vtkGetMacro(SearchMode, int);
  void SetSearchModeToKNN() { this->SetSearchMode(KNN); }
  void SetSearchModeToRadius() { this->SetSearchMode(RADIUS); }


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


  vtkSetMacro(Radius, double);
  vtkGetMacro(Radius, double);

  enum Style
  {
    AS_COMPUTED = 0,
    POINT = 1,
    GRAPH_TRAVERSAL = 3
  };


  vtkSetMacro(NormalOrientation, int);
  vtkGetMacro(NormalOrientation, int);
  void SetNormalOrientationToAsComputed() { this->SetNormalOrientation(AS_COMPUTED); }
  void SetNormalOrientationToPoint() { this->SetNormalOrientation(POINT); }
  void SetNormalOrientationToGraphTraversal() { this->SetNormalOrientation(GRAPH_TRAVERSAL); }


  vtkSetVector3Macro(OrientationPoint, double);
  vtkGetVectorMacro(OrientationPoint, double, 3);


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


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


  vtkSetMacro(CellGenerationMode, int);
  vtkGetMacro(CellGenerationMode, int);

protected:
  vtkPCANormalEstimation() = default;
  ~vtkPCANormalEstimation() override;

  // IVars
  int SampleSize = 25;
  double Radius = 0.; // Radius is not checked by default (in meter)
  vtkSmartPointer<vtkAbstractPointLocator> Locator = vtkStaticPointLocator::New();
  int SearchMode = vtkPCANormalEstimation::KNN;
  int NormalOrientation = vtkPCANormalEstimation::POINT;
  double OrientationPoint[3] = { 0. };
  bool FlipNormals = false;
  int CellGenerationMode = vtkConvertToPointCloud::NO_CELLS;

  // Methods used to produce consistent normal orientations
  template <typename TPointsRange>
  void TraverseAndFlip(
    TPointsRange& inPts, float* normals, char* pointMap, vtkIdList* wave, vtkIdList* wave2);

  // Pipeline management
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int FillInputPortInformation(int port, vtkInformation* info) override;

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

  friend struct vtkOrientNormalsWorker;
};

VTK_ABI_NAMESPACE_END
#endif