MaskWorkspace.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/IMaskWorkspace.h"
#include "MantidAPI/MatrixWorkspace_fwd.h"
#include "MantidDataObjects/DllConfig.h"
#include "MantidDataObjects/SpecialWorkspace2D.h"
#include "MantidDataObjects/Workspace2D.h"
#include "MantidGeometry/Instrument/DetectorInfo.h"
#include "MantidKernel/PropertyWithValue.h"
 
namespace Mantid {
namespace DataObjects {
 
// Reference Docs
// Concepts: TODO
// API: TODO
 
class MANTID_DATAOBJECTS_DLL MaskWorkspace : public SpecialWorkspace2D, public API::IMaskWorkspace {
public:
  MaskWorkspace() = default;
  MaskWorkspace(std::size_t numvectors);
  MaskWorkspace(const Mantid::Geometry::Instrument_const_sptr &instrument, const bool includeMonitors = false);
  MaskWorkspace(const API::MatrixWorkspace_const_sptr &parent);
  inline MaskWorkspace(const std::vector<detid_t> &detids) : SpecialWorkspace2D(detids) { this->clearMask(); }
 
  std::unique_ptr<MaskWorkspace> clone() const { return std::unique_ptr<MaskWorkspace>(doClone()); }
  std::unique_ptr<MaskWorkspace> cloneEmpty() const { return std::unique_ptr<MaskWorkspace>(doCloneEmpty()); }
  MaskWorkspace &operator=(const MaskWorkspace &other) = delete;
  bool containsDetID(const detid_t detectorID) const override;
  bool containsDetIDs(const std::set<detid_t> &detectorIDs) const override;
  bool containsDetIDs(const std::vector<detid_t> &detectorIDs) const override;
  bool isMasked(const detid_t detectorID) const override;
  bool isMasked(const std::set<detid_t> &detectorIDs) const override;
  bool isMaskedIndex(const std::size_t wkspIndex) const;
  void setMasked(const detid_t detectorID, const bool mask = true) override;
  void setMasked(const std::set<detid_t> &detectorIDs, const bool mask = true) override;
  void setMaskedIndex(const std::size_t wkspIndex, const bool mask = true);
  std::size_t getNumberMasked() const override;
  std::set<detid_t> getMaskedDetectors() const;
  std::set<std::size_t> getMaskedWkspIndices() const;
 
  const std::string id() const override;
 
  void copyFrom(std::shared_ptr<const SpecialWorkspace2D> sourcews) override;
 
  void combineToDetectorMasks(Mantid::Geometry::DetectorInfo &detectors) const;
 
  void combineToDetectorMasks() { combineToDetectorMasks(mutableDetectorInfo()); }
 
  void combineFromDetectorMasks(const Mantid::Geometry::DetectorInfo &detectors);
 
  void combineFromDetectorMasks() { combineFromDetectorMasks(detectorInfo()); }
 
  bool isConsistentWithDetectorMasks(const Mantid::Geometry::DetectorInfo &detectors) const;
 
  bool isConsistentWithDetectorMasks() const { return isConsistentWithDetectorMasks(detectorInfo()); }
 
protected:
  MaskWorkspace(const MaskWorkspace &) = default;
 
  const std::string toString() const override;
 
private:
  MaskWorkspace *doClone() const override { return new MaskWorkspace(*this); }
  MaskWorkspace *doCloneEmpty() const override { return new MaskWorkspace(); }
 
  IMaskWorkspace *doInterfaceClone() const override { return doClone(); }
  void clearMask();
 
  bool hasInstrument() const;
};
 
using MaskWorkspace_sptr = std::shared_ptr<MaskWorkspace>;
 
using MaskWorkspace_const_sptr = std::shared_ptr<const MaskWorkspace>;
 
} // namespace DataObjects
} // namespace Mantid
 
// Instantiated and exported by DataObjects/src/PropertyWithValue.cpp
MANTID_DATAOBJECTS_EXTERN_TEMPLATE(
    Mantid::Kernel::PropertyWithValue<std::shared_ptr<Mantid::DataObjects::MaskWorkspace>>);
 
#ifndef DataObjects_EXPORTS
#include "MantidAPI/WorkspaceProperty.h"
namespace Mantid::API {
extern template class MANTID_DATAOBJECTS_DLL WorkspaceProperty<DataObjects::MaskWorkspace>;
} // namespace Mantid::API
#endif