itkPDEDeformableRegistrationFilter.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 itkPDEDeformableRegistrationFilter_h
#define itkPDEDeformableRegistrationFilter_h

#include "itkDenseFiniteDifferenceImageFilter.h"
#include "itkPDEDeformableRegistrationFunction.h"

namespace itk
{
template< typename TFixedImage, typename TMovingImage, typename TDisplacementField >
class ITK_TEMPLATE_EXPORT PDEDeformableRegistrationFilter:
  public DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(PDEDeformableRegistrationFilter);

  using Self = PDEDeformableRegistrationFilter;
  using Superclass = DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkNewMacro(Self);

  itkTypeMacro(PDEDeformableRegistrationFilter,
               DenseFiniteDifferenceImageFilter);

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

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

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

  using OutputImageType = typename Superclass::OutputImageType;

  using FiniteDifferenceFunctionType = typename Superclass::FiniteDifferenceFunctionType;

  using PDEDeformableRegistrationFunctionType = PDEDeformableRegistrationFunction< FixedImageType, MovingImageType,
                                             DisplacementFieldType >;

  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  itkSetInputMacro(FixedImage, FixedImageType);

  itkGetInputMacro(FixedImage, FixedImageType);

  itkSetInputMacro(MovingImage, MovingImageType);

  itkGetInputMacro(MovingImage, MovingImageType);

  itkSetInputMacro(InitialDisplacementField, DisplacementFieldType);

  itkGetInputMacro(InitialDisplacementField, DisplacementFieldType);

  DisplacementFieldType * GetDisplacementField()
  { return this->GetOutput(); }

  std::vector< SmartPointer< DataObject > >::size_type GetNumberOfValidRequiredInputs() const override;

  itkSetMacro(SmoothDisplacementField, bool);
  itkGetConstMacro(SmoothDisplacementField, bool);
  itkBooleanMacro(SmoothDisplacementField);

  using StandardDeviationsType = FixedArray< double, ImageDimension >;

  itkSetMacro(StandardDeviations, StandardDeviationsType);
  virtual void SetStandardDeviations(double value);

  itkGetConstReferenceMacro(StandardDeviations, StandardDeviationsType);

  itkSetMacro(SmoothUpdateField, bool);
  itkGetConstMacro(SmoothUpdateField, bool);
  itkBooleanMacro(SmoothUpdateField);

  itkSetMacro(UpdateFieldStandardDeviations, StandardDeviationsType);
  virtual void SetUpdateFieldStandardDeviations(double value);

  itkGetConstReferenceMacro(UpdateFieldStandardDeviations, StandardDeviationsType);

  virtual void StopRegistration()
  { m_StopRegistrationFlag = true; }

  itkSetMacro(MaximumError, double);
  itkGetConstMacro(MaximumError, double);

  itkSetMacro(MaximumKernelWidth, unsigned int);
  itkGetConstMacro(MaximumKernelWidth, unsigned int);

protected:
  PDEDeformableRegistrationFilter();
  ~PDEDeformableRegistrationFilter() override = default;
  void PrintSelf(std::ostream & os, Indent indent) const override;

  bool Halt() override
  {
    if ( m_StopRegistrationFlag )
      {
      return true;
      }

    return this->Superclass::Halt();
  }

  void CopyInputToOutput() override;

  void InitializeIteration() override;

  virtual void SmoothDisplacementField();

  virtual void SmoothUpdateField();

  void PostProcessOutput() override;

  void Initialize() override;

  void GenerateOutputInformation() override;

  void GenerateInputRequestedRegion() override;

private:
  StandardDeviationsType m_StandardDeviations;
  StandardDeviationsType m_UpdateFieldStandardDeviations;

  bool m_SmoothDisplacementField;
  bool m_SmoothUpdateField;

  DisplacementFieldPointer m_TempField;

private:
  double m_MaximumError;

  unsigned int m_MaximumKernelWidth;

  bool m_StopRegistrationFlag;
};
} // end namespace itk

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

#endif