freDifferenceHistogramImageToImageMetric.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   F.R.E.E. - flexible registration evaluation engine
  Version:   v.1.0.0
  Date:      $Date: 2006/09/01 12:00:00 $
  Module:    $RCSfile: freDifferenceHistogramImageToImageMetric.h,v $
  Language:  C++
 
 
 
  Copyright (c) 2007 Ralf o Floca (Department of Medical Informatics,
  Institute for Medical Biometry and Informatics, University of Heidelberg,
  Germany). All rights reserved.
  See FREECopyright.txt or http://www.mi.med.uni-hd.de/free/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 __freDifferenceHistogramImageToImageMetric_h
#define __freDifferenceHistogramImageToImageMetric_h

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

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

    itkTypeMacro(DifferenceHistogramImageToImageMetric, 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 TDifImage                                       DifferenceImageType;
    typedef typename DifferenceImageType::PixelType         DifferenceImagePixelType;
    typedef typename Superclass::FixedImageConstPointer
    FixedImageConstPointer;
    typedef typename Superclass::MovingImageConstPointer
    MovingImageConstPointer;

    typedef Statistics::Histogram<double, 1> HistogramType;
    typedef typename HistogramType::MeasurementVectorType  MeasurementVectorType;
    typedef typename HistogramType::SizeType               HistogramSizeType;
    typedef typename HistogramType::Pointer                HistogramPointer;

    void Initialize() throw (ExceptionObject);

    itkSetMacro( HistogramSize, HistogramSizeType );

    itkGetConstReferenceMacro( HistogramSize, HistogramSizeType );

    itkSetMacro( UpperBoundIncreaseFactor, double );
    itkGetMacro( UpperBoundIncreaseFactor, double );

    itkGetConstReferenceMacro( Histogram, HistogramPointer );

    itkSetMacro( UseMask, bool );
    itkGetMacro( UseMask, bool );

    itkGetConstMacro( MaskedMaximum, FixedImagePixelType );
    itkSetMacro( MaskedMaximum, FixedImagePixelType );
    itkGetConstMacro( MaskedMinimum, FixedImagePixelType );
    itkSetMacro( MaskedMinimum, FixedImagePixelType );

    itkSetMacro( DerivativeStepLength, double );

    itkGetMacro( DerivativeStepLength, double );

    MeasureType GetValue(const TransformParametersType& parameters) const;

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

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

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

    HistogramSizeType m_HistogramSize;
    double m_UpperBoundIncreaseFactor;

    mutable MeasurementVectorType m_LowerBound;
    mutable MeasurementVectorType m_UpperBound;

    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;

    inline bool IsMaskedValue(const RealType& value) const
    {
        return (value<=m_MaskedMaximum) && (value>=m_MaskedMinimum);
    };

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

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

    FixedImagePixelType m_MaskedMaximum;
    FixedImagePixelType m_MaskedMinimum;

    bool m_UseMask;

    double m_DerivativeStepLength;

    HistogramPointer  m_Histogram;
};

} // end namespace itk

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

#endif // __freDifferenceHistogramImageToImageMetric_h

---