Workspace2D.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
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/HistoWorkspace.h"
#include "MantidDataObjects/DllConfig.h"
#include "MantidDataObjects/Histogram1D.h"
#include "MantidDataObjects/Workspace2D_fwd.h"
#include "MantidKernel/PropertyWithValue.h"
 
namespace Mantid {
 
namespace DataObjects {
class MANTID_DATAOBJECTS_DLL Workspace2D : public API::HistoWorkspace {
public:
  const std::string id() const override { return "Workspace2D"; }
 
  Workspace2D();
  Workspace2D &operator=(const Workspace2D &other) = delete;
  ~Workspace2D() override;
 
  std::unique_ptr<Workspace2D> clone() const { return std::unique_ptr<Workspace2D>(doClone()); }
 
  std::unique_ptr<Workspace2D> cloneEmpty() const { return std::unique_ptr<Workspace2D>(doCloneEmpty()); }
 
  bool isRaggedWorkspace() const override;
 
  // section required for iteration
  std::size_t size() const override;
 
  std::size_t blocksize() const override;
 
  std::size_t getNumberBins(const std::size_t &index) const override;
  std::size_t getMaxNumberBins() const override;
 
  std::size_t getNumberHistograms() const override;
 
  Histogram1D &getSpectrum(const size_t index) override {
    invalidateCommonBinsFlag();
    return getSpectrumWithoutInvalidation(index);
  }
  const Histogram1D &getSpectrum(const size_t index) const override;
 
  void generateHistogram(const std::size_t index, std::span<double const> X, MantidVec &Y, MantidVec &E,
                         bool skipError = false) const override;
 
  void setMonitorList(const std::vector<specnum_t> &mList) { m_monitorList = mList; }
 
  void setImageY(const API::MantidImage &image, size_t start = 0, bool parallelExecution = true) override;
  void setImageE(const API::MantidImage &image, size_t start = 0, bool parallelExecution = true) override;
  void setImageYAndE(const API::MantidImage &imageY, const API::MantidImage &imageE, size_t start = 0,
                     bool loadAsRectImg = false, double scale_1 = 1.0, [[maybe_unused]] bool parallelExecution = true);
 
protected:
  Workspace2D(const Workspace2D &other);
 
  void init(const std::size_t &NVectors, const std::size_t &XLength, const std::size_t &YLength) override;
  void init(const HistogramData::Histogram &histogram) override;
 
  std::vector<specnum_t> m_monitorList;
 
  std::vector<std::unique_ptr<Histogram1D>> data;
 
private:
  Workspace2D *doClone() const override;
  Workspace2D *doCloneEmpty() const override;
 
  Histogram1D &getSpectrumWithoutInvalidation(const size_t index) override;
  virtual std::size_t getHistogramNumberHelper() const;
};
} // namespace DataObjects
} // Namespace Mantid
 
// Instantiated and exported by DataObjects/src/PropertyWithValue.cpp
MANTID_DATAOBJECTS_EXTERN_TEMPLATE(
    Mantid::Kernel::PropertyWithValue<std::shared_ptr<Mantid::DataObjects::Workspace2D>>);
 
#ifndef DataObjects_EXPORTS
#include "MantidAPI/WorkspaceProperty.h"
namespace Mantid::API {
extern template class MANTID_DATAOBJECTS_DLL WorkspaceProperty<DataObjects::Workspace2D>;
} // namespace Mantid::API
#endif