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:
  ITK_DISALLOW_COPY_AND_ASSIGN(TwoProjectionImageRegistrationMethod);

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

  itkNewMacro(Self);

  itkTypeMacro(TwoProjectionImageRegistrationMethod, ProcessObject);

  using FixedImageType = TFixedImage;
  using FixedImageConstPointer = typename FixedImageType::ConstPointer;

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

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

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

  using DataObjectPointer = typename DataObject::Pointer;

  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 );
  itkGetConstObjectMacro( Optimizer,  OptimizerType );

  itkSetObjectMacro( Metric, MetricType );
  itkGetConstObjectMacro( Metric, MetricType );

  itkSetObjectMacro( Transform, TransformType );
  itkGetConstObjectMacro( Transform, TransformType );

  itkSetObjectMacro( Interpolator1, InterpolatorType );
  itkSetObjectMacro( Interpolator2, InterpolatorType );
  itkGetConstObjectMacro( Interpolator1, InterpolatorType );
  itkGetConstObjectMacro( 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;
  DataObjectPointer MakeOutput( DataObjectPointerArraySizeType idx) override;

  unsigned long GetMTime() const override;

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

  void GenerateData() override;

  itkSetMacro( LastTransformParameters, ParametersType );


private:
  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