MDDimensionStats.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 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 "MantidDataObjects/MDLeanEvent.h"
 
namespace Mantid {
namespace DataObjects {
 
class MANTID_DATAOBJECTS_DLL MDDimensionStats {
public:
  MDDimensionStats() : total(0.0), totalApproxVariance(0.0), numPoints(0) {}
 
  //---------------------------------------------------------------------------------------
  coord_t getMean() const { return total / static_cast<coord_t>(numPoints); }
 
  coord_t getApproxVariance() const { return totalApproxVariance / static_cast<coord_t>(numPoints); }
 
  //---------------------------------------------------------------------------------------
  void addPoint(const coord_t x) {
    total += x;
    numPoints++;
    coord_t diff = (x - total / static_cast<coord_t>(numPoints));
    totalApproxVariance += diff * diff;
  }
 
  //---------------------------------------------------------------------------------------
  //--- Public members ---
 
  coord_t total;
 
  coord_t totalApproxVariance;
 
  size_t numPoints;
};
 
} // namespace DataObjects
} // namespace Mantid