itkVariationalSymmetricDiffeomorphicRegistrationFilter.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 itkVariationalSymmetricDiffeomorphicRegistrationFilter_h
#define itkVariationalSymmetricDiffeomorphicRegistrationFilter_h

#include "itkVariationalDiffeomorphicRegistrationFilter.h"

namespace itk {

template< class TFixedImage, class TMovingImage, class TDisplacementField>
class VariationalSymmetricDiffeomorphicRegistrationFilter
  : public VariationalDiffeomorphicRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >
{
public:
  typedef VariationalSymmetricDiffeomorphicRegistrationFilter  Self;
  typedef VariationalDiffeomorphicRegistrationFilter<
      TFixedImage, TMovingImage, TDisplacementField >          Superclass;
  typedef SmartPointer< Self >                                 Pointer;
  typedef SmartPointer< const Self >                           ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(itkVariationalSymmetricDiffeomorphicRegistrationFilter, VariationalDiffeomorphicRegistrationFilter);

  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 OutputImageType                          UpdateBufferType;

  typedef typename Superclass::RegistrationFunctionType RegistrationFunctionType;

  typedef typename Superclass::RegularizerType     RegularizerType;

  typedef typename Superclass::TimeStepType        TimeStepType;

  itkGetModifiableObjectMacro( InverseDisplacementField, DisplacementFieldType );

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

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

  virtual void Initialize() ITK_OVERRIDE;

  virtual void InitializeBackwardIteration();

  virtual void ApplyUpdate( const TimeStepType& dt ) ITK_OVERRIDE;

  virtual TimeStepType CalculateChange() ITK_OVERRIDE;

  virtual void CalcInverseDeformationFromVelocityField( const DisplacementFieldType * velocityField );

  itkGetModifiableObjectMacro( BackwardUpdateBuffer, UpdateBufferType );

  typedef typename UpdateBufferType::RegionType ThreadRegionType;

  virtual void ThreadedApplyUpdate( const TimeStepType &dt,
                                    const ThreadRegionType &regionToProcess,
                                    unsigned int threadId ) ITK_OVERRIDE;

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

  typedef typename Superclass::FieldExponentiatorType FieldExponentiatorType;
  typedef typename FieldExponentiatorType::Pointer    FieldExponentiatorPointer;

  FieldExponentiatorPointer            m_InverseExponentiator;
  DisplacementFieldPointer             m_InverseDisplacementField;
  typename UpdateBufferType::Pointer   m_BackwardUpdateBuffer;

};

}// end namespace itk

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

#endif