NumericAxis.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2008 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
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Axis.h"
 
#include <span>
#include <string>
#include <vector>
 
namespace Mantid {
namespace API {
//----------------------------------------------------------------------
// Forward declaration
//----------------------------------------------------------------------
class MatrixWorkspace;
 
class MANTID_API_DLL NumericAxis : public Axis {
public:
  NumericAxis(const std::size_t &length);
  NumericAxis(std::vector<double> centres);
  NumericAxis(std::span<double const> centres);
 
  Axis *clone(const MatrixWorkspace *const parentWorkspace) override;
  Axis *clone(const std::size_t length, const MatrixWorkspace *const parentWorkspace) override;
  bool isNumeric() const override { return true; }
  std::size_t length() const override { return m_values.size(); }
  double operator()(const std::size_t &index, const std::size_t &verticalIndex = 0) const override;
  void setValue(const std::size_t &index, const double &value) override;
  size_t indexOfValue(const double value) const override;
  bool operator==(const NumericAxis &) const;
  bool operator==(const Axis &) const override;
  virtual bool equalWithinTolerance(const Axis &axis2, const double tolerance) const;
  std::string label(const std::size_t &index) const override;
  virtual std::vector<double> createBinBoundaries() const;
  virtual const std::vector<double> &getValues() const;
  double getMin() const override { return m_values.front(); }
  double getMax() const override { return m_values.back(); }
 
protected:
  NumericAxis();
 
  std::vector<double> m_values;
 
  std::string formatLabel(const double value) const;
};
 
} // namespace API
} // namespace Mantid