itkHistogramSimilarityMeasure.h

Go to the documentation of this file.

/*=============================================================================

  NifTK: A software platform for medical image computing.

  Copyright (c) University College London (UCL). All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.

  See LICENSE.txt in the top level directory for details.

=============================================================================*/

#ifndef itkHistogramSimilarityMeasure_h
#define itkHistogramSimilarityMeasure_h

#include "itkUCLHistogram.h"
#include "itkFiniteDifferenceGradientSimilarityMeasure.h"

namespace itk
{
template <class TFixedImage, class TMovingImage>
class ITK_EXPORT HistogramSimilarityMeasure : 
public FiniteDifferenceGradientSimilarityMeasure<TFixedImage, TMovingImage>
{
public:
  
  typedef HistogramSimilarityMeasure                      Self;
  typedef SimilarityMeasure<TFixedImage, TMovingImage>    Superclass;
  typedef SmartPointer<Self>                              Pointer;
  typedef SmartPointer<const Self>                        ConstPointer;

  itkTypeMacro(HistogramSimilarityMeasure, SimilarityMeasure);
 
  typedef typename Superclass::MeasureType                MeasureType;
  typedef typename Superclass::ParametersType             ParametersType;
  typedef typename Superclass::DerivativeType             DerivativeType;
  typedef typename Superclass::FixedImagePixelType        FixedImagePixelType;
  typedef typename Superclass::MovingImagePixelType       MovingImagePixelType;
  
  typedef Statistics::UCLHistogram<double, 2>             HistogramType;
  typedef typename HistogramType::Pointer                 HistogramPointer;
  typedef typename HistogramType::SizeType                HistogramSizeType;
  typedef typename HistogramType::MeasurementVectorType   HistogramMeasurementVectorType;
  typedef typename HistogramType::AbsoluteFrequencyType   HistogramFrequencyType;
  typedef typename HistogramType::Iterator                HistogramIteratorType;
  
  void Initialize() throw (ExceptionObject);

  void SetHistogramSize(int x, int y)
    {
      // The size of this vector is templated in base class.
      niftkitkDebugMacro(<< "HistogramSimilarityMeasure():Setting size to [" << niftk::ConvertToString((int)x) \
          << "," << niftk::ConvertToString((int)y) << "]");
      
      HistogramSizeType size(2);
      size[0] = x;
      size[1] = y;
      this->SetHistogramSize(size);
    };

  itkSetMacro( HistogramSize, HistogramSizeType );

  itkGetConstReferenceMacro( HistogramSize, HistogramSizeType );

  itkGetObjectMacro( Histogram, HistogramType );

  itkSetMacro(UseParzenFilling, bool);
  itkGetMacro(UseParzenFilling, bool);

  double GetParzenValue(double x);
  
  double GetParzenDerivative(double x);

protected:
  
  HistogramSimilarityMeasure();
  virtual ~HistogramSimilarityMeasure() {};

  HistogramSizeType m_HistogramSize;

  void ResetCostFunction() 
    {
      HistogramMeasurementVectorType lowerBounds(2);
      lowerBounds[0] = this->GetFixedLowerBound();
      lowerBounds[1] = this->GetMovingLowerBound();
      HistogramMeasurementVectorType upperBounds(2);
      upperBounds[0] = this->GetFixedUpperBound();
      upperBounds[1] = this->GetMovingUpperBound();
      
//      niftkitkDebugMacro(<< "HistogramSimilarityMeasure():Resetting histogram to size:" << this->m_HistogramSize << ", lowerBounds:" << lowerBounds << ", upperBounds:" << upperBounds);
      this->m_Histogram->Initialize( this->m_HistogramSize, lowerBounds, upperBounds );
      this->m_Histogram->SetToZero();
    }

  void AggregateCostFunctionPair(FixedImagePixelType fixedValue, MovingImagePixelType movingValue);
  
  void PrintSelf(std::ostream& os, Indent indent) const;

  MeasureType MeanFixed() const { return this->m_Histogram->MeanFixed(); }

  MeasureType MeanMoving() const { return this->m_Histogram->MeanMoving(); }

  MeasureType VarianceFixed() const { return this->m_Histogram->VarianceFixed(); }

  MeasureType VarianceMoving() const { return this->m_Histogram->VarianceMoving(); }

  MeasureType Covariance() const { return this->m_Histogram->Covariance(); }
  
  MeasureType EntropyFixed() const { return this->m_Histogram->EntropyFixed(); }
  
  MeasureType EntropyMoving() const { return this->m_Histogram->EntropyMoving(); }
  
  MeasureType JointEntropy() const { return this->m_Histogram->JointEntropy(); }

  HistogramPointer  m_Histogram;

private:
  HistogramSimilarityMeasure(const Self&);  // purposefully not implemented
  void operator=(const Self&);              // purposefully not implemented

  bool m_UseParzenFilling;
  
};

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkHistogramSimilarityMeasure.txx"
#endif

#endif // __itkHistogramSimilarityMeasure_h