itkVariationalRegistrationFastNCCFunction.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 itkVariationalRegistrationFastNCCFunction_h
#define itkVariationalRegistrationFastNCCFunction_h

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

namespace itk {

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

  using Self = VariationalRegistrationFastNCCFunction;
  using Superclass = VariationalRegistrationNCCFunction< TFixedImage,  TMovingImage, TDisplacementField >;

  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkNewMacro(Self);

  itkTypeMacro( VariationalRegistrationFastNCCFunction, VariationalRegistrationNCCFunction );

  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;
  typedef typename Superclass::DisplacementFieldTypePointer
                                                     DisplacementFieldTypePointer;

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

  using GradientCalculatorType = typename Superclass::GradientCalculatorType;
  using GradientCalculatorPointer = typename GradientCalculatorType::Pointer;

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

   void *GetGlobalDataPointer() const override;

   void ReleaseGlobalDataPointer(void *GlobalData) const override;

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

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

  using GlobalDataStruct = typename Superclass::GlobalDataStruct;

  struct NCCGlobalDataStruct
    {
    double          m_SumOfMetricValues;
    SizeValueType   m_NumberOfPixelsProcessed;
    double          m_SumOfSquaredChange;
    IndexType       m_LastIndex;
    bool bValuesAreValid;
    unsigned int lastSliceIndex;
    std::vector<double> sfSliceValueList;
    std::vector<double> smSliceValueList;
    std::vector<double> sffSliceValueList;
    std::vector<double> smmSliceValueList;
    std::vector<double> sfmSliceValueList;
    double sfLastValue;
    double smLastValue;
    double sffLastValue;
    double smmLastValue;
    double sfmLastValue;
    };
};


} // end namespace itk

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

#endif