itkFluidDeformableTransform.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 itkFluidDeformableTransform_h
#define itkFluidDeformableTransform_h

#include "itkDeformableTransform.h"
#include <itkImage.h>
#include <itkVector.h>


namespace itk
{
  
template <
    class TFixedImage,                   // Templated over the image type.
    class TScalarType,                   // Data type for scalars
    unsigned int NDimensions,            // Number of Dimensions i.e. 2D or 3D
    class TDeformationScalar>            // Data type in the deformation field.       
class ITK_EXPORT FluidDeformableTransform : 
public DeformableTransform< TFixedImage, TScalarType, NDimensions, TDeformationScalar >
{
public:
  
  typedef FluidDeformableTransform                                      Self;
  typedef DeformableTransform< TFixedImage, TScalarType, NDimensions, TDeformationScalar >  Superclass;
  typedef SmartPointer<Self>                                            Pointer;
  typedef SmartPointer<const Self>                                      ConstPointer;

  itkNewMacro( Self );
  
  itkTypeMacro( FluidDeformableTransform, DeformableTransform );
  
  itkStaticConstMacro(SpaceDimension, unsigned int, NDimensions);
  
  typedef typename Superclass::ScalarType                      ScalarType;
  
  typedef typename Superclass::ParametersType                  ParametersType;
  
  typedef typename Superclass::JacobianType                    JacobianType;

  typedef typename Superclass::OutputPointType                 OutputPointType;
  typedef typename Superclass::InputPointType                  InputPointType;

  typedef typename Superclass::DeformationFieldPixelType       DeformationFieldPixelType;
  typedef typename Superclass::DeformationFieldType            DeformationFieldType;

  typedef TFixedImage                                          FixedImageType;
  typedef typename TFixedImage::ConstPointer                   FixedImagePointer;
  
  typedef typename Superclass::VectorFieldImageType            DeformableParameterType; 
  typedef typename DeformableParameterType::Pointer            DeformableParameterPointerType; 

  virtual void Initialize(FixedImagePointer fixedImage);

  virtual void SetIdentity();

  virtual void SetParameters(const ParametersType & parameters)
  {
    niftkitkDebugMacro(<< "FluidDeformableTransform: set parameter does nothing");
  }
  
  virtual void SetDeformableParameters(DeformableParameterPointerType parameters); 
  
  virtual DeformableParameterPointerType GetDeformableParameters() { return this->m_DeformationField; }
  
  virtual void InterpolateNextGrid(FixedImagePointer image); 
  
  virtual bool IsRegridable() const { return true; }
  
  virtual void UpdateRegriddedDeformationParameters(DeformableParameterPointerType regriddedParameters, DeformableParameterPointerType currentPosition, double factor); 
  
  static DeformableParameterPointerType DuplicateDeformableParameters(const DeformableParameterType* deformableParameters); 
  
  virtual bool IsIdentity();
  
  void InvertUsingGradientDescent(typename Self::Pointer invertedTransform, unsigned int maxIteration, double tol); 
  
  void ComputeSquareRoot(typename Self::Pointer sqrtTransform, unsigned int maxInverseIteration, unsigned int maxIteration, double tol); 

protected:

  FluidDeformableTransform();
  virtual ~FluidDeformableTransform();

  void PrintSelf(std::ostream &os, Indent indent) const;
  
  virtual typename Superclass::JacobianDeterminantFilterType::OutputImageRegionType GetValidJacobianRegion() const 
  { 
    typename Superclass::JacobianDeterminantFilterType::OutputImageRegionType region = this->m_JacobianFilter->GetOutput()->GetLargestPossibleRegion(); 
  
    for (unsigned int i = 0; i < NDimensions; i++)
    {
      region.SetIndex(i, 2); 
      region.SetSize(i, region.GetSize(i)-4); 
    }
    return region; 
  } 
  
  
  

private:

  FluidDeformableTransform(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

};  
  
} // namespace itk.

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


#endif /*ITKFLUIDDEFORMABLETRANSFORM_H_*/