ISpectrum.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/ISpectrum.h"
#include "MantidAPI/MatrixWorkspace.h"
#include "MantidHistogramData/Histogram.h"
#include "MantidKernel/System.h"
 
namespace Mantid::API {
 
ISpectrum::ISpectrum(const specnum_t specNo) : m_specNo(specNo) {}
 
void ISpectrum::copyInfoFrom(const ISpectrum &other) {
  m_specNo = other.m_specNo;
  detectorIDs = other.detectorIDs;
  invalidateCachedSpectrumNumbers();
  invalidateSpectrumDefinition();
}
 
std::pair<double, double> ISpectrum::getXDataRange() const {
  const auto &xdata = readX();
  return std::pair<double, double>(xdata.front(), xdata.back());
}
 
const MantidVec &ISpectrum::readY() const { return this->dataY(); }
 
const MantidVec &ISpectrum::readE() const { return this->dataE(); }
 
void ISpectrum::addDetectorID(const detid_t detID) {
  size_t oldSize = detectorIDs.size();
  this->detectorIDs.insert(detID);
  if (detectorIDs.size() != oldSize)
    invalidateSpectrumDefinition();
}
 
void ISpectrum::addDetectorIDs(const std::set<detid_t> &detIDs) {
  size_t oldSize = detectorIDs.size();
  this->detectorIDs.insert(detIDs.begin(), detIDs.end());
  if (detectorIDs.size() != oldSize)
    invalidateSpectrumDefinition();
}
 
void ISpectrum::addDetectorIDs(const std::vector<detid_t> &detIDs) {
  size_t oldSize = detectorIDs.size();
  this->detectorIDs.insert(detIDs.begin(), detIDs.end());
  if (detectorIDs.size() != oldSize)
    invalidateSpectrumDefinition();
}
 
void ISpectrum::setDetectorID(const detid_t detID) {
  this->detectorIDs.clear();
  this->detectorIDs.insert(detID);
  invalidateSpectrumDefinition();
}
 
void ISpectrum::setDetectorIDs(const std::set<detid_t> &detIDs) {
  detectorIDs = detIDs;
  invalidateSpectrumDefinition();
}
 
void ISpectrum::setDetectorIDs(std::set<detid_t> &&detIDs) {
  detectorIDs = std::move(detIDs);
  invalidateSpectrumDefinition();
}
 
bool ISpectrum::hasDetectorID(const detid_t detID) const { return (detectorIDs.find(detID) != detectorIDs.end()); }
 
const std::set<detid_t> &ISpectrum::getDetectorIDs() const { return this->detectorIDs; }
 
void ISpectrum::clearDetectorIDs() {
  this->detectorIDs.clear();
  invalidateSpectrumDefinition();
}
 
specnum_t ISpectrum::getSpectrumNo() const { return m_specNo; }
 
void ISpectrum::setSpectrumNo(specnum_t num) {
  m_specNo = num;
  invalidateCachedSpectrumNumbers();
}
 
bool ISpectrum::hasDx() const { return bool(histogramRef().sharedDx()); }
 
void ISpectrum::resetHasDx() { mutableHistogramRef().setSharedDx(nullptr); }
 
ISpectrum::ISpectrum(const ISpectrum &other) : m_specNo(other.m_specNo), detectorIDs(other.detectorIDs) {
  // m_matrixWorkspace and m_index are not copied: A copy should not refer to
  // the parent of the source. m_experimentInfo will be nullptr.
}
 
ISpectrum::ISpectrum(ISpectrum &&other) : m_specNo(other.m_specNo), detectorIDs(std::move(other.detectorIDs)) {
  // m_matrixWorkspace and m_index are not copied: A copy should not refer to
  // the parent of the source. m_experimentInfo will be nullptr.
}
 
ISpectrum &ISpectrum::operator=(const ISpectrum &other) {
  m_specNo = other.m_specNo;
  detectorIDs = other.detectorIDs;
  // m_matrixWorkspace and m_index are not assigned: The lhs of the assignment
  // keeps its current values.
  invalidateCachedSpectrumNumbers();
  invalidateSpectrumDefinition();
  return *this;
}
 
ISpectrum &ISpectrum::operator=(ISpectrum &&other) {
  m_specNo = other.m_specNo;
  detectorIDs = std::move(other.detectorIDs);
  // m_matrixWorkspace and m_index are not assigned: The lhs of the assignment
  // keeps its current values.
  invalidateCachedSpectrumNumbers();
  invalidateSpectrumDefinition();
  return *this;
}
 
void ISpectrum::setMatrixWorkspace(MatrixWorkspace *matrixWorkspace, const size_t index) {
  m_matrixWorkspace = matrixWorkspace;
  m_index = index;
}
 
void ISpectrum::invalidateCachedSpectrumNumbers() const {
  if (m_matrixWorkspace)
    m_matrixWorkspace->invalidateCachedSpectrumNumbers();
}
 
void ISpectrum::invalidateSpectrumDefinition() const {
  if (m_matrixWorkspace)
    m_matrixWorkspace->invalidateSpectrumDefinition(m_index);
}
 
void ISpectrum::copyDataInto(DataObjects::EventList & /*unused*/) const {
  throw std::runtime_error("Incompatible types in ISpectrum::copyDataFrom");
}
void ISpectrum::copyDataInto(DataObjects::Histogram1D & /*unused*/) const {
  throw std::runtime_error("Incompatible types in ISpectrum::copyDataFrom");
}
 
void ISpectrum::copyDataInto(SpectrumTester & /*unused*/) const {
  throw std::runtime_error("Incompatible types in ISpectrum::copyDataFrom");
}
 
} // namespace Mantid::API