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< class TFixedImage, class TMovingImage, class TDisplacementField>
class VariationalDiffeomorphicRegistrationFilter
  : public VariationalRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
{
public:
  typedef VariationalDiffeomorphicRegistrationFilter   Self;
  typedef VariationalRegistrationFilter<
      TFixedImage, TMovingImage, TDisplacementField >  Superclass;
  typedef SmartPointer<Self>                           Pointer;
  typedef SmartPointer<const Self>                     ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(itkVariationalDiffeomorphicRegistrationFilter, VariationalRegistrationFilter );

  itkStaticConstMacro(ImageDimension, unsigned int,Superclass::ImageDimension);

  typedef TFixedImage                              FixedImageType;
  typedef typename FixedImageType::Pointer         FixedImagePointer;
  typedef typename FixedImageType::ConstPointer    FixedImageConstPointer;

  typedef TMovingImage                             MovingImageType;
  typedef typename MovingImageType::Pointer        MovingImagePointer;
  typedef typename MovingImageType::ConstPointer   MovingImageConstPointer;

  typedef TDisplacementField                       DisplacementFieldType;
  typedef typename DisplacementFieldType::Pointer  DisplacementFieldPointer;

  typedef typename Superclass::OutputImageType     OutputImageType;

  typedef typename Superclass::RegistrationFunctionType RegistrationFunctionType;

  typedef typename Superclass::RegularizerType     RegularizerType;

  typedef typename Superclass::TimeStepType        TimeStepType;

  itkSetMacro( NumberOfExponentiatorIterations, unsigned int );

  itkGetConstMacro( NumberOfExponentiatorIterations, unsigned int );

  virtual void SetInitialDisplacementField( DisplacementFieldType * ptr ) ITK_OVERRIDE;

  virtual DisplacementFieldType * GetDisplacementField() ITK_OVERRIDE
    { return m_DisplacementField; }

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

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

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

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

  virtual void Initialize() ITK_OVERRIDE;

  virtual void ApplyUpdate( const TimeStepType& dt ) ITK_OVERRIDE;

  virtual void CalcDeformationFromVelocityField( const DisplacementFieldType * velocityField );

  typedef itk::ExponentialDisplacementFieldImageFilter<
      DisplacementFieldType, DisplacementFieldType>  FieldExponentiatorType;

  typedef typename FieldExponentiatorType::Pointer FieldExponentiatorPointer;

  virtual FieldExponentiatorPointer GetExponentiator()
    { return m_Exponentiator; }

private:
  VariationalDiffeomorphicRegistrationFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  FieldExponentiatorPointer m_Exponentiator;
  DisplacementFieldPointer  m_DisplacementField;

  unsigned int m_NumberOfExponentiatorIterations;

};

}// end namespace itk

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

#endif