itkVariationalRegistrationFunction.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 itkVariationalRegistrationFunction_h
#define itkVariationalRegistrationFunction_h

#include "itkFiniteDifferenceFunction.h"
//#include "itkWarpImageFilter.h"
#include "itkContinuousBorderWarpImageFilter.h"
#include <mutex>

namespace itk {

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

  using Self = VariationalRegistrationFunction;
  using Superclass = FiniteDifferenceFunction< TDisplacementField >;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  using TimeStepType = typename Superclass::TimeStepType;

  itkTypeMacro(VariationalRegistrationFunction, FiniteDifferenceFunction);

  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  using MovingImageType = TMovingImage;
  using MovingImagePointer = typename MovingImageType::ConstPointer;

  using FixedImageType = TFixedImage;
  using FixedImagePointer = typename FixedImageType::ConstPointer;

  using WarpedImageType = TFixedImage;
  using WarpedImagePointer = typename WarpedImageType::ConstPointer;

  using DisplacementFieldType = TDisplacementField;
  using DisplacementFieldTypePointer = typename DisplacementFieldType::ConstPointer;

  using MaskImagePixelType = unsigned char;
  using MaskImageType = Image< MaskImagePixelType, ImageDimension >;
  using MaskImagePointer = typename MaskImageType::ConstPointer;

  // uncomment the following line to use the standard ITK warper (not recommended)
  //typedef itk::WarpImageFilter< FixedImageType, WarpedImageType, DisplacementFieldType >
  using MovingImageWarperType = itk::ContinuousBorderWarpImageFilter< FixedImageType, WarpedImageType, DisplacementFieldType >;
  using MovingImageWarperPointer = typename MovingImageWarperType::Pointer;


  virtual void SetMovingImage( const MovingImageType * ptr )
    { m_MovingImage = ptr; }

  virtual const MovingImageType * GetMovingImage(void) const
    { return m_MovingImage; }

  virtual void SetFixedImage( const FixedImageType * ptr )
    { m_FixedImage = ptr; }

  virtual const FixedImageType * GetFixedImage(void) const
    { return m_FixedImage; }

  virtual void SetDisplacementField(  DisplacementFieldType * ptr )
    { m_DisplacementField = ptr; }

  virtual const DisplacementFieldType * GetDisplacementField(void) const
    { return m_DisplacementField; }

  virtual void SetMaskImage( const MaskImageType * ptr )
    { m_MaskImage  = ptr; }

  virtual const MaskImageType * GetMaskImage(void) const
    { return m_MaskImage; }

  virtual void SetMovingImageWarper( MovingImageWarperType * ptr )
    { m_MovingImageWarper  = ptr; }

  virtual const MovingImageWarperType * GetMovingImageWarper(void) const
    { return m_MovingImageWarper; }

  virtual void SetTimeStep(  TimeStepType timeStep )
    { m_TimeStep = timeStep; }

  virtual const TimeStepType GetTimeStep(void) const
    { return m_TimeStep; }

  virtual void SetMaskBackgroundThreshold(  MaskImagePixelType threshold )
    { m_MaskBackgroundThreshold = threshold; }

  virtual MaskImagePixelType GetMaskBackgroundThreshold(void) const
    { return m_MaskBackgroundThreshold; }

  void InitializeIteration() override;

  TimeStepType ComputeGlobalTimeStep(void * itkNotUsed(GlobalData)) const override
    { return m_TimeStep; }

  void *GetGlobalDataPointer() const override;

  void ReleaseGlobalDataPointer(void *GlobalData) const override;

  //
  // Metric accessor methods
  virtual double GetMetric() const
    { return m_Metric; }

  virtual double GetRMSChange() const
    { return m_RMSChange; }

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

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

  virtual void WarpMovingImage(void);

  virtual const WarpedImagePointer GetWarpedImage(void) const;

  struct GlobalDataStruct
    {
    double          m_SumOfMetricValues;
    SizeValueType   m_NumberOfPixelsProcessed;
    double          m_SumOfSquaredChange;
    };

private:
  MovingImagePointer              m_MovingImage;

  FixedImagePointer               m_FixedImage;

  DisplacementFieldTypePointer    m_DisplacementField;

  MaskImagePointer                m_MaskImage;

  MovingImageWarperPointer        m_MovingImageWarper;

  TimeStepType                    m_TimeStep;

  MaskImagePixelType              m_MaskBackgroundThreshold;

  mutable double                  m_Metric;
  mutable double                  m_SumOfMetricValues;
  mutable SizeValueType           m_NumberOfPixelsProcessed;
  mutable double                  m_RMSChange;
  mutable double                  m_SumOfSquaredChange;

  mutable std::mutex              m_MetricCalculationLock;
};

} // end namespace itk

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

#endif