vtkIterativeClosestPointTransform.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 vtkIterativeClosestPointTransform_h
#define vtkIterativeClosestPointTransform_h
 
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkLinearTransform.h"
 
#define VTK_ICP_MODE_RMS 0
#define VTK_ICP_MODE_AV 1
 
VTK_ABI_NAMESPACE_BEGIN
class vtkCellLocator;
class vtkLandmarkTransform;
class vtkDataSet;
 
class VTKCOMMONDATAMODEL_EXPORT vtkIterativeClosestPointTransform : public vtkLinearTransform
{
public:
  static vtkIterativeClosestPointTransform* New();
  vtkTypeMacro(vtkIterativeClosestPointTransform, vtkLinearTransform);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  void SetSource(vtkDataSet* source);
  void SetTarget(vtkDataSet* target);
  vtkGetObjectMacro(Source, vtkDataSet);
  vtkGetObjectMacro(Target, vtkDataSet);


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


  vtkSetMacro(MaximumNumberOfIterations, int);
  vtkGetMacro(MaximumNumberOfIterations, int);


  vtkGetMacro(NumberOfIterations, int);


  vtkSetMacro(CheckMeanDistance, vtkTypeBool);
  vtkGetMacro(CheckMeanDistance, vtkTypeBool);
  vtkBooleanMacro(CheckMeanDistance, vtkTypeBool);


  vtkSetClampMacro(MeanDistanceMode, int, VTK_ICP_MODE_RMS, VTK_ICP_MODE_AV);
  vtkGetMacro(MeanDistanceMode, int);
  void SetMeanDistanceModeToRMS() { this->SetMeanDistanceMode(VTK_ICP_MODE_RMS); }
  void SetMeanDistanceModeToAbsoluteValue() { this->SetMeanDistanceMode(VTK_ICP_MODE_AV); }
  const char* GetMeanDistanceModeAsString();


  vtkSetMacro(MaximumMeanDistance, double);
  vtkGetMacro(MaximumMeanDistance, double);


  vtkGetMacro(MeanDistance, double);


  vtkSetMacro(MaximumNumberOfLandmarks, int);
  vtkGetMacro(MaximumNumberOfLandmarks, int);


  vtkSetMacro(StartByMatchingCentroids, vtkTypeBool);
  vtkGetMacro(StartByMatchingCentroids, vtkTypeBool);
  vtkBooleanMacro(StartByMatchingCentroids, vtkTypeBool);


  vtkGetObjectMacro(LandmarkTransform, vtkLandmarkTransform);

  void Inverse() override;

  vtkAbstractTransform* MakeTransform() override;
 
protected:

  void ReleaseSource();
  void ReleaseTarget();

  void ReleaseLocator();

  void CreateDefaultLocator();

  vtkMTimeType GetMTime() override;
 
  vtkIterativeClosestPointTransform();
  ~vtkIterativeClosestPointTransform() override;
 
  void InternalUpdate() override;

  void InternalDeepCopy(vtkAbstractTransform* transform) override;
 
  vtkDataSet* Source;
  vtkDataSet* Target;
  vtkCellLocator* Locator;
  int MaximumNumberOfIterations;
  vtkTypeBool CheckMeanDistance;
  int MeanDistanceMode;
  double MaximumMeanDistance;
  int MaximumNumberOfLandmarks;
  vtkTypeBool StartByMatchingCentroids;
 
  int NumberOfIterations;
  double MeanDistance;
  vtkLandmarkTransform* LandmarkTransform;
 
private:
  vtkIterativeClosestPointTransform(const vtkIterativeClosestPointTransform&) = delete;
  void operator=(const vtkIterativeClosestPointTransform&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif