MaskInstrument.cpp

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 +
#include "MantidAlgorithms/MaskInstrument.h"
#include "MantidAPI/MatrixWorkspace.h"
#include "MantidAPI/SpectrumInfo.h"
#include "MantidDataObjects/EventWorkspace.h"
#include "MantidGeometry/Instrument/DetectorInfo.h"
#include "MantidKernel/ArrayProperty.h"
 
using namespace Mantid::Kernel;
using namespace Mantid::API;
 
namespace Mantid::Algorithms {
 
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(MaskInstrument)
 
 
MaskInstrument::MaskInstrument() {
  useAlgorithm("MaskDetectors");
  deprecatedDate("2020-07-16");
}
 
const std::string MaskInstrument::name() const { return "MaskInstrument"; }
 
int MaskInstrument::version() const { return 1; }
 
const std::string MaskInstrument::category() const { return "Transforms\\Masking"; }
 
const std::string MaskInstrument::summary() const { return "Mask detectors in the instrument"; }
 
void MaskInstrument::init() {
  declareProperty(std::make_unique<WorkspaceProperty<>>("InputWorkspace", "The input workspace", Direction::Input));
  declareProperty(std::make_unique<WorkspaceProperty<>>("OutputWorkspace", "", Direction::Output),
                  "Name of the output workspace (can be same as InputWorkspace)");
  declareProperty(std::make_unique<ArrayProperty<detid_t>>("DetectorIDs"), "List of detector IDs to mask");
}
 
void MaskInstrument::exec() {
  MatrixWorkspace_sptr inputWS = getProperty("InputWorkspace");
  MatrixWorkspace_sptr outputWS = getProperty("OutputWorkspace");
  if (outputWS != inputWS) {
    outputWS = inputWS->clone();
    setProperty("OutputWorkspace", outputWS);
  }
 
  const std::vector<detid_t> detectorIds = getProperty("DetectorIDs");
  auto &detectorInfo = outputWS->mutableDetectorInfo();
  for (const auto &id : detectorIds)
    detectorInfo.setMasked(detectorInfo.indexOf(id), true);
 
  const auto &spectrumInfo = outputWS->spectrumInfo();
  for (size_t i = 0; i < spectrumInfo.size(); ++i) {
    if (spectrumInfo.hasDetectors(i) && spectrumInfo.isMasked(i))
      outputWS->getSpectrum(i).clearData();
  }
 
  if (auto event = dynamic_cast<DataObjects::EventWorkspace *>(outputWS.get()))
    event->clearMRU();
}
 
} // namespace Mantid::Algorithms