BinEdgeAxis.cpp

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 +
#include "MantidAPI/BinEdgeAxis.h"
#include "MantidKernel/Exception.h"
#include "MantidKernel/VectorHelper.h"
 
namespace Mantid::API {
 
//----------------------------------------------------------------------------------------------
BinEdgeAxis::BinEdgeAxis(const std::size_t &length)
    : NumericAxis() // default constructor
{
  m_values.resize(length);
}
 
BinEdgeAxis::BinEdgeAxis(const std::vector<double> &edges)
    : NumericAxis() // default constructor
{
  m_values = edges;
}
 
BinEdgeAxis::BinEdgeAxis(std::span<double const> edges)
    : NumericAxis() // default constructor
{
  m_values.assign(edges.begin(), edges.end());
}
 
Axis *BinEdgeAxis::clone(const MatrixWorkspace *const parentWorkspace) {
  UNUSED_ARG(parentWorkspace)
  return new BinEdgeAxis(*this);
}
 
Axis *BinEdgeAxis::clone(const std::size_t length, const MatrixWorkspace *const parentWorkspace) {
  UNUSED_ARG(parentWorkspace)
  auto *newAxis = new BinEdgeAxis(*this);
  newAxis->m_values.clear();
  newAxis->m_values.resize(length);
  return newAxis;
}
 
std::vector<double> BinEdgeAxis::createBinBoundaries() const { return this->getValues(); }
 
void BinEdgeAxis::setValue(const std::size_t &index, const double &value) {
  // Avoids setting edge information
  if (index >= length()) {
    throw Kernel::Exception::IndexError(index, length() - 1, "BinEdgeAxis: Index out of range.");
  }
  m_values[index] = value;
}
 
size_t BinEdgeAxis::indexOfValue(const double value) const {
  return Mantid::Kernel::VectorHelper::indexOfValueFromEdges(m_values, value);
}
 
std::string BinEdgeAxis::label(const std::size_t &index) const {
  if (index >= length() - 1) {
    throw Kernel::Exception::IndexError(index, length() - 2, "BinEdgeAxis: Bin index out of range.");
  }
  return formatLabel(((*this)(index) + (*this)(index + 1)) / 2);
}
} // namespace Mantid::API