itkPDEDeformableRegistrationFunction.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 itkPDEDeformableRegistrationFunction_h
#define itkPDEDeformableRegistrationFunction_h
 
#include "itkFiniteDifferenceFunction.h"
 
namespace itk
{
template <typename TFixedImage, typename TMovingImage, typename TDisplacementField>
class ITK_TEMPLATE_EXPORT PDEDeformableRegistrationFunction : public FiniteDifferenceFunction<TDisplacementField>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(PDEDeformableRegistrationFunction);

  using Self = PDEDeformableRegistrationFunction;
  using Superclass = FiniteDifferenceFunction<TDisplacementField>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(PDEDeformableRegistrationFunction);

  using MovingImageType = TMovingImage;
  using MovingImagePointer = typename MovingImageType::ConstPointer;

  using FixedImageType = TFixedImage;
  using FixedImagePointer = typename FixedImageType::ConstPointer;

  using DisplacementFieldType = TDisplacementField;
  using DisplacementFieldTypePointer = typename DisplacementFieldType::Pointer;

  void
  SetMovingImage(const MovingImageType * ptr)
  {
    m_MovingImage = ptr;
  }

  const MovingImageType *
  GetMovingImage() const
  {
    return m_MovingImage;
  }

  void
  SetFixedImage(const FixedImageType * ptr)
  {
    m_FixedImage = ptr;
  }

  const FixedImageType *
  GetFixedImage() const
  {
    return m_FixedImage;
  }

  void
  SetDisplacementField(DisplacementFieldTypePointer ptr)
  {
    m_DisplacementField = ptr;
  }

  DisplacementFieldType *
  GetDisplacementField()
  {
    return m_DisplacementField;
  }
 
  void
  SetEnergy(double e)
  {
    m_Energy = e;
  }
  double
  GetEnergy() const
  {
    return m_Energy;
  }
  void
  SetGradientStep(double e)
  {
    m_GradientStep = e;
  }
  double
  GetGradientStep() const
  {
    return m_GradientStep;
  }
  void
  SetNormalizeGradient(bool e)
  {
    m_NormalizeGradient = e;
  }
  bool
  GetNormalizeGradient() const
  {
    return m_NormalizeGradient;
  }
 
protected:
  PDEDeformableRegistrationFunction()
    : m_MovingImage(nullptr)
    , m_FixedImage(nullptr)
    , m_DisplacementField(nullptr)
    , m_NormalizeGradient(true)
    , m_GradientStep(1.0)
  {}
 
  ~PDEDeformableRegistrationFunction() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override
  {
    Superclass::PrintSelf(os, indent);
    os << indent << "MovingImage: ";
    os << m_MovingImage.GetPointer() << std::endl;
    os << indent << "FixedImage: ";
    os << m_FixedImage.GetPointer() << std::endl;
  }

  MovingImagePointer m_MovingImage{};

  FixedImagePointer m_FixedImage{};

  DisplacementFieldTypePointer m_DisplacementField{};
 
  mutable double m_Energy{};
 
  bool m_NormalizeGradient{};
 
  mutable double m_GradientStep{};
};
} // end namespace itk
 
#endif