SpectraAxis.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 "MantidAPI/DllConfig.h"
#include "MantidAPI/SpectraDetectorTypes.h"
#include "MantidKernel/Unit.h"
#include <string>
#include <vector>
 
namespace Mantid {
namespace API {
//----------------------------------------------------------------------
// Forward declaration
//----------------------------------------------------------------------
class MatrixWorkspace;
 
class MANTID_API_DLL SpectraAxis : public Axis {
public:
  explicit SpectraAxis(const MatrixWorkspace *const parentWorkspace);
  Axis *clone(const MatrixWorkspace *const parentWorkspace) override;
  Axis *clone(const std::size_t length, const MatrixWorkspace *const parentWorkspace) override;
  std::size_t length() const override;
  bool isSpectra() const override { return true; }
  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 Axis &) const override;
  std::string label(const std::size_t &index) const override;
 
  specnum_t spectraNo(const std::size_t &index) const override;
  // Get a map that contains the spectra index as the key and the index in the
  // array as the value
  spec2index_map getSpectraIndexMap() const;
 
  double getMin() const override;
  double getMax() const override;
 
private:
  SpectraAxis();
  SpectraAxis(const SpectraAxis &);
  const SpectraAxis &operator=(const SpectraAxis &);
  const MatrixWorkspace *const m_parentWS;
  mutable std::vector<double> m_edges;
};
 
} // namespace API
} // namespace Mantid