itkGoodnessOfFitComponentBase.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkGoodnessOfFitComponentBase.h,v $
  Language:  C++
  Date:      $Date: 2009-03-04 15:23:48 $
  Version:   $Revision: 1.10 $

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

#include "itkObject.h"
#include "itkArray.h"
#include "itkHistogram.h"
#include "itkFunctionBase.h"
#include "itkNeighborhoodSampler.h"
#include "itkSampleToHistogramProjectionFilter.h"
#include "vnl/vnl_matrix.h"
#include "itkVariableSizeMatrix.h"

namespace itk { 
namespace Statistics {

template< class TInputSample >
class GoodnessOfFitComponentBase 
  : public Object 
{
public:
  typedef GoodnessOfFitComponentBase Self;
  typedef Object                     Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  itkTypeMacro(GoodnessOfFitComponentBase, Object);

  typedef TInputSample InputSampleType;

  
  typedef typename TInputSample::MeasurementType           MeasurementType;
  typedef typename TInputSample::MeasurementVectorType     MeasurementVectorType;
  typedef typename TInputSample::MeasurementVectorSizeType MeasurementVectorSizeType;

  typedef Subsample< TInputSample > ResampledSampleType;

  typedef Histogram< float, 1 >                   HistogramType;
  typedef typename HistogramType::Pointer         HistogramPointer;
  typedef typename HistogramType::ConstPointer    HistogramConstPointer;

  typedef Array< double >  ParametersType;

  typedef Array< double >  CenterType;

  typedef double RadiusType;

  typedef Array< double >   MeanType;


  typedef double StandardDeviationType;

  virtual void SetInputSample(const TInputSample* sample);
  const TInputSample* GetInputSample() const;

  virtual unsigned int GetNumberOfParameters() const = 0;

  virtual void SetParameters(const ParametersType &parameters);
  ParametersType* GetParameters()
    { return m_Parameters; }

  void SetUseExpectedHistogram(bool flag);

  void SetHistogramNumberOfBins(int numberOfBins);
  int GetHistogramNumberOfBins()
    { return m_HistogramNumberOfBins; }

  void SetHistogramUseEquiProbableBins(bool flag);
  bool GetHistogramUseEquiProbableBins()
  { return m_HistogramUseEquiProbableBins; }

  void SetHistogramBinOverlap(double overlap);
  double GetHistogramBinOverlap()
    { return m_HistogramBinOverlap; }

  void SetHistogramExtent(double extent);
  double GetHistogramExtent()
    { return m_HistogramExtent; }

  virtual CenterType* GetCenter() = 0;

  virtual RadiusType* GetRadius() = 0;

  virtual MeanType* GetMean() = 0;

  virtual RadiusType* GetStandardDeviation() = 0;

  virtual void CreateHistograms();

  virtual void Resample();

  ResampledSampleType* GetResampledSample()
    { return m_Resampler->GetOutput(); }

  virtual unsigned int GetResampledSampleSize();

  virtual void CalculateProjectionAxes() = 0;

  virtual void Project(int projectionAxisIndex);

  virtual void UpdateExpectedHistogram();

  double* GetTotalObservedScale()
    { return &m_TotalObservedScale; } 

  virtual double GetCumulativeProbability(double x) const = 0;

  virtual double GetProbabilityDensity(MeasurementVectorType &measurements) 
    const = 0;

  virtual double GetProportion() const
    { return m_Proportion; }

  HistogramType *  GetObservedHistogram();

  HistogramType *  GetExpectedHistogram();

  virtual void PrintParameters(std::ostream &os) const = 0;

  virtual ParametersType GetFullParameters() const = 0;

  itkGetConstMacro( MeasurementVectorSize, MeasurementVectorSizeType );

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

  typedef NeighborhoodSampler< TInputSample > ResamplerType;

  typedef SampleToHistogramProjectionFilter< ResampledSampleType, float > 
  ProjectorType;

  
  typedef VariableSizeMatrix< double > ProjectionAxisArrayType;


  ProjectionAxisArrayType* GetProjectionAxes()
    { return &m_ProjectionAxes; }

  virtual void CreateEquiRangeBins();

  virtual void CreateEquiProbableBins();

private:
  MeasurementVectorSizeType m_MeasurementVectorSize;

  const TInputSample* m_InputSample;
  ParametersType      m_Parameters;

  typename ResamplerType::Pointer m_Resampler;
  typename ProjectorType::Pointer m_Projector;

  ProjectionAxisArrayType m_ProjectionAxes;

  unsigned int m_HistogramNumberOfBins;
  bool         m_HistogramUseEquiProbableBins;
  double       m_HistogramExtent;
  double       m_HistogramBinOverlap;
  bool         m_HistogramSizeChanged;

  double m_TotalObservedScale;
  double m_HistogramMean;
  double m_HistogramStandardDeviation;

  double m_Proportion;

  HistogramPointer m_ObservedHistogram;
  HistogramPointer m_ExpectedHistogram;
  bool             m_UseExpectedHistogram;

}; // end of class

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

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

#endif