itkMultiResolutionDeformableImageRegistrationMethod.h

Go to the documentation of this file.

/*=============================================================================

  NifTK: A software platform for medical image computing.

  Copyright (c) University College London (UCL). All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.

  See LICENSE.txt in the top level directory for details.

=============================================================================*/

#ifndef itkMultiResolutionDeformableImageRegistrationMethod_h
#define itkMultiResolutionDeformableImageRegistrationMethod_h

#include "itkMultiResolutionImageRegistrationWrapper.h"
#include <niftkConversionUtils.h>

namespace itk
{

template <typename TInputImageType, class TScalarType, unsigned int NDimensions, class TDeformationScalar, class TPyramidFilter = itk::RecursiveMultiResolutionPyramidImageFilter< TInputImageType, TInputImageType > >
class ITK_EXPORT MultiResolutionDeformableImageRegistrationMethod 
  : public MultiResolutionImageRegistrationWrapper<TInputImageType, TPyramidFilter> 
{
public:
  typedef MultiResolutionDeformableImageRegistrationMethod          Self;
  typedef MultiResolutionImageRegistrationWrapper<TInputImageType, TPyramidFilter>  Superclass;
  typedef SmartPointer<Self>                                        Pointer;
  typedef SmartPointer<const Self>                                  ConstPointer;

  itkNewMacro(Self);
  
  itkTypeMacro(MultiResolutionDeformableImageRegistrationMethod, MultiResolutionImageRegistrationWrapper);

  typedef TInputImageType InputImageType;
  typedef DeformableTransform<TInputImageType,TScalarType,  NDimensions, TDeformationScalar> DeformableTransformType;
  typedef DeformableTransformType*                                       DeformableTransformPointer;
  
  itkSetMacro(JacobianImageFileName, std::string);
  itkGetMacro(JacobianImageFileName, std::string);

  itkSetMacro(JacobianImageFileExtension, std::string);
  itkGetMacro(JacobianImageFileExtension, std::string);

  itkSetMacro(WriteJacobianImageAtEachLevel, bool);
  itkGetMacro(WriteJacobianImageAtEachLevel, bool);

  itkSetMacro(VectorImageFileName, std::string);
  itkGetMacro(VectorImageFileName, std::string);

  itkSetMacro(VectorImageFileExtension, std::string);
  itkGetMacro(VectorImageFileExtension, std::string);

  itkSetMacro(WriteVectorImageAtEachLevel, bool);
  itkGetMacro(WriteVectorImageAtEachLevel, bool);

  itkSetMacro(ParameterFileName, std::string);
  itkGetMacro(ParameterFileName, std::string);

  itkSetMacro(ParameterFileExt, std::string);
  itkGetMacro(ParameterFileExt, std::string);

  itkSetMacro(WriteParametersAtEachLevel, bool);
  itkGetMacro(WriteParametersAtEachLevel, bool);

  virtual void WriteJacobianImageForLevel() 
    { 
      this->WriteJacobianImage(this->m_JacobianImageFileName + "." + niftk::ConvertToString((int)this->m_CurrentLevel) + "." + this->m_JacobianImageFileExtension);
    }
  
  virtual void WriteJacobianImage()
    {
      this->WriteJacobianImage(this->m_JacobianImageFileName + "." + this->m_JacobianImageFileExtension);
    }

  virtual void WriteVectorImageForLevel() 
    { 
      this->WriteVectorImage(this->m_VectorImageFileName + "." + niftk::ConvertToString((int)this->m_CurrentLevel) + "." + this->m_VectorImageFileExtension);
    }
  
  virtual void WriteVectorImage()
    {
      this->WriteVectorImage(this->m_VectorImageFileName + "." + this->m_VectorImageFileExtension);
    }

  virtual void WriteParametersForLevel() 
    { 
      this->WriteParameters(this->m_ParameterFileName + "." + niftk::ConvertToString((int)this->m_CurrentLevel) + "." + this->m_ParameterFileExt);
    }
  
  virtual void WriteParameters()
    {
      this->WriteParameters(this->m_ParameterFileName + "." + this->m_ParameterFileExt);
    }

protected:
  MultiResolutionDeformableImageRegistrationMethod();
  virtual ~MultiResolutionDeformableImageRegistrationMethod() {};

  virtual void WriteJacobianImage(std::string filename);

  virtual void WriteVectorImage(std::string filename);

  virtual void WriteParameters(std::string filename);

  virtual void AfterSingleResolutionRegistration();
  
private:
  MultiResolutionDeformableImageRegistrationMethod(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  std::string m_JacobianImageFileName;
  
  std::string m_JacobianImageFileExtension;

  bool m_WriteJacobianImageAtEachLevel;
  
  std::string m_VectorImageFileName;
  
  std::string m_VectorImageFileExtension;

  bool m_WriteVectorImageAtEachLevel;
  
  std::string m_ParameterFileName;
  
  std::string m_ParameterFileExt;
  
  bool m_WriteParametersAtEachLevel;
  
};

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkMultiResolutionDeformableImageRegistrationMethod.txx"
#endif

#endif