itkFastSymmetricForcesDemonsRegistrationFilter.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 itkFastSymmetricForcesDemonsRegistrationFilter_h
#define itkFastSymmetricForcesDemonsRegistrationFilter_h
 
#include "itkPDEDeformableRegistrationFilter.h"
#include "itkESMDemonsRegistrationFunction.h"
 
#include "itkMultiplyImageFilter.h"
#include "itkExponentialDisplacementFieldImageFilter.h"
 
namespace itk
{
template <typename TFixedImage, typename TMovingImage, typename TDisplacementField>
class ITK_TEMPLATE_EXPORT FastSymmetricForcesDemonsRegistrationFilter
  : public PDEDeformableRegistrationFilter<TFixedImage, TMovingImage, TDisplacementField>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(FastSymmetricForcesDemonsRegistrationFilter);

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

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(FastSymmetricForcesDemonsRegistrationFilter);

  using typename Superclass::FixedImageType;
  using typename Superclass::FixedImagePointer;

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

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

  virtual double
  GetMetric() const;
 
  const double &
  GetRMSChange() const override;

  using DemonsRegistrationFunctionType =
    ESMDemonsRegistrationFunction<FixedImageType, MovingImageType, DisplacementFieldType>;
 
  using GradientType = typename DemonsRegistrationFunctionType::GradientEnum;
  virtual void
  SetUseGradientType(GradientType gtype);
 
  virtual GradientType
  GetUseGradientType() const;

  virtual void
  SetIntensityDifferenceThreshold(double);
 
  virtual double
  GetIntensityDifferenceThreshold() const;

  virtual void
  SetMaximumUpdateStepLength(double);
 
  virtual double
  GetMaximumUpdateStepLength() const;
 
protected:
  FastSymmetricForcesDemonsRegistrationFilter();
  ~FastSymmetricForcesDemonsRegistrationFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  InitializeIteration() override;

  void
  AllocateUpdateBuffer() override;

  using typename Superclass::FiniteDifferenceFunctionType;

  using TimeStepType = typename FiniteDifferenceFunctionType::TimeStepType;

  void
  ApplyUpdate(const TimeStepType & dt) override;

  using MultiplyByConstantType =
    MultiplyImageFilter<DisplacementFieldType, itk::Image<TimeStepType, ImageDimension>, DisplacementFieldType>;
 
  using AdderType = AddImageFilter<DisplacementFieldType, DisplacementFieldType, DisplacementFieldType>;
 
  using MultiplyByConstantPointer = typename MultiplyByConstantType::Pointer;
  using AdderPointer = typename AdderType::Pointer;
 
private:
  DemonsRegistrationFunctionType *
  DownCastDifferenceFunctionType();
 
  const DemonsRegistrationFunctionType *
  DownCastDifferenceFunctionType() const;
 
  MultiplyByConstantPointer m_Multiplier{};
  AdderPointer              m_Adder{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkFastSymmetricForcesDemonsRegistrationFilter.hxx"
#endif
 
#endif