itkTDistribution.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 itkTDistribution_h
#define itkTDistribution_h

#include "itkProbabilityDistribution.h"
#include "itkNumericTraits.h"
#include "ITKStatisticsExport.h"

namespace itk
{
namespace Statistics
{
class ITKStatistics_EXPORT TDistribution:
  public ProbabilityDistribution
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(TDistribution);

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

  itkTypeMacro(TDistribution, ProbabilityDistribution);

  itkNewMacro(Self);

  SizeValueType GetNumberOfParameters() const override { return 1; }

  double EvaluatePDF(double x) const override;

  double EvaluatePDF(double x, const ParametersType &) const override;

  virtual double EvaluatePDF(double x, SizeValueType degreesOfFreedom) const;

  double EvaluateCDF(double x) const override;

  double EvaluateCDF(double x, const ParametersType &) const override;

  virtual double EvaluateCDF(double x, SizeValueType degreesOfFreedom) const;

  double EvaluateInverseCDF(double p) const override;

  double EvaluateInverseCDF(double p, const ParametersType &) const override;

  virtual double EvaluateInverseCDF(double p, SizeValueType degreesOfFreedom) const;

  virtual void SetDegreesOfFreedom(SizeValueType);

  virtual SizeValueType GetDegreesOfFreedom() const;

  bool HasMean() const override { return true; }

  double GetMean() const override;

  bool HasVariance() const override;

  double GetVariance() const override;

  static double PDF(double x, const ParametersType &);

  static double PDF(double x, SizeValueType degreesOfFreedom);

  static double CDF(double x, const ParametersType &);

  static double CDF(double x, SizeValueType degreesOfFreedom);

  static double InverseCDF(double p, const ParametersType &);

  static double InverseCDF(double p, SizeValueType degreesOfFreedom);

protected:
  TDistribution();
  ~TDistribution() override = default;

  void PrintSelf(std::ostream & os, Indent indent) const override;
};                              // end of class
} // end of namespace Statistics
} // end namespace itk

#endif