Histogram1D.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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 "MantidAPI/ISpectrum.h"
#include "MantidDataObjects/DllConfig.h"
#include "MantidKernel/WarningSuppressions.h"
#include "MantidKernel/cow_ptr.h"
 
namespace Mantid {
namespace DataObjects {
class MANTID_DATAOBJECTS_DLL Histogram1D : public Mantid::API::ISpectrum {
private:
  HistogramData::Histogram m_histogram;
 
public:
  Histogram1D(HistogramData::Histogram::XMode xmode, HistogramData::Histogram::YMode ymode);
 
  Histogram1D(const Histogram1D &) = default;
  Histogram1D(Histogram1D &&) = default;
  Histogram1D(const ISpectrum &other);
 
  Histogram1D &operator=(const Histogram1D &) = default;
  Histogram1D &operator=(Histogram1D &&) = default;
  Histogram1D &operator=(const ISpectrum &rhs);
 
  void copyDataFrom(const ISpectrum &source) override;
 
  [[deprecated("use setSharedX() instead")]]
  void setX(const Kernel::cow_ptr<HistogramData::HistogramX> &X) override;
  [[deprecated("use mutableX() instead")]]
  MantidVec &dataX() override;
  [[deprecated("use x() instead")]]
  const MantidVec &dataX() const override;
  [[deprecated("use x() instead")]]
  const MantidVec &readX() const override;
  [[deprecated("use sharedX() instead")]]
  Kernel::cow_ptr<HistogramData::HistogramX> ptrX() const override;
 
  [[deprecated("use mutableDx() instead")]]
  MantidVec &dataDx() override;
  [[deprecated("use dx() instead")]]
  const MantidVec &dataDx() const override;
  [[deprecated("use dx() instead")]]
  const MantidVec &readDx() const override;
 
  void clearData() override;
 
  [[deprecated("use y() instead")]]
  const MantidVec &dataY() const override {
    return m_histogram.y().rawData();
  }
  [[deprecated("use e() instead")]]
  const MantidVec &dataE() const override {
    return m_histogram.e().rawData();
  }
 
  // The mutable legacy accessors below can only be expressed in terms of Histogram's own legacy
  // interface: handing out a mutable MantidVec would allow the length to be changed, so
  // FixedLengthVector::mutableRawData() is protected and Histogram is its only friend.
  GNU_DIAG_OFF("deprecated-declarations")
  MSVC_DIAG_OFF(4996)
  [[deprecated("use mutableY() instead")]]
  MantidVec &dataY() override {
    return m_histogram.dataY();
  }
  [[deprecated("use mutableE() instead")]]
  MantidVec &dataE() override {
    return m_histogram.dataE();
  }
  MSVC_DIAG_ON(4996)
  GNU_DIAG_ON("deprecated-declarations")
 
  virtual std::size_t size() const { return m_histogram.y().size(); } 
 
  bool isError() const { return e().empty(); }
 
  size_t getMemorySize() const override { return ((x().size() + y().size() + e().size()) * sizeof(double)); }
 
private:
  using ISpectrum::copyDataInto;
  void copyDataInto(Histogram1D &sink) const override;
 
  void checkAndSanitizeHistogram(HistogramData::Histogram &histogram) override;
  const HistogramData::Histogram &histogramRef() const override { return m_histogram; }
  HistogramData::Histogram &mutableHistogramRef() override { return m_histogram; }
};
 
} // namespace DataObjects
} // Namespace Mantid