itkVariationalRegistrationNCCFunction.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 itkVariationalRegistrationNCCFunction_h
#define itkVariationalRegistrationNCCFunction_h

#include "itkVariationalRegistrationFunction.h"
#include "itkCovariantVector.h"
#include "itkInterpolateImageFunction.h"
#include "itkLinearInterpolateImageFunction.h"
#include "itkCentralDifferenceImageFunction.h"

namespace itk {

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

  using Self = VariationalRegistrationNCCFunction;
  using Superclass = VariationalRegistrationFunction< TFixedImage,  TMovingImage, TDisplacementField >;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkNewMacro(Self);

  itkTypeMacro( VariationalRegistrationNCCFunction, VariationalRegistrationFunction );

  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  using MovingImageType = typename Superclass::MovingImageType;
  using MovingImagePointer = typename Superclass::MovingImagePointer;

  using FixedImageType = typename Superclass::FixedImageType;
  using FixedImagePointer = typename Superclass::FixedImagePointer;

  using MaskImageType = typename Superclass::MaskImageType;
  using MaskImagePointer = typename Superclass::MaskImagePointer;

  using IndexType = typename FixedImageType::IndexType;
  using SizeType = typename FixedImageType::SizeType;
  using SpacingType = typename FixedImageType::SpacingType;

  using DisplacementFieldType = typename Superclass::DisplacementFieldType;
  using DisplacementFieldTypePointer = typename Superclass::DisplacementFieldTypePointer;

  using PixelType = typename Superclass::PixelType;
  using RadiusType = typename Superclass::RadiusType;
  using NeighborhoodType = typename Superclass::NeighborhoodType;
  using FloatOffsetType = typename Superclass::FloatOffsetType;

  using GradientCalculatorType = CentralDifferenceImageFunction<FixedImageType>;
  using GradientCalculatorPointer = typename GradientCalculatorType::Pointer;

  void InitializeIteration() override;

  PixelType ComputeUpdate( const NeighborhoodType &neighborhood,
                    void *globalData,
                    const FloatOffsetType &offset = FloatOffsetType(0.0) ) 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; }

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

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

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

  using FixedImageNeighborhoodIteratorType = ConstNeighborhoodIterator<FixedImageType>;

  using GlobalDataStruct = typename Superclass::GlobalDataStruct;

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

  GradientCalculatorPointer       m_FixedImageGradientCalculator;

  GradientCalculatorPointer       m_WarpedImageGradientCalculator;

  GradientType                    m_GradientType;

  double                          m_Normalizer;
};


} // end namespace itk

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

#endif