itkCompareHistogramImageToImageMetric.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkCompareHistogramImageToImageMetric.h,v $
  Language:  C++
  Date:      $Date: 2008-10-23 16:15:23 $
  Version:   $Revision: 1.7 $

  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 __itkCompareHistogramImageToImageMetric_h
#define __itkCompareHistogramImageToImageMetric_h

#include "itkHistogramImageToImageMetric.h"

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

  itkTypeMacro(CompareHistogramImageToImageMetric,
    HistogramImageToImageMetric);

  typedef typename Superclass::RealType                 RealType;
  typedef typename Superclass::TransformType            TransformType;
  typedef typename Superclass::TransformPointer         TransformPointer;
  typedef typename TransformType::ConstPointer          TransformConstPointer;

  typedef typename Superclass::TransformParametersType
                                                        TransformParametersType;
  typedef typename Superclass::TransformJacobianType    TransformJacobianType;
  typedef typename Superclass::GradientPixelType        GradientPixelType;

  typedef typename Superclass::MeasureType              MeasureType;
  typedef typename Superclass::DerivativeType           DerivativeType;
  typedef typename Superclass::FixedImageType           FixedImageType;
  typedef typename Superclass::MovingImageType          MovingImageType;
  typedef typename Superclass::FixedImageConstPointer   FixedImageConstPointer;
  typedef typename Superclass::MovingImageConstPointer
                                                        MovingImageConstPointer;

  typedef typename Superclass::HistogramType            HistogramType;
  typedef typename Superclass::HistogramSizeType        HistogramSizeType;
  typedef typename HistogramType::MeasurementVectorType
                                                        HistogramMeasurementVectorType;
  typedef typename HistogramType::FrequencyType         HistogramFrequencyType;
  typedef typename HistogramType::Iterator              HistogramIteratorType;
  typedef typename HistogramType::Pointer               HistogramPointerType;

  typedef typename Superclass::InterpolatorType    InterpolatorType;
  typedef typename Superclass::InterpolatorPointer InterpolatorPointer;

  typedef typename Superclass::FixedImageRegionType 
                                                         FixedImageRegionType;

  itkSetMacro( TrainingHistogram, HistogramPointerType );

  itkGetConstReferenceMacro( TrainingHistogram, HistogramPointerType );

  itkSetConstObjectMacro( TrainingFixedImage, FixedImageType );

  itkGetConstObjectMacro( TrainingFixedImage, FixedImageType );

  itkSetConstObjectMacro( TrainingMovingImage, MovingImageType );

  itkGetConstObjectMacro( TrainingMovingImage, MovingImageType );

  itkSetObjectMacro( TrainingTransform, TransformType );

  itkGetObjectMacro( TrainingTransform, TransformType );

  itkSetObjectMacro( TrainingInterpolator, InterpolatorType );

  itkGetObjectMacro( TrainingInterpolator, InterpolatorType );

  itkSetMacro( TrainingFixedImageRegion, FixedImageRegionType );

  itkGetConstReferenceMacro( TrainingFixedImageRegion, FixedImageRegionType );

  unsigned int GetNumberOfParameters(void) const 
  { return this->GetTransform()->GetNumberOfParameters(); }

  void Initialize() throw (ExceptionObject);

protected:
  CompareHistogramImageToImageMetric();
  virtual ~CompareHistogramImageToImageMetric(){}
  void PrintSelf(std::ostream& os, Indent indent) const;

  void FormTrainingHistogram() throw (ExceptionObject);

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

private:
  // Purposely not implemented.
  CompareHistogramImageToImageMetric(Self const&);
  void operator=(Self const&); // Purposely not implemented.

  FixedImageConstPointer  m_TrainingFixedImage;
  MovingImageConstPointer m_TrainingMovingImage;
  TransformPointer        m_TrainingTransform;
  InterpolatorPointer     m_TrainingInterpolator;
  FixedImageRegionType    m_TrainingFixedImageRegion;
  HistogramPointerType    m_TrainingHistogram;

};

} // End namespace itk.

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

#endif // __itkCompareHistogramImageToImageMetric_h