SpecialWorkspace2D.h

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 +
#pragma once
 
#include "MantidAPI/MatrixWorkspace_fwd.h"
#include "MantidDataObjects/DllConfig.h"
#include "MantidDataObjects/Workspace2D.h"
#include "MantidGeometry/Instrument.h"
#include "MantidKernel/PropertyWithValue.h"
 
namespace Mantid {
namespace DataObjects {
 
class BinaryOperator {
public:
  enum e { AND, OR, XOR, NOT };
};
 
class MANTID_DATAOBJECTS_DLL SpecialWorkspace2D : public Workspace2D {
public:
  SpecialWorkspace2D() = default;
  SpecialWorkspace2D(const Geometry::Instrument_const_sptr &inst, const bool includeMonitors = false);
  SpecialWorkspace2D(const API::MatrixWorkspace_const_sptr &parent);
  SpecialWorkspace2D(const std::vector<detid_t> &detids);
 
  std::unique_ptr<SpecialWorkspace2D> clone() const { return std::unique_ptr<SpecialWorkspace2D>(doClone()); }
  std::unique_ptr<SpecialWorkspace2D> cloneEmpty() const {
    auto workspace = std::unique_ptr<SpecialWorkspace2D>(doCloneEmpty());
    workspace->detID_to_WI = this->detID_to_WI;
    return workspace;
  }
  SpecialWorkspace2D &operator=(const SpecialWorkspace2D &) = delete;
  const std::string id() const override { return "SpecialWorkspace2D"; }
 
  bool isDetectorIDMappingEmpty() const { return detID_to_WI.empty(); }
  void buildDetectorIDMapping();
  bool contains(const detid_t detectorID) const;
  double getValue(const detid_t detectorID) const;
  double getValue(const detid_t detectorID, const double defaultValue) const;
 
  void setValue(const detid_t detectorID, const double value, const double error = 0.);
  void setValue(const std::set<detid_t> &detectorIDs, const double value, const double error = 0.);
 
  std::set<detid_t> getDetectorIDs(const std::size_t workspaceIndex) const;
 
  void binaryOperation(const std::shared_ptr<const SpecialWorkspace2D> &ws, const unsigned int operatortype);
  void binaryOperation(const unsigned int operatortype);
 
  virtual void copyFrom(std::shared_ptr<const SpecialWorkspace2D> sourcews);
 
private:
  SpecialWorkspace2D *doClone() const override { return new SpecialWorkspace2D(*this); }
  SpecialWorkspace2D *doCloneEmpty() const override { return new SpecialWorkspace2D(); }
  bool isCompatible(const std::shared_ptr<const SpecialWorkspace2D> &ws);
 
protected:
  SpecialWorkspace2D(const SpecialWorkspace2D &) = default;
 
  void init(const size_t &NVectors, const size_t &XLength, const size_t &YLength) override;
  void init(const HistogramData::Histogram &histogram) override;
 
  const std::string toString() const override;
 
  void binaryAND(const std::shared_ptr<const SpecialWorkspace2D> &ws);
  void binaryOR(const std::shared_ptr<const SpecialWorkspace2D> &ws);
  void binaryXOR(const std::shared_ptr<const SpecialWorkspace2D> &ws);
  void binaryNOT();
 
  std::map<detid_t, std::size_t> detID_to_WI;
};
 
using SpecialWorkspace2D_sptr = std::shared_ptr<SpecialWorkspace2D>;
 
using SpecialWorkspace2D_const_sptr = std::shared_ptr<const SpecialWorkspace2D>;
 
} // namespace DataObjects
} // namespace Mantid
 
// Instantiated and exported by DataObjects/src/PropertyWithValue.cpp
MANTID_DATAOBJECTS_EXTERN_TEMPLATE(
    Mantid::Kernel::PropertyWithValue<std::shared_ptr<Mantid::DataObjects::SpecialWorkspace2D>>);
 
#ifndef DataObjects_EXPORTS
#include "MantidAPI/WorkspaceProperty.h"
namespace Mantid::API {
extern template class MANTID_DATAOBJECTS_DLL WorkspaceProperty<DataObjects::SpecialWorkspace2D>;
} // namespace Mantid::API
#endif