itkCurvatureRegistrationFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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_CUFFTW) && (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 ITK_TEMPLATE_EXPORT CurvatureRegistrationFilter
  : public PDEDeformableRegistrationFilter<TFixedImage, TMovingImage, TDisplacementField>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(CurvatureRegistrationFilter);

  using Self = CurvatureRegistrationFilter;
  using Superclass = PDEDeformableRegistrationFilter<TFixedImage, TMovingImage, TDisplacementField>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(CurvatureRegistrationFilter);

  using typename Superclass::TimeStepType;

  using typename Superclass::FixedImageType;
  using typename Superclass::FixedImagePointer;
  static constexpr unsigned int ImageDimension = FixedImageType::ImageDimension;

  using typename Superclass::MovingImageType;
  using typename Superclass::MovingImagePointer;

  using typename Superclass::DisplacementFieldType;
  using typename Superclass::DisplacementFieldPointer;
 
  using DisplacementFieldPixelType = typename TDisplacementField::PixelType;
  using DisplacementFieldComponentType = typename DisplacementFieldPixelType::ValueType;
  static constexpr unsigned int DeformationVectorDimension = DisplacementFieldPixelType::Dimension;
 
#  if defined(ITK_USE_FFTWD)
  // Prefer to use double precision
  using RealTypeDFT = double;
#  else
#    if defined(ITK_USE_FFTWF)
  // Allow to use single precision
#      warning "Using single precision for FFT computations!"
  using RealTypeDFT = double;
#    endif
#  endif
 
  using DisplacementFieldComponentImageType = Image<RealTypeDFT, TDisplacementField::ImageDimension>;
  using DisplacementFieldComponentImagePointer = typename DisplacementFieldComponentImageType::Pointer;

  using typename Superclass::FiniteDifferenceFunctionType;

  using RegistrationFunctionType = TImageForceFunction;

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

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

  virtual double
  GetMetric() const;
 
protected:
  CurvatureRegistrationFilter();
  ~CurvatureRegistrationFilter() override;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  Initialize() override;

  void
  ApplyUpdate(const TimeStepType & dt) override;
 
private:
  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