itkMultiResolutionImageRegistrationMethod2.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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
 *
 *        http://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.
 *
 *=========================================================================*/

/*=========================================================================
 
  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile$
  Date:      $Date: 2008-06-27 17:50:36 +0200 (Fri, 27 Jun 2008) $
  Version:   $Revision: 1728 $
 
  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm 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 notices for more information.
 
=========================================================================*/
#ifndef itkMultiResolutionImageRegistrationMethod2_h
#define itkMultiResolutionImageRegistrationMethod2_h
 
#include "itkProcessObject.h"
#include "itkAdvancedImageToImageMetric.h"
#include "itkSingleValuedNonLinearOptimizer.h"
#include "itkMultiResolutionPyramidImageFilter.h"
#include "itkNumericTraits.h"
#include "itkDataObjectDecorator.h"
 
namespace itk
{

template <typename TFixedImage, typename TMovingImage>
class ITK_TEMPLATE_EXPORT MultiResolutionImageRegistrationMethod2 : public ProcessObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(MultiResolutionImageRegistrationMethod2);

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

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(MultiResolutionImageRegistrationMethod2);

  using FixedImageType = TFixedImage;
  using FixedImageConstPointer = typename FixedImageType::ConstPointer;
  using FixedImageRegionType = typename FixedImageType::RegionType;
  using FixedImageRegionPyramidType = std::vector<FixedImageRegionType>;

  using MovingImageType = TMovingImage;
  using MovingImageConstPointer = typename MovingImageType::ConstPointer;

  using MetricType = AdvancedImageToImageMetric<FixedImageType, MovingImageType>;
  using MetricPointer = typename MetricType::Pointer;

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

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

  using InterpolatorType = typename MetricType::InterpolatorType;
  using InterpolatorPointer = typename InterpolatorType::Pointer;

  using OptimizerType = SingleValuedNonLinearOptimizer;

  using FixedImagePyramidType = MultiResolutionPyramidImageFilter<FixedImageType, FixedImageType>;
  using FixedImagePyramidPointer = typename FixedImagePyramidType::Pointer;

  using MovingImagePyramidType = MultiResolutionPyramidImageFilter<MovingImageType, MovingImageType>;
  using MovingImagePyramidPointer = typename MovingImagePyramidType::Pointer;

  using ParametersType = typename MetricType::TransformParametersType;

  using DataObjectPointer = typename DataObject::Pointer;

  void
  StopRegistration();

  itkSetConstObjectMacro(FixedImage, FixedImageType);
  itkGetConstObjectMacro(FixedImage, FixedImageType);

  itkSetConstObjectMacro(MovingImage, MovingImageType);
  itkGetConstObjectMacro(MovingImage, MovingImageType);

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

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

  itkSetMacro(FixedImageRegion, FixedImageRegionType);
  itkGetConstReferenceMacro(FixedImageRegion, FixedImageRegionType);

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

  itkSetObjectMacro(Interpolator, InterpolatorType);
  itkGetModifiableObjectMacro(Interpolator, InterpolatorType);

  itkSetObjectMacro(FixedImagePyramid, FixedImagePyramidType);
  itkGetModifiableObjectMacro(FixedImagePyramid, FixedImagePyramidType);

  itkSetObjectMacro(MovingImagePyramid, MovingImagePyramidType);
  itkGetModifiableObjectMacro(MovingImagePyramid, MovingImagePyramidType);

  itkSetClampMacro(NumberOfLevels, unsigned long, 1, NumericTraits<unsigned long>::max());
  itkGetConstMacro(NumberOfLevels, unsigned long);

  itkGetConstMacro(CurrentLevel, unsigned long);

  itkSetMacro(InitialTransformParameters, ParametersType);
  itkGetConstReferenceMacro(InitialTransformParameters, ParametersType);

  itkSetMacro(InitialTransformParametersOfNextLevel, ParametersType);
  itkGetConstReferenceMacro(InitialTransformParametersOfNextLevel, ParametersType);

  itkGetConstReferenceMacro(LastTransformParameters, ParametersType);

  const TransformOutputType *
  GetOutput() const;

  DataObjectPointer
  MakeOutput(ProcessObject::DataObjectPointerArraySizeType idx) override;

  ModifiedTimeType
  GetMTime() const override;
 
protected:
  MultiResolutionImageRegistrationMethod2();

  ~MultiResolutionImageRegistrationMethod2() override = default;

  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  GenerateData() override;

  virtual void
  Initialize();

  virtual void
  PreparePyramids();

  itkSetMacro(CurrentLevel, unsigned long);

  ParametersType m_LastTransformParameters{};
  bool           m_Stop{};
 
private:
  // Private using-declarations, to avoid `-Woverloaded-virtual` warnings from GCC (GCC 11.4).
  using ProcessObject::MakeOutput;

  MetricPointer          m_Metric{};
  OptimizerType::Pointer m_Optimizer{};
  TransformPointer       m_Transform{};
  InterpolatorPointer    m_Interpolator{};
 
  ParametersType m_InitialTransformParameters{};
  ParametersType m_InitialTransformParametersOfNextLevel{};
 
  MovingImageConstPointer   m_MovingImage{};
  FixedImageConstPointer    m_FixedImage{};
  MovingImagePyramidPointer m_MovingImagePyramid{};
  FixedImagePyramidPointer  m_FixedImagePyramid{};
 
  FixedImageRegionType        m_FixedImageRegion{};
  FixedImageRegionPyramidType m_FixedImageRegionPyramid{};
 
  unsigned long m_NumberOfLevels{};
  unsigned long m_CurrentLevel{};
};
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkMultiResolutionImageRegistrationMethod2.hxx"
#endif
 
#endif // end #ifndef itkMultiResolutionImageRegistrationMethod2_h