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"

namespace itk {

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

  typedef typename Superclass::TimeStepType              TimeStepType;

  itkTypeMacro(VariationalRegistrationFunction, FiniteDifferenceFunction);

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

  typedef TMovingImage                                   MovingImageType;
  typedef typename MovingImageType::ConstPointer         MovingImagePointer;

  typedef TFixedImage                                    FixedImageType;
  typedef typename FixedImageType::ConstPointer          FixedImagePointer;

  typedef TFixedImage                                    WarpedImageType;
  typedef typename WarpedImageType::ConstPointer         WarpedImagePointer;

  typedef TDisplacementField                             DisplacementFieldType;
  typedef typename DisplacementFieldType::ConstPointer   DisplacementFieldTypePointer;

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

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


  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; }

  virtual void InitializeIteration() ITK_OVERRIDE;

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

  virtual void *GetGlobalDataPointer() const ITK_OVERRIDE;

  virtual void ReleaseGlobalDataPointer(void *GlobalData) const ITK_OVERRIDE;

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

  virtual double GetRMSChange() const
    { return m_RMSChange; }

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

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

  virtual void WarpMovingImage(void);

  virtual const WarpedImagePointer GetWarpedImage(void) const;

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

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

  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 SimpleFastMutexLock     m_MetricCalculationLock;
};

} // end namespace itk

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

#endif