Review/Statistics/itkProbabilityDistribution.h

Go to the documentation of this file.

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

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

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

#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkArray.h"

namespace itk { 
namespace Statistics {

class ITK_EXPORT ProbabilityDistribution :
    public Object
{
public:
  typedef ProbabilityDistribution  Self;
  typedef Object                   Superclass;
  typedef SmartPointer<Self>       Pointer;
  typedef SmartPointer<const Self> ConstPointer;

  itkTypeMacro(ProbabilityDistribution, Object);

  typedef  Array< double >           ParametersType;

  virtual unsigned long GetNumberOfParameters() const = 0;

  itkGetConstReferenceMacro(Parameters, ParametersType);

  virtual void SetParameters(const ParametersType& params)
    {
    if ((params.GetSize() != m_Parameters.GetSize())
        || (params != m_Parameters))
      {
      m_Parameters = params;
      this->Modified();
      }
    }

  virtual double EvaluatePDF(double x) const = 0;

  virtual double EvaluatePDF(double x, const ParametersType&) const = 0;

  virtual double EvaluateCDF(double x) const = 0;

  virtual double EvaluateCDF(double x, const ParametersType&) const = 0;

  virtual double EvaluateInverseCDF(double p) const = 0;

  virtual double EvaluateInverseCDF(double p, const ParametersType&) const = 0;

  virtual bool HasMean() const = 0;

  virtual bool HasVariance() const = 0;

  virtual double GetMean() const = 0;

  virtual double GetVariance() const = 0;

protected:
  ProbabilityDistribution(void) {}
  virtual ~ProbabilityDistribution(void) {}
  void PrintSelf(std::ostream& os, Indent indent) const
    {
    Superclass::PrintSelf(os,indent);
    os << indent << "Parameters: " << m_Parameters << std::endl;
    }

  ParametersType m_Parameters;

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

}; // end of class

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

#endif