itkMultiMetricMultiResolutionImageRegistrationMethod.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.
 *
 *=========================================================================*/
#ifndef __itkMultiMetricMultiResolutionImageRegistrationMethod_h
#define __itkMultiMetricMultiResolutionImageRegistrationMethod_h
 
#include "itkMultiResolutionImageRegistrationMethod2.h"
#include "itkCombinationImageToImageMetric.h"
#include <vector>
 
#define elxOverrideSimpleSetMacro( _name, _type ) \
  void Set##_name( _type _arg ) override \
  { \
    this->Set##_name( _arg, 0 ); \
  }
 
#define itkSetNumberOfMacro( _name ) \
  virtual void SetNumberOf##_name##s( unsigned int _arg ) \
  { \
    if( this->m_##_name##s.size() != _arg ) \
    { \
      this->m_##_name##s.resize( _arg ); \
      this->Modified(); \
    } \
  }
 
#define itkGetNumberOfMacro( _name ) \
  virtual unsigned int GetNumberOf##_name##s( void ) const \
  { \
    return this->m_##_name##s.size(); \
  }
 
namespace itk
{
 
template< typename TFixedImage, typename TMovingImage >
class MultiMetricMultiResolutionImageRegistrationMethod :
  public MultiResolutionImageRegistrationMethod2< TFixedImage, TMovingImage >
{
public:
 
  typedef MultiMetricMultiResolutionImageRegistrationMethod Self;
  typedef MultiResolutionImageRegistrationMethod2<
    TFixedImage, TMovingImage >                               Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;
 
  itkNewMacro( Self );
 
  itkTypeMacro( MultiMetricMultiResolutionImageRegistrationMethod,
    MultiResolutionImageRegistrationMethod2 );
 
  typedef typename Superclass::FixedImageType          FixedImageType;
  typedef typename Superclass::FixedImageConstPointer  FixedImageConstPointer;
  typedef typename Superclass::FixedImageRegionType    FixedImageRegionType;
  typedef typename Superclass::MovingImageType         MovingImageType;
  typedef typename Superclass::MovingImageConstPointer MovingImageConstPointer;
 
  typedef typename Superclass::MetricType               MetricType;
  typedef typename Superclass::MetricPointer            MetricPointer;
  typedef typename Superclass::TransformType            TransformType;
  typedef typename Superclass::TransformPointer         TransformPointer;
  typedef typename Superclass::InterpolatorType         InterpolatorType;
  typedef typename Superclass::InterpolatorPointer      InterpolatorPointer;
  typedef typename Superclass::OptimizerType            OptimizerType;
  typedef typename OptimizerType::Pointer               OptimizerPointer;
  typedef typename Superclass::FixedImagePyramidType    FixedImagePyramidType;
  typedef typename Superclass::FixedImagePyramidPointer FixedImagePyramidPointer;
  typedef typename Superclass::MovingImagePyramidType   MovingImagePyramidType;
  typedef typename
    Superclass::MovingImagePyramidPointer MovingImagePyramidPointer;
 
  typedef typename Superclass::TransformOutputType    TransformOutputType;
  typedef typename Superclass::TransformOutputPointer TransformOutputPointer;
  typedef typename
    Superclass::TransformOutputConstPointer TransformOutputConstPointer;
 
  typedef typename Superclass::ParametersType    ParametersType;
  typedef typename Superclass::DataObjectPointer DataObjectPointer;
 
  typedef CombinationImageToImageMetric<
    FixedImageType, MovingImageType >                   CombinationMetricType;
  typedef typename CombinationMetricType::Pointer CombinationMetricPointer;
 
  virtual void StopMultiMetricRegistration( void )
  {
    this->m_Stop = true;
  }
 
 
  void SetMetric( MetricType * _arg ) override;
 
  virtual CombinationMetricType * GetCombinationMetric( void ) const
  {
    return this->m_CombinationMetric.GetPointer();
  }
 
 
  virtual void SetFixedImage( const FixedImageType * _arg, unsigned int pos );
 
  virtual const FixedImageType * GetFixedImage( unsigned int pos ) const;
 
  const FixedImageType * GetFixedImage( void ) const override
  {
    return this->GetFixedImage( 0 );
  }
 
 
  elxOverrideSimpleSetMacro( FixedImage, const FixedImageType * );
  itkSetNumberOfMacro( FixedImage );
  itkGetNumberOfMacro( FixedImage );
 
  virtual void SetMovingImage( const MovingImageType * _arg, unsigned int pos );
 
  virtual const MovingImageType * GetMovingImage( unsigned int pos ) const;
 
  const MovingImageType * GetMovingImage( void ) const override
  { return this->GetMovingImage( 0 ); }
  elxOverrideSimpleSetMacro( MovingImage, const MovingImageType * );
  itkSetNumberOfMacro( MovingImage );
  itkGetNumberOfMacro( MovingImage );
 
  virtual void SetFixedImageRegion( FixedImageRegionType _arg, unsigned int pos );
 
  virtual const FixedImageRegionType & GetFixedImageRegion( unsigned int pos ) const;
 
  const FixedImageRegionType & GetFixedImageRegion( void ) const override
  { return this->GetFixedImageRegion( 0 ); }
  elxOverrideSimpleSetMacro( FixedImageRegion, const FixedImageRegionType );
  itkSetNumberOfMacro( FixedImageRegion );
  itkGetNumberOfMacro( FixedImageRegion );
 
  virtual void SetInterpolator( InterpolatorType * _arg, unsigned int pos );
 
  virtual InterpolatorType * GetInterpolator( unsigned int pos ) const;
 
  InterpolatorType * GetInterpolator( void ) override
  { return this->GetInterpolator( 0 ); }
  elxOverrideSimpleSetMacro( Interpolator, InterpolatorType * );
  itkSetNumberOfMacro( Interpolator );
  itkGetNumberOfMacro( Interpolator );
 
  virtual void SetFixedImagePyramid( FixedImagePyramidType * _arg, unsigned int pos );
 
  virtual FixedImagePyramidType * GetFixedImagePyramid( unsigned int pos ) const;
 
  FixedImagePyramidType * GetFixedImagePyramid( void ) override
  { return this->GetFixedImagePyramid( 0 ); }
  elxOverrideSimpleSetMacro( FixedImagePyramid, FixedImagePyramidType * );
  itkSetNumberOfMacro( FixedImagePyramid );
  itkGetNumberOfMacro( FixedImagePyramid );
 
  virtual void SetMovingImagePyramid( MovingImagePyramidType * _arg, unsigned int pos );
 
  virtual MovingImagePyramidType * GetMovingImagePyramid( unsigned int pos ) const;
 
  MovingImagePyramidType * GetMovingImagePyramid( void ) override
  { return this->GetMovingImagePyramid( 0 ); }
  elxOverrideSimpleSetMacro( MovingImagePyramid, MovingImagePyramidType * );
  itkSetNumberOfMacro( MovingImagePyramid );
  itkGetNumberOfMacro( MovingImagePyramid );
 
  ModifiedTimeType GetMTime( void ) const override;
 
  const ParametersType & GetLastTransformParameters( void ) const override
  {
    return this->m_LastTransformParameters;
  }
 
 
protected:
 
  MultiMetricMultiResolutionImageRegistrationMethod();
  ~MultiMetricMultiResolutionImageRegistrationMethod() override {}
  void PrintSelf( std::ostream & os, Indent indent ) const override;
 
  typedef std::vector< FixedImageRegionType > FixedImageRegionPyramidType;
 
  void GenerateData( void ) override;
 
  void Initialize( void ) override;
 
  virtual void PrepareAllPyramids( void );
 
  virtual void CheckPyramids( void );
 
  virtual void CheckOnInitialize( void );
 
  bool           m_Stop;
  ParametersType m_LastTransformParameters;
 
  CombinationMetricPointer m_CombinationMetric;
 
  std::vector< FixedImageConstPointer >    m_FixedImages;
  std::vector< MovingImageConstPointer >   m_MovingImages;
  std::vector< FixedImageRegionType >      m_FixedImageRegions;
  std::vector< FixedImagePyramidPointer >  m_FixedImagePyramids;
  std::vector< MovingImagePyramidPointer > m_MovingImagePyramids;
  std::vector< InterpolatorPointer >       m_Interpolators;
 
  std::vector< FixedImageRegionPyramidType > m_FixedImageRegionPyramids;
 
  FixedImageRegionType m_NullFixedImageRegion;
 
private:
 
  MultiMetricMultiResolutionImageRegistrationMethod( const Self & ); // purposely not implemented
  void operator=( const Self & );                                    // purposely not implemented
 
};
 
} // end namespace itk
 
#undef itkSetNumberOfMacro
#undef itkGetNumberOfMacro
#undef elxOverrideSimpleSetMacro
 
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkMultiMetricMultiResolutionImageRegistrationMethod.hxx"
#endif
 
#endif