otbNCCRegistrationFunction.h

Go to the documentation of this file.

/*
 * Copyright (C) 1999-2011 Insight Software Consortium
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * 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
 *
 * 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 otbNCCRegistrationFunction_h
#define otbNCCRegistrationFunction_h
 
#include "itkPDEDeformableRegistrationFunction.h"
#include "itkPoint.h"
#include "itkLinearInterpolateImageFunction.h"
#include "itkCentralDifferenceImageFunction.h"
 
namespace otb
{
 
template <class TFixedImage, class TMovingImage, class TDisplacementField>
class ITK_EXPORT NCCRegistrationFunction : public itk::PDEDeformableRegistrationFunction<TFixedImage, TMovingImage, TDisplacementField>
{
public:
 
  typedef NCCRegistrationFunction Self;
  typedef itk::PDEDeformableRegistrationFunction<TFixedImage, TMovingImage, TDisplacementField> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(NCCRegistrationFunction, PDEDeformableRegistrationFunction);
 
  typedef typename Superclass::MovingImageType    MovingImageType;
  typedef typename Superclass::MovingImagePointer MovingImagePointer;
 
  typedef typename Superclass::FixedImageType    FixedImageType;
  typedef typename Superclass::FixedImagePointer FixedImagePointer;
  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;
 
  itkStaticConstMacro(ImageDimension, unsigned int, Superclass::ImageDimension);
 
  typedef typename Superclass::PixelType        PixelType;
  typedef typename Superclass::RadiusType       RadiusType;
  typedef typename Superclass::NeighborhoodType NeighborhoodType;
  //  typedef typename Superclass::NeighborhoodType    BoundaryNeighborhoodType;
  typedef typename Superclass::FloatOffsetType FloatOffsetType;
  typedef typename Superclass::TimeStepType    TimeStepType;
 
  typedef double CoordRepType;
  typedef itk::InterpolateImageFunction<MovingImageType, CoordRepType> InterpolatorType;
  typedef typename InterpolatorType::Pointer   InterpolatorPointer;
  typedef typename InterpolatorType::PointType PointType;
  typedef itk::LinearInterpolateImageFunction<MovingImageType, CoordRepType> DefaultInterpolatorType;
 
  typedef itk::CovariantVector<double, itkGetStaticConstMacro(ImageDimension)> CovariantVectorType;
 
  typedef itk::CentralDifferenceImageFunction<FixedImageType> GradientCalculatorType;
  typedef typename GradientCalculatorType::Pointer            GradientCalculatorPointer;
 
  void SetMovingImageInterpolator(InterpolatorType* ptr)
  {
    m_MovingImageInterpolator = ptr;
  }
 
  InterpolatorType* GetMovingImageInterpolator(void)
  {
    return m_MovingImageInterpolator;
  }
 
  TimeStepType ComputeGlobalTimeStep(void* itkNotUsed(GlobalData)) const override
  {
    return m_TimeStep;
  }
 
  void* GetGlobalDataPointer() const override
  {
    GlobalDataStruct* global = new GlobalDataStruct();
    return global;
  }
 
  void ReleaseGlobalDataPointer(void* GlobalData) const override
  {
    delete (GlobalDataStruct*)GlobalData;
  }
 
  void InitializeIteration() override;
 
  PixelType ComputeUpdate(const NeighborhoodType& neighborhood, void* globalData, const FloatOffsetType& offset = FloatOffsetType(0.0)) override;
 
protected:
  NCCRegistrationFunction();
  ~NCCRegistrationFunction() override
  {
  }
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  typedef itk::ConstNeighborhoodIterator<FixedImageType> FixedImageNeighborhoodIteratorType;
 
  struct GlobalDataStruct
  {
    FixedImageNeighborhoodIteratorType m_FixedImageIterator;
  };
 
private:
  NCCRegistrationFunction(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  SpacingType m_FixedImageSpacing;
  PointType   m_FixedImageOrigin;
 
  GradientCalculatorPointer m_FixedImageGradientCalculator;
 
  InterpolatorPointer m_MovingImageInterpolator;
 
  TimeStepType m_TimeStep;
 
  double m_DenominatorThreshold;
 
  double m_IntensityDifferenceThreshold;
 
  mutable double m_MetricTotal;
};
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbNCCRegistrationFunction.hxx"
#endif
 
#endif