Histogram1D.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 "MantidDataObjects/Histogram1D.h"
#include "MantidKernel/Exception.h"
#include "MantidKernel/WarningSuppressions.h"
 
namespace Mantid::DataObjects {
 
Histogram1D::Histogram1D(HistogramData::Histogram::XMode xmode, HistogramData::Histogram::YMode ymode)
    : API::ISpectrum(), m_histogram(xmode, ymode) {
  if (ymode == HistogramData::Histogram::YMode::Counts) {
    m_histogram.setCounts(0);
    m_histogram.setCountStandardDeviations(0);
  } else if (ymode == HistogramData::Histogram::YMode::Frequencies) {
    m_histogram.setFrequencies(0);
    m_histogram.setFrequencyStandardDeviations(0);
  } else {
    throw std::logic_error("Histogram1D: YMode must be Counts or Frequencies");
  }
}
 
Histogram1D::Histogram1D(const ISpectrum &other) : ISpectrum(other), m_histogram(other.histogram()) {}
 
Histogram1D &Histogram1D::operator=(const ISpectrum &rhs) {
  ISpectrum::operator=(rhs);
  m_histogram = rhs.histogram();
  return *this;
}
 
void Histogram1D::copyDataFrom(const ISpectrum &source) { source.copyDataInto(*this); }
 
void Histogram1D::copyDataInto(Histogram1D &sink) const { sink.m_histogram = m_histogram; }
 
void Histogram1D::clearData() {
  auto &yValues = this->mutableY();
  std::fill(yValues.begin(), yValues.end(), 0.0);
  auto &eValues = this->mutableE();
  std::fill(eValues.begin(), eValues.end(), 0.0);
}
 
void Histogram1D::setX(const Kernel::cow_ptr<HistogramData::HistogramX> &X) { m_histogram.setSharedX(X); }
 
// 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)
 
MantidVec &Histogram1D::dataX() { return m_histogram.dataX(); }
 
MSVC_DIAG_ON(4996)
GNU_DIAG_ON("deprecated-declarations")
 
const MantidVec &Histogram1D::dataX() const { return m_histogram.x().rawData(); }
 
const MantidVec &Histogram1D::readX() const { return m_histogram.x().rawData(); }
 
Kernel::cow_ptr<HistogramData::HistogramX> Histogram1D::ptrX() const { return m_histogram.sharedX(); }
 
GNU_DIAG_OFF("deprecated-declarations")
MSVC_DIAG_OFF(4996)
MantidVec &Histogram1D::dataDx() { return m_histogram.dataDx(); }
MSVC_DIAG_ON(4996)
GNU_DIAG_ON("deprecated-declarations")
const MantidVec &Histogram1D::dataDx() const { return m_histogram.dx().rawData(); }
const MantidVec &Histogram1D::readDx() const { return m_histogram.dx().rawData(); }
 
void Histogram1D::checkAndSanitizeHistogram(HistogramData::Histogram &histogram) {
  if (!histogram.sharedY()) {
    throw std::invalid_argument("Histogram1D: invalid input: Y data set to nullptr");
  }
  if (!histogram.sharedE()) {
    throw std::invalid_argument("Histogram1D: invalid input: E data set to nullptr");
  }
}
 
} // namespace Mantid::DataObjects