itkProbabilityDistribution.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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"
#include "ITKStatisticsExport.h"
 
namespace itk::Statistics
{
class ITKStatistics_EXPORT ProbabilityDistribution : public Object
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ProbabilityDistribution);

  using Self = ProbabilityDistribution;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(ProbabilityDistribution);

  using ParametersType = Array<double>;

  virtual SizeValueType
  GetNumberOfParameters() const = 0;

  itkGetConstReferenceMacro(Parameters, ParametersType);

  virtual void
  SetParameters(const ParametersType & params);

  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();
  ~ProbabilityDistribution() override;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  ParametersType m_Parameters{};
}; // end of class
} // namespace itk::Statistics
 
#endif