itkProbabilityDistribution.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef __itkProbabilityDistribution_h
#define __itkProbabilityDistribution_h

#include "itkIntTypes.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 SizeValueType 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