itkHistogramImageToImageMetric.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkHistogramImageToImageMetric.h,v $
  Language:  C++
  Date:      $Date: 2009-05-02 05:43:54 $
  Version:   $Revision: 1.17 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkHistogramImageToImageMetric_h
#define __itkHistogramImageToImageMetric_h

#include "itkHistogram.h"
#include "itkImageToImageMetric.h"

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

  itkTypeMacro(HistogramImageToImageMetric, ImageToImageMetric);

  typedef typename Superclass::RealType                   RealType;
  typedef typename Superclass::TransformType              TransformType;
  typedef typename Superclass::TransformPointer           TransformPointer;
  typedef typename Superclass::TransformParametersType
                                                          TransformParametersType;
  typedef typename Superclass::TransformJacobianType
                                                          TransformJacobianType;
  typedef typename Superclass::GradientPixelType          GradientPixelType;
  typedef typename Superclass::InputPointType             InputPointType;
  typedef typename Superclass::OutputPointType            OutputPointType;
  typedef typename Superclass::MeasureType                MeasureType;
  typedef typename Superclass::DerivativeType             DerivativeType;
  typedef typename Superclass::FixedImageType             FixedImageType;
  typedef typename Superclass::FixedImageType::PixelType  FixedImagePixelType;
  typedef typename Superclass::MovingImageType            MovingImageType;
  typedef typename Superclass::MovingImageType::PixelType MovingImagePixelType;
  typedef typename Superclass::FixedImageConstPointer
                                                          FixedImageConstPointerType;
  typedef typename Superclass::MovingImageConstPointer
                                                          MovingImageConstPointerType;

#ifdef ITK_USE_REVIEW_STATISTICS
  typedef Statistics::Histogram<double>                  HistogramType;
#else
  typedef Statistics::Histogram<double, 2>               HistogramType;
#endif

  typedef typename HistogramType::MeasurementVectorType  MeasurementVectorType;
  typedef typename HistogramType::SizeType               HistogramSizeType;
  typedef typename HistogramType::Pointer                HistogramPointer;

  void Initialize() throw (ExceptionObject);

  void SetTransform( TransformType * transform );

  itkSetMacro( HistogramSize, HistogramSizeType );

  itkGetConstReferenceMacro( HistogramSize, HistogramSizeType );

  itkSetMacro( UpperBoundIncreaseFactor, double );
  itkGetConstMacro( UpperBoundIncreaseFactor, double );

  itkSetMacro( PaddingValue, FixedImagePixelType );

  itkGetConstReferenceMacro( PaddingValue, FixedImagePixelType );

  itkGetConstReferenceMacro( Histogram, HistogramPointer );

  itkSetMacro( UsePaddingValue, bool );
  itkGetConstMacro( UsePaddingValue, bool );

  itkSetMacro( DerivativeStepLength, double );

  itkGetConstMacro( DerivativeStepLength, double );

  typedef Array<double> ScalesType;

  itkSetMacro( DerivativeStepLengthScales, ScalesType );

  itkGetConstReferenceMacro(DerivativeStepLengthScales, ScalesType);

  MeasureType GetValue(const TransformParametersType& parameters) const;

  void GetDerivative(const TransformParametersType & parameters,
                     DerivativeType & derivative) const;

  void GetValueAndDerivative(const TransformParametersType & parameters,
                             MeasureType& Value,
                             DerivativeType& Derivative) const;

  void SetLowerBound( const MeasurementVectorType & bound );

  void SetUpperBound( const MeasurementVectorType & bound );


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

  HistogramSizeType m_HistogramSize;

  mutable MeasurementVectorType m_LowerBound;

  mutable MeasurementVectorType m_UpperBound;

  double m_UpperBoundIncreaseFactor;

  bool m_LowerBoundSetByUser;

  bool m_UpperBoundSetByUser;

  void ComputeHistogram(const TransformParametersType & parameters,
                        HistogramType& histogram) const;

  void ComputeHistogram(const TransformParametersType & parameters,
                        unsigned int parameter,
                        double step,
                        HistogramType& histogram) const;

  void CopyHistogram(HistogramType& target, HistogramType& source) const;

  virtual MeasureType EvaluateMeasure(HistogramType& histogram) const = 0;

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

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

  FixedImagePixelType m_PaddingValue;

  bool m_UsePaddingValue;

  double m_DerivativeStepLength;

  ScalesType m_DerivativeStepLengthScales;

  HistogramPointer  m_Histogram;

};

} // end namespace itk

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

#endif // __itkHistogramImageToImageMetric_h