MaskDetectorsInShape.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2009 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/DistributedAlgorithm.h"
#include "MantidDataHandling/DllConfig.h"
 
namespace Mantid {
namespace DataHandling {
class MANTID_DATAHANDLING_DLL MaskDetectorsInShape : public API::DistributedAlgorithm {
public:
  const std::string name() const override { return "MaskDetectorsInShape"; };
  int version() const override { return 1; };
  const std::vector<std::string> seeAlso() const override { return {"MaskDetectors", "FindDetectorsInShape"}; }
  const std::string category() const override { return "Transforms\\Masking"; }
  const std::string summary() const override { return "Masks detectors whose centres fall within the given 3D shape."; }
 
private:
  // Implement abstract Algorithm methods
  void init() override;
  void exec() override;
 
  // internal functions
  std::vector<int> runFindDetectorsInShape(const API::MatrixWorkspace_sptr &workspace, const std::string &shapeXML,
                                           const bool includeMonitors);
  void runMaskDetectors(const API::MatrixWorkspace_sptr &workspace, const std::vector<int> &detectorIds);
};
 
} // namespace DataHandling
} // namespace Mantid