itkTwoProjectionImageRegistrationMethod.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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 itkTwoProjectionImageRegistrationMethod_h
#define itkTwoProjectionImageRegistrationMethod_h

#include "itkProcessObject.h"
#include "itkImage.h"
#include "itkTwoImageToOneImageMetric.h"
#include "itkSingleValuedNonLinearOptimizer.h"
#include "itkDataObjectDecorator.h"

namespace itk
{

template <typename TFixedImage, typename TMovingImage>
class TwoProjectionImageRegistrationMethod : public ProcessObject
{
public:
  typedef TwoProjectionImageRegistrationMethod Self;
  typedef ProcessObject                        Superclass;
  typedef SmartPointer<Self>                   Pointer;
  typedef SmartPointer<const Self>             ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(TwoProjectionImageRegistrationMethod, ProcessObject);

  typedef          TFixedImage                     FixedImageType;
  typedef typename FixedImageType::ConstPointer    FixedImageConstPointer;

  typedef          TMovingImage                     MovingImageType;
  typedef typename MovingImageType::ConstPointer    MovingImageConstPointer;

  typedef TwoImageToOneImageMetric< FixedImageType,
                              MovingImageType >       MetricType;
  typedef typename MetricType::Pointer                MetricPointer;
  typedef typename MetricType::FixedImageRegionType   FixedImageRegionType;

  typedef  typename MetricType::TransformType      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  typename MetricType::TransformParametersType    ParametersType;

  typedef typename DataObject::Pointer DataObjectPointer;

  void StartRegistration(void);

  void StartOptimization(void);

  void SetFixedImage1( const FixedImageType * fixedImage1 );
  void SetFixedImage2( const FixedImageType * fixedImage2 );
  itkGetConstObjectMacro( FixedImage1, FixedImageType );
  itkGetConstObjectMacro( FixedImage2, FixedImageType );

  void SetMovingImage( const MovingImageType * movingImage );
  itkGetConstObjectMacro( MovingImage, MovingImageType );

  itkSetObjectMacro( Optimizer,  OptimizerType );
  itkGetObjectMacro( Optimizer,  OptimizerType );

  itkSetObjectMacro( Metric, MetricType );
  itkGetObjectMacro( Metric, MetricType );

  itkSetObjectMacro( Transform, TransformType );
  itkGetObjectMacro( Transform, TransformType );

  itkSetObjectMacro( Interpolator1, InterpolatorType );
  itkSetObjectMacro( Interpolator2, InterpolatorType );
  itkGetObjectMacro( Interpolator1, InterpolatorType );
  itkGetObjectMacro( Interpolator2, InterpolatorType );

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

  itkGetConstReferenceMacro( LastTransformParameters, ParametersType );

  void SetFixedImageRegion1( const  FixedImageRegionType & region1 );
  void SetFixedImageRegion2( const  FixedImageRegionType & region2 );

  itkGetConstReferenceMacro( FixedImageRegion1, FixedImageRegionType );
  itkGetConstReferenceMacro( FixedImageRegion2, FixedImageRegionType );

  itkGetMacro( FixedImageRegionDefined1, bool );
  itkGetMacro( FixedImageRegionDefined2, bool );

  itkSetMacro( FixedImageRegionDefined1, bool );
  itkSetMacro( FixedImageRegionDefined2, bool );

  virtual void Initialize();

  const TransformOutputType * GetOutput() const;

  using Superclass::MakeOutput;
  virtual DataObjectPointer MakeOutput( DataObjectPointerArraySizeType idx);

  unsigned long GetMTime() const;

protected:
  TwoProjectionImageRegistrationMethod();
  virtual ~TwoProjectionImageRegistrationMethod() {};
  virtual void PrintSelf(std::ostream& os, Indent indent) const ITK_OVERRIDE;

  virtual void GenerateData() ITK_OVERRIDE;

  itkSetMacro( LastTransformParameters, ParametersType );


private:
  TwoProjectionImageRegistrationMethod(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  MetricPointer                    m_Metric;
  OptimizerType::Pointer           m_Optimizer;

  MovingImageConstPointer          m_MovingImage;
  FixedImageConstPointer           m_FixedImage1;
  FixedImageConstPointer           m_FixedImage2;

  TransformPointer                 m_Transform;
  InterpolatorPointer              m_Interpolator1;
  InterpolatorPointer              m_Interpolator2;

  ParametersType                   m_InitialTransformParameters;
  ParametersType                   m_LastTransformParameters;

  bool                             m_FixedImageRegionDefined1;
  bool                             m_FixedImageRegionDefined2;
  FixedImageRegionType             m_FixedImageRegion1;
  FixedImageRegionType             m_FixedImageRegion2;

};

} // end namespace itk


#ifndef ITK_MANUAL_INSTANTIATION
#include "itkTwoProjectionImageRegistrationMethod.hxx"
#endif

#endif