itkMultiResolutionImageRegistrationMethod.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 itkMultiResolutionImageRegistrationMethod_h
#define itkMultiResolutionImageRegistrationMethod_h
 
#include "itkProcessObject.h"
#include "itkImageToImageMetric.h"
#include "itkSingleValuedNonLinearOptimizer.h"
#include "itkMultiResolutionPyramidImageFilter.h"
#include "itkNumericTraits.h"
#include "itkDataObjectDecorator.h"
 
namespace itk
{
template <typename TFixedImage, typename TMovingImage>
class ITK_TEMPLATE_EXPORT MultiResolutionImageRegistrationMethod : public ProcessObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(MultiResolutionImageRegistrationMethod);
 
  using Self = MultiResolutionImageRegistrationMethod;
  using Superclass = ProcessObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkNewMacro(Self);
 
  itkOverrideGetNameOfClassMacro(MultiResolutionImageRegistrationMethod);
 
  using FixedImageType = TFixedImage;
  using FixedImageConstPointer = typename FixedImageType::ConstPointer;
  using FixedImageRegionType = typename FixedImageType::RegionType;
 
  using MovingImageType = TMovingImage;
  using MovingImageConstPointer = typename MovingImageType::ConstPointer;
 
  using MetricType = ImageToImageMetric<FixedImageType, MovingImageType>;
  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 InterpolatorType = typename MetricType::InterpolatorType;
  using InterpolatorPointer = typename InterpolatorType::Pointer;
 
  using OptimizerType = SingleValuedNonLinearOptimizer;
 
  using FixedImagePyramidType = MultiResolutionPyramidImageFilter<FixedImageType, FixedImageType>;
  using FixedImagePyramidPointer = typename FixedImagePyramidType::Pointer;
 
  using ScheduleType = typename FixedImagePyramidType::ScheduleType;
 
  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);
  void
  SetSchedules(const ScheduleType & fixedImagePyramidSchedule, const ScheduleType & movingImagePyramidSchedule);
 
  itkGetConstMacro(FixedImagePyramidSchedule, ScheduleType);
  itkGetConstMacro(MovingImagePyramidSchedule, ScheduleType);
 
  void
  SetNumberOfLevels(SizeValueType numberOfLevels);
 
  itkGetConstMacro(NumberOfLevels, SizeValueType);
 
  itkGetConstMacro(CurrentLevel, SizeValueType);
 
  itkSetMacro(InitialTransformParameters, ParametersType);
  itkGetConstReferenceMacro(InitialTransformParameters, ParametersType);
  itkSetMacro(InitialTransformParametersOfNextLevel, ParametersType);
  itkGetConstReferenceMacro(InitialTransformParametersOfNextLevel, ParametersType);
  itkGetConstReferenceMacro(LastTransformParameters, ParametersType);
 
  const TransformOutputType *
  GetOutput() const;
 
  using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType;
  using Superclass::MakeOutput;
  DataObjectPointer
  MakeOutput(DataObjectPointerArraySizeType output) override;
 
  ModifiedTimeType
  GetMTime() const override;
 
protected:
  MultiResolutionImageRegistrationMethod();
  ~MultiResolutionImageRegistrationMethod() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  void
  GenerateData() override;
 
  void
  Initialize();
 
  void
  PreparePyramids();
 
  itkSetMacro(CurrentLevel, SizeValueType);
 
private:
  MetricPointer          m_Metric{};
  OptimizerType::Pointer m_Optimizer{};
 
  MovingImageConstPointer m_MovingImage{};
  FixedImageConstPointer  m_FixedImage{};
 
  TransformPointer    m_Transform{};
  InterpolatorPointer m_Interpolator{};
 
  MovingImagePyramidPointer m_MovingImagePyramid{};
  FixedImagePyramidPointer  m_FixedImagePyramid{};
 
  ParametersType m_InitialTransformParameters{};
  ParametersType m_InitialTransformParametersOfNextLevel{};
  ParametersType m_LastTransformParameters{};
 
  FixedImageRegionType              m_FixedImageRegion{};
  std::vector<FixedImageRegionType> m_FixedImageRegionPyramid{};
 
  SizeValueType m_NumberOfLevels{};
  SizeValueType m_CurrentLevel{};
 
  bool m_Stop{};
 
  ScheduleType m_FixedImagePyramidSchedule{};
  ScheduleType m_MovingImagePyramidSchedule{};
 
  bool m_ScheduleSpecified{};
  bool m_NumberOfLevelsSpecified{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkMultiResolutionImageRegistrationMethod.hxx"
#endif
 
#endif