itkSymmetricForcesDemonsRegistrationFilter.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 itkSymmetricForcesDemonsRegistrationFilter_h
#define itkSymmetricForcesDemonsRegistrationFilter_h
 
#include "itkPDEDeformableRegistrationFilter.h"
#include "itkSymmetricForcesDemonsRegistrationFunction.h"
 
namespace itk
{
template <typename TFixedImage, typename TMovingImage, typename TDisplacementField>
class ITK_TEMPLATE_EXPORT SymmetricForcesDemonsRegistrationFilter
  : public PDEDeformableRegistrationFilter<TFixedImage, TMovingImage, TDisplacementField>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(SymmetricForcesDemonsRegistrationFilter);

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

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(SymmetricForcesDemonsRegistrationFilter);

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

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

  using typename Superclass::DisplacementFieldType;
  using typename Superclass::DisplacementFieldPointer;

  using typename Superclass::FiniteDifferenceFunctionType;

  using TimeStepType = typename FiniteDifferenceFunctionType::TimeStepType;

  using DemonsRegistrationFunctionType =
    SymmetricForcesDemonsRegistrationFunction<FixedImageType, MovingImageType, DisplacementFieldType>;

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

  virtual void
  SetIntensityDifferenceThreshold(double);
 
  virtual double
  GetIntensityDifferenceThreshold() const;
 
protected:
  SymmetricForcesDemonsRegistrationFilter();
  ~SymmetricForcesDemonsRegistrationFilter() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  InitializeIteration() override;

  void
  ApplyUpdate(const TimeStepType & dt) override;
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkSymmetricForcesDemonsRegistrationFilter.hxx"
#endif
 
#endif