itkGoodnessOfFitFunctionBase.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkGoodnessOfFitFunctionBase.h,v $
  Language:  C++
  Date:      $Date: 2009-03-04 15:23:49 $
  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 __itkGoodnessOfFitFunctionBase_h
#define __itkGoodnessOfFitFunctionBase_h

#include "itkSampleAlgorithmBase.h"
#include "itkFunctionBase.h"
#include "itkGoodnessOfFitComponentBase.h"

namespace itk { 
namespace Statistics {

template< class TInputHistogram >
class GoodnessOfFitFunctionBase 
  : public SampleAlgorithmBase< TInputHistogram > 
{
public:
  typedef GoodnessOfFitFunctionBase              Self;
  typedef SampleAlgorithmBase< TInputHistogram > Superclass;
  typedef SmartPointer< Self >                   Pointer;
  typedef SmartPointer< const Self >             ConstPointer;
  
  itkTypeMacro(GoodnessOfFitFunctionBase, 
               SampleAlgorithimBase);
  
  itkNewMacro(Self);

  itkStaticConstMacro(MeasurementVectorSize, unsigned int, 
                      TInputHistogram::MeasurementVectorSize);

  typedef typename TInputHistogram::MeasurementType       MeasurementType;
  typedef typename TInputHistogram::MeasurementVectorType MeasurementVectorType;
  typedef TInputHistogram                                 InputHistogramType;

  void SetObservedHistogram(InputHistogramType* histogram);

  InputHistogramType* GetObservedHistogram() 
    { return m_ObservedHistogram; }

  void SetExpectedHistogram(InputHistogramType* histogram);

  InputHistogramType* GetExpectedHistogram() 
    { return m_ExpectedHistogram; }

  itkGetMacro(UseExpectedHistogram, bool);

  void SetTotalObservedScale(double* scale)
    { 
    if ( m_TotalObservedScale != scale )
      {
      m_TotalObservedScale = scale;
      this->Modified();
      }
    }

  typedef double OutputType;

  OutputType& GetOutput()
    { return m_Output; }

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

  itkSetMacro(UseExpectedHistogram, bool);
  
  virtual void GenerateData() {}

  itkGetConstReferenceMacro(Epsilon,float);
  itkGetConstReferenceMacro(LogEpsilon,float);

private:
  float m_Epsilon;
  float m_LogEpsilon;

  bool m_UseExpectedHistogram;

  InputHistogramType* m_ObservedHistogram;
  InputHistogramType* m_ExpectedHistogram;
  
  double*    m_TotalObservedScale;
  OutputType m_Output;

}; // end of class

} // end of namespace Statistics 
} // end of namespace itk

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

#endif