itkCurvatureRegistrationFilter.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 itkCurvatureRegistrationFilter_h
#define itkCurvatureRegistrationFilter_h

#include "itkPDEDeformableRegistrationFilter.h"
#include "itkMeanSquareRegistrationFunction.h"

#if defined( ITK_USE_FFTWF ) || defined( ITK_USE_FFTWD )
#include "fftw3.h"

namespace itk
{
template< typename TFixedImage, typename TMovingImage, typename TDisplacementField,
          typename TImageForceFunction =
            MeanSquareRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField > >
class CurvatureRegistrationFilter:
  public PDEDeformableRegistrationFilter< TFixedImage, TMovingImage,
                                          TDisplacementField >
{
public:
  typedef CurvatureRegistrationFilter                                                     Self;
  typedef PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField > Superclass;
  typedef SmartPointer< Self >                                                            Pointer;
  typedef SmartPointer< const Self >                                                      ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(CurvatureRegistrationFilter,
               PDEDeformableRegistrationFilter);

  typedef typename Superclass::TimeStepType TimeStepType;

  typedef typename Superclass::FixedImageType    FixedImageType;
  typedef typename Superclass::FixedImagePointer FixedImagePointer;
  itkStaticConstMacro(ImageDimension, unsigned int, FixedImageType::ImageDimension);

  typedef typename Superclass::MovingImageType    MovingImageType;
  typedef typename Superclass::MovingImagePointer MovingImagePointer;

  typedef typename Superclass::DisplacementFieldType
  DisplacementFieldType;
  typedef typename Superclass::DisplacementFieldPointer
  DisplacementFieldPointer;

  typedef typename TDisplacementField::PixelType         DisplacementFieldPixelType;
  typedef typename DisplacementFieldPixelType::ValueType DisplacementFieldComponentType;
  itkStaticConstMacro(DeformationVectorDimension, unsigned int, DisplacementFieldPixelType::Dimension);

  #if defined( ITK_USE_FFTWD )
  //Prefer to use double precision
  typedef double RealTypeDFT;
  #else
    #if defined( ITK_USE_FFTWF )
  //Allow to use single precision
      #warning "Using single precision for FFT computations!"
  typedef double RealTypeDFT;
    #endif
  #endif

  typedef Image< RealTypeDFT, TDisplacementField::ImageDimension > DisplacementFieldComponentImageType;
  typedef typename DisplacementFieldComponentImageType::Pointer    DisplacementFieldComponentImagePointer;

  typedef typename Superclass::FiniteDifferenceFunctionType
  FiniteDifferenceFunctionType;

  typedef TImageForceFunction RegistrationFunctionType;

  void SetConstraintWeight(const float w) { m_ConstraintWeight = w; }

  void SetTimeStep(const TimeStepType ts) { m_TimeStep = ts; }

  virtual double GetMetric() const;

protected:
  CurvatureRegistrationFilter();
  ~CurvatureRegistrationFilter();
  void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;

  virtual void Initialize();

  virtual void ApplyUpdate(const TimeStepType& dt);

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

  unsigned int m_FixedImageDimensions[ImageDimension];

  RealTypeDFT *m_DisplacementFieldComponentImage;
  RealTypeDFT *m_DisplacementFieldComponentImageDCT;

  float m_ConstraintWeight;

  fftw_plan m_PlanForwardDCT;
  fftw_plan m_PlanBackwardDCT;

  TimeStepType m_TimeStep;

  RealTypeDFT *m_DiagonalElements[ImageDimension];
};
} // end namespace itk

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

#endif //defined(ITK_USE_FFTWF) || defined(ITK_USE_FFTWD)

#endif