itkPointSetToPointSetRegistrationMethod.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkPointSetToPointSetRegistrationMethod_h
#define itkPointSetToPointSetRegistrationMethod_h
 
#include "itkProcessObject.h"
#include "itkPointSetToPointSetMetric.h"
#include "itkMultipleValuedNonLinearOptimizer.h"
#include "itkDataObjectDecorator.h"
 
namespace itk
{
template <typename TFixedPointSet, typename TMovingPointSet>
class ITK_TEMPLATE_EXPORT PointSetToPointSetRegistrationMethod : public ProcessObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(PointSetToPointSetRegistrationMethod);

  using Self = PointSetToPointSetRegistrationMethod;
  using Superclass = ProcessObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(PointSetToPointSetRegistrationMethod);

  using FixedPointSetType = TFixedPointSet;
  using FixedPointSetConstPointer = typename FixedPointSetType::ConstPointer;

  using MovingPointSetType = TMovingPointSet;
  using MovingPointSetConstPointer = typename MovingPointSetType::ConstPointer;

  using MetricType = PointSetToPointSetMetric<FixedPointSetType, MovingPointSetType>;
  using MetricPointer = typename MetricType::Pointer;

  using TransformType = typename MetricType::TransformType;
  using TransformPointer = typename TransformType::Pointer;

  using TransformOutputType = DataObjectDecorator<TransformType>;
  using TransformOutputPointer = typename TransformOutputType::Pointer;
  using TransformOutputConstPointer = typename TransformOutputType::ConstPointer;

  using OptimizerType = MultipleValuedNonLinearOptimizer;

  using ParametersType = typename MetricType::TransformParametersType;

  using DataObjectPointer = typename DataObject::Pointer;

  itkSetConstObjectMacro(FixedPointSet, FixedPointSetType);
  itkGetConstObjectMacro(FixedPointSet, FixedPointSetType);

  itkSetConstObjectMacro(MovingPointSet, MovingPointSetType);
  itkGetConstObjectMacro(MovingPointSet, MovingPointSetType);

  itkSetObjectMacro(Optimizer, OptimizerType);
  itkGetModifiableObjectMacro(Optimizer, OptimizerType);

  itkSetObjectMacro(Metric, MetricType);
  itkGetModifiableObjectMacro(Metric, MetricType);

  itkSetObjectMacro(Transform, TransformType);
  itkGetModifiableObjectMacro(Transform, TransformType);

  virtual void
  SetInitialTransformParameters(const ParametersType & param);
 
  itkGetConstReferenceMacro(InitialTransformParameters, ParametersType);

  itkGetConstReferenceMacro(LastTransformParameters, ParametersType);

  void
  Initialize();

  const TransformOutputType *
  GetOutput() const;

  using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType;
  using Superclass::MakeOutput;
  DataObjectPointer
  MakeOutput(DataObjectPointerArraySizeType output) override;
 
  ModifiedTimeType
  GetMTime() const override;
 
protected:
  PointSetToPointSetRegistrationMethod();
  ~PointSetToPointSetRegistrationMethod() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  GenerateData() override;
 
private:
  MetricPointer          m_Metric{};
  OptimizerType::Pointer m_Optimizer{};
 
  MovingPointSetConstPointer m_MovingPointSet{};
  FixedPointSetConstPointer  m_FixedPointSet{};
 
  TransformPointer m_Transform{};
 
  ParametersType m_InitialTransformParameters{};
  ParametersType m_LastTransformParameters{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkPointSetToPointSetRegistrationMethod.hxx"
#endif
 
#endif