RebinnedOutput.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2012 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 "MantidDataObjects/Workspace2D.h"
#include "MantidKernel/PropertyWithValue.h"
 
namespace Mantid {
namespace DataObjects {
 
class MANTID_DATAOBJECTS_DLL RebinnedOutput : public Workspace2D {
public:
  RebinnedOutput() : m_finalized(false), m_hasSqrdErrs(true) {}
  RebinnedOutput(bool finalized, bool hasSqrdErrs) : m_finalized(finalized), m_hasSqrdErrs(hasSqrdErrs) {}
  std::unique_ptr<RebinnedOutput> clone() const { return std::unique_ptr<RebinnedOutput>(doClone()); }
  std::unique_ptr<RebinnedOutput> cloneEmpty() const { return std::unique_ptr<RebinnedOutput>(doCloneEmpty()); }
  RebinnedOutput &operator=(const RebinnedOutput &) = delete;
 
  const std::string id() const override;
 
  virtual MantidVec &dataF(const std::size_t index);
 
  virtual const MantidVec &dataF(const std::size_t index) const;
 
  void finalize(bool hasSqrdErrs = true);
  void unfinalize();
 
  bool isFinalized() const { return m_finalized; }
  void setFinalized(bool value) { m_finalized = value; }
 
  bool hasSqrdErrors() const { return m_hasSqrdErrs; }
  void setSqrdErrors(bool value) { m_hasSqrdErrs = value; }
 
  const MantidVec &readF(std::size_t const index) const;
 
  void setF(const std::size_t index, const MantidVecPtr &F);
  void scaleF(const double scale);
  bool nonZeroF() const;
 
protected:
  RebinnedOutput(const RebinnedOutput &) = default;
 
  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<MantidVec> fracArea;
 
  bool m_finalized;
 
  bool m_hasSqrdErrs;
 
private:
  RebinnedOutput *doClone() const override { return new RebinnedOutput(*this); }
  RebinnedOutput *doCloneEmpty() const override { return new RebinnedOutput(m_finalized, m_hasSqrdErrs); }
};
 
using RebinnedOutput_sptr = std::shared_ptr<RebinnedOutput>;
using RebinnedOutput_const_sptr = std::shared_ptr<const RebinnedOutput>;
 
} // namespace DataObjects
} // namespace Mantid
 
// Instantiated and exported by DataObjects/src/PropertyWithValue.cpp
MANTID_DATAOBJECTS_EXTERN_TEMPLATE(
    Mantid::Kernel::PropertyWithValue<std::shared_ptr<Mantid::DataObjects::RebinnedOutput>>);