itkVariationalRegistrationSSDFunction.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 itkVariationalRegistrationSSDFunction_h
#define itkVariationalRegistrationSSDFunction_h

#include "itkVariationalRegistrationFunction.h"

#include "itkCentralDifferenceImageFunction.h"

namespace itk {

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

  itkNewMacro(Self);

  itkTypeMacro( VariationalRegistrationSSDFunction, VariationalRegistrationFunction );

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

  typedef typename Superclass::MovingImageType       MovingImageType;
  typedef typename Superclass::MovingImagePointer    MovingImagePointer;

  typedef typename Superclass::FixedImageType        FixedImageType;
  typedef typename Superclass::FixedImagePointer     FixedImagePointer;

  typedef typename Superclass::MaskImageType         MaskImageType;
  typedef typename Superclass::MaskImagePointer      MaskImagePointer;

  typedef typename FixedImageType::IndexType         IndexType;
  typedef typename FixedImageType::SizeType          SizeType;
  typedef typename FixedImageType::SpacingType       SpacingType;

  typedef typename Superclass::DisplacementFieldType DisplacementFieldType;
  typedef typename Superclass::DisplacementFieldTypePointer
                                                     DisplacementFieldTypePointer;

  typedef typename Superclass::PixelType             PixelType;
  typedef typename Superclass::RadiusType            RadiusType;
  typedef typename Superclass::NeighborhoodType      NeighborhoodType;
  typedef typename Superclass::FloatOffsetType       FloatOffsetType;

  typedef CentralDifferenceImageFunction<FixedImageType>
                                                     GradientCalculatorType;
  typedef typename GradientCalculatorType::Pointer   GradientCalculatorPointer;

  virtual void InitializeIteration() ITK_OVERRIDE;

  virtual PixelType ComputeUpdate(
      const NeighborhoodType &neighborhood,
      void *globalData,
      const FloatOffsetType &offset = FloatOffsetType( 0.0 ) ) ITK_OVERRIDE;

  virtual void SetGradientTypeToFixedImage()
    { m_GradientType = GRADIENT_TYPE_FIXED; }

  virtual void SetGradientTypeToWarpedMovingImage()
    { m_GradientType = GRADIENT_TYPE_WARPED; }

  virtual void SetGradientTypeToSymmetric()
    { m_GradientType = GRADIENT_TYPE_SYMMETRIC; }

  virtual void SetIntensityDifferenceThreshold( const double threshold )
    { m_IntensityDifferenceThreshold = threshold; }

  virtual double GetIntensityDifferenceThreshold() const
    { return m_IntensityDifferenceThreshold; }

  virtual typename Superclass::TimeStepType ComputeGlobalTimeStep(void * itkNotUsed(GlobalData)) const ITK_OVERRIDE
    { return this->GetTimeStep() * m_Normalizer; }

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

  typedef typename Superclass::GlobalDataStruct       GlobalDataStruct;

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

  enum GradientType {
    GRADIENT_TYPE_WARPED = 0,
    GRADIENT_TYPE_FIXED = 1,
    GRADIENT_TYPE_SYMMETRIC = 2
  };

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

  GradientCalculatorPointer       m_FixedImageGradientCalculator;

  GradientCalculatorPointer       m_WarpedImageGradientCalculator;

  GradientType                    m_GradientType;

  double                          m_IntensityDifferenceThreshold;

  double                          m_Normalizer;

  PixelType                       m_ZeroUpdateReturn;
};

} // end namespace itk

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

#endif