Statistics.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2010 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#include "MantidKernel/DllConfig.h"
#include <span>
#include <vector>
 
namespace Mantid {
namespace Kernel {
namespace Math {
enum StatisticType : int {
  FirstValue,
  LastValue,
  Minimum,
  Maximum,
  Mean,
  TimeAveragedMean,
  Median,
  StdDev,
  TimeAverageStdDev
};
} // namespace Math
 
struct MANTID_KERNEL_DLL Statistics {
  double minimum;
  double maximum;
  double mean;
  double median;
  double standard_deviation;
 
  Statistics();
};
 
struct StatOptions {
  enum Flag {
    SortedData = 1,        // is the data sorted?
    Mean = 2,              // calculate the mean
    UncorrectedStdDev = 4, // calculate the s.d. using N dofs
    CorrectedStdDev = 8,   // calculate the s.d. using N-1 dofs
    Median = 16,           // calculate the median
    AllStats = (Mean | UncorrectedStdDev | Median)
  };
};
 
struct Rfactor {
  double Rwp;
  double Rp;
  Rfactor(double rwp, double rp) : Rwp(rwp), Rp(rp) {}
  Rfactor() {
    Rwp = -1.0;
    Rp = -1.0;
  }
};
 
template <typename TYPE>
Statistics getStatistics(const std::vector<TYPE> &data, const unsigned int flags = StatOptions::AllStats);
template <typename TYPE> std::vector<double> getZscore(const std::vector<TYPE> &data);
 
MANTID_KERNEL_DLL Statistics getStatistics(std::span<double const> data,
                                           const unsigned int flags = StatOptions::AllStats);
MANTID_KERNEL_DLL std::vector<double> getZscore(std::span<double const> data);
 
template <typename TYPE>
std::vector<double> getWeightedZscore(const std::vector<TYPE> &data, const std::vector<TYPE> &weights);
template <typename TYPE> std::vector<double> getModifiedZscore(const std::vector<TYPE> &data);
Rfactor MANTID_KERNEL_DLL getRFactor(std::span<double const> obsI, std::span<double const> calI,
                                     std::span<double const> obsE);
 
template <typename TYPE>
std::vector<double> getMomentsAboutOrigin(const std::vector<TYPE> &x, const std::vector<TYPE> &y,
                                          const int maxMoment = 3);
template <typename TYPE>
std::vector<double> getMomentsAboutMean(const std::vector<TYPE> &x, const std::vector<TYPE> &y,
                                        const int maxMoment = 3);
} // namespace Kernel
} // namespace Mantid