EqualBinsChecker.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2016 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 "MantidKernel/cow_ptr.h"
#include <span>
#include <string>
 
namespace Mantid {
namespace Kernel {
 
class MANTID_KERNEL_DLL EqualBinsChecker {
public:
  enum class ReferenceBin { Average, First };
  enum class ErrorType { Cumulative, Individual };
  // Note: xData is a non-owning view and must outlive this object. It is a span so that the
  // size-checked histogram data types can be checked directly, without a std::vector<double>.
  EqualBinsChecker(std::span<double const> xData, const double errorLevel, const double warningLevel = -1);
  virtual ~EqualBinsChecker() = default;
  virtual std::string validate() const;
  virtual void setReferenceBin(const ReferenceBin &refBinType);
  virtual void setErrorType(const ErrorType &errorType);
 
protected:
  virtual double getReferenceDx() const;
  virtual double getDifference(const size_t bin, const double dx) const;
 
private:
  std::span<double const> const m_xData;
  const double m_errorLevel;
  const bool m_warn;
  const double m_warningLevel;
  ReferenceBin m_refBinType;
  ErrorType m_errorType;
};
 
} // namespace Kernel
} // namespace Mantid