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$
  Language:  C++
  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 MultiResolutionImageRegistrationMethod2 : public ProcessObject
{
public:
 
  typedef MultiResolutionImageRegistrationMethod2 Self;
  typedef ProcessObject                           Superclass;
  typedef SmartPointer< Self >                    Pointer;
  typedef SmartPointer< const Self >              ConstPointer;
 
  itkNewMacro( Self );
 
  itkTypeMacro( MultiResolutionImageRegistrationMethod2, ProcessObject );
 
  typedef          TFixedImage                  FixedImageType;
  typedef typename FixedImageType::ConstPointer FixedImageConstPointer;
  typedef typename FixedImageType::RegionType   FixedImageRegionType;
  typedef std::vector< FixedImageRegionType >   FixedImageRegionPyramidType;
 
  typedef          TMovingImage                  MovingImageType;
  typedef typename MovingImageType::ConstPointer MovingImageConstPointer;
 
  typedef AdvancedImageToImageMetric<
    FixedImageType, MovingImageType >                 MetricType;
  typedef typename MetricType::Pointer MetricPointer;
 
  typedef typename MetricType::AdvancedTransformType TransformType;
  typedef typename TransformType::Pointer            TransformPointer;
 
  typedef  DataObjectDecorator< TransformType >      TransformOutputType;
  typedef typename TransformOutputType::Pointer      TransformOutputPointer;
  typedef typename TransformOutputType::ConstPointer TransformOutputConstPointer;
 
  typedef typename MetricType::InterpolatorType InterpolatorType;
  typedef typename InterpolatorType::Pointer    InterpolatorPointer;
 
  typedef SingleValuedNonLinearOptimizer OptimizerType;
 
  typedef MultiResolutionPyramidImageFilter<
    FixedImageType, FixedImageType >                  FixedImagePyramidType;
  typedef typename FixedImagePyramidType::Pointer FixedImagePyramidPointer;
 
  typedef MultiResolutionPyramidImageFilter<
    MovingImageType, MovingImageType >                MovingImagePyramidType;
  typedef typename MovingImagePyramidType::Pointer MovingImagePyramidPointer;
 
  typedef typename MetricType::TransformParametersType ParametersType;
 
  typedef typename DataObject::Pointer DataObjectPointer;
 
  virtual void StartRegistration( void );
 
  virtual void StopRegistration( void );
 
  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() );
  itkGetMacro( NumberOfLevels, unsigned long );
 
  itkGetMacro( CurrentLevel, unsigned long );
 
  itkSetMacro( InitialTransformParameters, ParametersType );
  itkGetConstReferenceMacro( InitialTransformParameters, ParametersType );
 
  itkSetMacro( InitialTransformParametersOfNextLevel, ParametersType );
  itkGetConstReferenceMacro( InitialTransformParametersOfNextLevel, ParametersType );
 
  itkGetConstReferenceMacro( LastTransformParameters, ParametersType );
 
  const TransformOutputType * GetOutput( void ) const;
 
  virtual DataObjectPointer MakeOutput( unsigned int idx  );
 
  ModifiedTimeType GetMTime( void ) const override;
 
protected:
 
  MultiResolutionImageRegistrationMethod2();
 
  ~MultiResolutionImageRegistrationMethod2() override {}
 
  void PrintSelf( std::ostream & os, Indent indent ) const override;
 
  void GenerateData( void ) override;
 
  virtual void Initialize();
 
  virtual void PreparePyramids( void );
 
  itkSetMacro( CurrentLevel, unsigned long );
 
  ParametersType m_LastTransformParameters;
  bool           m_Stop;
 
private:
 
  MultiResolutionImageRegistrationMethod2( const Self & ); // purposely not implemented
  void operator=( const Self & );                          // purposely not implemented
 
  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