RobustAverage.h

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
 
 
#ifndef ALICEO2_ROBUSTAVERAGE_H_
#define ALICEO2_ROBUSTAVERAGE_H_
 
#include <vector>
 
namespace o2::tpc
{
 
 
class RobustAverage
{
 public:
  RobustAverage(const unsigned int maxValues, bool withWeights = true) : mUseWeights{withWeights}
  {
    mValues.reserve(maxValues);
    if (mUseWeights) {
      mWeights.reserve(maxValues);
    }
  }
 
  RobustAverage() = default;
 
  RobustAverage(std::vector<float>&& values) : mValues{std::move(values)} {};
 
  void reserve(const unsigned int maxValues);
 
  void clear();
 
  void addValue(const float value, const float weight = 1);
 
  std::pair<float, float> getFilteredAverage(const float sigma = 3, const float interQuartileRange = 0.9);
 
  std::tuple<float, float, float, unsigned int> filterPointsMedian(const float maxAbsMedian, const float sigma = 5);
 
  float getMean() const { return mValues.empty() ? 0 : getMean(mValues.begin(), mValues.end()); }
 
  float getTrunctedMean(float low, float high);
 
  float getMedian();
 
  float getWeightedMean() const { return mUseWeights ? getWeightedMean(mValues.begin(), mValues.end(), mWeights.begin(), mWeights.end()) : 0; }
 
  float getStdDev() { return getStdDev(getMean(), mValues.begin(), mValues.end()); }
 
  const auto& getValues() const { return mValues; }
 
  void setValues(const std::vector<float>& values) { mValues = values; }
 
  const auto& getWeigths() const { return mWeights; }
 
  void print() const;
 
  // sorting values and weights
  void sort();
 
  bool getUseWeights() const { return mUseWeights; }
 
  void setUseWeights(bool useweights) { mUseWeights = useweights; }
 
  float getQuantile(float quantile, int type);
 
 private:
  std::vector<float> mValues{};    
  std::vector<float> mWeights{};   
  std::vector<float> mTmpValues{}; 
  bool mUseWeights{};              
 
  float getMean(std::vector<float>::const_iterator begin, std::vector<float>::const_iterator end) const;
 
  float getWeightedMean(std::vector<float>::const_iterator beginValues, std::vector<float>::const_iterator endValues, std::vector<float>::const_iterator beginWeight, std::vector<float>::const_iterator endWeight) const;
 
  float getStdDev(const float mean, std::vector<float>::const_iterator begin, std::vector<float>::const_iterator end);
 
  float getFilteredMean(const float mean, const float stdev, const float sigma) const;
};
 
} // namespace o2::tpc
 
#endif