itkVariationalDiffeomorphicRegistrationFilter.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 itkVariationalDiffeomorphicRegistrationFilter_h
#define itkVariationalDiffeomorphicRegistrationFilter_h

#include "itkVariationalRegistrationFilter.h"
#include "itkExponentialDisplacementFieldImageFilter.h"


namespace itk {

template< typename TFixedImage, typename TMovingImage, typename TDisplacementField>
class VariationalDiffeomorphicRegistrationFilter
  : public VariationalRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(VariationalDiffeomorphicRegistrationFilter);

  using Self = VariationalDiffeomorphicRegistrationFilter;
  using Superclass = VariationalRegistrationFilter<
      TFixedImage, TMovingImage, TDisplacementField >;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);

  itkTypeMacro( VariationalDiffeomorphicRegistrationFilter, VariationalRegistrationFilter );

  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  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 RegistrationFunctionType = typename Superclass::RegistrationFunctionType;

  using RegularizerType = typename Superclass::RegularizerType;

  using TimeStepType = typename Superclass::TimeStepType;

  itkSetMacro( NumberOfExponentiatorIterations, unsigned int );

  itkGetConstMacro( NumberOfExponentiatorIterations, unsigned int );

  void SetInitialDisplacementField( DisplacementFieldType * ptr ) override;

  DisplacementFieldType * GetDisplacementField() override
    { return m_DisplacementField; }

  virtual void SetInitialVelocityField( DisplacementFieldType * ptr )
    { this->SetInput( ptr ); }

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

protected:
  VariationalDiffeomorphicRegistrationFilter();
  ~VariationalDiffeomorphicRegistrationFilter() override {}

  void PrintSelf(std::ostream& os, Indent indent) const override;

  void Initialize() override;

  void ApplyUpdate( const TimeStepType& dt ) override;

  virtual void CalcDeformationFromVelocityField( const DisplacementFieldType * velocityField );

  using FieldExponentiatorType = itk::ExponentialDisplacementFieldImageFilter<
      DisplacementFieldType, DisplacementFieldType>;

  using FieldExponentiatorPointer = typename FieldExponentiatorType::Pointer;

  virtual FieldExponentiatorPointer GetExponentiator()
    { return m_Exponentiator; }

private:
  FieldExponentiatorPointer m_Exponentiator;
  DisplacementFieldPointer  m_DisplacementField;

  unsigned int m_NumberOfExponentiatorIterations;

};

}// end namespace itk

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

#endif